Class: InventoryManagementAndItemManagementAndOrderManagementAndPriceManagement::List

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb

Overview

List Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(elements = nil, meta = nil, errors = nil) ⇒ List

Returns a new instance of List.



44
45
46
47
48
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 44

def initialize(elements = nil, meta = nil, errors = nil)
  @elements = elements
  @meta = meta
  @errors = errors
end

Instance Attribute Details

#elementsElements1

TODO: Write general description for this method

Returns:



15
16
17
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 15

def elements
  @elements
end

#errorsArray[Error2]

TODO: Write general description for this method

Returns:



23
24
25
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 23

def errors
  @errors
end

#metaMeta1

TODO: Write general description for this method

Returns:



19
20
21
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 19

def meta
  @meta
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 51

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  elements = Elements1.from_hash(hash['elements']) if hash['elements']
  meta = Meta1.from_hash(hash['meta']) if hash['meta']
  # Parameter is an array, so we need to iterate through it
  errors = nil
  unless hash['errors'].nil?
    errors = []
    hash['errors'].each do |structure|
      errors << (Error2.from_hash(structure) if structure)
    end
  end

  errors = nil unless hash.key?('errors')

  # Create object from extracted values.
  List.new(elements,
           meta,
           errors)
end

.namesObject

A mapping from model property names to API property names.



26
27
28
29
30
31
32
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['elements'] = 'elements'
  @_hash['meta'] = 'meta'
  @_hash['errors'] = 'errors'
  @_hash
end

.nullablesObject

An array for nullable fields



40
41
42
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 40

def self.nullables
  []
end

.optionalsObject

An array for optional fields



35
36
37
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 35

def self.optionals
  []
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



81
82
83
84
85
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 81

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} elements: #{@elements.inspect}, meta: #{@meta.inspect}, errors:"\
  " #{@errors.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



75
76
77
78
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/list.rb', line 75

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} elements: #{@elements}, meta: #{@meta}, errors: #{@errors}>"
end