Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Push.V2.Token

Contents

PushToken
PushToken fields
API types

Synopsis

newtype PushTokenList = PushTokenList {
- pushTokens :: [PushToken]
}
data PushToken
pushToken :: Transport -> AppName -> Token -> ClientId -> PushToken
tokenTransport :: Lens' PushToken Transport
tokenApp :: Lens' PushToken AppName
tokenClient :: Lens' PushToken ClientId
token :: Lens' PushToken Token
data Transport
- = GCM
- | APNS
- | APNSSandbox
- | APNSVoIP
- | APNSVoIPSandbox
newtype Token = Token {
- tokenText :: Text
}
newtype AppName = AppName {
- appNameText :: Text
}
data AddTokenError
data AddTokenSuccess = AddTokenSuccess PushToken
type AddTokenResponses = AddTokenErrorResponses .++ '[AddTokenSuccessResponses]
type DeleteTokenResponses = '[ErrorResponse 'TokenNotFound, RespondEmpty 204 "Push token unregistered"]

PushToken

newtype PushTokenList Source #

Constructors

PushTokenList
Fields pushTokens :: [PushToken]

Instances

Instances details

Arbitrary PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen PushTokenList Source # shrink :: PushTokenList -> [PushTokenList] Source #
FromJSON PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser PushTokenList Source # parseJSONList :: Value -> Parser [PushTokenList] Source #
ToJSON PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: PushTokenList -> Value Source # toEncoding :: PushTokenList -> Encoding Source # toJSONList :: [PushTokenList] -> Value Source # toEncodingList :: [PushTokenList] -> Encoding Source #
Show PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> PushTokenList -> ShowS # show :: PushTokenList -> String # showList :: [PushTokenList] -> ShowS #
Eq PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: PushTokenList -> PushTokenList -> Bool # (/=) :: PushTokenList -> PushTokenList -> Bool #
ToSchema PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy PushTokenList -> Declare (Definitions Schema) NamedSchema Source #
ToSchema PushTokenList Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc PushTokenList Source #

data PushToken Source #

Instances

Instances details

