Class: WalmartApIs::Department

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/walmart_ap_is/models/department.rb

Overview

Department 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(department_id: SKIP, display_name: SKIP, additional_properties: nil) ⇒ Department

Returns a new instance of Department.



41
42
43
44
45
46
47
48
49
 
# File 'lib/walmart_ap_is/models/department.rb', line 41

def initialize(department_id: SKIP, display_name: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @department_id = department_id unless department_id == SKIP
  @display_name = display_name unless display_name == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#department_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/walmart_ap_is/models/department.rb', line 14

def department_id
  @department_id
end

#display_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/walmart_ap_is/models/department.rb', line 18

def display_name
  @display_name
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  department_id = hash.key?('departmentId') ? hash['departmentId'] : SKIP
  display_name = hash.key?('displayName') ? hash['displayName'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Department.new(department_id: department_id,
                 display_name: display_name,
                 additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/walmart_ap_is/models/department.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['department_id'] = 'departmentId'
  @_hash['display_name'] = 'displayName'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/walmart_ap_is/models/department.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/walmart_ap_is/models/department.rb', line 29

def self.optionals
  %w[
    department_id
    display_name
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



80
81
82
83
84
 
# File 'lib/walmart_ap_is/models/department.rb', line 80

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



73
74
75
76
77
 
# File 'lib/walmart_ap_is/models/department.rb', line 73

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} department_id: #{@department_id}, display_name: #{@display_name},"\
  " additional_properties: #{@additional_properties}>"
end