Safe Haskell	None
Language	Haskell2010

Web.Giphy

Contents

Request Data Types
Response Data Types
Giphy Monad
Lenses
API calls

Description

Provides a Giphy monad that can be used to issue selected API calls under a selected API key.

import qualified Web.Giphy as Giphy

let apiKey = Giphy.Key "dc6zaTOxFJmzC"
let config = Giphy.GiphyConfig apiKey
resp <- Giphy.runGiphy (Giphy.search $ Giphy.query "puppies") config
let fstUrl = resp ^? _Right
                   . Giphy.searchItems
                   . _head
                   . Giphy.gifImages
                   . at "original"
                   . traverse
                   . Giphy.imageUrl
                   . traverse
print fstUrl

Synopsis

newtype Key = Key Text
newtype Query = Query Text
newtype Phrase = Phrase Text
newtype Tag = Tag Text
data Pagination = Pagination {
- _paginationTotalCount :: Int
- _paginationCount :: Int
- _paginationOffset :: Int
}
newtype GifId = GifId Text
data Gif = Gif {
- _gifId :: Text
- _gifSlug :: Text
- _gifUrl :: URI
- _gifImages :: ImageMap
}
data Image = Image {
- _imageUrl :: Maybe URI
- _imageSize :: Maybe Int
- _imageMp4Url :: Maybe URI
- _imageMp4Size :: Maybe Int
- _imageWebpUrl :: Maybe URI
- _imageWebpSize :: Maybe Int
- _imageWidth :: Maybe Int
- _imageHeight :: Maybe Int
}
type ImageMap = Map Text Image
newtype PaginationOffset = PaginationOffset Int
data SearchResponse = SearchResponse {
- _searchItems :: [Gif]
- _searchPagination :: Pagination
}
newtype SingleGifResponse = SingleGifResponse {
- _singleGifItem :: Gif
}
newtype TranslateResponse = TranslateResponse {
- _translateItem :: Gif
}
newtype RandomResponse = RandomResponse {
- _randomGifItem :: Gif
}
newtype GiphyConfig = GiphyConfig {
- configApiKey :: Key
}
type Giphy = ReaderT GiphyContext ClientM
runGiphy :: MonadIO m => Giphy a -> GiphyConfig -> m (Either ClientError a)
runGiphy' :: MonadIO m => Manager -> Giphy a -> GiphyConfig -> m (Either ClientError a)
gifId :: Lens' Gif Text
gifImages :: Lens' Gif ImageMap
gifSlug :: Lens' Gif Text
gifUrl :: Lens' Gif URI
imageHeight :: Lens' Image (Maybe Int)
imageUrl :: Lens' Image (Maybe URI)
imageSize :: Lens' Image (Maybe Int)
imageWidth :: Lens' Image (Maybe Int)
imageMp4Url :: Lens' Image (Maybe URI)
imageMp4Size :: Lens' Image (Maybe Int)
imageWebpUrl :: Lens' Image (Maybe URI)
imageWebpSize :: Lens' Image (Maybe Int)
paginationCount :: Lens' Pagination Int
paginationOffset :: Lens' Pagination Int
paginationTotalCount :: Lens' Pagination Int
searchItems :: Lens' SearchResponse [Gif]
searchPagination :: Lens' SearchResponse Pagination
singleGifItem :: Lens' SingleGifResponse Gif
translateItem :: Lens' TranslateResponse Gif
randomGifItem :: Lens' RandomResponse Gif
search :: Query -> Giphy SearchResponse
searchOffset :: Query -> PaginationOffset -> Giphy SearchResponse
translate :: Phrase -> Giphy TranslateResponse
gif :: GifId -> Giphy SingleGifResponse
random :: Maybe Tag -> Giphy RandomResponse

Request Data Types

These data types are used to encapsulate otherwise weakly typed arguments.

newtype Key Source #

The API Key. See https://github.com/Giphy/GiphyAPI

Constructors

Key Text

Instances

Eq Key Source #
Instance details Defined in Web.Giphy Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Show Key Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
ToHttpApiData Key Source #
Instance details Defined in Web.Giphy Methods toUrlPiece :: Key -> Text # toEncodedUrlPiece :: Key -> Builder # toHeader :: Key -> ByteString # toQueryParam :: Key -> Text #
FromHttpApiData Key Source #
Instance details Defined in Web.Giphy Methods parseUrlPiece :: Text -> Either Text Key # parseHeader :: ByteString -> Either Text Key # parseQueryParam :: Text -> Either Text Key #

