Exception: Assinafy::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/assinafy/errors.rb,
sig/assinafy.rbs

Overview

Base class for all errors raised by the SDK. Carries an optional context Hash that may contain useful debugging details (e.g. response data, IDs).

Direct Known Subclasses

ApiError, NetworkError, ValidationError

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, context = {}) ⇒ Error

Returns a new instance of Error.

Parameters:

  • message (String, nil) (defaults to: nil)
  • context (Hash[Symbol | String, untyped], nil) (defaults to: {}) 


10
11
12
13
 
# File 'lib/assinafy/errors.rb', line 10

def initialize(message = nil, context = {})
  super(message)
  @context = context || {}
end

Instance Attribute Details

#context ⇒ Hash (readonly)

Returns arbitrary metadata about the error.

Returns:

  • (Hash) —

    arbitrary metadata about the error



8
9
10
 
# File 'lib/assinafy/errors.rb', line 8

def context
  @context
end