Class: PaysecureApiDocumentationLive::CreatePayOutRequest4

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb

Overview

CreatePayOutRequest4 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(client:, purpose:, currency:, payout_method:, amount:, success_callback:, failure_callback:, additional_properties: nil) ⇒ CreatePayOutRequest4

Returns a new instance of CreatePayOutRequest4.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 63

def initialize(client:, purpose:, currency:, payout_method:, amount:,
               success_callback:, failure_callback:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @client = client
  @purpose = purpose
  @currency = currency
  @payout_method = payout_method
  @amount = amount
  @success_callback = success_callback
  @failure_callback = failure_callback
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 30

def amount
  @amount
end

#client ⇒ Client37

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 14

def client
  @client
end

#currency ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 22

def currency
  @currency
end

#failure_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 38

def failure_callback
  @failure_callback
end

#payout_method ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 26

def payout_method
  @payout_method
end

#purpose ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 18

def purpose
  @purpose
end

#success_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


34
35
36
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 34

def success_callback
  @success_callback
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 80

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client = Client37.from_hash(hash['client']) if hash['client']
  purpose = hash.key?('purpose') ? hash['purpose'] : nil
  currency = hash.key?('currency') ? hash['currency'] : nil
  payout_method = hash.key?('payoutMethod') ? hash['payoutMethod'] : nil
  amount = hash.key?('amount') ? hash['amount'] : nil
  success_callback =
    hash.key?('success_callback') ? hash['success_callback'] : nil
  failure_callback =
    hash.key?('failure_callback') ? hash['failure_callback'] : nil

  # 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.
  CreatePayOutRequest4.new(client: client,
                           purpose: purpose,
                           currency: currency,
                           payout_method: payout_method,
                           amount: amount,
                           success_callback: success_callback,
                           failure_callback: failure_callback,
                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 41

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client'] = 'client'
  @_hash['purpose'] = 'purpose'
  @_hash['currency'] = 'currency'
  @_hash['payout_method'] = 'payoutMethod'
  @_hash['amount'] = 'amount'
  @_hash['success_callback'] = 'success_callback'
  @_hash['failure_callback'] = 'failure_callback'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



59
60
61
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 59

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 54

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



122
123
124
125
126
127
128
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 122

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client: #{@client.inspect}, purpose: #{@purpose.inspect}, currency:"\
  " #{@currency.inspect}, payout_method: #{@payout_method.inspect}, amount:"\
  " #{@amount.inspect}, success_callback: #{@success_callback.inspect}, failure_callback:"\
  " #{@failure_callback.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



113
114
115
116
117
118
119
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request4.rb', line 113

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client: #{@client}, purpose: #{@purpose}, currency: #{@currency},"\
  " payout_method: #{@payout_method}, amount: #{@amount}, success_callback:"\
  " #{@success_callback}, failure_callback: #{@failure_callback}, additional_properties:"\
  " #{@additional_properties}>"
end