Exception: Ksef::ApiError

Inherits:

Error

• Object
• StandardError
• Error
• Ksef::ApiError

Defined in:

lib/ksef/errors.rb

Overview

Any error response from the KSeF API.

Direct Known Subclasses

AuthorizationError, InvoiceRejectedError, RateLimitedError, ResourceGoneError, ServerError, SessionError

Instance Attribute Summary

Attributes inherited from Error

#problem

Instance Method Summary

• #code ⇒ Integer^?

  The first KSeF error code, when the body carried one.

• #details ⇒ Array<String>

  Flattened detail messages.

• #raw ⇒ Object^?

  The undecoded response body.

• #status ⇒ Integer^?

  HTTP status.

• #trace_id ⇒ String^?

  The Ministry's correlation id — quote this in support requests.

Methods inherited from Error

#initialize

Constructor Details

This class inherits a constructor from Ksef::Error

Instance Method Details

#code ⇒ Integer^?

Returns the first KSeF error code, when the body carried one.

Returns:

• (Integer, nil) —

  the first KSeF error code, when the body carried one

# File 'lib/ksef/errors.rb', line 38

def code = problem&.code

#details ⇒ Array<String>

Returns flattened detail messages.

Returns:

• (Array<String>) —

  flattened detail messages

# File 'lib/ksef/errors.rb', line 41

def details = problem&.details || []

#raw ⇒ Object^?

Returns the undecoded response body.

Returns:

• (Object, nil) —

  the undecoded response body

# File 'lib/ksef/errors.rb', line 47

def raw = problem&.raw

#status ⇒ Integer^?

Returns HTTP status.

Returns:

• (Integer, nil) —

  HTTP status

# File 'lib/ksef/errors.rb', line 35

def status = problem&.status

#trace_id ⇒ String^?

Returns the Ministry's correlation id — quote this in support requests.

Returns:

• (String, nil) —

  the Ministry's correlation id — quote this in support requests

# File 'lib/ksef/errors.rb', line 44

def trace_id = problem&.trace_id