Class: AmznSpApi::SalesApiModel::OrderMetricsInterval

Inherits:
Object
  • Object
show all
Defined in:
lib/sales_api_model/models/order_metrics_interval.rb

Overview

Contains order metrics.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderMetricsInterval

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 60

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::SalesApiModel::OrderMetricsInterval` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::SalesApiModel::OrderMetricsInterval`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.interval = attributes[:interval] if attributes.key?(:interval)

  self.unit_count = attributes[:unit_count] if attributes.key?(:unit_count)

  self.order_item_count = attributes[:order_item_count] if attributes.key?(:order_item_count)

  self.order_count = attributes[:order_count] if attributes.key?(:order_count)

  self.average_unit_price = attributes[:average_unit_price] if attributes.key?(:average_unit_price)

  return unless attributes.key?(:total_sales)

  self.total_sales = attributes[:total_sales]
end

Instance Attribute Details

#average_unit_price ⇒ Object

Returns the value of attribute average_unit_price.



27
28
29
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 27

def average_unit_price
  @average_unit_price
end

#interval ⇒ Object

The interval of time based on requested granularity (ex. Hour, Day, etc.) If this is the first or the last interval from the list, it might contain incomplete data if the requested interval doesn’t align with the requested granularity (ex. request interval 2018-09-01T02:00:00Z–2018-09-04T19:00:00Z and granularity day will result in Sept 1st UTC day and Sept 4th UTC days having partial data).



16
17
18
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 16

def interval
  @interval
end

#order_count ⇒ Object

The number of orders based on the specified filters.



25
26
27
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 25

def order_count
  @order_count
end

#order_item_count ⇒ Object

The number of order items based on the specified filters.



22
23
24
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 22

def order_item_count
  @order_item_count
end

#total_sales ⇒ Object

Returns the value of attribute total_sales.



27
28
29
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 27

def total_sales
  @total_sales
end

#unit_count ⇒ Object

The number of units in orders based on the specified filters.



19
20
21
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 19

def unit_count
  @unit_count
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 30

def self.attribute_map
  {
    'interval': :interval,
    'unit_count': :unitCount,
    'order_item_count': :orderItemCount,
    'order_count': :orderCount,
    'average_unit_price': :averageUnitPrice,
    'total_sales': :totalSales
  }
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



146
147
148
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 146

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



54
55
56
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 54

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

.openapi_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 42

def self.openapi_types
  {
    'interval': :Object,
    'unit_count': :Object,
    'order_item_count': :Object,
    'order_count': :Object,
    'average_unit_price': :Object,
    'total_sales': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 119

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    interval == other.interval &&
    unit_count == other.unit_count &&
    order_item_count == other.order_item_count &&
    order_count == other.order_count &&
    average_unit_price == other.average_unit_price &&
    total_sales == other.total_sales
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



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
206
207
208
209
210
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 175

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
    AmznSpApi::SalesApiModel.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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 244

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 153

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


133
134
135
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 133

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



139
140
141
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 139

def hash
  [interval, unit_count, order_item_count, order_count, average_unit_price, total_sales].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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 87

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "interval", interval cannot be nil.') if @interval.nil?

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

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

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

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

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

  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



220
221
222
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 220

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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 226

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



214
215
216
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 214

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



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/sales_api_model/models/order_metrics_interval.rb', line 106

def valid?
  return false if @interval.nil?
  return false if @unit_count.nil?
  return false if @order_item_count.nil?
  return false if @order_count.nil?
  return false if @average_unit_price.nil?
  return false if @total_sales.nil?

  true
end