Class: WalmartApIs::InitiatePayoutResponse

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

Overview

InitiatePayoutResponse 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(payout_id: SKIP, status: SKIP, amount: SKIP, additional_properties: nil) ⇒ InitiatePayoutResponse

Returns a new instance of InitiatePayoutResponse.



47
48
49
50
51
52
53
54
55
56
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 47

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

  @payout_id = payout_id unless payout_id == SKIP
  @status = status unless status == SKIP
  @amount = amount unless amount == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#amountMoney

TODO: Write general description for this method

Returns:



22
23
24
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 22

def amount
  @amount
end

#payout_idString

TODO: Write general description for this method

Returns:

  • (String)


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

def payout_id
  @payout_id
end

#statusString

TODO: Write general description for this method

Returns:

  • (String)


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

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 59

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  payout_id = hash.key?('payoutId') ? hash['payoutId'] : SKIP
  status = hash.key?('status') ? hash['status'] : SKIP
  amount = Money.from_hash(hash['amount']) if hash['amount']

  # 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.
  InitiatePayoutResponse.new(payout_id: payout_id,
                             status: status,
                             amount: amount,
                             additional_properties: additional_properties)
end

.namesObject

A mapping from model property names to API property names.



25
26
27
28
29
30
31
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['payout_id'] = 'payoutId'
  @_hash['status'] = 'status'
  @_hash['amount'] = 'amount'
  @_hash
end

.nullablesObject

An array for nullable fields



43
44
45
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 43

def self.nullables
  []
end

.optionalsObject

An array for optional fields



34
35
36
37
38
39
40
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 34

def self.optionals
  %w[
    payout_id
    status
    amount
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



89
90
91
92
93
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 89

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

#to_sObject

Provides a human-readable string representation of the object.



82
83
84
85
86
# File 'lib/walmart_ap_is/models/initiate_payout_response.rb', line 82

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