Class: KoronaCloudClient::Inventory

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-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



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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 152

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

indicates whether the object is active for use or not



19
20
21
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 19

def active
  @active
end

#automatic_booking ⇒ Object

Returns the value of attribute automatic_booking.



30
31
32
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 30

def automatic_booking
  @automatic_booking
end

#automatic_booking_after_days ⇒ Object

only if isAutomaticBooking=true



33
34
35
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 33

def automatic_booking_after_days
  @automatic_booking_after_days
end

#check_product_assortment_validity ⇒ Object

Returns the value of attribute check_product_assortment_validity.



35
36
37
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 35

def check_product_assortment_validity
  @check_product_assortment_validity
end

#check_product_listing ⇒ Object

Returns the value of attribute check_product_listing.



37
38
39
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 37

def check_product_listing
  @check_product_listing
end

#create_time ⇒ Object

Format: yyyy-MM-dd’T’HH:mm:ssXXX



40
41
42
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 40

def create_time
  @create_time
end

#description ⇒ Object

Returns the value of attribute description.



42
43
44
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 42

def description
  @description
end

#execution_days ⇒ Object

only if type=PERPETUAL_INVENTORY



45
46
47
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 45

def execution_days
  @execution_days
end

#execution_time ⇒ Object

Format: yyyy-MM-dd’T’HH:mm:ssXXX



48
49
50
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 48

def execution_time
  @execution_time
end

#has_booked_receipts ⇒ Object

Returns the value of attribute has_booked_receipts.



50
51
52
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 50

def has_booked_receipts
  @has_booked_receipts
end

#id ⇒ Object

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



22
23
24
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 22

def id
  @id
end

#max_products_per_list ⇒ Object

only if type=ANNUAL_INVENTORY | INVENTORY_IRREGULARITY



53
54
55
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 53

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



28
29
30
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 28

def number
  @number
end

#one_commodity_group_per_inventory_list ⇒ Object

only if type=ANNUAL_INVENTORY | INVENTORY_IRREGULARITY



56
57
58
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 56

def one_commodity_group_per_inventory_list
  @one_commodity_group_per_inventory_list
end

#only_negative_product_stocks ⇒ Object

only if type=INVENTORY_IRREGULARITY



59
60
61
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 59

def only_negative_product_stocks
  @only_negative_product_stocks
end

#organizational_units ⇒ Object

Returns the value of attribute organizational_units.



61
62
63
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 61

def organizational_units
  @organizational_units
end

#product_filter ⇒ Object

Returns the value of attribute product_filter.



63
64
65
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 63

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.



25
26
27
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 25

def revision
  @revision
end

#type ⇒ Object

Returns the value of attribute type.



65
66
67
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 65

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



115
116
117
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 115

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 90

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'revision' => :'revision',
    :'number' => :'number',
    :'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

.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



330
331
332
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 330

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



145
146
147
148
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 145

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

.openapi_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 120

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'id' => :'String',
    :'revision' => :'Integer',
    :'number' => :'String',
    :'automatic_booking' => :'Boolean',
    :'automatic_booking_after_days' => :'Integer',
    :'check_product_assortment_validity' => :'Boolean',
    :'check_product_listing' => :'Boolean',
    :'create_time' => :'Time',
    :'description' => :'String',
    :'execution_days' => :'Array<String>',
    :'execution_time' => :'Time',
    :'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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      revision == o.revision &&
      number == o.number &&
      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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 361

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = KoronaCloudClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 432

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 337

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


317
318
319
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 323

def hash
  [active, id, revision, number, 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



248
249
250
251
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 248

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



408
409
410
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 414

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



402
403
404
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 402

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



255
256
257
258
259
260
261
 
# File 'lib/korona-cloud-client/models/inventory.rb', line 255

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