integration-0.1.0

Safe Haskell	None
Language	GHC2021

API.Cargohold

Synopsis

type LByteString = ByteString
uploadAsset :: (HasCallStack, MakesValue user) => user -> String -> App Response
uploadRaw :: (HasCallStack, MakesValue user) => user -> ByteString -> App Response
uploadAssetV3 :: (HasCallStack, MakesValue user, MakesValue assetRetention) => user -> Bool -> assetRetention -> MIMEType -> LByteString -> App Response
uploadRawV3 :: (HasCallStack, MakesValue user) => user -> ByteString -> App Response
uploadProviderAsset :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response
downloadAsset' :: (HasCallStack, MakesValue user, IsAssetLocation loc, IsAssetToken tok) => user -> loc -> tok -> App Response
downloadAsset :: (HasCallStack, MakesValue user, MakesValue key, MakesValue assetDomain) => user -> assetDomain -> key -> String -> (Request -> Request) -> App Response
downloadAssetWithQualifiedAssetKey :: (HasCallStack, IsAssetToken tok, MakesValue key, MakesValue user) => (Request -> Request) -> user -> key -> tok -> App Response
deleteAssetV3 :: (HasCallStack, MakesValue user, MakesValue key) => user -> key -> App Response
deleteAsset :: (HasCallStack, MakesValue user, MakesValue key) => user -> key -> App Response
postToken :: (MakesValue user, HasCallStack) => user -> String -> App Response
deleteToken :: (MakesValue user, HasCallStack) => user -> String -> App Response
getFederationAsset :: (HasCallStack, MakesValue asset) => asset -> App Response
uploadSomeAsset :: (HasCallStack, MakesValue user) => user -> App Response
txtAsset :: HasCallStack => String -> App RequestBody
textPlainMime :: MIMEType
multipartMixedMime :: String
buildUploadAssetRequestBody :: (HasCallStack, MakesValue assetRetention) => Bool -> assetRetention -> LByteString -> MIMEType -> App RequestBody
class IsAssetLocation key where
- locationPathFragment :: key -> App String
noRedirect :: Request -> Request
uploadSimpleV3 :: (HasCallStack, MakesValue user, MakesValue settings) => user -> settings -> (MIMEType, ByteString) -> App Response
uploadSimple :: (HasCallStack, MakesValue user, MakesValue settings) => user -> settings -> (MIMEType, ByteString) -> App Response
decodeHeaderOrFail :: (HasCallStack, FromByteString a) => HeaderName -> Response -> a
getHeader' :: HeaderName -> Response -> ByteString
getHeader :: HeaderName -> Response -> Maybe ByteString
getContentType :: Response -> Maybe Type
applicationText :: MIMEType
applicationOctetStream :: MIMEType
applicationOctetStream' :: Type
header :: String -> String -> Request -> Request
class IsAssetToken tok where
- tokenParam :: tok -> Request -> Request
buildMultipartBody :: (HasCallStack, MakesValue header) => header -> ByteString -> MIMEType -> App ByteString
multipartBoundary :: String
buildMultipartBody' :: Value -> Type -> ByteString -> Builder
beginMultipartBody :: Value -> Type -> Word -> Builder
endMultipartBody' :: Builder

Documentation

type LByteString = ByteString Source #

uploadAsset :: (HasCallStack, MakesValue user) => user -> String -> App Response Source #

uploadRaw :: (HasCallStack, MakesValue user) => user -> ByteString -> App Response Source #

uploadAssetV3 :: (HasCallStack, MakesValue user, MakesValue assetRetention) => user -> Bool -> assetRetention -> MIMEType -> LByteString -> App Response Source #

uploadRawV3 :: (HasCallStack, MakesValue user) => user -> ByteString -> App Response Source #

uploadProviderAsset :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response Source #

downloadAsset' :: (HasCallStack, MakesValue user, IsAssetLocation loc, IsAssetToken tok) => user -> loc -> tok -> App Response Source #

downloadAsset :: (HasCallStack, MakesValue user, MakesValue key, MakesValue assetDomain) => user -> assetDomain -> key -> String -> (Request -> Request) -> App Response Source #

