Safe Haskell	None
Language	Haskell2010

Maestro.Client.Error

Synopsis

data ApiError = ApiError {
- apiErrorError ∷ !(Maybe Text)
- apiErrorMessage ∷ !Text
- apiErrorCode ∷ !(Maybe Word)
}
data MaestroError
- = MaestroError !Text
- | MaestroBadRequest !Text
- | MaestroApiKeyMissing !Text
- | MaestroNotFound
- | MaestroUnsupportedMediaType
- | MaestroUsageLimitReached
- | MaestroInternalError !Text
- | ServantClientError !ClientError
fromServantClientError ∷ ClientError → MaestroError

Documentation

data ApiError #

In cases of failure, at times, Maestro returns a JSON object with an error message.

Constructors

ApiError
Fields apiErrorError ∷ !(Maybe Text) The error type (corresponding to status code). Optional as it is not always present. apiErrorMessage ∷ !Text The error message. apiErrorCode ∷ !(Maybe Word) The HTTP status code. Optional as it is not always present.

Instances

Instances details

Eq ApiError #
Instance details Defined in Maestro.Client.Error Methods (==) ∷ ApiError → ApiError → Bool # (/=) ∷ ApiError → ApiError → Bool #
Show ApiError #
Instance details Defined in Maestro.Client.Error Methods showsPrec ∷ Int → ApiError → ShowS # show ∷ ApiError → String # showList ∷ [ApiError] → ShowS #
Generic ApiError #
Instance details Defined in Maestro.Client.Error Associated Types type Rep ApiError ∷ Type → Type # Methods from ∷ ApiError → Rep ApiError x # to ∷ Rep ApiError x → ApiError #
ToJSON ApiError #
Instance details Defined in Maestro.Client.Error Methods toJSON ∷ ApiError → Value toEncoding ∷ ApiError → Encoding toJSONList ∷ [ApiError] → Value toEncodingList ∷ [ApiError] → Encoding omitField ∷ ApiError → Bool
FromJSON ApiError #
Instance details Defined in Maestro.Client.Error Methods parseJSON ∷ Value → Parser ApiError parseJSONList ∷ Value → Parser [ApiError] omittedField ∷ Maybe ApiError
type Rep ApiError #
Instance details Defined in Maestro.Client.Error type Rep ApiError = D1 ('MetaData "ApiError" "Maestro.Client.Error" "maestro-sdk-1.7.3-inplace" 'False) (C1 ('MetaCons "ApiError" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiErrorError") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "apiErrorMessage") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "apiErrorCode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Word)))))

data MaestroError #

Maestro errors.

Constructors

MaestroError !Text	Other Maestro error.
MaestroBadRequest !Text	400 status code.
MaestroApiKeyMissing !Text	401 status code.
MaestroNotFound	404 status code.
MaestroUnsupportedMediaType	415 status code.
MaestroUsageLimitReached	429 status code.
MaestroInternalError !Text	500 status code.
ServantClientError !ClientError	When `ClientError` is not of form `FailureResponse`.

Instances

Instances details

Eq MaestroError #
Instance details Defined in Maestro.Client.Error Methods (==) ∷ MaestroError → MaestroError → Bool # (/=) ∷ MaestroError → MaestroError → Bool #
Show MaestroError #
Instance details Defined in Maestro.Client.Error Methods showsPrec ∷ Int → MaestroError → ShowS # show ∷ MaestroError → String # showList ∷ [MaestroError] → ShowS #
Exception MaestroError #
Instance details Defined in Maestro.Client.Error Methods toException ∷ MaestroError → SomeException # fromException ∷ SomeException → Maybe MaestroError # displayException ∷ MaestroError → String #

fromServantClientError ∷ ClientError → MaestroError #