Class: CoreLibrary::SignatureVerificationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/apimatic-core-interfaces/types/signature_verification_result.rb

Overview

Represents the result of signature verification.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ok:, errors: nil) ⇒ SignatureVerificationResult

Returns a new instance of SignatureVerificationResult.



11
12
13
14
 
# File 'lib/apimatic-core-interfaces/types/signature_verification_result.rb', line 11

def initialize(ok:, errors: nil)
  @ok = ok
  @errors = errors
end

Instance Attribute Details

#errors ⇒ Object (readonly)

Outcome of signature verification. Attributes:

ok: true if the signature verification passed.
errors: list of error messages raised by the verifier. nil when ok is true.



9
10
11
 
# File 'lib/apimatic-core-interfaces/types/signature_verification_result.rb', line 9

def errors
  @errors
end

#ok ⇒ Object (readonly)

Outcome of signature verification. Attributes:

ok: true if the signature verification passed.
errors: list of error messages raised by the verifier. nil when ok is true.



9
10
11
 
# File 'lib/apimatic-core-interfaces/types/signature_verification_result.rb', line 9

def ok
  @ok
end

Class Method Details

.failed(errors = nil) ⇒ Object 



20
21
22
 
# File 'lib/apimatic-core-interfaces/types/signature_verification_result.rb', line 20

def self.failed(errors = nil)
  new(ok: false, errors: errors)
end

.passed ⇒ Object 



16
17
18
 
# File 'lib/apimatic-core-interfaces/types/signature_verification_result.rb', line 16

def self.passed
  new(ok: true)
end