Class: AmznSpApi::FbaInventoryApiModel::ReservedQuantity

Inherits:
Object
  • Object
show all
Defined in:
lib/fba_inventory_api_model/models/reserved_quantity.rb

Overview

The quantity of reserved inventory.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReservedQuantity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 54

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FbaInventoryApiModel::ReservedQuantity` 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::FbaInventoryApiModel::ReservedQuantity`. 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.total_reserved_quantity = attributes[:total_reserved_quantity] if attributes.key?(:total_reserved_quantity)

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

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

  return unless attributes.key?(:fc_processing_quantity)

  self.fc_processing_quantity = attributes[:fc_processing_quantity]
end

Instance Attribute Details

#fc_processing_quantity ⇒ Object

The number of units that have been sidelined at the fulfillment center for additional processing.



25
26
27
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 25

def fc_processing_quantity
  @fc_processing_quantity
end

#pending_customer_order_quantity ⇒ Object

The number of units reserved for customer orders.



19
20
21
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 19

def pending_customer_order_quantity
  @pending_customer_order_quantity
end

#pending_transshipment_quantity ⇒ Object

The number of units being transferred from one fulfillment center to another.



22
23
24
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 22

def pending_transshipment_quantity
  @pending_transshipment_quantity
end

#total_reserved_quantity ⇒ Object

The total number of units in Amazon’s fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes.



16
17
18
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 16

def total_reserved_quantity
  @total_reserved_quantity
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 28

def self.attribute_map
  {
    'total_reserved_quantity': :totalReservedQuantity,
    'pending_customer_order_quantity': :pendingCustomerOrderQuantity,
    'pending_transshipment_quantity': :pendingTransshipmentQuantity,
    'fc_processing_quantity': :fcProcessingQuantity
  }
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



114
115
116
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 114

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 48

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

.openapi_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 38

def self.openapi_types
  {
    'total_reserved_quantity': :Object,
    'pending_customer_order_quantity': :Object,
    'pending_transshipment_quantity': :Object,
    'fc_processing_quantity': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
94
95
96
97
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 89

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

  self.class == other.class &&
    total_reserved_quantity == other.total_reserved_quantity &&
    pending_customer_order_quantity == other.pending_customer_order_quantity &&
    pending_transshipment_quantity == other.pending_transshipment_quantity &&
    fc_processing_quantity == other.fc_processing_quantity
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



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
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 143

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::FbaInventoryApiModel.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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 212

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 121

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


101
102
103
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 101

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



107
108
109
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 107

def hash
  [total_reserved_quantity, pending_customer_order_quantity, pending_transshipment_quantity, fc_processing_quantity].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



77
78
79
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 77

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



188
189
190
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 188

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



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 194

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



182
183
184
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 182

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



83
84
85
 
# File 'lib/fba_inventory_api_model/models/reserved_quantity.rb', line 83

def valid?
  true
end