Microsoft.Translator.API.Auth

Servant types and client for the authorization API

Documentation

newtype SubscriptionKey

A key to your subscription to the service. Used to retrieve an AuthToken.

Constructors

SubKey Text

Instances

Show SubscriptionKey

Defined in Microsoft.Translator.API.Auth

Methods

showsPrec :: Int -> SubscriptionKey -> ShowS

show :: SubscriptionKey -> String

showList :: [SubscriptionKey] -> ShowS

IsString SubscriptionKey

Defined in Microsoft.Translator.API.Auth

Methods

fromString :: String -> SubscriptionKey

ToHttpApiData SubscriptionKey

Defined in Microsoft.Translator.API.Auth

Methods

toUrlPiece :: SubscriptionKey -> Text

toEncodedUrlPiece :: SubscriptionKey -> Builder

toHeader :: SubscriptionKey -> ByteString

toQueryParam :: SubscriptionKey -> Text

data AuthToken

The JSON Web Token issued by MS Microsoft.Translator token service. Consists of wrapped text. Valid for ten minutes.

Instances

Show AuthToken

Defined in Microsoft.Translator.API.Auth

Methods

showsPrec :: Int -> AuthToken -> ShowS

show :: AuthToken -> String

showList :: [AuthToken] -> ShowS

Generic AuthToken

Defined in Microsoft.Translator.API.Auth

Associated Types

type Rep AuthToken :: Type -> Type

Methods

from :: AuthToken -> Rep AuthToken x

to :: Rep AuthToken x -> AuthToken

ToHttpApiData AuthToken

Defined in Microsoft.Translator.API.Auth

Methods

toUrlPiece :: AuthToken -> Text

toEncodedUrlPiece :: AuthToken -> Builder

toHeader :: AuthToken -> ByteString

toQueryParam :: AuthToken -> Text

type Rep AuthToken

Defined in Microsoft.Translator.API.Auth

type Rep AuthToken = D1 (MetaData "AuthToken" "Microsoft.Translator.API.Auth" "microsoft-translator-0.1.2-2WixOZLIJMQ2W9Ir6On7A3" True) (C1 (MetaCons "AuthToken" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data TranslatorException

Instances

Show TranslatorException

Defined in Microsoft.Translator.Exception

Methods

showsPrec :: Int -> TranslatorException -> ShowS

show :: TranslatorException -> String

showList :: [TranslatorException] -> ShowS

Exception TranslatorException

Defined in Microsoft.Translator.Exception

Methods

toException :: TranslatorException -> SomeException

fromException :: SomeException -> Maybe TranslatorException

displayException :: TranslatorException -> String

issueToken :: Manager -> SubscriptionKey -> IO (Either TranslatorException AuthToken)

Retrieve a token from the API. It will be valid for 10 minutes.