Class: PaysecureApiDocumentationLive::Metadata

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

Overview

Metadata 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(has_subtransactions:, total_subtransactions:, transaction_hierarchy_level:, additional_properties: nil) ⇒ Metadata

Returns a new instance of Metadata.



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

def initialize(has_subtransactions:, total_subtransactions:,
               transaction_hierarchy_level:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @has_subtransactions = has_subtransactions
  @total_subtransactions = total_subtransactions
  @transaction_hierarchy_level = transaction_hierarchy_level
  @additional_properties = additional_properties
end

Instance Attribute Details

#has_subtransactions ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def has_subtransactions
  @has_subtransactions
end

#total_subtransactions ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def total_subtransactions
  @total_subtransactions
end

#transaction_hierarchy_level ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def transaction_hierarchy_level
  @transaction_hierarchy_level
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/paysecure_api_documentation_live/models/metadata.rb', line 55

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  has_subtransactions =
    hash.key?('has_subtransactions') ? hash['has_subtransactions'] : nil
  total_subtransactions =
    hash.key?('total_subtransactions') ? hash['total_subtransactions'] : nil
  transaction_hierarchy_level =
    hash.key?('transaction_hierarchy_level') ? hash['transaction_hierarchy_level'] : 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.
  Metadata.new(has_subtransactions: has_subtransactions,
               total_subtransactions: total_subtransactions,
               transaction_hierarchy_level: transaction_hierarchy_level,
               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['has_subtransactions'] = 'has_subtransactions'
  @_hash['total_subtransactions'] = 'total_subtransactions'
  @_hash['transaction_hierarchy_level'] = 'transaction_hierarchy_level'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/paysecure_api_documentation_live/models/metadata.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



89
90
91
92
93
94
95
 
# File 'lib/paysecure_api_documentation_live/models/metadata.rb', line 89

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



81
82
83
84
85
86
 
# File 'lib/paysecure_api_documentation_live/models/metadata.rb', line 81

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