Class: UltracartClient::ItemShippingDistributionCenter

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/item_shipping_distribution_center.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemShippingDistributionCenter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 101

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?(:'allocated_to_placed_orders')
    self.allocated_to_placed_orders = attributes[:'allocated_to_placed_orders']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allocated_to_placed_orders ⇒ Object

Allocated to placed orders



18
19
20
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 18

def allocated_to_placed_orders
  @allocated_to_placed_orders
end

#allocated_to_shopping_carts ⇒ Object

Allocated to shopping carts



21
22
23
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 21

def allocated_to_shopping_carts
  @allocated_to_shopping_carts
end

#available_to_allocate ⇒ Object

Available to allocate



24
25
26
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 24

def available_to_allocate
  @available_to_allocate
end

#cogs ⇒ Object

Cost of goods sold override at the distribution center level



27
28
29
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 27

def cogs
  @cogs
end

#desired_inventory_level ⇒ Object

Desired inventory level



30
31
32
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 30

def desired_inventory_level
  @desired_inventory_level
end

#distribution_center_code ⇒ Object

Distribution center code



33
34
35
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 33

def distribution_center_code
  @distribution_center_code
end

#distribution_center_oid ⇒ Object

Distribution center object identifier



36
37
38
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 36

def distribution_center_oid
  @distribution_center_oid
end

#eta ⇒ Object

Estimated time of arrival



39
40
41
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 39

def eta
  @eta
end

#handles ⇒ Object

True if this distribution center handles this item



42
43
44
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 42

def handles
  @handles
end

#inventory_level ⇒ Object

Inventory level



45
46
47
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 45

def inventory_level
  @inventory_level
end

#maximum_backorder ⇒ Object

Maximum back-order



48
49
50
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 48

def maximum_backorder
  @maximum_backorder
end

#reorder_inventory_level ⇒ Object

Reorder inventory level (triggers notification)



51
52
53
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 51

def reorder_inventory_level
  @reorder_inventory_level
end

#sku ⇒ Object

SKU



54
55
56
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 54

def sku
  @sku
end

#stock_picking_location ⇒ Object

Stock picking location



57
58
59
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 57

def stock_picking_location
  @stock_picking_location
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 60

def self.attribute_map
  {
    :'allocated_to_placed_orders' => :'allocated_to_placed_orders',
    :'allocated_to_shopping_carts' => :'allocated_to_shopping_carts',
    :'available_to_allocate' => :'available_to_allocate',
    :'cogs' => :'cogs',
    :'desired_inventory_level' => :'desired_inventory_level',
    :'distribution_center_code' => :'distribution_center_code',
    :'distribution_center_oid' => :'distribution_center_oid',
    :'eta' => :'eta',
    :'handles' => :'handles',
    :'inventory_level' => :'inventory_level',
    :'maximum_backorder' => :'maximum_backorder',
    :'reorder_inventory_level' => :'reorder_inventory_level',
    :'sku' => :'sku',
    :'stock_picking_location' => :'stock_picking_location'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 80

def self.swagger_types
  {
    :'allocated_to_placed_orders' => :'Float',
    :'allocated_to_shopping_carts' => :'Float',
    :'available_to_allocate' => :'Float',
    :'cogs' => :'Float',
    :'desired_inventory_level' => :'Float',
    :'distribution_center_code' => :'String',
    :'distribution_center_oid' => :'Integer',
    :'eta' => :'String',
    :'handles' => :'BOOLEAN',
    :'inventory_level' => :'Float',
    :'maximum_backorder' => :'Integer',
    :'reorder_inventory_level' => :'Float',
    :'sku' => :'String',
    :'stock_picking_location' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allocated_to_placed_orders == o.allocated_to_placed_orders &&
      allocated_to_shopping_carts == o.allocated_to_shopping_carts &&
      available_to_allocate == o.available_to_allocate &&
      cogs == o.cogs &&
      desired_inventory_level == o.desired_inventory_level &&
      distribution_center_code == o.distribution_center_code &&
      distribution_center_oid == o.distribution_center_oid &&
      eta == o.eta &&
      handles == o.handles &&
      inventory_level == o.inventory_level &&
      maximum_backorder == o.maximum_backorder &&
      reorder_inventory_level == o.reorder_inventory_level &&
      sku == o.sku &&
      stock_picking_location == o.stock_picking_location
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



264
265
266
267
268
269
270
271
272
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
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 264

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 = UltracartClient.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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 330

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


230
231
232
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 236

def hash
  [allocated_to_placed_orders, allocated_to_shopping_carts, available_to_allocate, cogs, desired_inventory_level, distribution_center_code, distribution_center_oid, eta, handles, inventory_level, maximum_backorder, reorder_inventory_level, sku, stock_picking_location].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



166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 166

def list_invalid_properties
  invalid_properties = Array.new
  if !@sku.nil? && @sku.to_s.length > 50
    invalid_properties.push('invalid value for "sku", the character length must be smaller than or equal to 50.')
  end

  if !@stock_picking_location.nil? && @stock_picking_location.to_s.length > 20
    invalid_properties.push('invalid value for "stock_picking_location", the character length must be smaller than or equal to 20.')
  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



310
311
312
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 310

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



316
317
318
319
320
321
322
323
324
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 316

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



304
305
306
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 304

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



181
182
183
184
185
 
# File 'lib/ultracart_api/models/item_shipping_distribution_center.rb', line 181

def valid?
  return false if !@sku.nil? && @sku.to_s.length > 50
  return false if !@stock_picking_location.nil? && @stock_picking_location.to_s.length > 20
  true
end