wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.Asset

Synopsis

Asset

type Asset = Asset' (Qualified AssetKey) Source #

data Asset' key Source #

A newly uploaded asset.

Instances

Instances details
Functor Asset' Source # 
Instance details

Defined in Wire.API.Asset

Methods

fmap :: (a -> b) -> Asset' a -> Asset' b #

(<$) :: a -> Asset' b -> Asset' a #

ToSchema Asset Source # 
Instance details

Defined in Wire.API.Asset

Methods

schema :: ValueSchema NamedSwaggerDoc Asset Source #

Arbitrary key => Arbitrary (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

Methods

arbitrary :: Gen (Asset' key) Source #

shrink :: Asset' key -> [Asset' key] Source #

ToSchema (Asset' key) => FromJSON (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseJSON :: Value -> Parser (Asset' key) Source #

parseJSONList :: Value -> Parser [Asset' key] Source #

ToSchema (Asset' key) => ToJSON (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

Methods

toJSON :: Asset' key -> Value Source #

toEncoding :: Asset' key -> Encoding Source #

toJSONList :: [Asset' key] -> Value Source #

toEncodingList :: [Asset' key] -> Encoding Source #

Generic (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

Associated Types

type Rep (Asset' key) :: Type -> Type #

Methods

from :: Asset' key -> Rep (Asset' key) x #

to :: Rep (Asset' key) x -> Asset' key #

Show key => Show (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

Methods

showsPrec :: Int -> Asset' key -> ShowS #

show :: Asset' key -> String #

showList :: [Asset' key] -> ShowS #

Eq key => Eq (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

Methods

(==) :: Asset' key -> Asset' key -> Bool #

(/=) :: Asset' key -> Asset' key -> Bool #

(Typeable key, ToSchema (Asset' key)) => ToSchema (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

Methods

declareNamedSchema :: Proxy (Asset' key) -> Declare (Definitions Schema) NamedSchema Source #

type Rep (Asset' key) Source # 
Instance details

Defined in Wire.API.Asset

type Rep (Asset' key) = D1 ('MetaData "Asset'" "Wire.API.Asset" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "Asset" 'PrefixI 'True) (S1 ('MetaSel ('Just "_assetKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 key) :*: (S1 ('MetaSel ('Just "_assetExpires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :*: S1 ('MetaSel ('Just "_assetToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssetToken)))))

mkAsset :: key -> Asset' key Source #

assetKey :: forall key key. Lens (Asset' key) (Asset' key) key key Source #

assetExpires :: forall key. Lens' (Asset' key) (Maybe UTCTime) Source #

assetToken :: forall key. Lens' (Asset' key) (Maybe AssetToken) Source #

AssetKey

data AssetKey Source #

A unique, versioned asset identifier. Note: Can be turned into a sum type with additional constructors for future versions.

Constructors

AssetKeyV3 AssetId AssetRetention 

Instances

Instances details
Arbitrary AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

arbitrary :: Gen AssetKey Source #

shrink :: AssetKey -> [AssetKey] Source #

FromJSON AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseJSON :: Value -> Parser AssetKey Source #

parseJSONList :: Value -> Parser [AssetKey] Source #

ToJSON AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

toJSON :: AssetKey -> Value Source #

toEncoding :: AssetKey -> Encoding Source #

toJSONList :: [AssetKey] -> Value Source #

toEncodingList :: [AssetKey] -> Encoding Source #

Generic AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Associated Types

type Rep AssetKey :: Type -> Type #

Methods

from :: AssetKey -> Rep AssetKey x #

to :: Rep AssetKey x -> AssetKey #

Show AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

showsPrec :: Int -> AssetKey -> ShowS #

show :: AssetKey -> String #

showList :: [AssetKey] -> ShowS #

FromByteString AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

parser :: Parser AssetKey Source #

ToByteString AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

builder :: AssetKey -> Builder Source #

Cql AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

ctype :: Tagged AssetKey ColumnType Source #

toCql :: AssetKey -> Value Source #

fromCql :: Value -> Either String AssetKey Source #

Eq AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

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

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

Ord AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

compare :: AssetKey -> AssetKey -> Ordering #

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

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

(>) :: AssetKey -> AssetKey -> Bool #

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

max :: AssetKey -> AssetKey -> AssetKey #

min :: AssetKey -> AssetKey -> AssetKey #

FromHttpApiData AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseUrlPiece :: Text -> Either Text AssetKey Source #

parseHeader :: ByteString -> Either Text AssetKey Source #

parseQueryParam :: Text -> Either Text AssetKey Source #

ToParamSchema AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

toParamSchema :: Proxy AssetKey -> Schema Source #

ToSchema AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

declareNamedSchema :: Proxy AssetKey -> Declare (Definitions Schema) NamedSchema Source #

ToSchema Asset Source # 
Instance details

Defined in Wire.API.Asset

Methods

schema :: ValueSchema NamedSwaggerDoc Asset Source #

ToSchema AssetKey Source # 
Instance details

Defined in Wire.API.Asset

Methods

schema :: ValueSchema NamedSwaggerDoc AssetKey Source #

type Rep AssetKey Source # 
Instance details

Defined in Wire.API.Asset

type Rep AssetKey = D1 ('MetaData "AssetKey" "Wire.API.Asset" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "AssetKeyV3" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssetId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssetRetention)))

assetKeyToText :: AssetKey -> Text Source #

AssetToken

newtype AssetToken Source #

Asset tokens are bearer tokens that grant access to a single asset.

Constructors

AssetToken 

Fields

Instances

Instances details
Arbitrary AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

arbitrary :: Gen AssetToken Source #

shrink :: AssetToken -> [AssetToken] Source #

FromJSON AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseJSON :: Value -> Parser AssetToken Source #

parseJSONList :: Value -> Parser [AssetToken] Source #

ToJSON AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

toJSON :: AssetToken -> Value Source #

toEncoding :: AssetToken -> Encoding Source #

toJSONList :: [AssetToken] -> Value Source #

toEncodingList :: [AssetToken] -> Encoding Source #

Show AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

showsPrec :: Int -> AssetToken -> ShowS #

show :: AssetToken -> String #

showList :: [AssetToken] -> ShowS #

FromByteString AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

parser :: Parser AssetToken Source #

ToByteString AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

builder :: AssetToken -> Builder Source #

Eq AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

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

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

FromHttpApiData AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseUrlPiece :: Text -> Either Text AssetToken Source #

parseHeader :: ByteString -> Either Text AssetToken Source #

parseQueryParam :: Text -> Either Text AssetToken Source #

ToParamSchema AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

toParamSchema :: Proxy AssetToken -> Schema Source #

ToSchema AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

declareNamedSchema :: Proxy AssetToken -> Declare (Definitions Schema) NamedSchema Source #

ToSchema AssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

schema :: ValueSchema NamedSwaggerDoc AssetToken Source #

newtype NewAssetToken Source #

A newly (re)generated token for an existing asset.

Constructors

NewAssetToken 

Fields

Instances

Instances details
Arbitrary NewAssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

arbitrary :: Gen NewAssetToken Source #

shrink :: NewAssetToken -> [NewAssetToken] Source #

FromJSON NewAssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseJSON :: Value -> Parser NewAssetToken Source #

parseJSONList :: Value -> Parser [NewAssetToken] Source #

ToJSON NewAssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

toJSON :: NewAssetToken -> Value Source #

toEncoding :: NewAssetToken -> Encoding Source #

toJSONList :: [NewAssetToken] -> Value Source #

toEncodingList :: [NewAssetToken] -> Encoding Source #

Show NewAssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

showsPrec :: Int -> NewAssetToken -> ShowS #

show :: NewAssetToken -> String #

showList :: [NewAssetToken] -> ShowS #

Eq NewAssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

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

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

ToSchema NewAssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

declareNamedSchema :: Proxy NewAssetToken -> Declare (Definitions Schema) NamedSchema Source #

ToSchema NewAssetToken Source # 
Instance details

Defined in Wire.API.Asset

Methods

schema :: ValueSchema NamedSwaggerDoc NewAssetToken Source #

Body Construction

buildMultipartBody :: AssetSettings -> Type -> LByteString -> Builder Source #

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

beginMultipartBody :: AssetSettings -> AssetHeaders -> 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.

AssetHeaders

data AssetHeaders Source #

Headers provided during upload.

Constructors

AssetHeaders 

Fields

mkHeaders :: Type -> LByteString -> AssetHeaders Source #

AssetSettings

data AssetSettings Source #

Settings provided during upload.

Instances

Instances details
Arbitrary AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Methods

arbitrary :: Gen AssetSettings Source #

shrink :: AssetSettings -> [AssetSettings] Source #

FromJSON AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseJSON :: Value -> Parser AssetSettings Source #

parseJSONList :: Value -> Parser [AssetSettings] Source #

ToJSON AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Methods

toJSON :: AssetSettings -> Value Source #

toEncoding :: AssetSettings -> Encoding Source #

toJSONList :: [AssetSettings] -> Value Source #

toEncodingList :: [AssetSettings] -> Encoding Source #

Generic AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Associated Types

type Rep AssetSettings :: Type -> Type #

Methods

from :: AssetSettings -> Rep AssetSettings x #

to :: Rep AssetSettings x -> AssetSettings #

Show AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Methods

showsPrec :: Int -> AssetSettings -> ShowS #

show :: AssetSettings -> String #

showList :: [AssetSettings] -> ShowS #

Eq AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Methods

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

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

ToSchema AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Methods

declareNamedSchema :: Proxy AssetSettings -> Declare (Definitions Schema) NamedSchema Source #

ToSchema AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

Methods

schema :: ValueSchema NamedSwaggerDoc AssetSettings Source #

type Rep AssetSettings Source # 
Instance details

Defined in Wire.API.Asset

type Rep AssetSettings = D1 ('MetaData "AssetSettings" "Wire.API.Asset" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "AssetSettings" 'PrefixI 'True) (S1 ('MetaSel ('Just "_setAssetPublic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_setAssetRetention") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssetRetention))))

defAssetSettings :: AssetSettings Source #

setAssetPublic :: Lens' AssetSettings Bool Source #

setAssetRetention :: Lens' AssetSettings (Maybe AssetRetention) Source #

data AssetRetention Source #

The desired asset retention.

Constructors

AssetEternal

The asset is retained indefinitely. Typically used for profile pictures / assets frequently accessed.

AssetPersistent

DEPRECATED: should not be used by clients for new assets The asset is retained indefinitely.

AssetVolatile

The asset is retained for a short period of time.

AssetEternalInfrequentAccess

The asset is retained indefinitely, storage is optimised for infrequent access

AssetExpiring

The asset is retained for an extended period of time, but not indefinitely.

Instances

Instances details
Arbitrary AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

arbitrary :: Gen AssetRetention Source #

shrink :: AssetRetention -> [AssetRetention] Source #

FromJSON AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseJSON :: Value -> Parser AssetRetention Source #

parseJSONList :: Value -> Parser [AssetRetention] Source #

ToJSON AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

toJSON :: AssetRetention -> Value Source #

toEncoding :: AssetRetention -> Encoding Source #

toJSONList :: [AssetRetention] -> Value Source #

toEncodingList :: [AssetRetention] -> Encoding Source #

Bounded AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

minBound :: AssetRetention #

maxBound :: AssetRetention #

Enum AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

succ :: AssetRetention -> AssetRetention #

pred :: AssetRetention -> AssetRetention #

toEnum :: Int -> AssetRetention #

fromEnum :: AssetRetention -> Int #

enumFrom :: AssetRetention -> [AssetRetention] #

enumFromThen :: AssetRetention -> AssetRetention -> [AssetRetention] #

enumFromTo :: AssetRetention -> AssetRetention -> [AssetRetention] #

enumFromThenTo :: AssetRetention -> AssetRetention -> AssetRetention -> [AssetRetention] #

Generic AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Associated Types

type Rep AssetRetention :: Type -> Type #

Methods

from :: AssetRetention -> Rep AssetRetention x #

to :: Rep AssetRetention x -> AssetRetention #

Show AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

showsPrec :: Int -> AssetRetention -> ShowS #

show :: AssetRetention -> String #

showList :: [AssetRetention] -> ShowS #

FromByteString AssetRetention Source #

ByteString representation is used in AssetKey

Instance details

Defined in Wire.API.Asset

Methods

parser :: Parser AssetRetention Source #

ToByteString AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

builder :: AssetRetention -> Builder Source #

Eq AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

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

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

Ord AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

compare :: AssetRetention -> AssetRetention -> Ordering #

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

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

(>) :: AssetRetention -> AssetRetention -> Bool #

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

max :: AssetRetention -> AssetRetention -> AssetRetention #

min :: AssetRetention -> AssetRetention -> AssetRetention #

ToSchema AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

declareNamedSchema :: Proxy AssetRetention -> Declare (Definitions Schema) NamedSchema Source #

ToSchema AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

Methods

schema :: ValueSchema NamedSwaggerDoc AssetRetention Source #

type Rep AssetRetention Source # 
Instance details

Defined in Wire.API.Asset

type Rep AssetRetention = D1 ('MetaData "AssetRetention" "Wire.API.Asset" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) ((C1 ('MetaCons "AssetEternal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AssetPersistent" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "AssetVolatile" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AssetEternalInfrequentAccess" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AssetExpiring" 'PrefixI 'False) (U1 :: Type -> Type))))

assetRetentionSeconds :: AssetRetention -> Maybe NominalDiffTime Source #

The minimum TTL in seconds corresponding to a chosen retention.

assetExpiringSeconds :: NominalDiffTime Source #

assetVolatileSeconds :: NominalDiffTime Source #

retentionToTextRep :: AssetRetention -> Text Source #

Streaming

newtype AssetLocation r Source #

Constructors

AssetLocation 

Fields

Instances

Instances details
FromHttpApiData (AssetLocation Absolute) Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseUrlPiece :: Text -> Either Text (AssetLocation Absolute) Source #

parseHeader :: ByteString -> Either Text (AssetLocation Absolute) Source #

parseQueryParam :: Text -> Either Text (AssetLocation Absolute) Source #

FromHttpApiData (AssetLocation Relative) Source # 
Instance details

Defined in Wire.API.Asset

Methods

parseUrlPiece :: Text -> Either Text (AssetLocation Relative) Source #

parseHeader :: ByteString -> Either Text (AssetLocation Relative) Source #

parseQueryParam :: Text -> Either Text (AssetLocation Relative) Source #

ToHttpApiData (AssetLocation r) Source # 
Instance details

Defined in Wire.API.Asset

Methods

toUrlPiece :: AssetLocation r -> Text Source #

toEncodedUrlPiece :: AssetLocation r -> Builder Source #

toHeader :: AssetLocation r -> ByteString Source #

toQueryParam :: AssetLocation r -> Text Source #

toEncodedQueryParam :: AssetLocation r -> Builder Source #

ToParamSchema (AssetLocation r) Source # 
Instance details

Defined in Wire.API.Asset

Methods

toParamSchema :: Proxy (AssetLocation r) -> Schema Source #

data LocalOrRemoteAsset Source #

An asset as returned by the download API: if the asset is local, only a URL is returned, and if it is remote the content of the asset is streamed.

Constructors

LocalAsset (AssetLocation Absolute) 
RemoteAsset (SourceIO ByteString) 

Instances

Instances details
(ResponseType r1 ~ AssetLocation Absolute, ResponseType r2 ~ SourceIO ByteString, KnownError (MapError e)) => AsUnion '[ErrorResponse e, r1, r2] (Maybe LocalOrRemoteAsset) Source # 
Instance details

Defined in Wire.API.Asset

Methods

toUnion :: Maybe LocalOrRemoteAsset -> Union (ResponseTypes '[ErrorResponse e, r1, r2]) Source #

fromUnion :: Union (ResponseTypes '[ErrorResponse e, r1, r2]) -> Maybe LocalOrRemoteAsset Source #