Class: PaysecureApiDocumentationLive::PayoutSession

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

Overview

PayoutSession 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(session_url:, brand_id:, customer_id:, session_id:, expiry_on:, created_on:, additional_properties: nil) ⇒ PayoutSession

Returns a new instance of PayoutSession.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/paysecure_api_documentation_live/models/payout_session.rb', line 58

def initialize(session_url:, brand_id:, customer_id:, session_id:,
               expiry_on:, created_on:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @session_url = session_url
  @brand_id = brand_id
  @customer_id = customer_id
  @session_id = session_id
  @expiry_on = expiry_on
  @created_on = created_on
  @additional_properties = additional_properties
end

Instance Attribute Details

#brand_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def brand_id
  @brand_id
end

#created_on ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def created_on
  @created_on
end

#customer_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def customer_id
  @customer_id
end

#expiry_on ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def expiry_on
  @expiry_on
end

#session_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def session_id
  @session_id
end

#session_url ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def session_url
  @session_url
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/paysecure_api_documentation_live/models/payout_session.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  session_url = hash.key?('sessionUrl') ? hash['sessionUrl'] : nil
  brand_id = hash.key?('brandId') ? hash['brandId'] : nil
  customer_id = hash.key?('customerId') ? hash['customerId'] : nil
  session_id = hash.key?('sessionId') ? hash['sessionId'] : nil
  expiry_on = hash.key?('expiryOn') ? hash['expiryOn'] : nil
  created_on = hash.key?('createdOn') ? hash['createdOn'] : 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.
  PayoutSession.new(session_url: session_url,
                    brand_id: brand_id,
                    customer_id: customer_id,
                    session_id: session_id,
                    expiry_on: expiry_on,
                    created_on: created_on,
                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/paysecure_api_documentation_live/models/payout_session.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['session_url'] = 'sessionUrl'
  @_hash['brand_id'] = 'brandId'
  @_hash['customer_id'] = 'customerId'
  @_hash['session_id'] = 'sessionId'
  @_hash['expiry_on'] = 'expiryOn'
  @_hash['created_on'] = 'createdOn'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



49
50
51
 
# File 'lib/paysecure_api_documentation_live/models/payout_session.rb', line 49

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



110
111
112
113
114
115
116
 
# File 'lib/paysecure_api_documentation_live/models/payout_session.rb', line 110

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} session_url: #{@session_url.inspect}, brand_id: #{@brand_id.inspect},"\
  " customer_id: #{@customer_id.inspect}, session_id: #{@session_id.inspect}, expiry_on:"\
  " #{@expiry_on.inspect}, created_on: #{@created_on.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



102
103
104
105
106
107
 
# File 'lib/paysecure_api_documentation_live/models/payout_session.rb', line 102

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} session_url: #{@session_url}, brand_id: #{@brand_id}, customer_id:"\
  " #{@customer_id}, session_id: #{@session_id}, expiry_on: #{@expiry_on}, created_on:"\
  " #{@created_on}, additional_properties: #{@additional_properties}>"
end