DocuSign.Client.Types

Documentation

data AccountId

Instances

Enum AccountId

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

Defined in DocuSign.Client.Types

Methods

(==) :: AccountId -> AccountId -> Bool

(/=) :: AccountId -> AccountId -> Bool

Integral AccountId

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

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

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

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS AccountId

readList :: ReadS [AccountId]

readPrec :: ReadPrec AccountId

readListPrec :: ReadPrec [AccountId]

Real AccountId

Defined in DocuSign.Client.Types

Methods

toRational :: AccountId -> Rational

Show AccountId

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> AccountId -> ShowS

show :: AccountId -> String

showList :: [AccountId] -> ShowS

ToJSON AccountId

Defined in DocuSign.Client.Types

Methods

toJSON :: AccountId -> Value

toEncoding :: AccountId -> Encoding

toJSONList :: [AccountId] -> Value

toEncodingList :: [AccountId] -> Encoding

FromJSON AccountId

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser AccountId

parseJSONList :: Value -> Parser [AccountId]

Convert AccountId Text

Defined in DocuSign.Client.Types.Conversion

Methods

convert :: AccountId -> Text

Parse Text AccountId

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe AccountId

data AccountName

Instances

Eq AccountName

Defined in DocuSign.Client.Types

Methods

(==) :: AccountName -> AccountName -> Bool

(/=) :: AccountName -> AccountName -> Bool

Read AccountName

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS AccountName

readList :: ReadS [AccountName]

readPrec :: ReadPrec AccountName

readListPrec :: ReadPrec [AccountName]

Show AccountName

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> AccountName -> ShowS

show :: AccountName -> String

showList :: [AccountName] -> ShowS

ToJSON AccountName

Defined in DocuSign.Client.Types

Methods

toJSON :: AccountName -> Value

toEncoding :: AccountName -> Encoding

toJSONList :: [AccountName] -> Value

toEncodingList :: [AccountName] -> Encoding

FromJSON AccountName

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser AccountName

parseJSONList :: Value -> Parser [AccountName]

data DocumentId

Instances

Enum DocumentId

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

Defined in DocuSign.Client.Types

Methods

(==) :: DocumentId -> DocumentId -> Bool

(/=) :: DocumentId -> DocumentId -> Bool

Integral DocumentId

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

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

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

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

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS DocumentId

readList :: ReadS [DocumentId]

readPrec :: ReadPrec DocumentId

readListPrec :: ReadPrec [DocumentId]

Real DocumentId

Defined in DocuSign.Client.Types

Methods

toRational :: DocumentId -> Rational

Show DocumentId

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> DocumentId -> ShowS

show :: DocumentId -> String

showList :: [DocumentId] -> ShowS

ToJSON DocumentId

Defined in DocuSign.Client.Types

Methods

toJSON :: DocumentId -> Value

toEncoding :: DocumentId -> Encoding

toJSONList :: [DocumentId] -> Value

toEncodingList :: [DocumentId] -> Encoding

FromJSON DocumentId

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser DocumentId

parseJSONList :: Value -> Parser [DocumentId]

Convert DocumentId Text

Defined in DocuSign.Client.Types.Conversion

Methods

convert :: DocumentId -> Text

data EmailAddress

Instances

Eq EmailAddress

Defined in DocuSign.Client.Types

Methods

(==) :: EmailAddress -> EmailAddress -> Bool

(/=) :: EmailAddress -> EmailAddress -> Bool

Read EmailAddress

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS EmailAddress

readList :: ReadS [EmailAddress]

readPrec :: ReadPrec EmailAddress

readListPrec :: ReadPrec [EmailAddress]

Show EmailAddress

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> EmailAddress -> ShowS

show :: EmailAddress -> String

showList :: [EmailAddress] -> ShowS

ToJSON EmailAddress

Defined in DocuSign.Client.Types

Methods

toJSON :: EmailAddress -> Value

toEncoding :: EmailAddress -> Encoding

toJSONList :: [EmailAddress] -> Value

toEncodingList :: [EmailAddress] -> Encoding

FromJSON EmailAddress

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser EmailAddress

parseJSONList :: Value -> Parser [EmailAddress]

data EnvelopeId

Instances

Eq EnvelopeId

Defined in DocuSign.Client.Types

Methods

(==) :: EnvelopeId -> EnvelopeId -> Bool

(/=) :: EnvelopeId -> EnvelopeId -> Bool

Data EnvelopeId

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

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS EnvelopeId

readList :: ReadS [EnvelopeId]

readPrec :: ReadPrec EnvelopeId

readListPrec :: ReadPrec [EnvelopeId]

Show EnvelopeId

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> EnvelopeId -> ShowS

show :: EnvelopeId -> String

showList :: [EnvelopeId] -> ShowS

ToJSON EnvelopeId

Defined in DocuSign.Client.Types

Methods

toJSON :: EnvelopeId -> Value

toEncoding :: EnvelopeId -> Encoding

toJSONList :: [EnvelopeId] -> Value

toEncodingList :: [EnvelopeId] -> Encoding

FromJSON EnvelopeId

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser EnvelopeId

parseJSONList :: Value -> Parser [EnvelopeId]

Convert EnvelopeId Text

Defined in DocuSign.Client.Types.Conversion

Methods

convert :: EnvelopeId -> Text

Parse Text EnvelopeId

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe EnvelopeId

Parse EnvelopeSummary EnvelopeId

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: EnvelopeSummary -> Maybe EnvelopeId

