Class: PaysecureApiDocumentationLive::CreatePayOutRequest

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

Overview

CreatePayOutRequest 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:, payout_method:, purpose:, currency:, amount:, success_redirect:, failure_redirect:, pending_redirect:, additional_properties: nil) ⇒ CreatePayOutRequest

Returns a new instance of CreatePayOutRequest.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request.rb', line 68

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

  @client = client
  @payout_method = payout_method
  @purpose = purpose
  @currency = currency
  @amount = amount
  @success_redirect = success_redirect
  @failure_redirect = failure_redirect
  @pending_redirect = pending_redirect
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


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

def amount
  @amount
end

#client ⇒ Client8

TODO: Write general description for this method

Returns:



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

def client
  @client
end

#currency ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def currency
  @currency
end

#failure_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def failure_redirect
  @failure_redirect
end

#payout_method ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def payout_method
  @payout_method
end

#pending_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


42
43
44
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request.rb', line 42

def pending_redirect
  @pending_redirect
end

#purpose ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def purpose
  @purpose
end

#success_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def success_redirect
  @success_redirect
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
111
112
113
114
115
116
117
118
119
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request.rb', line 86

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client = Client8.from_hash(hash['client']) if hash['client']
  payout_method = hash.key?('payoutMethod') ? hash['payoutMethod'] : nil
  purpose = hash.key?('purpose') ? hash['purpose'] : nil
  currency = hash.key?('currency') ? hash['currency'] : nil
  amount = hash.key?('amount') ? hash['amount'] : nil
  success_redirect =
    hash.key?('success_redirect') ? hash['success_redirect'] : nil
  failure_redirect =
    hash.key?('failure_redirect') ? hash['failure_redirect'] : nil
  pending_redirect =
    hash.key?('pending_redirect') ? hash['pending_redirect'] : 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.
  CreatePayOutRequest.new(client: client,
                          payout_method: payout_method,
                          purpose: purpose,
                          currency: currency,
                          amount: amount,
                          success_redirect: success_redirect,
                          failure_redirect: failure_redirect,
                          pending_redirect: pending_redirect,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request.rb', line 45

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

.nullables ⇒ Object

An array for nullable fields



64
65
66
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request.rb', line 64

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



131
132
133
134
135
136
137
138
 
# File 'lib/paysecure_api_documentation_live/models/create_pay_out_request.rb', line 131

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

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