Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.Error

Description

Contains the types generated from the schema Error

Synopsis

data Error = Error {
- errorMessage :: Maybe Text
- errorParams :: Maybe [ErrorParams]
- errorType :: Maybe ErrorType
}
mkError :: Error
data ErrorParams = ErrorParams {
- errorParamsParam :: Maybe Text
}
mkErrorParams :: ErrorParams
data ErrorType

Documentation

data Error Source #

Defines the object schema located at components.schemas.Error in the specification.

Constructors

Error
Fields errorMessage :: Maybe Text message errorParams :: Maybe [ErrorParams] params errorType :: Maybe ErrorType type

Instances

Instances details

FromJSON Error Source #
Instance details Defined in RecurlyClient.Types.Error Methods parseJSON :: Value -> Parser Error # parseJSONList :: Value -> Parser [Error] #
ToJSON Error Source #
Instance details Defined in RecurlyClient.Types.Error Methods toJSON :: Error -> Value # toEncoding :: Error -> Encoding # toJSONList :: [Error] -> Value # toEncodingList :: [Error] -> Encoding #
Show Error Source #
Instance details Defined in RecurlyClient.Types.Error Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Eq Error Source #
Instance details Defined in RecurlyClient.Types.Error Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #

mkError :: Error Source #

Create a new Error with all required fields.

data ErrorParams Source #

Defines the object schema located at components.schemas.Error.properties.params.items in the specification.

Constructors

ErrorParams
Fields errorParamsParam :: Maybe Text param

Instances

Instances details

FromJSON ErrorParams Source #
Instance details Defined in RecurlyClient.Types.Error Methods parseJSON :: Value -> Parser ErrorParams # parseJSONList :: Value -> Parser [ErrorParams] #
ToJSON ErrorParams Source #
Instance details Defined in RecurlyClient.Types.Error Methods toJSON :: ErrorParams -> Value # toEncoding :: ErrorParams -> Encoding # toJSONList :: [ErrorParams] -> Value # toEncodingList :: [ErrorParams] -> Encoding #
Show ErrorParams Source #
Instance details Defined in RecurlyClient.Types.Error Methods showsPrec :: Int -> ErrorParams -> ShowS # show :: ErrorParams -> String # showList :: [ErrorParams] -> ShowS #
Eq ErrorParams Source #
Instance details Defined in RecurlyClient.Types.Error Methods (==) :: ErrorParams -> ErrorParams -> Bool # (/=) :: ErrorParams -> ErrorParams -> Bool #

mkErrorParams :: ErrorParams Source #

Create a new ErrorParams with all required fields.

data ErrorType Source #

Defines the enum schema located at components.schemas.Error.properties.type in the specification.

Constructors

ErrorTypeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ErrorTypeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
ErrorTypeEnumBad_request	Represents the JSON value `"bad_request"`
ErrorTypeEnumImmutable_subscription	Represents the JSON value `"immutable_subscription"`
ErrorTypeEnumInternal_server_error	Represents the JSON value `"internal_server_error"`
ErrorTypeEnumInvalid_api_key	Represents the JSON value `"invalid_api_key"`
ErrorTypeEnumInvalid_api_version	Represents the JSON value `"invalid_api_version"`
ErrorTypeEnumInvalid_content_type	Represents the JSON value `"invalid_content_type"`
ErrorTypeEnumInvalid_permissions	Represents the JSON value `"invalid_permissions"`
ErrorTypeEnumInvalid_token	Represents the JSON value `"invalid_token"`
ErrorTypeEnumMissing_feature	Represents the JSON value `"missing_feature"`
ErrorTypeEnumNot_found	Represents the JSON value `"not_found"`
ErrorTypeEnumRate_limited	Represents the JSON value `"rate_limited"`
ErrorTypeEnumService_not_available	Represents the JSON value `"service_not_available"`
ErrorTypeEnumSimultaneous_request	Represents the JSON value `"simultaneous_request"`
ErrorTypeEnumTax_service_error	Represents the JSON value `"tax_service_error"`
ErrorTypeEnumTransaction	Represents the JSON value `"transaction"`
ErrorTypeEnumUnauthorized	Represents the JSON value `"unauthorized"`
ErrorTypeEnumUnavailable_in_api_version	Represents the JSON value `"unavailable_in_api_version"`
ErrorTypeEnumUnknown_api_version	Represents the JSON value `"unknown_api_version"`
ErrorTypeEnumValidation	Represents the JSON value `"validation"`

Instances

Instances details

FromJSON ErrorType Source #
Instance details Defined in RecurlyClient.Types.Error Methods parseJSON :: Value -> Parser ErrorType # parseJSONList :: Value -> Parser [ErrorType] #
ToJSON ErrorType Source #
Instance details Defined in RecurlyClient.Types.Error Methods toJSON :: ErrorType -> Value # toEncoding :: ErrorType -> Encoding # toJSONList :: [ErrorType] -> Value # toEncodingList :: [ErrorType] -> Encoding #
Show ErrorType Source #
Instance details Defined in RecurlyClient.Types.Error Methods showsPrec :: Int -> ErrorType -> ShowS # show :: ErrorType -> String # showList :: [ErrorType] -> ShowS #
Eq ErrorType Source #
Instance details Defined in RecurlyClient.Types.Error Methods (==) :: ErrorType -> ErrorType -> Bool # (/=) :: ErrorType -> ErrorType -> Bool #