Safe Haskell	None
Language	GHC2021

Network.Globus.Types

Synopsis

(/:) :: forall {k} (a :: k). Uri a -> String -> Uri a
param :: forall {k} (a :: k). Text -> Text -> Uri a -> Uri a
appendQuery :: Text -> Maybe Text -> String -> String
renderUri :: forall {k} (a :: k). Uri a -> Text
newtype State = State Text
data TokenItem = TokenItem {
- scope :: Scopes
- access_token :: Token 'Access
- expires_in :: Int
- state :: State
}
data GlobusError
- = InvalidURI String URI
- | Unauthorized Request ByteString
- | ResponseBadStatus Request Status ByteString
- | ResponseBadJSON Request String ByteString
- | MissingScope Scope (NonEmpty TokenItem)
type Token (a :: k) = Tagged a Text
type Id (a :: k) = Tagged a Text
type Uri (a :: k) = Tagged a URI
data Token'
- = ClientId
- | ClientSecret
- | Exchange
- | Access
data Id'
- = Submission
- | Request
- | Collection
dataLabelsToJSON :: (Generic a, GToJSON' Value Zero (Rep a)) => a -> Value
dataLabelsFromJSON :: (Generic a, GFromJSON Zero (Rep a)) => Value -> Parser a
dataLabels :: String -> String
data DataType (s :: Symbol) = DataType
data DataKey (s :: Symbol) = DataKey {
- data_type :: DataType s
- value :: Text
}
data Endpoint
- = Redirect
- | Authorization
- | Tokens
- | App
data Scope
- = TransferAll
- | Identity ScopeIdentity
data ScopeIdentity
- = OpenId
- | Email
- | Profile
scopeText :: Scope -> Text
scope :: Text -> Maybe Scope
newtype Scopes = Scopes (NonEmpty Scope)

Documentation

(/:) :: forall {k} (a :: k). Uri a -> String -> Uri a infixl 5 Source #

param :: forall {k} (a :: k). Text -> Text -> Uri a -> Uri a Source #

appendQuery :: Text -> Maybe Text -> String -> String Source #

renderUri :: forall {k} (a :: k). Uri a -> Text Source #

newtype State Source #

Opaque secret identifying the user. Validate on redirect

Constructors

State Text

Instances

Instances details

FromJSON State Source #
Instance details Defined in Network.Globus.Types Methods parseJSON :: Value -> Parser State # parseJSONList :: Value -> Parser [State] # omittedField :: Maybe State #
IsString State Source #
Instance details Defined in Network.Globus.Types Methods fromString :: String -> State #
Show State Source #
Instance details Defined in Network.Globus.Types Methods showsPrec :: Int -> State -> ShowS # show :: State -> String # showList :: [State] -> ShowS #
Eq State Source #
Instance details Defined in Network.Globus.Types Methods (==) :: State -> State -> Bool # (/=) :: State -> State -> Bool #

data TokenItem Source #

Constructors

TokenItem
Fields scope :: Scopes access_token :: Token 'Access expires_in :: Int state :: State

Instances

Instances details

FromJSON TokenItem Source #

Instance details

Defined in Network.Globus.Types

Methods

parseJSON :: Value -> Parser TokenItem #

parseJSONList :: Value -> Parser [TokenItem] #

omittedField :: Maybe TokenItem #

Generic TokenItem Source #

Instance details

Defined in Network.Globus.Types

Associated Types

type Rep TokenItem

Instance details

Defined in Network.Globus.Types

type Rep TokenItem = D1 ('MetaData "TokenItem" "Network.Globus.Types" "globus-0.2.1-85rzRRnpoUqQWRs7VBwFT" 'False) (C1 ('MetaCons "TokenItem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scopes) :*: S1 ('MetaSel ('Just "access_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Token 'Access))) :*: (S1 ('MetaSel ('Just "expires_in") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 State))))

Methods

from :: TokenItem -> Rep TokenItem x #

to :: Rep TokenItem x -> TokenItem #

Show TokenItem Source #

Instance details

Defined in Network.Globus.Types

Methods

showsPrec :: Int -> TokenItem -> ShowS #

show :: TokenItem -> String #

showList :: [TokenItem] -> ShowS #

Eq TokenItem Source #

Instance details

Defined in Network.Globus.Types

Methods

(==) :: TokenItem -> TokenItem -> Bool #

(/=) :: TokenItem -> TokenItem -> Bool #

type Rep TokenItem Source #

Instance details

Defined in Network.Globus.Types

type Rep TokenItem = D1 ('MetaData "TokenItem" "Network.Globus.Types" "globus-0.2.1-85rzRRnpoUqQWRs7VBwFT" 'False) (C1 ('MetaCons "TokenItem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scopes) :*: S1 ('MetaSel ('Just "access_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Token 'Access))) :*: (S1 ('MetaSel ('Just "expires_in") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 State))))

data GlobusError Source #

Constructors

InvalidURI String URI
Unauthorized Request ByteString
ResponseBadStatus Request Status ByteString
ResponseBadJSON Request String ByteString
MissingScope Scope (NonEmpty TokenItem)

