Safe Haskell	None
Language	Haskell2010

DocuSign.Client.Types

Synopsis

data AccountId
data AccountName
data DocumentId
data EmailAddress
data EnvelopeId
type PostSigningUri = Uri
data RecipientId
type SigningUri = Uri
data Uri
data UserId
data UserName
mkAccountId :: Integer -> AccountId
mkAccountName :: Text -> AccountName
mkDocumentId :: Integer -> DocumentId
mkEmailAddress :: Text -> EmailAddress
mkEnvelopeId :: UUID -> EnvelopeId
mkRecipientId :: Text -> RecipientId
mkUri :: Text -> Uri
mkUserId :: Text -> UserId
mkUserName :: Text -> UserName
unAccountId :: AccountId -> Integer
unAccountName :: AccountName -> Text
unDocumentId :: DocumentId -> Integer
unEmailAddress :: EmailAddress -> Text
unEnvelopeId :: EnvelopeId -> UUID
unRecipientId :: RecipientId -> Text
unUri :: Uri -> Text
unUserId :: UserId -> Text
unUserName :: UserName -> Text
data AccountInfo = AccountInfo {
- accountId :: AccountId
- accountIsDefault :: Bool
- accountName :: AccountName
- accountUserId :: UserId
- accountUserName :: UserName
}
data Document = Document {
- documentContent :: PDF
- documentId :: DocumentId
- documentName :: Text
}
data Envelope = Envelope {
- envelopeSubject :: Text
- envelopeMessage :: Text
}
data Recipient = Recipient {
- recipientClientUserId :: UserId
- recipientEmailAddress :: EmailAddress
- recipientName :: Text
- recipientSignatureAnchorText :: Maybe Text
}
newtype RedirectionOptions = RedirectionOptions {
- postSigningRedirectionUri :: Uri
}
data SigningEvent
- = SigningCancelled
- | SigningCompleted
- | SigningDeclined
- | SigningException
- | SigningFaxPending
- | SigningIdCheckFailed
- | SigningSessionExpired
- | SigningTokenExpired
- | SigningViewingCompleted
data SigningMethod
- = EmailBasedSigning
- | RedirectionBasedSigning

Documentation

data AccountId Source #

Instances

Enum AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods succ :: AccountId -> AccountId # pred :: AccountId -> AccountId # toEnum :: Int -> AccountId # fromEnum :: AccountId -> Int # enumFrom :: AccountId -> [AccountId] # enumFromThen :: AccountId -> AccountId -> [AccountId] # enumFromTo :: AccountId -> AccountId -> [AccountId] # enumFromThenTo :: AccountId -> AccountId -> AccountId -> [AccountId] #
Eq AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: AccountId -> AccountId -> Bool # (/=) :: AccountId -> AccountId -> Bool #
Integral AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods quot :: AccountId -> AccountId -> AccountId # rem :: AccountId -> AccountId -> AccountId # div :: AccountId -> AccountId -> AccountId # mod :: AccountId -> AccountId -> AccountId # quotRem :: AccountId -> AccountId -> (AccountId, AccountId) # divMod :: AccountId -> AccountId -> (AccountId, AccountId) # toInteger :: AccountId -> Integer #
Num AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods (+) :: AccountId -> AccountId -> AccountId # (-) :: AccountId -> AccountId -> AccountId # (*) :: AccountId -> AccountId -> AccountId # negate :: AccountId -> AccountId # abs :: AccountId -> AccountId # signum :: AccountId -> AccountId # fromInteger :: Integer -> AccountId #
Ord AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods compare :: AccountId -> AccountId -> Ordering # (<) :: AccountId -> AccountId -> Bool # (<=) :: AccountId -> AccountId -> Bool # (>) :: AccountId -> AccountId -> Bool # (>=) :: AccountId -> AccountId -> Bool # max :: AccountId -> AccountId -> AccountId # min :: AccountId -> AccountId -> AccountId #
Read AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS AccountId # readList :: ReadS [AccountId] # readPrec :: ReadPrec AccountId # readListPrec :: ReadPrec [AccountId] #
Real AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods toRational :: AccountId -> Rational #
Show AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> AccountId -> ShowS # show :: AccountId -> String # showList :: [AccountId] -> ShowS #
ToJSON AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: AccountId -> Value # toEncoding :: AccountId -> Encoding # toJSONList :: [AccountId] -> Value # toEncodingList :: [AccountId] -> Encoding #
FromJSON AccountId Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser AccountId # parseJSONList :: Value -> Parser [AccountId] #
Convert AccountId Text Source #
Instance details Defined in DocuSign.Client.Types.Conversion Methods convert :: AccountId -> Text Source #
Parse Text AccountId Source #
Instance details Defined in DocuSign.Client.Types.Parsing Methods parse :: Text -> Maybe AccountId Source #