downloadAssetWithQualifiedAssetKey :: (HasCallStack, IsAssetToken tok, MakesValue key, MakesValue user) => (Request -> Request) -> user -> key -> tok -> App Response Source #

deleteAssetV3 :: (HasCallStack, MakesValue user, MakesValue key) => user -> key -> App Response Source #

deleteAsset :: (HasCallStack, MakesValue user, MakesValue key) => user -> key -> App Response Source #

postToken :: (MakesValue user, HasCallStack) => user -> String -> App Response Source #

deleteToken :: (MakesValue user, HasCallStack) => user -> String -> App Response Source #

getFederationAsset :: (HasCallStack, MakesValue asset) => asset -> App Response Source #

uploadSomeAsset :: (HasCallStack, MakesValue user) => user -> App Response Source #

txtAsset :: HasCallStack => String -> App RequestBody Source #

textPlainMime :: MIMEType Source #

multipartMixedMime :: String Source #

buildUploadAssetRequestBody :: (HasCallStack, MakesValue assetRetention) => Bool -> assetRetention -> LByteString -> MIMEType -> App RequestBody Source #

class IsAssetLocation key where Source #

Methods

locationPathFragment :: key -> App String Source #

Instances

Instances details

IsAssetLocation String Source #
Instance details Defined in API.Cargohold Methods locationPathFragment :: String -> App String Source #
MakesValue loc => IsAssetLocation loc Source #
Instance details Defined in API.Cargohold Methods locationPathFragment :: loc -> App String Source #

noRedirect :: Request -> Request Source #

uploadSimpleV3 :: (HasCallStack, MakesValue user, MakesValue settings) => user -> settings -> (MIMEType, ByteString) -> App Response Source #

uploadSimple :: (HasCallStack, MakesValue user, MakesValue settings) => user -> settings -> (MIMEType, ByteString) -> App Response Source #

decodeHeaderOrFail :: (HasCallStack, FromByteString a) => HeaderName -> Response -> a Source #

getHeader' :: HeaderName -> Response -> ByteString Source #

Like getHeader, but if no value exists for the given key, return the static ByteString NO_HEADER_VALUE.

getHeader :: HeaderName -> Response -> Maybe ByteString Source #

getContentType :: Response -> Maybe Type Source #

applicationText :: MIMEType Source #

applicationOctetStream :: MIMEType Source #

applicationOctetStream' :: Type Source #

header :: String -> String -> Request -> Request Source #

class IsAssetToken tok where Source #

Methods

tokenParam :: tok -> Request -> Request Source #

Instances

Instances details

IsAssetToken Value Source #
Instance details Defined in API.Cargohold Methods tokenParam :: Value -> Request -> Request Source #
IsAssetToken String Source #
Instance details Defined in API.Cargohold Methods tokenParam :: String -> Request -> Request Source #
IsAssetToken () Source #
Instance details Defined in API.Cargohold Methods tokenParam :: () -> Request -> Request Source #
(IsAssetToken a, IsAssetToken b) => IsAssetToken (Either a b) Source #
Instance details Defined in API.Cargohold Methods tokenParam :: Either a b -> Request -> Request Source #
IsAssetToken (Request -> Request) Source #
Instance details Defined in API.Cargohold Methods tokenParam :: (Request -> Request) -> Request -> Request Source #

buildMultipartBody :: (HasCallStack, MakesValue header) => header -> ByteString -> MIMEType -> App ByteString Source #

Build a complete multipart/mixed request body for a one-shot, non-resumable asset upload.

multipartBoundary :: String Source #

buildMultipartBody' :: Value -> Type -> ByteString -> Builder Source #

beginMultipartBody :: Value -> Type -> Word -> Builder Source #

Begin building a multipart/mixed request body for a non-resumable upload. The returned Builder can be immediately followed by the actual asset bytes.

endMultipartBody' :: Builder Source #

The trailer of a non-resumable multipart/mixed request body initiated via beginMultipartBody.