-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Client bindings for the DocuSign API -- -- DocuSign is an electronic signature technology and digital transaction -- management. This is the client API. @package docusign-client @version 0.0.2 module DocuSign.Client.Types data AccountId data AccountName data DocumentId data EmailAddress data EnvelopeId -- | Represents a post-signing redirection target. type PostSigningUri = Uri data RecipientId -- | Represents a single-use signing link. 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 -> Bool -> AccountName -> UserId -> UserName -> AccountInfo [accountId] :: AccountInfo -> AccountId [accountIsDefault] :: AccountInfo -> Bool [accountName] :: AccountInfo -> AccountName [accountUserId] :: AccountInfo -> UserId [accountUserName] :: AccountInfo -> UserName data Document Document :: PDF -> DocumentId -> Text -> Document [documentContent] :: Document -> PDF [documentId] :: Document -> DocumentId [documentName] :: Document -> Text data Envelope Envelope :: Text -> Text -> Envelope [envelopeSubject] :: Envelope -> Text [envelopeMessage] :: Envelope -> Text data Recipient Recipient :: UserId -> EmailAddress -> Text -> Maybe Text -> Recipient [recipientClientUserId] :: Recipient -> UserId [recipientEmailAddress] :: Recipient -> EmailAddress [recipientName] :: Recipient -> Text [recipientSignatureAnchorText] :: Recipient -> Maybe Text newtype RedirectionOptions RedirectionOptions :: Uri -> RedirectionOptions [postSigningRedirectionUri] :: RedirectionOptions -> Uri data SigningEvent SigningCancelled :: SigningEvent SigningCompleted :: SigningEvent SigningDeclined :: SigningEvent SigningException :: SigningEvent SigningFaxPending :: SigningEvent SigningIdCheckFailed :: SigningEvent SigningSessionExpired :: SigningEvent SigningTokenExpired :: SigningEvent SigningViewingCompleted :: SigningEvent data SigningMethod EmailBasedSigning :: SigningMethod RedirectionBasedSigning :: SigningMethod instance GHC.Show.Show DocuSign.Client.Types.SigningEvent instance GHC.Classes.Eq DocuSign.Client.Types.SigningEvent instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.UserName instance GHC.Show.Show DocuSign.Client.Types.UserName instance GHC.Read.Read DocuSign.Client.Types.UserName instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.UserName instance GHC.Classes.Eq DocuSign.Client.Types.UserName instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.UserId instance GHC.Show.Show DocuSign.Client.Types.UserId instance GHC.Read.Read DocuSign.Client.Types.UserId instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.UserId instance GHC.Classes.Eq DocuSign.Client.Types.UserId instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.Uri instance GHC.Show.Show DocuSign.Client.Types.Uri instance GHC.Read.Read DocuSign.Client.Types.Uri instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.Uri instance GHC.Classes.Eq DocuSign.Client.Types.Uri instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.RecipientId instance GHC.Show.Show DocuSign.Client.Types.RecipientId instance GHC.Read.Read DocuSign.Client.Types.RecipientId instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.RecipientId instance GHC.Classes.Eq DocuSign.Client.Types.RecipientId instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.EnvelopeId instance GHC.Show.Show DocuSign.Client.Types.EnvelopeId instance GHC.Read.Read DocuSign.Client.Types.EnvelopeId instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.EnvelopeId instance GHC.Classes.Eq DocuSign.Client.Types.EnvelopeId instance Data.Data.Data DocuSign.Client.Types.EnvelopeId instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.EmailAddress instance GHC.Show.Show DocuSign.Client.Types.EmailAddress instance GHC.Read.Read DocuSign.Client.Types.EmailAddress instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.EmailAddress instance GHC.Classes.Eq DocuSign.Client.Types.EmailAddress instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.DocumentId instance GHC.Show.Show DocuSign.Client.Types.DocumentId instance GHC.Real.Real DocuSign.Client.Types.DocumentId instance GHC.Read.Read DocuSign.Client.Types.DocumentId instance GHC.Classes.Ord DocuSign.Client.Types.DocumentId instance GHC.Num.Num DocuSign.Client.Types.DocumentId instance GHC.Real.Integral DocuSign.Client.Types.DocumentId instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.DocumentId instance GHC.Classes.Eq DocuSign.Client.Types.DocumentId instance GHC.Enum.Enum DocuSign.Client.Types.DocumentId instance Data.Data.Data DocuSign.Client.Types.DocumentId instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.AccountName instance GHC.Show.Show DocuSign.Client.Types.AccountName instance GHC.Read.Read DocuSign.Client.Types.AccountName instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.AccountName instance GHC.Classes.Eq DocuSign.Client.Types.AccountName instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Types.AccountId instance GHC.Show.Show DocuSign.Client.Types.AccountId instance GHC.Real.Real DocuSign.Client.Types.AccountId instance GHC.Read.Read DocuSign.Client.Types.AccountId instance GHC.Classes.Ord DocuSign.Client.Types.AccountId instance GHC.Num.Num DocuSign.Client.Types.AccountId instance GHC.Real.Integral DocuSign.Client.Types.AccountId instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Types.AccountId instance GHC.Classes.Eq DocuSign.Client.Types.AccountId instance GHC.Enum.Enum DocuSign.Client.Types.AccountId module DocuSign.Client.Configuration data Config Config :: AccountConfig -> ServerConfig -> Config [configAccount] :: Config -> AccountConfig [configServer] :: Config -> ServerConfig data AccountConfig AccountConfig :: AccountId -> UUID -> Text -> Text -> AccountConfig [accountId] :: AccountConfig -> AccountId [accountKey] :: AccountConfig -> UUID [accountUsername] :: AccountConfig -> Text [accountPassword] :: AccountConfig -> Text data ServerConfig ServerConfig :: Text -> Int -> ServerConfig [serverHost] :: ServerConfig -> Text [serverPort] :: ServerConfig -> Int instance GHC.Show.Show DocuSign.Client.Configuration.Config instance GHC.Read.Read DocuSign.Client.Configuration.Config instance GHC.Generics.Generic DocuSign.Client.Configuration.Config instance GHC.Show.Show DocuSign.Client.Configuration.ServerConfig instance GHC.Read.Read DocuSign.Client.Configuration.ServerConfig instance GHC.Generics.Generic DocuSign.Client.Configuration.ServerConfig instance GHC.Show.Show DocuSign.Client.Configuration.AccountConfig instance GHC.Read.Read DocuSign.Client.Configuration.AccountConfig instance GHC.Generics.Generic DocuSign.Client.Configuration.AccountConfig instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Configuration.Config instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Configuration.Config instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Configuration.ServerConfig instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Configuration.ServerConfig instance Data.Aeson.Types.FromJSON.FromJSON DocuSign.Client.Configuration.AccountConfig instance Data.Aeson.Types.ToJSON.ToJSON DocuSign.Client.Configuration.AccountConfig -- | This module contains conversion operations that are guaranteed not to -- fail. -- -- Such conversions are typically used when preparing messages to be sent -- to a DocuSign server instance, and convert from types exposed by the -- user-facing high-level client API to types consumed by the lower-level -- REST API. module DocuSign.Client.Types.Conversion -- | A class for conversions that are guaranteed not to fail. class Convert a b convert :: Convert a b => a -> b instance DocuSign.Client.Types.Conversion.Convert DocuSign.Client.Types.AccountId Data.Text.Internal.Text instance DocuSign.Client.Types.Conversion.Convert DocuSign.Client.Types.DocumentId Data.Text.Internal.Text instance DocuSign.Client.Types.Conversion.Convert DocuSign.Client.Types.EnvelopeId Data.Text.Internal.Text -- | 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. module DocuSign.Client.Types.Parsing -- | A class for conversions that have the potential to fail. class Parse a b parse :: Parse a b => a -> Maybe b -- | Parse a value monadically. parseM :: forall a b m. MonadThrow m => Parse a b => Show a => Typeable a => Typeable b => a -> m b -- | Thrown when the base API fails to return a value that was expected. data ParseFailure a b ParseFailure :: a -> TypeRep a -> TypeRep b -> ParseFailure a b [sourceValue] :: ParseFailure a b -> a [sourceType] :: ParseFailure a b -> TypeRep a [targetType] :: ParseFailure a b -> TypeRep b parseFailure :: Typeable a => Typeable b => a -> ParseFailure a b instance GHC.Show.Show a => GHC.Show.Show (DocuSign.Client.Types.Parsing.ParseFailure a b) instance (GHC.Show.Show a, Data.Typeable.Internal.Typeable a, Data.Typeable.Internal.Typeable b) => GHC.Exception.Type.Exception (DocuSign.Client.Types.Parsing.ParseFailure a b) instance DocuSign.Client.Types.Parsing.Parse DocuSign.Base.Types.Authentication.Authentication [DocuSign.Client.Types.AccountInfo] instance DocuSign.Client.Types.Parsing.Parse Data.Text.Internal.Text DocuSign.Client.Types.AccountId instance DocuSign.Client.Types.Parsing.Parse DocuSign.Base.Types.LoginAccount.LoginAccount DocuSign.Client.Types.AccountInfo instance DocuSign.Client.Types.Parsing.Parse Data.Text.Internal.Text Data.UUID.Types.Internal.UUID instance DocuSign.Client.Types.Parsing.Parse Data.Text.Internal.Text DocuSign.Client.Types.EnvelopeId instance DocuSign.Client.Types.Parsing.Parse DocuSign.Base.Types.EnvelopeSummary.EnvelopeSummary DocuSign.Client.Types.EnvelopeId instance DocuSign.Client.Types.Parsing.Parse DocuSign.Base.Types.EnvelopeViews.EnvelopeViews DocuSign.Client.Types.Uri instance DocuSign.Client.Types.Parsing.Parse Data.Text.Internal.Text GHC.Types.Bool instance DocuSign.Client.Types.Parsing.Parse Data.Text.Internal.Text DocuSign.Client.Types.SigningEvent -- | A simple client for communicating with a DocuSign server instance. module DocuSign.Client data DocuSignClient m DocuSignClient :: m [AccountInfo] -> (AccountId -> [Document] -> Envelope -> Recipient -> m EnvelopeId) -> (AccountId -> [Document] -> Envelope -> Recipient -> (EnvelopeId -> PostSigningUri) -> m (EnvelopeId, SigningUri)) -> (AccountId -> EnvelopeId -> DocumentId -> m PDF) -> DocuSignClient m -- | List all accounts associated with the current set of credentials. [listAccounts] :: DocuSignClient m -> m [AccountInfo] -- | Post a set of documents to a single recipient for signing via email. [postDocumentsForEmailBasedSigning] :: DocuSignClient m -> AccountId -> [Document] -> Envelope -> Recipient -> m EnvelopeId -- | Post a set of documents to a single recipient for signing via browser -- redirection. [postDocumentsForRedirectionBasedSigning] :: DocuSignClient m -> AccountId -> [Document] -> Envelope -> Recipient -> (EnvelopeId -> PostSigningUri) -> m (EnvelopeId, SigningUri) -- | Fetch a document in its current state, regardless of whether it has or -- has not been signed. [fetchDocument] :: DocuSignClient m -> AccountId -> EnvelopeId -> DocumentId -> m PDF docuSignClient :: DocuSignClient ClientM runClient :: Config -> ClientM a -> IO (Either ServantError a)