Copyright	(c) 2015-2022 Brendan Hay <brendan.g.hay@gmail.com>
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Types

Description

Synopsis

data AltJSON = AltJSON
data AltMedia = AltMedia
data Multipart = Multipart
newtype OAuthScope = OAuthScope Text
newtype AccessToken = AccessToken Text
newtype RefreshToken = RefreshToken Text
newtype ClientId = ClientId Text
newtype ServiceId = ServiceId Text
newtype GSecret = GSecret Text
newtype MediaDownload a = MediaDownload a
data MediaUpload a = MediaUpload a GBody
_Coerce :: (Coercible a b, Coercible b a) => Iso' a b
_Default :: Monoid a => Iso' (Maybe a) a
type Stream = ConduitM () ByteString (ResourceT IO) ()
data Error
- = TransportError HttpException
- | SerializeError SerializeError
- | ServiceError ServiceError
data SerializeError = SerializeError' {
- _serializeId :: !ServiceId
- _serializeHeaders :: [Header]
- _serializeStatus :: !Status
- _serializeMessage :: !String
- _serializeBody :: !(Maybe ByteString)
}
data ServiceError = ServiceError' {
- _serviceId :: !ServiceId
- _serviceStatus :: !Status
- _serviceHeaders :: ![Header]
- _serviceBody :: !(Maybe ByteString)
}
class AsError a where
- _Error :: Prism' a Error
- _TransportError :: Prism' a HttpException
- _SerializeError :: Prism' a SerializeError
- _ServiceError :: Prism' a ServiceError
data ServiceConfig = ServiceConfig {
- _svcId :: !ServiceId
- _svcHost :: !ByteString
- _svcPath :: !Builder
- _svcPort :: !Int
- _svcSecure :: !Bool
- _svcTimeout :: !(Maybe Seconds)
}
defaultService :: ServiceId -> ByteString -> ServiceConfig
serviceHost :: Lens' ServiceConfig ByteString
servicePort :: Lens' ServiceConfig Int
servicePath :: Lens' ServiceConfig Builder
serviceSecure :: Lens' ServiceConfig Bool
serviceTimeout :: Lens' ServiceConfig (Maybe Seconds)
data GBody = GBody !MediaType !RequestBody
bodyContentType :: Lens' GBody MediaType
data Request = Request {
- _rqPath :: !Builder
- _rqQuery :: !(DList (ByteString, Maybe ByteString))
- _rqHeaders :: !(DList (HeaderName, ByteString))
- _rqBody :: ![GBody]
}
appendPath :: Request -> Builder -> Request
appendPaths :: ToHttpApiData a => Request -> [a] -> Request
appendQuery :: Request -> ByteString -> Maybe Text -> Request
appendHeader :: Request -> HeaderName -> Maybe Text -> Request
setBody :: Request -> [GBody] -> Request
data GClient a = GClient {
- _cliAccept :: !(Maybe MediaType)
- _cliMethod :: !Method
- _cliCheck :: !(Status -> Bool)
- _cliService :: !ServiceConfig
- _cliRequest :: !Request
- _cliResponse :: !(Stream -> ResourceT IO (Either (String, ByteString) a))
}
clientService :: forall a f. Functor f => (ServiceConfig -> f ServiceConfig) -> GClient a -> f (GClient a)
mime :: forall {k} (c :: k) a. FromStream c a => Proxy c -> Method -> [Int] -> Request -> ServiceConfig -> GClient a
discard :: Method -> [Int] -> Request -> ServiceConfig -> GClient ()
gClient :: (Stream -> ResourceT IO (Either (String, ByteString) a)) -> Maybe MediaType -> Method -> [Int] -> Request -> ServiceConfig -> GClient a
class Accept c => ToBody (c :: k) a where
- toBody :: Proxy c -> a -> GBody
class Accept c => FromStream (c :: k) a where
- fromStream :: Proxy c -> Stream -> ResourceT IO (Either (String, ByteString) a)
class GoogleRequest a where
- type Rs a
- type Scopes a :: [Symbol]
- requestClient :: a -> GClient (Rs a)
class GoogleClient (fn :: k) where
- type Fn (fn :: k)
- buildClient :: Proxy fn -> Request -> Fn fn
data Captures (s :: Symbol) (a :: k)
data CaptureMode (s :: Symbol) (m :: Symbol) (a :: k)
data MultipartRelated (cs :: [Type]) (m :: k)
sinkLBS :: Stream -> ResourceT IO ByteString
buildText :: ToHttpApiData a => a -> Builder
buildSymbol :: forall (n :: Symbol) proxy. KnownSymbol n => proxy n -> Builder
byteSymbol :: forall (n :: Symbol) proxy. KnownSymbol n => proxy n -> ByteString
newtype Seconds = Seconds Int
seconds :: Seconds -> Int
microseconds :: Seconds -> Int
newtype FieldMask = FieldMask {
- fromFieldMask :: Text
}

Documentation

data AltJSON Source #

Constructors

AltJSON

Instances

Instances details

