Exception: Unitpost::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/unitpost/errors.rb

Overview

A structured API error. Returned on Result#error (not raised by default).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code:, message:, status:, request_id: nil, details: nil) ⇒ Error

details holds field-level validation errors (present on 422 validation_error): an array of { "field" => "<dotted.path>", "message" => "" } hashes. Empty array otherwise.



11
12
13
14
15
16
17
 
# File 'lib/unitpost/errors.rb', line 11

def initialize(code:, message:, status:, request_id: nil, details: nil)
  super(message)
  @code = code
  @status = status
  @request_id = request_id
  @details = details || []
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



6
7
8
 
# File 'lib/unitpost/errors.rb', line 6

def code
  @code
end

#details ⇒ Object (readonly)

Returns the value of attribute details.



6
7
8
 
# File 'lib/unitpost/errors.rb', line 6

def details
  @details
end

#request_id ⇒ Object (readonly)

Returns the value of attribute request_id.



6
7
8
 
# File 'lib/unitpost/errors.rb', line 6

def request_id
  @request_id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



6
7
8
 
# File 'lib/unitpost/errors.rb', line 6

def status
  @status
end