Arbitrary PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen PushToken Source # shrink :: PushToken -> [PushToken] Source #
FromJSON PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser PushToken Source # parseJSONList :: Value -> Parser [PushToken] Source #
ToJSON PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: PushToken -> Value Source # toEncoding :: PushToken -> Encoding Source # toJSONList :: [PushToken] -> Value Source # toEncodingList :: [PushToken] -> Encoding Source #
Generic PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Associated Types type Rep PushToken :: Type -> Type # Methods from :: PushToken -> Rep PushToken x # to :: Rep PushToken x -> PushToken #
Show PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> PushToken -> ShowS # show :: PushToken -> String # showList :: [PushToken] -> ShowS #
Eq PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: PushToken -> PushToken -> Bool # (/=) :: PushToken -> PushToken -> Bool #
Ord PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: PushToken -> PushToken -> Ordering # (<) :: PushToken -> PushToken -> Bool # (<=) :: PushToken -> PushToken -> Bool # (>) :: PushToken -> PushToken -> Bool # (>=) :: PushToken -> PushToken -> Bool # max :: PushToken -> PushToken -> PushToken # min :: PushToken -> PushToken -> PushToken #
ToSchema PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy PushToken -> Declare (Definitions Schema) NamedSchema Source #
ToSchema PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc PushToken Source #
AsHeaders '[Token] PushToken AddTokenSuccess Source #
Instance details Defined in Wire.API.Push.V2.Token Methods fromHeaders :: (NP I '[Token], PushToken) -> AddTokenSuccess Source # toHeaders :: AddTokenSuccess -> (NP I '[Token], PushToken) Source #
type Rep PushToken Source #
Instance details Defined in Wire.API.Push.V2.Token type Rep PushToken = D1 ('MetaData "PushToken" "Wire.API.Push.V2.Token" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "PushToken" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_tokenTransport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Transport) :: S1 ('MetaSel ('Just "_tokenApp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppName)) :: (S1 ('MetaSel ('Just "_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Token) :*: S1 ('MetaSel ('Just "_tokenClient") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientId))))

pushToken :: Transport -> AppName -> Token -> ClientId -> PushToken Source #

tokenTransport :: Lens' PushToken Transport Source #

tokenApp :: Lens' PushToken AppName Source #

tokenClient :: Lens' PushToken ClientId Source #

token :: Lens' PushToken Token Source #

PushToken fields

data Transport Source #

Constructors

GCM
APNS
APNSSandbox
APNSVoIP
APNSVoIPSandbox

Instances

Instances details

Arbitrary Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen Transport Source # shrink :: Transport -> [Transport] Source #
FromJSON Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser Transport Source # parseJSONList :: Value -> Parser [Transport] Source #
ToJSON Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: Transport -> Value Source # toEncoding :: Transport -> Encoding Source # toJSONList :: [Transport] -> Value Source # toEncodingList :: [Transport] -> Encoding Source #
Bounded Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods minBound :: Transport # maxBound :: Transport #
Enum Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods succ :: Transport -> Transport # pred :: Transport -> Transport # toEnum :: Int -> Transport # fromEnum :: Transport -> Int # enumFrom :: Transport -> [Transport] # enumFromThen :: Transport -> Transport -> [Transport] # enumFromTo :: Transport -> Transport -> [Transport] # enumFromThenTo :: Transport -> Transport -> Transport -> [Transport] #
Generic Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Associated Types type Rep Transport :: Type -> Type # Methods from :: Transport -> Rep Transport x # to :: Rep Transport x -> Transport #
Show Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> Transport -> ShowS # show :: Transport -> String # showList :: [Transport] -> ShowS #
FromByteString Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parser :: Parser Transport Source #
Eq Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: Transport -> Transport -> Bool # (/=) :: Transport -> Transport -> Bool #
Ord Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: Transport -> Transport -> Ordering # (<) :: Transport -> Transport -> Bool # (<=) :: Transport -> Transport -> Bool # (>) :: Transport -> Transport -> Bool # (>=) :: Transport -> Transport -> Bool # max :: Transport -> Transport -> Transport # min :: Transport -> Transport -> Transport #
ToSchema Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy Transport -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Transport Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc Transport Source #
type Rep Transport Source #
Instance details Defined in Wire.API.Push.V2.Token type Rep Transport = D1 ('MetaData "Transport" "Wire.API.Push.V2.Token" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) ((C1 ('MetaCons "GCM" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "APNS" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "APNSSandbox" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "APNSVoIP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "APNSVoIPSandbox" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype Token Source #

Constructors

Token
Fields tokenText :: Text

Instances

Instances details

Arbitrary Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen Token Source # shrink :: Token -> [Token] Source #
FromJSON Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser Token Source # parseJSONList :: Value -> Parser [Token] Source #
ToJSON Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: Token -> Value Source # toEncoding :: Token -> Encoding Source # toJSONList :: [Token] -> Value Source # toEncodingList :: [Token] -> Encoding Source #
Show Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
FromByteString Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parser :: Parser Token Source #
ToByteString Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods builder :: Token -> Builder Source #
Eq Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Ord Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: Token -> Token -> Ordering # (<) :: Token -> Token -> Bool # (<=) :: Token -> Token -> Bool # (>) :: Token -> Token -> Bool # (>=) :: Token -> Token -> Bool # max :: Token -> Token -> Token # min :: Token -> Token -> Token #
FromHttpApiData Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseUrlPiece :: Text -> Either Text Token Source # parseHeader :: ByteString -> Either Text Token Source # parseQueryParam :: Text -> Either Text Token Source #
ToHttpApiData Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toUrlPiece :: Token -> Text Source # toEncodedUrlPiece :: Token -> Builder Source # toHeader :: Token -> ByteString Source # toQueryParam :: Token -> Text Source # toEncodedQueryParam :: Token -> Builder Source #
ToParamSchema Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toParamSchema :: Proxy Token -> Schema Source #
ToSchema Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy Token -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Token Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc Token Source #
AsHeaders '[Token] PushToken AddTokenSuccess Source #
Instance details Defined in Wire.API.Push.V2.Token Methods fromHeaders :: (NP I '[Token], PushToken) -> AddTokenSuccess Source # toHeaders :: AddTokenSuccess -> (NP I '[Token], PushToken) Source #

newtype AppName Source #

Constructors

AppName
Fields appNameText :: Text

Instances

Instances details

Arbitrary AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods arbitrary :: Gen AppName Source # shrink :: AppName -> [AppName] Source #
FromJSON AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods parseJSON :: Value -> Parser AppName Source # parseJSONList :: Value -> Parser [AppName] Source #
ToJSON AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toJSON :: AppName -> Value Source # toEncoding :: AppName -> Encoding Source # toJSONList :: [AppName] -> Value Source # toEncodingList :: [AppName] -> Encoding Source #
IsString AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods fromString :: String -> AppName #
Show AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> AppName -> ShowS # show :: AppName -> String # showList :: [AppName] -> ShowS #
Eq AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods (==) :: AppName -> AppName -> Bool # (/=) :: AppName -> AppName -> Bool #
Ord AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods compare :: AppName -> AppName -> Ordering # (<) :: AppName -> AppName -> Bool # (<=) :: AppName -> AppName -> Bool # (>) :: AppName -> AppName -> Bool # (>=) :: AppName -> AppName -> Bool # max :: AppName -> AppName -> AppName # min :: AppName -> AppName -> AppName #
ToSchema AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods declareNamedSchema :: Proxy AppName -> Declare (Definitions Schema) NamedSchema Source #
ToSchema AppName Source #
Instance details Defined in Wire.API.Push.V2.Token Methods schema :: ValueSchema NamedSwaggerDoc AppName Source #

API types

data AddTokenError Source #

Constructors

AddTokenErrorNoBudget
AddTokenErrorNotFound
AddTokenErrorInvalid
AddTokenErrorTooLong
AddTokenErrorMetadataTooLong
AddTokenErrorApnsVoipNotSupported

Instances

Instances details

Generic AddTokenError Source #
Instance details Defined in Wire.API.Push.V2.Token Associated Types type Rep AddTokenError :: Type -> Type # Methods from :: AddTokenError -> Rep AddTokenError x # to :: Rep AddTokenError x -> AddTokenError #
Show AddTokenError Source #
Instance details Defined in Wire.API.Push.V2.Token Methods showsPrec :: Int -> AddTokenError -> ShowS # show :: AddTokenError -> String # showList :: [AddTokenError] -> ShowS #
Generic AddTokenError Source #
Instance details Defined in Wire.API.Push.V2.Token Associated Types type Code AddTokenError :: [[Type]] Source # Methods from :: AddTokenError -> Rep AddTokenError Source # to :: Rep AddTokenError -> AddTokenError Source #
res ~ AddTokenResponses => AsUnion res (Either AddTokenError AddTokenSuccess) Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toUnion :: Either AddTokenError AddTokenSuccess -> Union (ResponseTypes res) Source # fromUnion :: Union (ResponseTypes res) -> Either AddTokenError AddTokenSuccess Source #
type Rep AddTokenError Source #
Instance details Defined in Wire.API.Push.V2.Token type Rep AddTokenError = D1 ('MetaData "AddTokenError" "Wire.API.Push.V2.Token" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) ((C1 ('MetaCons "AddTokenErrorNoBudget" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AddTokenErrorNotFound" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AddTokenErrorInvalid" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "AddTokenErrorTooLong" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AddTokenErrorMetadataTooLong" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AddTokenErrorApnsVoipNotSupported" 'PrefixI 'False) (U1 :: Type -> Type))))
type Code AddTokenError Source #
Instance details Defined in Wire.API.Push.V2.Token type Code AddTokenError = GCode AddTokenError

data AddTokenSuccess Source #

Constructors

AddTokenSuccess PushToken

Instances

Instances details

res ~ AddTokenResponses => AsUnion res (Either AddTokenError AddTokenSuccess) Source #
Instance details Defined in Wire.API.Push.V2.Token Methods toUnion :: Either AddTokenError AddTokenSuccess -> Union (ResponseTypes res) Source # fromUnion :: Union (ResponseTypes res) -> Either AddTokenError AddTokenSuccess Source #
AsHeaders '[Token] PushToken AddTokenSuccess Source #
Instance details Defined in Wire.API.Push.V2.Token Methods fromHeaders :: (NP I '[Token], PushToken) -> AddTokenSuccess Source # toHeaders :: AddTokenSuccess -> (NP I '[Token], PushToken) Source #

type AddTokenResponses = AddTokenErrorResponses .++ '[AddTokenSuccessResponses] Source #

type DeleteTokenResponses = '[ErrorResponse 'TokenNotFound, RespondEmpty 204 "Push token unregistered"] Source #