Class: PaysecureApiDocumentationLive::Header

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

Overview

Header 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(ephemeral_public_key:, public_key_hash:, transaction_id:, additional_properties: nil) ⇒ Header

Returns a new instance of Header.



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

def initialize(ephemeral_public_key:, public_key_hash:, transaction_id:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @ephemeral_public_key = ephemeral_public_key
  @public_key_hash = public_key_hash
  @transaction_id = transaction_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#ephemeral_public_key ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def ephemeral_public_key
  @ephemeral_public_key
end

#public_key_hash ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def public_key_hash
  @public_key_hash
end

#transaction_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def transaction_id
  @transaction_id
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
 
# File 'lib/paysecure_api_documentation_live/models/header.rb', line 55

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  ephemeral_public_key =
    hash.key?('ephemeralPublicKey') ? hash['ephemeralPublicKey'] : nil
  public_key_hash = hash.key?('publicKeyHash') ? hash['publicKeyHash'] : nil
  transaction_id = hash.key?('transactionId') ? hash['transactionId'] : 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.
  Header.new(ephemeral_public_key: ephemeral_public_key,
             public_key_hash: public_key_hash,
             transaction_id: transaction_id,
             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/header.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['ephemeral_public_key'] = 'ephemeralPublicKey'
  @_hash['public_key_hash'] = 'publicKeyHash'
  @_hash['transaction_id'] = 'transactionId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



87
88
89
90
91
92
 
# File 'lib/paysecure_api_documentation_live/models/header.rb', line 87

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



79
80
81
82
83
84
 
# File 'lib/paysecure_api_documentation_live/models/header.rb', line 79

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