data AccountName Source #

Instances

Eq AccountName Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: AccountName -> AccountName -> Bool # (/=) :: AccountName -> AccountName -> Bool #
Read AccountName Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS AccountName # readList :: ReadS [AccountName] # readPrec :: ReadPrec AccountName # readListPrec :: ReadPrec [AccountName] #
Show AccountName Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> AccountName -> ShowS # show :: AccountName -> String # showList :: [AccountName] -> ShowS #
ToJSON AccountName Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: AccountName -> Value # toEncoding :: AccountName -> Encoding # toJSONList :: [AccountName] -> Value # toEncodingList :: [AccountName] -> Encoding #
FromJSON AccountName Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser AccountName # parseJSONList :: Value -> Parser [AccountName] #

data DocumentId Source #

Instances

Enum DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods succ :: DocumentId -> DocumentId # pred :: DocumentId -> DocumentId # toEnum :: Int -> DocumentId # fromEnum :: DocumentId -> Int # enumFrom :: DocumentId -> [DocumentId] # enumFromThen :: DocumentId -> DocumentId -> [DocumentId] # enumFromTo :: DocumentId -> DocumentId -> [DocumentId] # enumFromThenTo :: DocumentId -> DocumentId -> DocumentId -> [DocumentId] #
Eq DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: DocumentId -> DocumentId -> Bool # (/=) :: DocumentId -> DocumentId -> Bool #
Integral DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods quot :: DocumentId -> DocumentId -> DocumentId # rem :: DocumentId -> DocumentId -> DocumentId # div :: DocumentId -> DocumentId -> DocumentId # mod :: DocumentId -> DocumentId -> DocumentId # quotRem :: DocumentId -> DocumentId -> (DocumentId, DocumentId) # divMod :: DocumentId -> DocumentId -> (DocumentId, DocumentId) # toInteger :: DocumentId -> Integer #
Data DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentId -> c DocumentId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentId # toConstr :: DocumentId -> Constr # dataTypeOf :: DocumentId -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DocumentId) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentId) # gmapT :: (forall b. Data b => b -> b) -> DocumentId -> DocumentId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentId -> r # gmapQ :: (forall d. Data d => d -> u) -> DocumentId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentId -> m DocumentId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentId -> m DocumentId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentId -> m DocumentId #
Num DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods (+) :: DocumentId -> DocumentId -> DocumentId # (-) :: DocumentId -> DocumentId -> DocumentId # (*) :: DocumentId -> DocumentId -> DocumentId # negate :: DocumentId -> DocumentId # abs :: DocumentId -> DocumentId # signum :: DocumentId -> DocumentId # fromInteger :: Integer -> DocumentId #
Ord DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods compare :: DocumentId -> DocumentId -> Ordering # (<) :: DocumentId -> DocumentId -> Bool # (<=) :: DocumentId -> DocumentId -> Bool # (>) :: DocumentId -> DocumentId -> Bool # (>=) :: DocumentId -> DocumentId -> Bool # max :: DocumentId -> DocumentId -> DocumentId # min :: DocumentId -> DocumentId -> DocumentId #
Read DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS DocumentId # readList :: ReadS [DocumentId] # readPrec :: ReadPrec DocumentId # readListPrec :: ReadPrec [DocumentId] #
Real DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods toRational :: DocumentId -> Rational #
Show DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> DocumentId -> ShowS # show :: DocumentId -> String # showList :: [DocumentId] -> ShowS #
ToJSON DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: DocumentId -> Value # toEncoding :: DocumentId -> Encoding # toJSONList :: [DocumentId] -> Value # toEncodingList :: [DocumentId] -> Encoding #
FromJSON DocumentId Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser DocumentId # parseJSONList :: Value -> Parser [DocumentId] #
Convert DocumentId Text Source #
Instance details Defined in DocuSign.Client.Types.Conversion Methods convert :: DocumentId -> Text Source #

data EmailAddress Source #

Instances

