Class: KoronaClient::Inventory

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/models/inventory.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Inventory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/korona_client/models/inventory.rb', line 138

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

indicates whether the object is active for use or not



18
19
20
 
# File 'lib/korona_client/models/inventory.rb', line 18

def active
  @active
end

#automatic_booking ⇒ Object

Returns the value of attribute automatic_booking.



29
30
31
 
# File 'lib/korona_client/models/inventory.rb', line 29

def automatic_booking
  @automatic_booking
end

#automatic_booking_after_days ⇒ Object

only if isAutomaticBooking=true



32
33
34
 
# File 'lib/korona_client/models/inventory.rb', line 32

def automatic_booking_after_days
  @automatic_booking_after_days
end

#check_product_assortment_validity ⇒ Object

Returns the value of attribute check_product_assortment_validity.



34
35
36
 
# File 'lib/korona_client/models/inventory.rb', line 34

def check_product_assortment_validity
  @check_product_assortment_validity
end

#check_product_listing ⇒ Object

Returns the value of attribute check_product_listing.



36
37
38
 
# File 'lib/korona_client/models/inventory.rb', line 36

def check_product_listing
  @check_product_listing
end

#create_time ⇒ Object

Returns the value of attribute create_time.



38
39
40
 
# File 'lib/korona_client/models/inventory.rb', line 38

def create_time
  @create_time
end

#description ⇒ Object

Returns the value of attribute description.



40
41
42
 
# File 'lib/korona_client/models/inventory.rb', line 40

def description
  @description
end

#execution_days ⇒ Object

only if type=PERPETUAL_INVENTORY



43
44
45
 
# File 'lib/korona_client/models/inventory.rb', line 43

def execution_days
  @execution_days
end

#execution_time ⇒ Object

Returns the value of attribute execution_time.



45
46
47
 
# File 'lib/korona_client/models/inventory.rb', line 45

def execution_time
  @execution_time
end

#has_booked_receipts ⇒ Object

Returns the value of attribute has_booked_receipts.



47
48
49
 
# File 'lib/korona_client/models/inventory.rb', line 47

def has_booked_receipts
  @has_booked_receipts
end

#id ⇒ Object

global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)



21
22
23
 
# File 'lib/korona_client/models/inventory.rb', line 21

def id
  @id
end

#max_products_per_list ⇒ Object

only if type=ANNUAL_INVENTORY | INVENTORY_IRREGULARITY



50
51
52
 
# File 'lib/korona_client/models/inventory.rb', line 50

def max_products_per_list
  @max_products_per_list
end

#number ⇒ Object

number of the object, like it is set in backoffice; will be removed when active=false



24
25
26
 
# File 'lib/korona_client/models/inventory.rb', line 24

def number
  @number
end

#one_commodity_group_per_inventory_list ⇒ Object

only if type=ANNUAL_INVENTORY | INVENTORY_IRREGULARITY



53
54
55
 
# File 'lib/korona_client/models/inventory.rb', line 53

def one_commodity_group_per_inventory_list
  @one_commodity_group_per_inventory_list
end

#only_negative_product_stocks ⇒ Object

only if type=INVENTORY_IRREGULARITY



56
57
58
 
# File 'lib/korona_client/models/inventory.rb', line 56

def only_negative_product_stocks
  @only_negative_product_stocks
end

#organizational_units ⇒ Object

Returns the value of attribute organizational_units.



58
59
60
 
# File 'lib/korona_client/models/inventory.rb', line 58

def organizational_units
  @organizational_units
end

#product_filter ⇒ Object

Returns the value of attribute product_filter.



60
61
62
 
# File 'lib/korona_client/models/inventory.rb', line 60

def product_filter
  @product_filter
end

#revision ⇒ Object

the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers.



27
28
29
 
# File 'lib/korona_client/models/inventory.rb', line 27

def revision
  @revision
end

#type ⇒ Object

Returns the value of attribute type.



62
63
64
 
