Class: PaysecureApiDocumentationLive::PayoutSessionRequest

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

Overview

PayoutSessionRequest 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(customer_id:, currency:, products:, total_amount:, tax_amount:, tax_percent:, type:, success_redirect:, pending_redirect:, failure_redirect:, success_callback:, failure_callback:, extra_param:, additional_properties: nil) ⇒ PayoutSessionRequest

Returns a new instance of PayoutSessionRequest.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 93

def initialize(customer_id:, currency:, products:, total_amount:,
               tax_amount:, tax_percent:, type:, success_redirect:,
               pending_redirect:, failure_redirect:, success_callback:,
               failure_callback:, extra_param:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @customer_id = customer_id
  @currency = currency
  @products = products
  @total_amount = total_amount
  @tax_amount = tax_amount
  @tax_percent = tax_percent
  @type = type
  @success_redirect = success_redirect
  @pending_redirect = pending_redirect
  @failure_redirect = failure_redirect
  @success_callback = success_callback
  @failure_callback = failure_callback
  @extra_param = extra_param
  @additional_properties = additional_properties
end

Instance Attribute Details

#currency ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def currency
  @currency
end

#customer_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def customer_id
  @customer_id
end

#extra_param ⇒ ExtraParam21

TODO: Write general description for this method

Returns:



62
63
64
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 62

def extra_param
  @extra_param
end

#failure_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


58
59
60
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 58

def failure_callback
  @failure_callback
end

#failure_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


50
51
52
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 50

def failure_redirect
  @failure_redirect
end

#pending_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


46
47
48
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 46

def pending_redirect
  @pending_redirect
end

#products ⇒ Array[Product]

TODO: Write general description for this method

Returns:



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

def products
  @products
end

#success_callback ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def success_callback
  @success_callback
end

#success_redirect ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def success_redirect
  @success_redirect
end

#tax_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def tax_amount
  @tax_amount
end

#tax_percent ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def tax_percent
  @tax_percent
end

#total_amount ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def total_amount
  @total_amount
end

#type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 117

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  customer_id = hash.key?('customerId') ? hash['customerId'] : nil
  currency = hash.key?('currency') ? hash['currency'] : nil
  # Parameter is an array, so we need to iterate through it
  products = nil
  unless hash['products'].nil?
    products = []
    hash['products'].each do |structure|
      products << (Product.from_hash(structure) if structure)
    end
  end

  products = nil unless hash.key?('products')
  total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : nil
  tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : nil
  tax_percent = hash.key?('tax_percent') ? hash['tax_percent'] : nil
  type = hash.key?('type') ? hash['type'] : nil
  success_redirect =
    hash.key?('success_redirect') ? hash['success_redirect'] : nil
  pending_redirect =
    hash.key?('pending_redirect') ? hash['pending_redirect'] : nil
  failure_redirect =
    hash.key?('failure_redirect') ? hash['failure_redirect'] : nil
  success_callback =
    hash.key?('success_callback') ? hash['success_callback'] : nil
  failure_callback =
    hash.key?('failure_callback') ? hash['failure_callback'] : nil
  extra_param = ExtraParam21.from_hash(hash['extraParam']) if hash['extraParam']

  # 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.
  PayoutSessionRequest.new(customer_id: customer_id,
                           currency: currency,
                           products: products,
                           total_amount: total_amount,
                           tax_amount: tax_amount,
                           tax_percent: tax_percent,
                           type: type,
                           success_redirect: success_redirect,
                           pending_redirect: pending_redirect,
                           failure_redirect: failure_redirect,
                           success_callback: success_callback,
                           failure_callback: failure_callback,
                           extra_param: extra_param,
                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 65

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['customer_id'] = 'customerId'
  @_hash['currency'] = 'currency'
  @_hash['products'] = 'products'
  @_hash['total_amount'] = 'totalAmount'
  @_hash['tax_amount'] = 'tax_amount'
  @_hash['tax_percent'] = 'tax_percent'
  @_hash['type'] = 'type'
  @_hash['success_redirect'] = 'success_redirect'
  @_hash['pending_redirect'] = 'pending_redirect'
  @_hash['failure_redirect'] = 'failure_redirect'
  @_hash['success_callback'] = 'success_callback'
  @_hash['failure_callback'] = 'failure_callback'
  @_hash['extra_param'] = 'extraParam'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



89
90
91
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 89

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



84
85
86
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 84

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 185

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} customer_id: #{@customer_id.inspect}, currency: #{@currency.inspect},"\
  " products: #{@products.inspect}, total_amount: #{@total_amount.inspect}, tax_amount:"\
  " #{@tax_amount.inspect}, tax_percent: #{@tax_percent.inspect}, type: #{@type.inspect},"\
  " success_redirect: #{@success_redirect.inspect}, pending_redirect:"\
  " #{@pending_redirect.inspect}, failure_redirect: #{@failure_redirect.inspect},"\
  " success_callback: #{@success_callback.inspect}, failure_callback:"\
  " #{@failure_callback.inspect}, extra_param: #{@extra_param.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



174
175
176
177
178
179
180
181
182
 
# File 'lib/paysecure_api_documentation_live/models/payout_session_request.rb', line 174

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} customer_id: #{@customer_id}, currency: #{@currency}, products:"\
  " #{@products}, total_amount: #{@total_amount}, tax_amount: #{@tax_amount}, tax_percent:"\
  " #{@tax_percent}, type: #{@type}, success_redirect: #{@success_redirect}, pending_redirect:"\
  " #{@pending_redirect}, failure_redirect: #{@failure_redirect}, success_callback:"\
  " #{@success_callback}, failure_callback: #{@failure_callback}, extra_param:"\
  " #{@extra_param}, additional_properties: #{@additional_properties}>"
end