Class: WalmartApIs::RefundOrderLine

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

Overview

RefundOrderLine 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(line_number:, refund_amount:, refund_type:, reason: SKIP, additional_properties: nil) ⇒ RefundOrderLine

Returns a new instance of RefundOrderLine.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 53

def initialize(line_number:, refund_amount:, refund_type:, reason: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @line_number = line_number
  @refund_amount = refund_amount
  @refund_type = refund_type
  @reason = reason unless reason == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#line_number ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def line_number
  @line_number
end

#reason ⇒ String

Optional free-form note (e.g. "item arrived damaged").

Returns:

  • (String) 


29
30
31
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 29

def reason
  @reason
end

#refund_amount ⇒ Money

TODO: Write general description for this method

Returns:



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

def refund_amount
  @refund_amount
end

#refund_type ⇒ RefundType

Why the refund is being issued. Compressed from gmp-orders-mono's 22-entry RefundReason enum to the three classes that actually drive downstream behaviour today (return-flow vs cancel-flow vs goodwill-credit). Free-form sub-reason goes in reason.

Returns:



25
26
27
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 25

def refund_type
  @refund_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 66

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  line_number = hash.key?('lineNumber') ? hash['lineNumber'] : nil
  refund_amount = Money.from_hash(hash['refundAmount']) if hash['refundAmount']
  refund_type = hash.key?('refundType') ? hash['refundType'] : nil
  reason = hash.key?('reason') ? hash['reason'] : 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.
  RefundOrderLine.new(line_number: line_number,
                      refund_amount: refund_amount,
                      refund_type: refund_type,
                      reason: reason,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



32
33
34
35
36
37
38
39
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 32

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['line_number'] = 'lineNumber'
  @_hash['refund_amount'] = 'refundAmount'
  @_hash['refund_type'] = 'refundType'
  @_hash['reason'] = 'reason'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



42
43
44
45
46
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 42

def self.optionals
  %w[
    reason
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



99
100
101
102
103
104
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 99

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



91
92
93
94
95
96
 
# File 'lib/walmart_ap_is/models/refund_order_line.rb', line 91

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