Instances

Instances details

Exception GlobusError Source #
Instance details Defined in Network.Globus.Types Methods toException :: GlobusError -> SomeException # fromException :: SomeException -> Maybe GlobusError # displayException :: GlobusError -> String #
Show GlobusError Source #
Instance details Defined in Network.Globus.Types Methods showsPrec :: Int -> GlobusError -> ShowS # show :: GlobusError -> String # showList :: [GlobusError] -> ShowS #

type Token (a :: k) = Tagged a Text Source #

type Id (a :: k) = Tagged a Text Source #

type Uri (a :: k) = Tagged a URI Source #

data Token' Source #

Constructors

ClientId
ClientSecret
Exchange
Access

data Id' Source #

Constructors

Submission
Request
Collection

dataLabelsToJSON :: (Generic a, GToJSON' Value Zero (Rep a)) => a -> Value Source #

dataLabelsFromJSON :: (Generic a, GFromJSON Zero (Rep a)) => Value -> Parser a Source #

dataLabels :: String -> String Source #

data DataType (s :: Symbol) Source #

Constructors

DataType

Instances

Instances details

FromJSON (DataType s) Source #
Instance details Defined in Network.Globus.Types Methods parseJSON :: Value -> Parser (DataType s) # parseJSONList :: Value -> Parser [DataType s] # omittedField :: Maybe (DataType s) #
KnownSymbol s => ToJSON (DataType s) Source #
Instance details Defined in Network.Globus.Types Methods toJSON :: DataType s -> Value # toEncoding :: DataType s -> Encoding # toJSONList :: [DataType s] -> Value # toEncodingList :: [DataType s] -> Encoding # omitField :: DataType s -> Bool #

data DataKey (s :: Symbol) Source #

Constructors

DataKey
Fields data_type :: DataType s value :: Text

Instances

Instances details

FromJSON (DataKey s) Source #

Instance details

Defined in Network.Globus.Types

Methods

parseJSON :: Value -> Parser (DataKey s) #

parseJSONList :: Value -> Parser [DataKey s] #

omittedField :: Maybe (DataKey s) #

Generic (DataKey s) Source #

Instance details

Defined in Network.Globus.Types

Associated Types

type Rep (DataKey s)

Instance details

Defined in Network.Globus.Types

type Rep (DataKey s) = D1 ('MetaData "DataKey" "Network.Globus.Types" "globus-0.2.1-85rzRRnpoUqQWRs7VBwFT" 'False) (C1 ('MetaCons "DataKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "data_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (DataType s)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

Methods

from :: DataKey s -> Rep (DataKey s) x #

to :: Rep (DataKey s) x -> DataKey s #

type Rep (DataKey s) Source #

Instance details

Defined in Network.Globus.Types

type Rep (DataKey s) = D1 ('MetaData "DataKey" "Network.Globus.Types" "globus-0.2.1-85rzRRnpoUqQWRs7VBwFT" 'False) (C1 ('MetaCons "DataKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "data_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (DataType s)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

data Endpoint Source #

Constructors

Redirect
Authorization
Tokens
App

data Scope Source #

Constructors

TransferAll
Identity ScopeIdentity

Instances

Instances details

FromJSON Scope Source #
Instance details Defined in Network.Globus.Types Methods parseJSON :: Value -> Parser Scope # parseJSONList :: Value -> Parser [Scope] # omittedField :: Maybe Scope #
Show Scope Source #
Instance details Defined in Network.Globus.Types Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
Eq Scope Source #
Instance details Defined in Network.Globus.Types Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #

data ScopeIdentity Source #

Constructors

OpenId
Email
Profile

Instances

Instances details

Show ScopeIdentity Source #
Instance details Defined in Network.Globus.Types Methods showsPrec :: Int -> ScopeIdentity -> ShowS # show :: ScopeIdentity -> String # showList :: [ScopeIdentity] -> ShowS #
Eq ScopeIdentity Source #
Instance details Defined in Network.Globus.Types Methods (==) :: ScopeIdentity -> ScopeIdentity -> Bool # (/=) :: ScopeIdentity -> ScopeIdentity -> Bool #

scopeText :: Scope -> Text Source #

scope :: Text -> Maybe Scope Source #

newtype Scopes Source #

Constructors

Scopes (NonEmpty Scope)

Instances

Instances details

FromJSON Scopes Source #
Instance details Defined in Network.Globus.Types Methods parseJSON :: Value -> Parser Scopes # parseJSONList :: Value -> Parser [Scopes] # omittedField :: Maybe Scopes #
Show Scopes Source #
Instance details Defined in Network.Globus.Types Methods showsPrec :: Int -> Scopes -> ShowS # show :: Scopes -> String # showList :: [Scopes] -> ShowS #
Eq Scopes Source #
Instance details Defined in Network.Globus.Types Methods (==) :: Scopes -> Scopes -> Bool # (/=) :: Scopes -> Scopes -> Bool #