Eq EmailAddress Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: EmailAddress -> EmailAddress -> Bool # (/=) :: EmailAddress -> EmailAddress -> Bool #
Read EmailAddress Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS EmailAddress # readList :: ReadS [EmailAddress] # readPrec :: ReadPrec EmailAddress # readListPrec :: ReadPrec [EmailAddress] #
Show EmailAddress Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> EmailAddress -> ShowS # show :: EmailAddress -> String # showList :: [EmailAddress] -> ShowS #
ToJSON EmailAddress Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: EmailAddress -> Value # toEncoding :: EmailAddress -> Encoding # toJSONList :: [EmailAddress] -> Value # toEncodingList :: [EmailAddress] -> Encoding #
FromJSON EmailAddress Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser EmailAddress # parseJSONList :: Value -> Parser [EmailAddress] #

data EnvelopeId Source #

Instances

Eq EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: EnvelopeId -> EnvelopeId -> Bool # (/=) :: EnvelopeId -> EnvelopeId -> Bool #
Data EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnvelopeId -> c EnvelopeId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnvelopeId # toConstr :: EnvelopeId -> Constr # dataTypeOf :: EnvelopeId -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EnvelopeId) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnvelopeId) # gmapT :: (forall b. Data b => b -> b) -> EnvelopeId -> EnvelopeId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnvelopeId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnvelopeId -> r # gmapQ :: (forall d. Data d => d -> u) -> EnvelopeId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> EnvelopeId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnvelopeId -> m EnvelopeId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvelopeId -> m EnvelopeId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvelopeId -> m EnvelopeId #
Read EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS EnvelopeId # readList :: ReadS [EnvelopeId] # readPrec :: ReadPrec EnvelopeId # readListPrec :: ReadPrec [EnvelopeId] #
Show EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> EnvelopeId -> ShowS # show :: EnvelopeId -> String # showList :: [EnvelopeId] -> ShowS #
ToJSON EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: EnvelopeId -> Value # toEncoding :: EnvelopeId -> Encoding # toJSONList :: [EnvelopeId] -> Value # toEncodingList :: [EnvelopeId] -> Encoding #
FromJSON EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser EnvelopeId # parseJSONList :: Value -> Parser [EnvelopeId] #
Convert EnvelopeId Text Source #
Instance details Defined in DocuSign.Client.Types.Conversion Methods convert :: EnvelopeId -> Text Source #
Parse Text EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types.Parsing Methods parse :: Text -> Maybe EnvelopeId Source #
Parse EnvelopeSummary EnvelopeId Source #
Instance details Defined in DocuSign.Client.Types.Parsing Methods parse :: EnvelopeSummary -> Maybe EnvelopeId Source #

type PostSigningUri = Uri Source #

Represents a post-signing redirection target.

data RecipientId Source #

Instances

Eq RecipientId Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: RecipientId -> RecipientId -> Bool # (/=) :: RecipientId -> RecipientId -> Bool #
Read RecipientId Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS RecipientId # readList :: ReadS [RecipientId] # readPrec :: ReadPrec RecipientId # readListPrec :: ReadPrec [RecipientId] #
Show RecipientId Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> RecipientId -> ShowS # show :: RecipientId -> String # showList :: [RecipientId] -> ShowS #
ToJSON RecipientId Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: RecipientId -> Value # toEncoding :: RecipientId -> Encoding # toJSONList :: [RecipientId] -> Value # toEncodingList :: [RecipientId] -> Encoding #
FromJSON RecipientId Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser RecipientId # parseJSONList :: Value -> Parser [RecipientId] #

type SigningUri = Uri Source #

Represents a single-use signing link.

data Uri Source #

Instances

Eq Uri Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: Uri -> Uri -> Bool # (/=) :: Uri -> Uri -> Bool #
Read Uri Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS Uri # readList :: ReadS [Uri] # readPrec :: ReadPrec Uri # readListPrec :: ReadPrec [Uri] #
Show Uri Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> Uri -> ShowS # show :: Uri -> String # showList :: [Uri] -> ShowS #
ToJSON Uri Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: Uri -> Value # toEncoding :: Uri -> Encoding # toJSONList :: [Uri] -> Value # toEncodingList :: [Uri] -> Encoding #
FromJSON Uri Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser Uri # parseJSONList :: Value -> Parser [Uri] #
Parse EnvelopeViews Uri Source #
Instance details Defined in DocuSign.Client.Types.Parsing Methods parse :: EnvelopeViews -> Maybe Uri Source #

data UserId Source #

Instances