newtype Query Source #

A search query.

Constructors

Query Text

Instances

Eq Query Source #
Instance details Defined in Web.Giphy Methods (==) :: Query -> Query -> Bool # (/=) :: Query -> Query -> Bool #
Show Query Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #
ToHttpApiData Query Source #
Instance details Defined in Web.Giphy Methods toUrlPiece :: Query -> Text # toEncodedUrlPiece :: Query -> Builder # toHeader :: Query -> ByteString # toQueryParam :: Query -> Text #
FromHttpApiData Query Source #
Instance details Defined in Web.Giphy Methods parseUrlPiece :: Text -> Either Text Query # parseHeader :: ByteString -> Either Text Query # parseQueryParam :: Text -> Either Text Query #

newtype Phrase Source #

A phrase or term used for translation.

Constructors

Phrase Text

Instances

Eq Phrase Source #
Instance details Defined in Web.Giphy Methods (==) :: Phrase -> Phrase -> Bool # (/=) :: Phrase -> Phrase -> Bool #
Show Phrase Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> Phrase -> ShowS # show :: Phrase -> String # showList :: [Phrase] -> ShowS #
ToHttpApiData Phrase Source #
Instance details Defined in Web.Giphy Methods toUrlPiece :: Phrase -> Text # toEncodedUrlPiece :: Phrase -> Builder # toHeader :: Phrase -> ByteString # toQueryParam :: Phrase -> Text #
FromHttpApiData Phrase Source #
Instance details Defined in Web.Giphy Methods parseUrlPiece :: Text -> Either Text Phrase # parseHeader :: ByteString -> Either Text Phrase # parseQueryParam :: Text -> Either Text Phrase #

newtype Tag Source #

A tag to retrieve a random GIF for.

Constructors

Tag Text

Instances

Eq Tag Source #
Instance details Defined in Web.Giphy Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Show Tag Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
ToHttpApiData Tag Source #
Instance details Defined in Web.Giphy Methods toUrlPiece :: Tag -> Text # toEncodedUrlPiece :: Tag -> Builder # toHeader :: Tag -> ByteString # toQueryParam :: Tag -> Text #
FromHttpApiData Tag Source #
Instance details Defined in Web.Giphy Methods parseUrlPiece :: Text -> Either Text Tag # parseHeader :: ByteString -> Either Text Tag # parseQueryParam :: Text -> Either Text Tag #

data Pagination Source #

Metadata about pagination in a response.

Constructors

Pagination
Fields _paginationTotalCount :: Int _paginationCount :: Int _paginationOffset :: Int

newtype GifId Source #

A unique gif identifier.

Constructors

GifId Text

Instances

Eq GifId Source #
Instance details Defined in Web.Giphy Methods (==) :: GifId -> GifId -> Bool # (/=) :: GifId -> GifId -> Bool #
Show GifId Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> GifId -> ShowS # show :: GifId -> String # showList :: [GifId] -> ShowS #
ToHttpApiData GifId Source #
Instance details Defined in Web.Giphy Methods toUrlPiece :: GifId -> Text # toEncodedUrlPiece :: GifId -> Builder # toHeader :: GifId -> ByteString # toQueryParam :: GifId -> Text #
FromHttpApiData GifId Source #
Instance details Defined in Web.Giphy Methods parseUrlPiece :: Text -> Either Text GifId # parseHeader :: ByteString -> Either Text GifId # parseQueryParam :: Text -> Either Text GifId #

Response Data Types

These data types contain are the parsed JSON responses from the Giphy API.

data Gif Source #

A search response item.

Constructors

Gif
Fields _gifId :: Text _gifSlug :: Text _gifUrl :: URI _gifImages :: ImageMap

Instances

