ExQuickbooks.Error (ex_quickbooks v0.9.0)

Copy Markdown View Source

Typed error values returned by ExQuickbooks for expected failures.

Summary

Types

t()
type()

Functions

new(type, options \\ [])

Builds a typed error value.

validation_failed(message, details \\ nil)

Builds a validation error value.

Types

t()

@type t() :: %ExQuickbooks.Error{
  details: map() | nil,
  message: String.t() | nil,
  status: pos_integer() | nil,
  type: type()
}

type()

@type type() ::
  :unauthorized
  | :forbidden
  | :not_found
  | :rate_limited
  | :validation_failed
  | :api_error
  | :network_error
  | :server_error

Functions

new(type, options \\ [])

@spec new(
  type(),
  keyword()
) :: t()

Builds a typed error value.

validation_failed(message, details \\ nil)

@spec validation_failed(String.t(), map() | nil) :: t()

Builds a validation error value.