Generic AltJSON Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep AltJSON
Instance details Defined in Gogol.Types type Rep AltJSON = D1 ('MetaData "AltJSON" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'False) (C1 ('MetaCons "AltJSON" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: AltJSON -> Rep AltJSON x #

to :: Rep AltJSON x -> AltJSON #

Read AltJSON Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS AltJSON #

readList :: ReadS [AltJSON] #

readPrec :: ReadPrec AltJSON #

readListPrec :: ReadPrec [AltJSON] #

Show AltJSON Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> AltJSON -> ShowS #

show :: AltJSON -> String #

showList :: [AltJSON] -> ShowS #

Eq AltJSON Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord AltJSON Source #

Instance details

Defined in Gogol.Types

Methods

compare :: AltJSON -> AltJSON -> Ordering #

(<) :: AltJSON -> AltJSON -> Bool #

(<=) :: AltJSON -> AltJSON -> Bool #

(>) :: AltJSON -> AltJSON -> Bool #

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

max :: AltJSON -> AltJSON -> AltJSON #

min :: AltJSON -> AltJSON -> AltJSON #

ToHttpApiData AltJSON Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: AltJSON -> Text #

toEncodedUrlPiece :: AltJSON -> Builder #

toHeader :: AltJSON -> ByteString #

toQueryParam :: AltJSON -> Text #

toEncodedQueryParam :: AltJSON -> Builder #

type Rep AltJSON Source #

Instance details

Defined in Gogol.Types

type Rep AltJSON = D1 ('MetaData "AltJSON" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'False) (C1 ('MetaCons "AltJSON" 'PrefixI 'False) (U1 :: Type -> Type))

data AltMedia Source #

Constructors

AltMedia

Instances

Instances details

Generic AltMedia Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep AltMedia
Instance details Defined in Gogol.Types type Rep AltMedia = D1 ('MetaData "AltMedia" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'False) (C1 ('MetaCons "AltMedia" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: AltMedia -> Rep AltMedia x #

to :: Rep AltMedia x -> AltMedia #

Read AltMedia Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS AltMedia #

readList :: ReadS [AltMedia] #

readPrec :: ReadPrec AltMedia #

readListPrec :: ReadPrec [AltMedia] #

Show AltMedia Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> AltMedia -> ShowS #

show :: AltMedia -> String #

showList :: [AltMedia] -> ShowS #

Eq AltMedia Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord AltMedia Source #

Instance details

Defined in Gogol.Types

Methods

compare :: AltMedia -> AltMedia -> Ordering #

(<) :: AltMedia -> AltMedia -> Bool #

(<=) :: AltMedia -> AltMedia -> Bool #

(>) :: AltMedia -> AltMedia -> Bool #

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

max :: AltMedia -> AltMedia -> AltMedia #

min :: AltMedia -> AltMedia -> AltMedia #

ToHttpApiData AltMedia Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: AltMedia -> Text #

toEncodedUrlPiece :: AltMedia -> Builder #

toHeader :: AltMedia -> ByteString #

toQueryParam :: AltMedia -> Text #

toEncodedQueryParam :: AltMedia -> Builder #

GoogleClient fn => GoogleClient (AltMedia :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (AltMedia :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (AltMedia :> fn :: Type) = GBody -> Fn fn

Methods

buildClient :: Proxy (AltMedia :> fn) -> Request -> Fn (AltMedia :> fn) Source #

type Rep AltMedia Source #

Instance details

Defined in Gogol.Types

type Rep AltMedia = D1 ('MetaData "AltMedia" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'False) (C1 ('MetaCons "AltMedia" 'PrefixI 'False) (U1 :: Type -> Type))

type Fn (AltMedia :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

type Fn (AltMedia :> fn :: Type) = GBody -> Fn fn

data Multipart Source #

Constructors

Multipart

Instances

Instances details

Generic Multipart Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep Multipart
Instance details Defined in Gogol.Types type Rep Multipart = D1 ('MetaData "Multipart" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'False) (C1 ('MetaCons "Multipart" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Multipart -> Rep Multipart x #

to :: Rep Multipart x -> Multipart #

Read Multipart Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS Multipart #

readList :: ReadS [Multipart] #

readPrec :: ReadPrec Multipart #

readListPrec :: ReadPrec [Multipart] #

Show Multipart Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> Multipart -> ShowS #

show :: Multipart -> String #

showList :: [Multipart] -> ShowS #

Eq Multipart Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord Multipart Source #

Instance details

Defined in Gogol.Types

Methods

compare :: Multipart -> Multipart -> Ordering #

(<) :: Multipart -> Multipart -> Bool #

(<=) :: Multipart -> Multipart -> Bool #

(>) :: Multipart -> Multipart -> Bool #

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

max :: Multipart -> Multipart -> Multipart #

min :: Multipart -> Multipart -> Multipart #

ToHttpApiData Multipart Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: Multipart -> Text #

toEncodedUrlPiece :: Multipart -> Builder #

toHeader :: Multipart -> ByteString #

toQueryParam :: Multipart -> Text #

toEncodedQueryParam :: Multipart -> Builder #

type Rep Multipart Source #

Instance details

Defined in Gogol.Types

type Rep Multipart = D1 ('MetaData "Multipart" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'False) (C1 ('MetaCons "Multipart" 'PrefixI 'False) (U1 :: Type -> Type))

newtype OAuthScope Source #

An OAuth2 scope.

Constructors

OAuthScope Text

Instances

Instances details

FromJSON OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

parseJSON :: Value -> Parser OAuthScope #

parseJSONList :: Value -> Parser [OAuthScope] #

omittedField :: Maybe OAuthScope #

ToJSON OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

toJSON :: OAuthScope -> Value #

toEncoding :: OAuthScope -> Encoding #

toJSONList :: [OAuthScope] -> Value #

toEncodingList :: [OAuthScope] -> Encoding #

omitField :: OAuthScope -> Bool #

IsString OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

fromString :: String -> OAuthScope #

Generic OAuthScope Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep OAuthScope
Instance details Defined in Gogol.Types type Rep OAuthScope = D1 ('MetaData "OAuthScope" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "OAuthScope" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: OAuthScope -> Rep OAuthScope x #

to :: Rep OAuthScope x -> OAuthScope #

Read OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS OAuthScope #

readList :: ReadS [OAuthScope] #

readPrec :: ReadPrec OAuthScope #

readListPrec :: ReadPrec [OAuthScope] #

Show OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> OAuthScope -> ShowS #

show :: OAuthScope -> String #

showList :: [OAuthScope] -> ShowS #

Eq OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

compare :: OAuthScope -> OAuthScope -> Ordering #

(<) :: OAuthScope -> OAuthScope -> Bool #

(<=) :: OAuthScope -> OAuthScope -> Bool #

(>) :: OAuthScope -> OAuthScope -> Bool #

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

max :: OAuthScope -> OAuthScope -> OAuthScope #

min :: OAuthScope -> OAuthScope -> OAuthScope #

FromHttpApiData OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

parseUrlPiece :: Text -> Either Text OAuthScope #

parseHeader :: ByteString -> Either Text OAuthScope #

parseQueryParam :: Text -> Either Text OAuthScope #

ToHttpApiData OAuthScope Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: OAuthScope -> Text #

toEncodedUrlPiece :: OAuthScope -> Builder #

toHeader :: OAuthScope -> ByteString #

toQueryParam :: OAuthScope -> Text #

toEncodedQueryParam :: OAuthScope -> Builder #

type Rep OAuthScope Source #

Instance details

Defined in Gogol.Types

type Rep OAuthScope = D1 ('MetaData "OAuthScope" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "OAuthScope" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype AccessToken Source #

An OAuth2 access token.

Constructors

AccessToken Text

Instances

Instances details

FromJSON AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

parseJSON :: Value -> Parser AccessToken #

parseJSONList :: Value -> Parser [AccessToken] #

omittedField :: Maybe AccessToken #

ToJSON AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

toJSON :: AccessToken -> Value #

toEncoding :: AccessToken -> Encoding #

toJSONList :: [AccessToken] -> Value #

toEncodingList :: [AccessToken] -> Encoding #

omitField :: AccessToken -> Bool #

IsString AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

fromString :: String -> AccessToken #

Generic AccessToken Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep AccessToken
Instance details Defined in Gogol.Types type Rep AccessToken = D1 ('MetaData "AccessToken" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "AccessToken" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: AccessToken -> Rep AccessToken x #

to :: Rep AccessToken x -> AccessToken #

Read AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS AccessToken #

readList :: ReadS [AccessToken] #

readPrec :: ReadPrec AccessToken #

readListPrec :: ReadPrec [AccessToken] #

Show AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> AccessToken -> ShowS #

show :: AccessToken -> String #

showList :: [AccessToken] -> ShowS #

Eq AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

compare :: AccessToken -> AccessToken -> Ordering #

(<) :: AccessToken -> AccessToken -> Bool #

(<=) :: AccessToken -> AccessToken -> Bool #

(>) :: AccessToken -> AccessToken -> Bool #

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

max :: AccessToken -> AccessToken -> AccessToken #

min :: AccessToken -> AccessToken -> AccessToken #

FromHttpApiData AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

parseUrlPiece :: Text -> Either Text AccessToken #

parseHeader :: ByteString -> Either Text AccessToken #

parseQueryParam :: Text -> Either Text AccessToken #

ToHttpApiData AccessToken Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: AccessToken -> Text #

toEncodedUrlPiece :: AccessToken -> Builder #

toHeader :: AccessToken -> ByteString #

toQueryParam :: AccessToken -> Text #

toEncodedQueryParam :: AccessToken -> Builder #

type Rep AccessToken Source #

Instance details

Defined in Gogol.Types

type Rep AccessToken = D1 ('MetaData "AccessToken" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "AccessToken" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype RefreshToken Source #

An OAuth2 refresh token.

Constructors

RefreshToken Text

Instances

Instances details

FromJSON RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

parseJSON :: Value -> Parser RefreshToken #

parseJSONList :: Value -> Parser [RefreshToken] #

omittedField :: Maybe RefreshToken #

ToJSON RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

toJSON :: RefreshToken -> Value #

toEncoding :: RefreshToken -> Encoding #

toJSONList :: [RefreshToken] -> Value #

toEncodingList :: [RefreshToken] -> Encoding #

omitField :: RefreshToken -> Bool #

IsString RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

fromString :: String -> RefreshToken #

Generic RefreshToken Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep RefreshToken
Instance details Defined in Gogol.Types type Rep RefreshToken = D1 ('MetaData "RefreshToken" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "RefreshToken" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: RefreshToken -> Rep RefreshToken x #

to :: Rep RefreshToken x -> RefreshToken #

Read RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS RefreshToken #

readList :: ReadS [RefreshToken] #

readPrec :: ReadPrec RefreshToken #

readListPrec :: ReadPrec [RefreshToken] #

Show RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> RefreshToken -> ShowS #

show :: RefreshToken -> String #

showList :: [RefreshToken] -> ShowS #

Eq RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

compare :: RefreshToken -> RefreshToken -> Ordering #

(<) :: RefreshToken -> RefreshToken -> Bool #

(<=) :: RefreshToken -> RefreshToken -> Bool #

(>) :: RefreshToken -> RefreshToken -> Bool #

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

max :: RefreshToken -> RefreshToken -> RefreshToken #

min :: RefreshToken -> RefreshToken -> RefreshToken #

FromHttpApiData RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

parseUrlPiece :: Text -> Either Text RefreshToken #

parseHeader :: ByteString -> Either Text RefreshToken #

parseQueryParam :: Text -> Either Text RefreshToken #

ToHttpApiData RefreshToken Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: RefreshToken -> Text #

toEncodedUrlPiece :: RefreshToken -> Builder #

toHeader :: RefreshToken -> ByteString #

toQueryParam :: RefreshToken -> Text #

toEncodedQueryParam :: RefreshToken -> Builder #

type Rep RefreshToken Source #

Instance details

Defined in Gogol.Types

type Rep RefreshToken = D1 ('MetaData "RefreshToken" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "RefreshToken" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype ClientId Source #

A client identifier.

Constructors

ClientId Text

Instances

Instances details

FromJSON ClientId Source #

Instance details

Defined in Gogol.Types

Methods

parseJSON :: Value -> Parser ClientId #

parseJSONList :: Value -> Parser [ClientId] #

omittedField :: Maybe ClientId #

ToJSON ClientId Source #

Instance details

Defined in Gogol.Types

Methods

toJSON :: ClientId -> Value #

toEncoding :: ClientId -> Encoding #

toJSONList :: [ClientId] -> Value #

toEncodingList :: [ClientId] -> Encoding #

omitField :: ClientId -> Bool #

IsString ClientId Source #

Instance details

Defined in Gogol.Types

Methods

fromString :: String -> ClientId #

Generic ClientId Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep ClientId
Instance details Defined in Gogol.Types type Rep ClientId = D1 ('MetaData "ClientId" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "ClientId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: ClientId -> Rep ClientId x #

to :: Rep ClientId x -> ClientId #

Read ClientId Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS ClientId #

readList :: ReadS [ClientId] #

readPrec :: ReadPrec ClientId #

readListPrec :: ReadPrec [ClientId] #

Show ClientId Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> ClientId -> ShowS #

show :: ClientId -> String #

showList :: [ClientId] -> ShowS #

Eq ClientId Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord ClientId Source #

Instance details

Defined in Gogol.Types

Methods

compare :: ClientId -> ClientId -> Ordering #

(<) :: ClientId -> ClientId -> Bool #

(<=) :: ClientId -> ClientId -> Bool #

(>) :: ClientId -> ClientId -> Bool #

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

max :: ClientId -> ClientId -> ClientId #

min :: ClientId -> ClientId -> ClientId #

FromHttpApiData ClientId Source #

Instance details

Defined in Gogol.Types

Methods

parseUrlPiece :: Text -> Either Text ClientId #

parseHeader :: ByteString -> Either Text ClientId #

parseQueryParam :: Text -> Either Text ClientId #

ToHttpApiData ClientId Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: ClientId -> Text #

toEncodedUrlPiece :: ClientId -> Builder #

toHeader :: ClientId -> ByteString #

toQueryParam :: ClientId -> Text #

toEncodedQueryParam :: ClientId -> Builder #

type Rep ClientId Source #

Instance details

Defined in Gogol.Types

type Rep ClientId = D1 ('MetaData "ClientId" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "ClientId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype ServiceId Source #

A service identifier.

Constructors

ServiceId Text

Instances

Instances details

FromJSON ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

parseJSON :: Value -> Parser ServiceId #

parseJSONList :: Value -> Parser [ServiceId] #

omittedField :: Maybe ServiceId #

ToJSON ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

toJSON :: ServiceId -> Value #

toEncoding :: ServiceId -> Encoding #

toJSONList :: [ServiceId] -> Value #

toEncodingList :: [ServiceId] -> Encoding #

omitField :: ServiceId -> Bool #

IsString ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

fromString :: String -> ServiceId #

Generic ServiceId Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep ServiceId
Instance details Defined in Gogol.Types type Rep ServiceId = D1 ('MetaData "ServiceId" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "ServiceId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: ServiceId -> Rep ServiceId x #

to :: Rep ServiceId x -> ServiceId #

Read ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS ServiceId #

readList :: ReadS [ServiceId] #

readPrec :: ReadPrec ServiceId #

readListPrec :: ReadPrec [ServiceId] #

Show ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> ServiceId -> ShowS #

show :: ServiceId -> String #

showList :: [ServiceId] -> ShowS #

Eq ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

compare :: ServiceId -> ServiceId -> Ordering #

(<) :: ServiceId -> ServiceId -> Bool #

(<=) :: ServiceId -> ServiceId -> Bool #

(>) :: ServiceId -> ServiceId -> Bool #

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

max :: ServiceId -> ServiceId -> ServiceId #

min :: ServiceId -> ServiceId -> ServiceId #

FromHttpApiData ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

parseUrlPiece :: Text -> Either Text ServiceId #

parseHeader :: ByteString -> Either Text ServiceId #

parseQueryParam :: Text -> Either Text ServiceId #

ToHttpApiData ServiceId Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: ServiceId -> Text #

toEncodedUrlPiece :: ServiceId -> Builder #

toHeader :: ServiceId -> ByteString #

toQueryParam :: ServiceId -> Text #

toEncodedQueryParam :: ServiceId -> Builder #

type Rep ServiceId Source #

Instance details

Defined in Gogol.Types

type Rep ServiceId = D1 ('MetaData "ServiceId" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "ServiceId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype GSecret Source #

An opaque client secret.

Constructors

GSecret Text

Instances

Instances details

FromJSON GSecret Source #

Instance details

Defined in Gogol.Types

Methods

parseJSON :: Value -> Parser GSecret #

parseJSONList :: Value -> Parser [GSecret] #

omittedField :: Maybe GSecret #

ToJSON GSecret Source #

Instance details

Defined in Gogol.Types

Methods

toJSON :: GSecret -> Value #

toEncoding :: GSecret -> Encoding #

toJSONList :: [GSecret] -> Value #

toEncodingList :: [GSecret] -> Encoding #

omitField :: GSecret -> Bool #

IsString GSecret Source #

Instance details

Defined in Gogol.Types

Methods

fromString :: String -> GSecret #

Generic GSecret Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep GSecret
Instance details Defined in Gogol.Types type Rep GSecret = D1 ('MetaData "GSecret" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "GSecret" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: GSecret -> Rep GSecret x #

to :: Rep GSecret x -> GSecret #

Read GSecret Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS GSecret #

readList :: ReadS [GSecret] #

readPrec :: ReadPrec GSecret #

readListPrec :: ReadPrec [GSecret] #

Show GSecret Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> GSecret -> ShowS #

show :: GSecret -> String #

showList :: [GSecret] -> ShowS #

Eq GSecret Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord GSecret Source #

Instance details

Defined in Gogol.Types

Methods

compare :: GSecret -> GSecret -> Ordering #

(<) :: GSecret -> GSecret -> Bool #

(<=) :: GSecret -> GSecret -> Bool #

(>) :: GSecret -> GSecret -> Bool #

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

max :: GSecret -> GSecret -> GSecret #

min :: GSecret -> GSecret -> GSecret #

FromHttpApiData GSecret Source #

Instance details

Defined in Gogol.Types

Methods

parseUrlPiece :: Text -> Either Text GSecret #

parseHeader :: ByteString -> Either Text GSecret #

parseQueryParam :: Text -> Either Text GSecret #

ToHttpApiData GSecret Source #

Instance details

Defined in Gogol.Types

Methods

toUrlPiece :: GSecret -> Text #

toEncodedUrlPiece :: GSecret -> Builder #

toHeader :: GSecret -> ByteString #

toQueryParam :: GSecret -> Text #

toEncodedQueryParam :: GSecret -> Builder #

type Rep GSecret Source #

Instance details

Defined in Gogol.Types

type Rep GSecret = D1 ('MetaData "GSecret" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "GSecret" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype MediaDownload a Source #

Constructors

MediaDownload a

data MediaUpload a Source #

Constructors

MediaUpload a GBody

_Coerce :: (Coercible a b, Coercible b a) => Iso' a b Source #

_Default :: Monoid a => Iso' (Maybe a) a Source #

Invalid Iso, exists for ease of composition with the current 'Lens . Iso' chaining to hide internal types from the user.

type Stream = ConduitM () ByteString (ResourceT IO) () Source #

data Error Source #

Constructors

TransportError HttpException
SerializeError SerializeError
ServiceError ServiceError

Instances

Instances details

Exception Error Source #
Instance details Defined in Gogol.Types Methods toException :: Error -> SomeException # fromException :: SomeException -> Maybe Error # displayException :: Error -> String #
Show Error Source #
Instance details Defined in Gogol.Types Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
AsError Error Source #
Instance details Defined in Gogol.Types Methods _Error :: Prism' Error Error Source # _TransportError :: Prism' Error HttpException Source # _SerializeError :: Prism' Error SerializeError Source # _ServiceError :: Prism' Error ServiceError Source #

data SerializeError Source #

Constructors

SerializeError'
Fields _serializeId :: !ServiceId _serializeHeaders :: [Header] _serializeStatus :: !Status _serializeMessage :: !String _serializeBody :: !(Maybe ByteString)

Instances

Instances details

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

data ServiceError Source #

Constructors

ServiceError'
Fields _serviceId :: !ServiceId _serviceStatus :: !Status _serviceHeaders :: ![Header] _serviceBody :: !(Maybe ByteString)

Instances

Instances details

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

class AsError a where Source #

Minimal complete definition

_Error

Methods

_Error :: Prism' a Error Source #

A general Amazonka error.

_TransportError :: Prism' a HttpException Source #

An error occured while communicating over HTTP with a remote service.

_SerializeError :: Prism' a SerializeError Source #

A serialisation error occured when attempting to deserialise a response.

_ServiceError :: Prism' a ServiceError Source #

A service specific error returned by the remote service.

Instances

Instances details

AsError SomeException Source #
Instance details Defined in Gogol.Types Methods _Error :: Prism' SomeException Error Source # _TransportError :: Prism' SomeException HttpException Source # _SerializeError :: Prism' SomeException SerializeError Source # _ServiceError :: Prism' SomeException ServiceError Source #
AsError Error Source #
Instance details Defined in Gogol.Types Methods _Error :: Prism' Error Error Source # _TransportError :: Prism' Error HttpException Source # _SerializeError :: Prism' Error SerializeError Source # _ServiceError :: Prism' Error ServiceError Source #

data ServiceConfig Source #

Constructors

ServiceConfig
Fields _svcId :: !ServiceId _svcHost :: !ByteString _svcPath :: !Builder _svcPort :: !Int _svcSecure :: !Bool _svcTimeout :: !(Maybe Seconds)

defaultService :: ServiceId -> ByteString -> ServiceConfig Source #

serviceHost :: Lens' ServiceConfig ByteString Source #

The remote host name, used for both the IP address to connect to and the host request header.

servicePort :: Lens' ServiceConfig Int Source #

The remote port to connect to.

Defaults to 443.

servicePath :: Lens' ServiceConfig Builder Source #

A path prefix that is prepended to any sent HTTP request.

Defaults to mempty.

serviceSecure :: Lens' ServiceConfig Bool Source #

Whether to use HTTPS/SSL.

Defaults to True.

serviceTimeout :: Lens' ServiceConfig (Maybe Seconds) Source #

Number of seconds to wait for a response.

data GBody Source #

A single part of a (potentially multipart) request body.

Note: The IsString instance defaults to a text/plain MIME type.

Constructors

GBody !MediaType !RequestBody

Instances

Instances details

IsString GBody Source #
Instance details Defined in Gogol.Types Methods fromString :: String -> GBody #

bodyContentType :: Lens' GBody MediaType Source #

A lens into the MediaType of a request Body.

data Request Source #

An intermediary request builder.

Constructors

Request
Fields _rqPath :: !Builder _rqQuery :: !(DList (ByteString, Maybe ByteString)) _rqHeaders :: !(DList (HeaderName, ByteString)) _rqBody :: ![GBody]

Instances

Instances details

Monoid Request Source #
Instance details Defined in Gogol.Types Methods mempty :: Request # mappend :: Request -> Request -> Request # mconcat :: [Request] -> Request #
Semigroup Request Source #
Instance details Defined in Gogol.Types Methods (<>) :: Request -> Request -> Request # sconcat :: NonEmpty Request -> Request # stimes :: Integral b => b -> Request -> Request #

appendPath :: Request -> Builder -> Request Source #

appendPaths :: ToHttpApiData a => Request -> [a] -> Request Source #

appendQuery :: Request -> ByteString -> Maybe Text -> Request Source #

appendHeader :: Request -> HeaderName -> Maybe Text -> Request Source #

setBody :: Request -> [GBody] -> Request Source #

data GClient a Source #

A materialised 'http-client' request and associated response parser.

Constructors

GClient
Fields _cliAccept :: !(Maybe MediaType) _cliMethod :: !Method _cliCheck :: !(Status -> Bool) _cliService :: !ServiceConfig _cliRequest :: !Request _cliResponse :: !(Stream -> ResourceT IO (Either (String, ByteString) a))

clientService :: forall a f. Functor f => (ServiceConfig -> f ServiceConfig) -> GClient a -> f (GClient a) Source #

mime :: forall {k} (c :: k) a. FromStream c a => Proxy c -> Method -> [Int] -> Request -> ServiceConfig -> GClient a Source #

discard :: Method -> [Int] -> Request -> ServiceConfig -> GClient () Source #

gClient :: (Stream -> ResourceT IO (Either (String, ByteString) a)) -> Maybe MediaType -> Method -> [Int] -> Request -> ServiceConfig -> GClient a Source #

class Accept c => ToBody (c :: k) a where Source #

Methods

toBody :: Proxy c -> a -> GBody Source #

Instances

Instances details

ToJSON a => ToBody JSON a Source #
Instance details Defined in Gogol.Types Methods toBody :: Proxy JSON -> a -> GBody Source #
ToBody OctetStream ByteString Source #
Instance details Defined in Gogol.Types Methods toBody :: Proxy OctetStream -> ByteString -> GBody Source #
ToBody OctetStream ByteString Source #
Instance details Defined in Gogol.Types Methods toBody :: Proxy OctetStream -> ByteString -> GBody Source #
ToBody PlainText ByteString Source #
Instance details Defined in Gogol.Types Methods toBody :: Proxy PlainText -> ByteString -> GBody Source #
ToBody PlainText ByteString Source #
Instance details Defined in Gogol.Types Methods toBody :: Proxy PlainText -> ByteString -> GBody Source #

class Accept c => FromStream (c :: k) a where Source #

Methods

fromStream :: Proxy c -> Stream -> ResourceT IO (Either (String, ByteString) a) Source #

Instances

Instances details

FromJSON a => FromStream JSON a Source #
Instance details Defined in Gogol.Types Methods fromStream :: Proxy JSON -> Stream -> ResourceT IO (Either (String, ByteString) a) Source #
FromStream OctetStream Stream Source #
Instance details Defined in Gogol.Types Methods fromStream :: Proxy OctetStream -> Stream -> ResourceT IO (Either (String, ByteString) Stream) Source #

class GoogleRequest a where Source #

Associated Types

type Rs a Source #

type Scopes a :: [Symbol] Source #

Methods

requestClient :: a -> GClient (Rs a) Source #

class GoogleClient (fn :: k) where Source #

Associated Types

type Fn (fn :: k) Source #

Methods

buildClient :: Proxy fn -> Request -> Fn fn Source #

Instances

Instances details

(GoogleClient a, GoogleClient b) => GoogleClient (a :<|> b :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (a :<\|> b :: Type)
Instance details Defined in Gogol.Types type Fn (a :<\|> b :: Type) = Fn a :<\|> Fn b

Methods

buildClient :: Proxy (a :<|> b) -> Request -> Fn (a :<|> b) Source #

GoogleClient (Delete (c ': cs) () :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Delete (c ': cs) () :: Type)
Instance details Defined in Gogol.Types type Fn (Delete (c ': cs) () :: Type) = ServiceConfig -> GClient ()
type Fn (Delete (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Delete (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Delete (c ': cs) ()) -> Request -> Fn (Delete (c ': cs) ()) Source #

FromStream c a => GoogleClient (Delete (c ': cs) a :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Delete (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Delete (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Delete (c ': cs) a) -> Request -> Fn (Delete (c ': cs) a) Source #

GoogleClient (Get (c ': cs) () :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Get (c ': cs) () :: Type)
Instance details Defined in Gogol.Types type Fn (Get (c ': cs) () :: Type) = ServiceConfig -> GClient ()
type Fn (Get (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Get (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Get (c ': cs) ()) -> Request -> Fn (Get (c ': cs) ()) Source #

FromStream c a => GoogleClient (Get (c ': cs) a :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Get (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Get (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Get (c ': cs) a) -> Request -> Fn (Get (c ': cs) a) Source #

GoogleClient (Patch (c ': cs) () :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Patch (c ': cs) () :: Type)
Instance details Defined in Gogol.Types type Fn (Patch (c ': cs) () :: Type) = ServiceConfig -> GClient ()
type Fn (Patch (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Patch (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Patch (c ': cs) ()) -> Request -> Fn (Patch (c ': cs) ()) Source #

FromStream c a => GoogleClient (Patch (c ': cs) a :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Patch (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Patch (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Patch (c ': cs) a) -> Request -> Fn (Patch (c ': cs) a) Source #

GoogleClient (Post cs () :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Post cs () :: Type)
Instance details Defined in Gogol.Types type Fn (Post cs () :: Type) = ServiceConfig -> GClient ()
type Fn (Post cs' a :: Type)
Instance details Defined in Gogol.Types type Fn (Post cs' a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Post cs ()) -> Request -> Fn (Post cs ()) Source #

(FromStream c a, cs' ~ (c ': cs)) => GoogleClient (Post cs' a :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Post cs' a :: Type)
Instance details Defined in Gogol.Types type Fn (Post cs' a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Post cs' a) -> Request -> Fn (Post cs' a) Source #

GoogleClient (Put (c ': cs) () :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Put (c ': cs) () :: Type)
Instance details Defined in Gogol.Types type Fn (Put (c ': cs) () :: Type) = ServiceConfig -> GClient ()
type Fn (Put (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Put (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Put (c ': cs) ()) -> Request -> Fn (Put (c ': cs) ()) Source #

FromStream c a => GoogleClient (Put (c ': cs) a :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Put (c ': cs) a :: Type)
Instance details Defined in Gogol.Types type Fn (Put (c ': cs) a :: Type) = ServiceConfig -> GClient a

Methods

buildClient :: Proxy (Put (c ': cs) a) -> Request -> Fn (Put (c ': cs) a) Source #

(KnownSymbol s, GoogleClient fn) => GoogleClient (s :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (s :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (s :> fn :: Type) = Fn fn

Methods

buildClient :: Proxy (s :> fn) -> Request -> Fn (s :> fn) Source #

GoogleClient fn => GoogleClient (AltMedia :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (AltMedia :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (AltMedia :> fn :: Type) = GBody -> Fn fn

Methods

buildClient :: Proxy (AltMedia :> fn) -> Request -> Fn (AltMedia :> fn) Source #

(KnownSymbol s, KnownSymbol m, ToHttpApiData a, GoogleClient fn) => GoogleClient (CaptureMode s m a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (CaptureMode s m a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (CaptureMode s m a :> fn :: Type) = a -> Fn fn

Methods

buildClient :: Proxy (CaptureMode s m a :> fn) -> Request -> Fn (CaptureMode s m a :> fn) Source #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient (Captures s a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Captures s a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (Captures s a :> fn :: Type) = [a] -> Fn fn

Methods

buildClient :: Proxy (Captures s a :> fn) -> Request -> Fn (Captures s a :> fn) Source #

(ToBody c m, GoogleClient fn) => GoogleClient (MultipartRelated (c ': cs) m :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (MultipartRelated (c ': cs) m :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (MultipartRelated (c ': cs) m :> fn :: Type) = m -> GBody -> Fn fn

Methods

buildClient :: Proxy (MultipartRelated (c ': cs) m :> fn) -> Request -> Fn (MultipartRelated (c ': cs) m :> fn) Source #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient (Capture s a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Capture s a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (Capture s a :> fn :: Type) = a -> Fn fn

Methods

buildClient :: Proxy (Capture s a :> fn) -> Request -> Fn (Capture s a :> fn) Source #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient (Header s a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Header s a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (Header s a :> fn :: Type) = Maybe a -> Fn fn

Methods

buildClient :: Proxy (Header s a :> fn) -> Request -> Fn (Header s a :> fn) Source #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient (QueryParam s a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (QueryParam s a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (QueryParam s a :> fn :: Type) = Maybe a -> Fn fn

Methods

buildClient :: Proxy (QueryParam s a :> fn) -> Request -> Fn (QueryParam s a :> fn) Source #

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient (QueryParams s a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (QueryParams s a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (QueryParams s a :> fn :: Type) = [a] -> Fn fn

Methods

buildClient :: Proxy (QueryParams s a :> fn) -> Request -> Fn (QueryParams s a :> fn) Source #

(ToBody c a, GoogleClient fn) => GoogleClient (ReqBody (c ': cs) a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (ReqBody (c ': cs) a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (ReqBody (c ': cs) a :> fn :: Type) = a -> Fn fn

Methods

buildClient :: Proxy (ReqBody (c ': cs) a :> fn) -> Request -> Fn (ReqBody (c ': cs) a :> fn) Source #

data Captures (s :: Symbol) (a :: k) Source #

Multiple path captures, with [xs] forming x1x2x2....

Instances

Instances details

(KnownSymbol s, ToHttpApiData a, GoogleClient fn) => GoogleClient (Captures s a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (Captures s a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (Captures s a :> fn :: Type) = [a] -> Fn fn

Methods

buildClient :: Proxy (Captures s a :> fn) -> Request -> Fn (Captures s a :> fn) Source #

type Fn (Captures s a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

type Fn (Captures s a :> fn :: Type) = [a] -> Fn fn

data CaptureMode (s :: Symbol) (m :: Symbol) (a :: k) Source #

Form a Google style sub-resource, such as /capture:mode.

Instances

Instances details

(KnownSymbol s, KnownSymbol m, ToHttpApiData a, GoogleClient fn) => GoogleClient (CaptureMode s m a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (CaptureMode s m a :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (CaptureMode s m a :> fn :: Type) = a -> Fn fn

Methods

buildClient :: Proxy (CaptureMode s m a :> fn) -> Request -> Fn (CaptureMode s m a :> fn) Source #

type Fn (CaptureMode s m a :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

type Fn (CaptureMode s m a :> fn :: Type) = a -> Fn fn

data MultipartRelated (cs :: [Type]) (m :: k) Source #

Instances

Instances details

(ToBody c m, GoogleClient fn) => GoogleClient (MultipartRelated (c ': cs) m :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

Associated Types

type Fn (MultipartRelated (c ': cs) m :> fn :: Type)
Instance details Defined in Gogol.Types type Fn (MultipartRelated (c ': cs) m :> fn :: Type) = m -> GBody -> Fn fn

Methods

buildClient :: Proxy (MultipartRelated (c ': cs) m :> fn) -> Request -> Fn (MultipartRelated (c ': cs) m :> fn) Source #

type Fn (MultipartRelated (c ': cs) m :> fn :: Type) Source #

Instance details

Defined in Gogol.Types

type Fn (MultipartRelated (c ': cs) m :> fn :: Type) = m -> GBody -> Fn fn

sinkLBS :: Stream -> ResourceT IO ByteString Source #

buildText :: ToHttpApiData a => a -> Builder Source #

buildSymbol :: forall (n :: Symbol) proxy. KnownSymbol n => proxy n -> Builder Source #

byteSymbol :: forall (n :: Symbol) proxy. KnownSymbol n => proxy n -> ByteString Source #

newtype Seconds Source #

An integral value representing seconds.

Constructors

Seconds Int

Instances

Instances details

Bounded Seconds Source #

Instance details

Defined in Gogol.Types

Methods

minBound :: Seconds #

maxBound :: Seconds #

Enum Seconds Source #

Instance details

Defined in Gogol.Types

Methods

succ :: Seconds -> Seconds #

pred :: Seconds -> Seconds #

toEnum :: Int -> Seconds #

fromEnum :: Seconds -> Int #

enumFrom :: Seconds -> [Seconds] #

enumFromThen :: Seconds -> Seconds -> [Seconds] #

enumFromTo :: Seconds -> Seconds -> [Seconds] #

enumFromThenTo :: Seconds -> Seconds -> Seconds -> [Seconds] #

Generic Seconds Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep Seconds
Instance details Defined in Gogol.Types type Rep Seconds = D1 ('MetaData "Seconds" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "Seconds" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: Seconds -> Rep Seconds x #

to :: Rep Seconds x -> Seconds #

Num Seconds Source #

Instance details

Defined in Gogol.Types

Methods

(+) :: Seconds -> Seconds -> Seconds #

(-) :: Seconds -> Seconds -> Seconds #

(*) :: Seconds -> Seconds -> Seconds #

negate :: Seconds -> Seconds #

abs :: Seconds -> Seconds #

signum :: Seconds -> Seconds #

fromInteger :: Integer -> Seconds #

Read Seconds Source #

Instance details

Defined in Gogol.Types

Methods

readsPrec :: Int -> ReadS Seconds #

readList :: ReadS [Seconds] #

readPrec :: ReadPrec Seconds #

readListPrec :: ReadPrec [Seconds] #

Integral Seconds Source #

Instance details

Defined in Gogol.Types

Methods

quot :: Seconds -> Seconds -> Seconds #

rem :: Seconds -> Seconds -> Seconds #

div :: Seconds -> Seconds -> Seconds #

mod :: Seconds -> Seconds -> Seconds #

quotRem :: Seconds -> Seconds -> (Seconds, Seconds) #

divMod :: Seconds -> Seconds -> (Seconds, Seconds) #

toInteger :: Seconds -> Integer #

Real Seconds Source #

Instance details

Defined in Gogol.Types

Methods

toRational :: Seconds -> Rational #

Show Seconds Source #

Instance details

Defined in Gogol.Types

Methods

showsPrec :: Int -> Seconds -> ShowS #

show :: Seconds -> String #

showList :: [Seconds] -> ShowS #

Eq Seconds Source #

Instance details

Defined in Gogol.Types

Methods

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

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

Ord Seconds Source #

Instance details

Defined in Gogol.Types

Methods

compare :: Seconds -> Seconds -> Ordering #

(<) :: Seconds -> Seconds -> Bool #

(<=) :: Seconds -> Seconds -> Bool #

(>) :: Seconds -> Seconds -> Bool #

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

max :: Seconds -> Seconds -> Seconds #

min :: Seconds -> Seconds -> Seconds #

type Rep Seconds Source #

Instance details

Defined in Gogol.Types

type Rep Seconds = D1 ('MetaData "Seconds" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "Seconds" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

seconds :: Seconds -> Int Source #

microseconds :: Seconds -> Int Source #

newtype FieldMask Source #

Constructors

FieldMask
Fields fromFieldMask :: Text

Instances

Instances details

FromJSON FieldMask Source #

Instance details

Defined in Gogol.Types

Methods

parseJSON :: Value -> Parser FieldMask #

parseJSONList :: Value -> Parser [FieldMask] #

omittedField :: Maybe FieldMask #

ToJSON FieldMask Source #

Instance details

Defined in Gogol.Types

Methods

toJSON :: FieldMask -> Value #

toEncoding :: FieldMask -> Encoding #

toJSONList :: [FieldMask] -> Value #

toEncodingList :: [FieldMask] -> Encoding #

omitField :: FieldMask -> Bool #

IsString FieldMask Source #

Instance details

Defined in Gogol.Types

Methods

fromString :: String -> FieldMask #

Generic FieldMask Source #

Instance details

Defined in Gogol.Types

Associated Types

type Rep FieldMask
Instance details Defined in Gogol.Types type Rep FieldMask = D1 ('MetaData "FieldMask" "Gogol.Types" "gogol-core-1.0.0.0-6X37EOsTod1GwsjdWl3qQA" 'True) (C1 ('MetaCons "FieldMask" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFieldMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))