Eq Gif Source #
Instance details Defined in Web.Giphy Methods (==) :: Gif -> Gif -> Bool # (/=) :: Gif -> Gif -> Bool #
Ord Gif Source #
Instance details Defined in Web.Giphy Methods compare :: Gif -> Gif -> Ordering # (<) :: Gif -> Gif -> Bool # (<=) :: Gif -> Gif -> Bool # (>) :: Gif -> Gif -> Bool # (>=) :: Gif -> Gif -> Bool # max :: Gif -> Gif -> Gif # min :: Gif -> Gif -> Gif #
Show Gif Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> Gif -> ShowS # show :: Gif -> String # showList :: [Gif] -> ShowS #
Generic Gif Source #
Instance details Defined in Web.Giphy Associated Types type Rep Gif :: Type -> Type # Methods from :: Gif -> Rep Gif x # to :: Rep Gif x -> Gif #
FromJSON Gif Source #
Instance details Defined in Web.Giphy Methods parseJSON :: Value -> Parser Gif # parseJSONList :: Value -> Parser [Gif] #
type Rep Gif Source #
Instance details Defined in Web.Giphy type Rep Gif = D1 (MetaData "Gif" "Web.Giphy" "giphy-api-0.7.0.0-GKIHg4B0k0i279jBFZMsh0" False) (C1 (MetaCons "Gif" PrefixI True) ((S1 (MetaSel (Just "_gifId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "_gifSlug") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :: (S1 (MetaSel (Just "_gifUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 URI) :*: S1 (MetaSel (Just "_gifImages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ImageMap))))

data Image Source #

An image contained in a Giphy response.

Constructors

Image
Fields _imageUrl :: Maybe URI _imageSize :: Maybe Int _imageMp4Url :: Maybe URI _imageMp4Size :: Maybe Int _imageWebpUrl :: Maybe URI _imageWebpSize :: Maybe Int _imageWidth :: Maybe Int _imageHeight :: Maybe Int

Instances

Eq Image Source #
Instance details Defined in Web.Giphy Methods (==) :: Image -> Image -> Bool # (/=) :: Image -> Image -> Bool #
Ord Image Source #
Instance details Defined in Web.Giphy Methods compare :: Image -> Image -> Ordering # (<) :: Image -> Image -> Bool # (<=) :: Image -> Image -> Bool # (>) :: Image -> Image -> Bool # (>=) :: Image -> Image -> Bool # max :: Image -> Image -> Image # min :: Image -> Image -> Image #
Show Image Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
Generic Image Source #
Instance details Defined in Web.Giphy Associated Types type Rep Image :: Type -> Type # Methods from :: Image -> Rep Image x # to :: Rep Image x -> Image #
FromJSON Image Source #
Instance details Defined in Web.Giphy Methods parseJSON :: Value -> Parser Image # parseJSONList :: Value -> Parser [Image] #
type Rep Image Source #
Instance details Defined in Web.Giphy type Rep Image = D1 (MetaData "Image" "Web.Giphy" "giphy-api-0.7.0.0-GKIHg4B0k0i279jBFZMsh0" False) (C1 (MetaCons "Image" PrefixI True) (((S1 (MetaSel (Just "_imageUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI)) :: S1 (MetaSel (Just "_imageSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) :: (S1 (MetaSel (Just "_imageMp4Url") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI)) :: S1 (MetaSel (Just "_imageMp4Size") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 (MetaSel (Just "_imageWebpUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI)) :: S1 (MetaSel (Just "_imageWebpSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) :: (S1 (MetaSel (Just "_imageWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_imageHeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))))

type ImageMap = Map Text Image Source #

Mapping from a Text identifier to an Image.

newtype PaginationOffset Source #

Offset for paginated requests.

Constructors

PaginationOffset Int

Instances

Eq PaginationOffset Source #
Instance details Defined in Web.Giphy Methods (==) :: PaginationOffset -> PaginationOffset -> Bool # (/=) :: PaginationOffset -> PaginationOffset -> Bool #
Show PaginationOffset Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> PaginationOffset -> ShowS # show :: PaginationOffset -> String # showList :: [PaginationOffset] -> ShowS #
ToHttpApiData PaginationOffset Source #
Instance details Defined in Web.Giphy Methods toUrlPiece :: PaginationOffset -> Text # toEncodedUrlPiece :: PaginationOffset -> Builder # toHeader :: PaginationOffset -> ByteString # toQueryParam :: PaginationOffset -> Text #
FromHttpApiData PaginationOffset Source #
Instance details Defined in Web.Giphy Methods parseUrlPiece :: Text -> Either Text PaginationOffset # parseHeader :: ByteString -> Either Text PaginationOffset # parseQueryParam :: Text -> Either Text PaginationOffset #

data SearchResponse Source #

A collection of GIFs as part of a search response.

Constructors

SearchResponse
Fields _searchItems :: [Gif] _searchPagination :: Pagination

Instances

Eq SearchResponse Source #
Instance details Defined in Web.Giphy Methods (==) :: SearchResponse -> SearchResponse -> Bool # (/=) :: SearchResponse -> SearchResponse -> Bool #
Ord SearchResponse Source #
Instance details Defined in Web.Giphy Methods compare :: SearchResponse -> SearchResponse -> Ordering # (<) :: SearchResponse -> SearchResponse -> Bool # (<=) :: SearchResponse -> SearchResponse -> Bool # (>) :: SearchResponse -> SearchResponse -> Bool # (>=) :: SearchResponse -> SearchResponse -> Bool # max :: SearchResponse -> SearchResponse -> SearchResponse # min :: SearchResponse -> SearchResponse -> SearchResponse #
Show SearchResponse Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> SearchResponse -> ShowS # show :: SearchResponse -> String # showList :: [SearchResponse] -> ShowS #
Generic SearchResponse Source #
Instance details Defined in Web.Giphy Associated Types type Rep SearchResponse :: Type -> Type # Methods from :: SearchResponse -> Rep SearchResponse x # to :: Rep SearchResponse x -> SearchResponse #
FromJSON SearchResponse Source #
Instance details Defined in Web.Giphy Methods parseJSON :: Value -> Parser SearchResponse # parseJSONList :: Value -> Parser [SearchResponse] #
type Rep SearchResponse Source #
Instance details Defined in Web.Giphy type Rep SearchResponse = D1 (MetaData "SearchResponse" "Web.Giphy" "giphy-api-0.7.0.0-GKIHg4B0k0i279jBFZMsh0" False) (C1 (MetaCons "SearchResponse" PrefixI True) (S1 (MetaSel (Just "_searchItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Gif]) :*: S1 (MetaSel (Just "_searchPagination") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Pagination)))

newtype SingleGifResponse Source #

A single gif as part of a response.

Constructors

SingleGifResponse
Fields _singleGifItem :: Gif

Instances

Eq SingleGifResponse Source #
Instance details Defined in Web.Giphy Methods (==) :: SingleGifResponse -> SingleGifResponse -> Bool # (/=) :: SingleGifResponse -> SingleGifResponse -> Bool #
Ord SingleGifResponse Source #
Instance details Defined in Web.Giphy Methods compare :: SingleGifResponse -> SingleGifResponse -> Ordering # (<) :: SingleGifResponse -> SingleGifResponse -> Bool # (<=) :: SingleGifResponse -> SingleGifResponse -> Bool # (>) :: SingleGifResponse -> SingleGifResponse -> Bool # (>=) :: SingleGifResponse -> SingleGifResponse -> Bool # max :: SingleGifResponse -> SingleGifResponse -> SingleGifResponse # min :: SingleGifResponse -> SingleGifResponse -> SingleGifResponse #
Show SingleGifResponse Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> SingleGifResponse -> ShowS # show :: SingleGifResponse -> String # showList :: [SingleGifResponse] -> ShowS #
Generic SingleGifResponse Source #
Instance details Defined in Web.Giphy Associated Types type Rep SingleGifResponse :: Type -> Type # Methods from :: SingleGifResponse -> Rep SingleGifResponse x # to :: Rep SingleGifResponse x -> SingleGifResponse #
FromJSON SingleGifResponse Source #
Instance details Defined in Web.Giphy Methods parseJSON :: Value -> Parser SingleGifResponse # parseJSONList :: Value -> Parser [SingleGifResponse] #
type Rep SingleGifResponse Source #
Instance details Defined in Web.Giphy type Rep SingleGifResponse = D1 (MetaData "SingleGifResponse" "Web.Giphy" "giphy-api-0.7.0.0-GKIHg4B0k0i279jBFZMsh0" True) (C1 (MetaCons "SingleGifResponse" PrefixI True) (S1 (MetaSel (Just "_singleGifItem") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Gif)))

newtype TranslateResponse Source #

A single GIF as part of a translate response.

Constructors

TranslateResponse
Fields _translateItem :: Gif

Instances

Eq TranslateResponse Source #
Instance details Defined in Web.Giphy Methods (==) :: TranslateResponse -> TranslateResponse -> Bool # (/=) :: TranslateResponse -> TranslateResponse -> Bool #
Ord TranslateResponse Source #
Instance details Defined in Web.Giphy Methods compare :: TranslateResponse -> TranslateResponse -> Ordering # (<) :: TranslateResponse -> TranslateResponse -> Bool # (<=) :: TranslateResponse -> TranslateResponse -> Bool # (>) :: TranslateResponse -> TranslateResponse -> Bool # (>=) :: TranslateResponse -> TranslateResponse -> Bool # max :: TranslateResponse -> TranslateResponse -> TranslateResponse # min :: TranslateResponse -> TranslateResponse -> TranslateResponse #
Show TranslateResponse Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> TranslateResponse -> ShowS # show :: TranslateResponse -> String # showList :: [TranslateResponse] -> ShowS #
Generic TranslateResponse Source #
Instance details Defined in Web.Giphy Associated Types type Rep TranslateResponse :: Type -> Type # Methods from :: TranslateResponse -> Rep TranslateResponse x # to :: Rep TranslateResponse x -> TranslateResponse #
FromJSON TranslateResponse Source #
Instance details Defined in Web.Giphy Methods parseJSON :: Value -> Parser TranslateResponse # parseJSONList :: Value -> Parser [TranslateResponse] #
type Rep TranslateResponse Source #
Instance details Defined in Web.Giphy type Rep TranslateResponse = D1 (MetaData "TranslateResponse" "Web.Giphy" "giphy-api-0.7.0.0-GKIHg4B0k0i279jBFZMsh0" True) (C1 (MetaCons "TranslateResponse" PrefixI True) (S1 (MetaSel (Just "_translateItem") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Gif)))

newtype RandomResponse Source #

A single gif as part of a response.

Constructors

RandomResponse
Fields _randomGifItem :: Gif

Instances

Eq RandomResponse Source #
Instance details Defined in Web.Giphy Methods (==) :: RandomResponse -> RandomResponse -> Bool # (/=) :: RandomResponse -> RandomResponse -> Bool #
Ord RandomResponse Source #
Instance details Defined in Web.Giphy Methods compare :: RandomResponse -> RandomResponse -> Ordering # (<) :: RandomResponse -> RandomResponse -> Bool # (<=) :: RandomResponse -> RandomResponse -> Bool # (>) :: RandomResponse -> RandomResponse -> Bool # (>=) :: RandomResponse -> RandomResponse -> Bool # max :: RandomResponse -> RandomResponse -> RandomResponse # min :: RandomResponse -> RandomResponse -> RandomResponse #
Show RandomResponse Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> RandomResponse -> ShowS # show :: RandomResponse -> String # showList :: [RandomResponse] -> ShowS #
Generic RandomResponse Source #
Instance details Defined in Web.Giphy Associated Types type Rep RandomResponse :: Type -> Type # Methods from :: RandomResponse -> Rep RandomResponse x # to :: Rep RandomResponse x -> RandomResponse #
FromJSON RandomResponse Source #
Instance details Defined in Web.Giphy Methods parseJSON :: Value -> Parser RandomResponse # parseJSONList :: Value -> Parser [RandomResponse] #
type Rep RandomResponse Source #
Instance details Defined in Web.Giphy type Rep RandomResponse = D1 (MetaData "RandomResponse" "Web.Giphy" "giphy-api-0.7.0.0-GKIHg4B0k0i279jBFZMsh0" True) (C1 (MetaCons "RandomResponse" PrefixI True) (S1 (MetaSel (Just "_randomGifItem") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Gif)))

Giphy Monad

Use runGiphy to lift the Giphy monad into IO.

newtype GiphyConfig Source #

Contains the key to access the API.

Constructors

GiphyConfig
Fields configApiKey :: Key

Instances

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

type Giphy = ReaderT GiphyContext ClientM Source #

The Giphy monad contains the execution context.

runGiphy :: MonadIO m => Giphy a -> GiphyConfig -> m (Either ClientError a) Source #

You need to provide a GiphyConfig to lift a Giphy computation into MonadIO.

runGiphy' Source #

Arguments

:: MonadIO m
=> Manager	This must be a TLS-enabled Manager
-> Giphy a
-> GiphyConfig
-> m (Either ClientError a)

Same as runGiphy but accepts an explicit Manager instead of implicitly creating one for you.

Lenses

You can use these lenses if you prefer them to manually accessing record fields.

gifId :: Lens' Gif Text Source #

gifImages :: Lens' Gif ImageMap Source #

gifSlug :: Lens' Gif Text Source #

gifUrl :: Lens' Gif URI Source #

imageHeight :: Lens' Image (Maybe Int) Source #

imageUrl :: Lens' Image (Maybe URI) Source #

imageSize :: Lens' Image (Maybe Int) Source #

imageWidth :: Lens' Image (Maybe Int) Source #

imageMp4Url :: Lens' Image (Maybe URI) Source #

imageMp4Size :: Lens' Image (Maybe Int) Source #

imageWebpUrl :: Lens' Image (Maybe URI) Source #

imageWebpSize :: Lens' Image (Maybe Int) Source #

paginationCount :: Lens' Pagination Int Source #

paginationOffset :: Lens' Pagination Int Source #

paginationTotalCount :: Lens' Pagination Int Source #

searchItems :: Lens' SearchResponse [Gif] Source #

searchPagination :: Lens' SearchResponse Pagination Source #

singleGifItem :: Lens' SingleGifResponse Gif Source #

translateItem :: Lens' TranslateResponse Gif Source #

randomGifItem :: Lens' RandomResponse Gif Source #

API calls

Functions that directly access the Giphy API. All these functions run in the Giphy monad.

search :: Query -> Giphy SearchResponse Source #

Issue a search request for the given query without specifying an offset. E.g. https://api.giphy.com/v1/gifs/search?q=funny+cat&api_key=dc6zaTOxFJmzC

searchOffset Source #

Arguments

:: Query
-> PaginationOffset	Offset as a number of items you want to skip.
-> Giphy SearchResponse

Issue a search request for the given query by specifying a pagination offset. E.g. https://api.giphy.com/v1/gifs/search?q=funny+cat&api_key=dc6zaTOxFJmzC&offset=25

translate :: Phrase -> Giphy TranslateResponse Source #

Issue a translate request for a given phrase or term. E.g. https://api.giphy.com/v1/gifs/translate?s=superman&api_key=dc6zaTOxFJmzC

gif :: GifId -> Giphy SingleGifResponse Source #

Issue a request for a single GIF identified by its GifId. E.g. https://api.giphy.com/v1/gifs/feqkVgjJpYtjy?api_key=dc6zaTOxFJmzC

random :: Maybe Tag -> Giphy RandomResponse Source #

Issue a request for a random GIF for the given (optional) tag. E.g. https://api.giphy.com/v1/gifs/random?api_key=dc6zaTOxFJmzC&tag=american+psycho

Eq Pagination Source #
Instance details Defined in Web.Giphy Methods (==) :: Pagination -> Pagination -> Bool # (/=) :: Pagination -> Pagination -> Bool #
Ord Pagination Source #
Instance details Defined in Web.Giphy Methods compare :: Pagination -> Pagination -> Ordering # (<) :: Pagination -> Pagination -> Bool # (<=) :: Pagination -> Pagination -> Bool # (>) :: Pagination -> Pagination -> Bool # (>=) :: Pagination -> Pagination -> Bool # max :: Pagination -> Pagination -> Pagination # min :: Pagination -> Pagination -> Pagination #
Show Pagination Source #
Instance details Defined in Web.Giphy Methods showsPrec :: Int -> Pagination -> ShowS # show :: Pagination -> String # showList :: [Pagination] -> ShowS #
Generic Pagination Source #
Instance details Defined in Web.Giphy Associated Types type Rep Pagination :: Type -> Type # Methods from :: Pagination -> Rep Pagination x # to :: Rep Pagination x -> Pagination #
FromJSON Pagination Source #
Instance details Defined in Web.Giphy Methods parseJSON :: Value -> Parser Pagination # parseJSONList :: Value -> Parser [Pagination] #
type Rep Pagination Source #
Instance details Defined in Web.Giphy type Rep Pagination = D1 (MetaData "Pagination" "Web.Giphy" "giphy-api-0.7.0.0-GKIHg4B0k0i279jBFZMsh0" False) (C1 (MetaCons "Pagination" PrefixI True) (S1 (MetaSel (Just "_paginationTotalCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: (S1 (MetaSel (Just "_paginationCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "_paginationOffset") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))