Eq UserId Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: UserId -> UserId -> Bool # (/=) :: UserId -> UserId -> Bool #
Read UserId Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS UserId # readList :: ReadS [UserId] # readPrec :: ReadPrec UserId # readListPrec :: ReadPrec [UserId] #
Show UserId Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> UserId -> ShowS # show :: UserId -> String # showList :: [UserId] -> ShowS #
ToJSON UserId Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: UserId -> Value # toEncoding :: UserId -> Encoding # toJSONList :: [UserId] -> Value # toEncodingList :: [UserId] -> Encoding #
FromJSON UserId Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser UserId # parseJSONList :: Value -> Parser [UserId] #

data UserName Source #

Instances

Eq UserName Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: UserName -> UserName -> Bool # (/=) :: UserName -> UserName -> Bool #
Read UserName Source #
Instance details Defined in DocuSign.Client.Types Methods readsPrec :: Int -> ReadS UserName # readList :: ReadS [UserName] # readPrec :: ReadPrec UserName # readListPrec :: ReadPrec [UserName] #
Show UserName Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> UserName -> ShowS # show :: UserName -> String # showList :: [UserName] -> ShowS #
ToJSON UserName Source #
Instance details Defined in DocuSign.Client.Types Methods toJSON :: UserName -> Value # toEncoding :: UserName -> Encoding # toJSONList :: [UserName] -> Value # toEncodingList :: [UserName] -> Encoding #
FromJSON UserName Source #
Instance details Defined in DocuSign.Client.Types Methods parseJSON :: Value -> Parser UserName # parseJSONList :: Value -> Parser [UserName] #

mkAccountId :: Integer -> AccountId Source #

mkAccountName :: Text -> AccountName Source #

mkDocumentId :: Integer -> DocumentId Source #

mkEmailAddress :: Text -> EmailAddress Source #

mkEnvelopeId :: UUID -> EnvelopeId Source #

mkRecipientId :: Text -> RecipientId Source #

mkUri :: Text -> Uri Source #

mkUserId :: Text -> UserId Source #

mkUserName :: Text -> UserName Source #

unAccountId :: AccountId -> Integer Source #

unAccountName :: AccountName -> Text Source #

unDocumentId :: DocumentId -> Integer Source #

unEmailAddress :: EmailAddress -> Text Source #

unEnvelopeId :: EnvelopeId -> UUID Source #

unRecipientId :: RecipientId -> Text Source #

unUri :: Uri -> Text Source #

unUserId :: UserId -> Text Source #

unUserName :: UserName -> Text Source #

data AccountInfo Source #

Constructors

AccountInfo
Fields accountId :: AccountId accountIsDefault :: Bool accountName :: AccountName accountUserId :: UserId accountUserName :: UserName

Instances

Parse LoginAccount AccountInfo Source #
Instance details Defined in DocuSign.Client.Types.Parsing Methods parse :: LoginAccount -> Maybe AccountInfo Source #
Parse Authentication [AccountInfo] Source #
Instance details Defined in DocuSign.Client.Types.Parsing Methods parse :: Authentication -> Maybe [AccountInfo] Source #

data Document Source #

Constructors

Document
Fields documentContent :: PDF documentId :: DocumentId documentName :: Text

data Envelope Source #

Constructors

Envelope
Fields envelopeSubject :: Text envelopeMessage :: Text

data Recipient Source #

Constructors

Recipient
Fields recipientClientUserId :: UserId recipientEmailAddress :: EmailAddress recipientName :: Text recipientSignatureAnchorText :: Maybe Text

newtype RedirectionOptions Source #

Constructors

RedirectionOptions
Fields postSigningRedirectionUri :: Uri

data SigningEvent Source #

Constructors

SigningCancelled
SigningCompleted
SigningDeclined
SigningException
SigningFaxPending
SigningIdCheckFailed
SigningSessionExpired
SigningTokenExpired
SigningViewingCompleted

Instances

Eq SigningEvent Source #
Instance details Defined in DocuSign.Client.Types Methods (==) :: SigningEvent -> SigningEvent -> Bool # (/=) :: SigningEvent -> SigningEvent -> Bool #
Show SigningEvent Source #
Instance details Defined in DocuSign.Client.Types Methods showsPrec :: Int -> SigningEvent -> ShowS # show :: SigningEvent -> String # showList :: [SigningEvent] -> ShowS #
Parse Text SigningEvent Source #
Instance details Defined in DocuSign.Client.Types.Parsing Methods parse :: Text -> Maybe SigningEvent Source #

data SigningMethod Source #

Constructors

EmailBasedSigning
RedirectionBasedSigning