# File 'lib/korona_client/models/inventory.rb', line 62

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/korona_client/models/inventory.rb', line 87

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'number' => :'number',
    :'revision' => :'revision',
    :'automatic_booking' => :'automaticBooking',
    :'automatic_booking_after_days' => :'automaticBookingAfterDays',
    :'check_product_assortment_validity' => :'checkProductAssortmentValidity',
    :'check_product_listing' => :'checkProductListing',
    :'create_time' => :'createTime',
    :'description' => :'description',
    :'execution_days' => :'executionDays',
    :'execution_time' => :'executionTime',
    :'has_booked_receipts' => :'hasBookedReceipts',
    :'max_products_per_list' => :'maxProductsPerList',
    :'one_commodity_group_per_inventory_list' => :'oneCommodityGroupPerInventoryList',
    :'only_negative_product_stocks' => :'onlyNegativeProductStocks',
    :'organizational_units' => :'organizationalUnits',
    :'product_filter' => :'productFilter',
    :'type' => :'type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/korona_client/models/inventory.rb', line 112

def self.swagger_types
  {
    :'active' => :'BOOLEAN',
    :'id' => :'String',
    :'number' => :'String',
    :'revision' => :'Integer',
    :'automatic_booking' => :'BOOLEAN',
    :'automatic_booking_after_days' => :'Integer',
    :'check_product_assortment_validity' => :'BOOLEAN',
    :'check_product_listing' => :'BOOLEAN',
    :'create_time' => :'DateTime',
    :'description' => :'String',
    :'execution_days' => :'Array<String>',
    :'execution_time' => :'DateTime',
    :'has_booked_receipts' => :'BOOLEAN',
    :'max_products_per_list' => :'Integer',
    :'one_commodity_group_per_inventory_list' => :'BOOLEAN',
    :'only_negative_product_stocks' => :'BOOLEAN',
    :'organizational_units' => :'Array<ModelReference>',
    :'product_filter' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/korona_client/models/inventory.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      number == o.number &&
      revision == o.revision &&
      automatic_booking == o.automatic_booking &&
      automatic_booking_after_days == o.automatic_booking_after_days &&
      check_product_assortment_validity == o.check_product_assortment_validity &&
      check_product_listing == o.check_product_listing &&
      create_time == o.create_time &&
      description == o.description &&
      execution_days == o.execution_days &&
      execution_time == o.execution_time &&
      has_booked_receipts == o.has_booked_receipts &&
      max_products_per_list == o.max_products_per_list &&
      one_commodity_group_per_inventory_list == o.one_commodity_group_per_inventory_list &&
      only_negative_product_stocks == o.only_negative_product_stocks &&
      organizational_units == o.organizational_units &&
      product_filter == o.product_filter &&
      type == o.type
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/korona_client/models/inventory.rb', line 324

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/korona_client/models/inventory.rb', line 390

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/korona_client/models/inventory.rb', line 303

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


290
291
292
 
# File 'lib/korona_client/models/inventory.rb', line 290

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



296
297
298
 
# File 'lib/korona_client/models/inventory.rb', line 296

def hash
  [active, id, number, revision, automatic_booking, automatic_booking_after_days, check_product_assortment_validity, check_product_listing, create_time, description, execution_days, execution_time, has_booked_receipts, max_products_per_list, one_commodity_group_per_inventory_list, only_negative_product_stocks, organizational_units, product_filter, type].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



227
228
229
230
 
# File 'lib/korona_client/models/inventory.rb', line 227

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



370
371
372
 
# File 'lib/korona_client/models/inventory.rb', line 370

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



376
377
378
379
380
381
382
383
384
 
# File 'lib/korona_client/models/inventory.rb', line 376

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



364
365
366
 
# File 'lib/korona_client/models/inventory.rb', line 364

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



234
235
236
237
238
239
240
 
# File 'lib/korona_client/models/inventory.rb', line 234

def valid?
  product_filter_validator = EnumAttributeValidator.new('String', ['ACTIVE', 'ALL', 'DEACTIVATED'])
  return false unless product_filter_validator.valid?(@product_filter)
  type_validator = EnumAttributeValidator.new('String', ['ANNUAL_INVENTORY', 'INVENTORY_IRREGULARITY', 'INVENTORY_SAMPLING', 'PERPETUAL_INVENTORY'])
  return false unless type_validator.valid?(@type)
  true
end