DocuSign.Client.Types.Parsing

This module contains conversion operations that have the potential to fail.

Such conversions are typically used when processing messages received from a DocuSign server instance, which may return values that are incomplete.

Such messages typically include record instances for which only a subset of values are present. The precise subset of values included often depends on which particular operation was invoked, or on the current server state.

The knowledge of when to expect that values will be present (and when to expect that they will be missing) is encapsulated in this module.

Documentation

class Parse a b where

A class for conversions that have the potential to fail.

Methods

parse :: a -> Maybe b

Instances

Parse Text Bool

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe Bool

Parse Text UUID

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe UUID

Parse Text SigningEvent

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe SigningEvent

Parse Text EnvelopeId

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe EnvelopeId

Parse Text AccountId

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe AccountId

Parse LoginAccount AccountInfo

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: LoginAccount -> Maybe AccountInfo

Parse EnvelopeViews Uri

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: EnvelopeViews -> Maybe Uri

Parse EnvelopeSummary EnvelopeId

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: EnvelopeSummary -> Maybe EnvelopeId

Parse Authentication [AccountInfo]

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Authentication -> Maybe [AccountInfo]

parseM :: forall a b m. MonadThrow m => Parse a b => Show a => Typeable a => Typeable b => a -> m b

Parse a value monadically.

data ParseFailure a b

Thrown when the base API fails to return a value that was expected.

Constructors

ParseFailure

Fields

• sourceValue :: a
• sourceType :: TypeRep a
• targetType :: TypeRep b

Instances

Show a => Show (ParseFailure a b)

Defined in DocuSign.Client.Types.Parsing

Methods

showsPrec :: Int -> ParseFailure a b -> ShowS

show :: ParseFailure a b -> String

showList :: [ParseFailure a b] -> ShowS

(Show a, Typeable a, Typeable b) => Exception (ParseFailure a b)

Defined in DocuSign.Client.Types.Parsing

Methods

toException :: ParseFailure a b -> SomeException

fromException :: SomeException -> Maybe (ParseFailure a b)

displayException :: ParseFailure a b -> String

parseFailure :: Typeable a => Typeable b => a -> ParseFailure a b