type PostSigningUri = Uri

Represents a post-signing redirection target.

data RecipientId

Instances

Eq RecipientId

Defined in DocuSign.Client.Types

Methods

(==) :: RecipientId -> RecipientId -> Bool

(/=) :: RecipientId -> RecipientId -> Bool

Read RecipientId

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS RecipientId

readList :: ReadS [RecipientId]

readPrec :: ReadPrec RecipientId

readListPrec :: ReadPrec [RecipientId]

Show RecipientId

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> RecipientId -> ShowS

show :: RecipientId -> String

showList :: [RecipientId] -> ShowS

ToJSON RecipientId

Defined in DocuSign.Client.Types

Methods

toJSON :: RecipientId -> Value

toEncoding :: RecipientId -> Encoding

toJSONList :: [RecipientId] -> Value

toEncodingList :: [RecipientId] -> Encoding

FromJSON RecipientId

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser RecipientId

parseJSONList :: Value -> Parser [RecipientId]

type SigningUri = Uri

Represents a single-use signing link.

data Uri

Instances

Eq Uri

Defined in DocuSign.Client.Types

Methods

(==) :: Uri -> Uri -> Bool

(/=) :: Uri -> Uri -> Bool

Read Uri

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS Uri

readList :: ReadS [Uri]

readPrec :: ReadPrec Uri

readListPrec :: ReadPrec [Uri]

Show Uri

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> Uri -> ShowS

show :: Uri -> String

showList :: [Uri] -> ShowS

ToJSON Uri

Defined in DocuSign.Client.Types

Methods

toJSON :: Uri -> Value

toEncoding :: Uri -> Encoding

toJSONList :: [Uri] -> Value

toEncodingList :: [Uri] -> Encoding

FromJSON Uri

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser Uri

parseJSONList :: Value -> Parser [Uri]

Parse EnvelopeViews Uri

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: EnvelopeViews -> Maybe Uri

data UserId

Instances

Eq UserId

Defined in DocuSign.Client.Types

Methods

(==) :: UserId -> UserId -> Bool

(/=) :: UserId -> UserId -> Bool

Read UserId

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS UserId

readList :: ReadS [UserId]

readPrec :: ReadPrec UserId

readListPrec :: ReadPrec [UserId]

Show UserId

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> UserId -> ShowS

show :: UserId -> String

showList :: [UserId] -> ShowS

ToJSON UserId

Defined in DocuSign.Client.Types

Methods

toJSON :: UserId -> Value

toEncoding :: UserId -> Encoding

toJSONList :: [UserId] -> Value

toEncodingList :: [UserId] -> Encoding

FromJSON UserId

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser UserId

parseJSONList :: Value -> Parser [UserId]

data UserName

Instances

Eq UserName

Defined in DocuSign.Client.Types

Methods

(==) :: UserName -> UserName -> Bool

(/=) :: UserName -> UserName -> Bool

Read UserName

Defined in DocuSign.Client.Types

Methods

readsPrec :: Int -> ReadS UserName

readList :: ReadS [UserName]

readPrec :: ReadPrec UserName

readListPrec :: ReadPrec [UserName]

Show UserName

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> UserName -> ShowS

show :: UserName -> String

showList :: [UserName] -> ShowS

ToJSON UserName

Defined in DocuSign.Client.Types

Methods

toJSON :: UserName -> Value

toEncoding :: UserName -> Encoding

toJSONList :: [UserName] -> Value

toEncodingList :: [UserName] -> Encoding

FromJSON UserName

Defined in DocuSign.Client.Types

Methods

parseJSON :: Value -> Parser UserName

parseJSONList :: Value -> Parser [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

Constructors

AccountInfo

Fields

• accountId :: AccountId
• accountIsDefault :: Bool
• accountName :: AccountName
• accountUserId :: UserId
• accountUserName :: UserName

Instances

Parse LoginAccount AccountInfo

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: LoginAccount -> Maybe AccountInfo

Parse Authentication [AccountInfo]

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Authentication -> Maybe [AccountInfo]

data Document

Constructors

Document

Fields

• documentContent :: PDF
• documentId :: DocumentId
• documentName :: Text

data Envelope

Constructors

Envelope

Fields

• envelopeSubject :: Text
• envelopeMessage :: Text

data Recipient

Constructors

Recipient

Fields

• recipientClientUserId :: UserId
• recipientEmailAddress :: EmailAddress
• recipientName :: Text
• recipientSignatureAnchorText :: Maybe Text

newtype RedirectionOptions

Constructors

RedirectionOptions

Fields

• postSigningRedirectionUri :: Uri

data SigningEvent

Constructors

SigningCancelled

SigningCompleted

SigningDeclined

SigningException

SigningFaxPending

SigningIdCheckFailed

SigningSessionExpired

SigningTokenExpired

SigningViewingCompleted

Instances

Eq SigningEvent

Defined in DocuSign.Client.Types

Methods

(==) :: SigningEvent -> SigningEvent -> Bool

(/=) :: SigningEvent -> SigningEvent -> Bool

Show SigningEvent

Defined in DocuSign.Client.Types

Methods

showsPrec :: Int -> SigningEvent -> ShowS

show :: SigningEvent -> String

showList :: [SigningEvent] -> ShowS

Parse Text SigningEvent

Defined in DocuSign.Client.Types.Parsing

Methods

parse :: Text -> Maybe SigningEvent

data SigningMethod

Constructors

EmailBasedSigning

RedirectionBasedSigning