Safe Haskell	None
Language	Haskell2010

SwaggerPetstore.Model

Contents

Models
Utils
DateTime Formatting
Date Formatting

Description

Synopsis

Models

ApiResponse

data ApiResponse Source #

An uploaded response

Describes the result of uploading an image resource

Constructors

ApiResponse
Fields apiResponseCode :: Maybe Int "code" apiResponseType :: Maybe Text "type" apiResponseMessage :: Maybe Text "message"

Instances

Eq ApiResponse Source #
Methods (==) :: ApiResponse -> ApiResponse -> Bool # (/=) :: ApiResponse -> ApiResponse -> Bool #
Show ApiResponse Source #
Methods showsPrec :: Int -> ApiResponse -> ShowS # show :: ApiResponse -> String # showList :: [ApiResponse] -> ShowS #
ToJSON ApiResponse Source #
Methods toJSON :: ApiResponse -> Value # toEncoding :: ApiResponse -> Encoding # toJSONList :: [ApiResponse] -> Value # toEncodingList :: [ApiResponse] -> Encoding #
FromJSON ApiResponse Source #
Methods parseJSON :: Value -> Parser ApiResponse # parseJSONList :: Value -> Parser [ApiResponse] #

mkApiResponse :: ApiResponse Source #

Construct a value of type ApiResponse (by applying it's required fields, if any)

Order

data Order Source #

Pet Order

An order for a pets from the pet store

Constructors

Order
Fields orderId :: Maybe Integer "id" orderPetId :: Maybe Integer "petId" orderQuantity :: Maybe Int "quantity" orderShipDate :: Maybe UTCTime "shipDate" orderStatus :: Maybe Text "status" - Order Status orderComplete :: Maybe Bool "complete"

Instances

Eq Order Source #
Methods (==) :: Order -> Order -> Bool # (/=) :: Order -> Order -> Bool #
Show Order Source #
Methods showsPrec :: Int -> Order -> ShowS # show :: Order -> String # showList :: [Order] -> ShowS #
ToJSON Order Source #
Methods toJSON :: Order -> Value # toEncoding :: Order -> Encoding # toJSONList :: [Order] -> Value # toEncodingList :: [Order] -> Encoding #
FromJSON Order Source #
Methods parseJSON :: Value -> Parser Order # parseJSONList :: Value -> Parser [Order] #
HasBodyParam PlaceOrder Order Source #	Body Param "body" - order placed for purchasing the pet
Methods setBodyParam :: (Consumes PlaceOrder contentType, MimeRender contentType Order) => SwaggerPetstoreRequest PlaceOrder contentType res -> Order -> SwaggerPetstoreRequest PlaceOrder contentType res Source #

mkOrder :: Order Source #

Construct a value of type Order (by applying it's required fields, if any)

Pet

data Pet Source #

a Pet

A pet for sale in the pet store

Constructors

Pet
Fields petId :: Maybe Integer "id" petCategory :: Maybe Category "category" petName :: Text Required "name" petPhotoUrls :: [Text] Required "photoUrls" petTags :: Maybe [Tag] "tags" petStatus :: Maybe Text "status" - pet status in the store

Instances

Eq Pet Source #
Methods (==) :: Pet -> Pet -> Bool # (/=) :: Pet -> Pet -> Bool #
Show Pet Source #
Methods showsPrec :: Int -> Pet -> ShowS # show :: Pet -> String # showList :: [Pet] -> ShowS #
ToJSON Pet Source #
Methods toJSON :: Pet -> Value # toEncoding :: Pet -> Encoding # toJSONList :: [Pet] -> Value # toEncodingList :: [Pet] -> Encoding #
FromJSON Pet Source #
Methods parseJSON :: Value -> Parser Pet # parseJSONList :: Value -> Parser [Pet] #
HasBodyParam UpdatePet Pet Source #	Body Param "body" - Pet object that needs to be added to the store
Methods setBodyParam :: (Consumes UpdatePet contentType, MimeRender contentType Pet) => SwaggerPetstoreRequest UpdatePet contentType res -> Pet -> SwaggerPetstoreRequest UpdatePet contentType res Source #
HasBodyParam AddPet Pet Source #	Body Param "body" - Pet object that needs to be added to the store
Methods setBodyParam :: (Consumes AddPet contentType, MimeRender contentType Pet) => SwaggerPetstoreRequest AddPet contentType res -> Pet -> SwaggerPetstoreRequest AddPet contentType res Source #

mkPet Source #

Arguments

:: Text	`petName`
-> [Text]	`petPhotoUrls`
-> Pet

Construct a value of type Pet (by applying it's required fields, if any)

Tag

data Tag Source #

Pet Tag

A tag for a pet

Constructors

Tag
Fields tagId :: Maybe Integer "id" tagName :: Maybe Text "name"

Instances

Eq Tag Source #
Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Show Tag Source #
Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
ToJSON Tag Source #
Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
FromJSON Tag Source #
Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #

mkTag :: Tag Source #

Construct a value of type Tag (by applying it's required fields, if any)

User

data User Source #

a User

A User who is purchasing from the pet store

Constructors

User
Fields userId :: Maybe Integer "id" userUsername :: Maybe Text "username" userFirstName :: Maybe Text "firstName" userLastName :: Maybe Text "lastName" userEmail :: Maybe Text "email" userPassword :: Maybe Text "password" userPhone :: Maybe Text "phone" userUserStatus :: Maybe Int "userStatus" - User Status

Instances

Eq User Source #
Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Show User Source #
Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
ToJSON User Source #
Methods toJSON :: User -> Value # toEncoding :: User -> Encoding # toJSONList :: [User] -> Value # toEncodingList :: [User] -> Encoding #
FromJSON User Source #
Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #
HasBodyParam UpdateUser User Source #	Body Param "body" - Updated user object
Methods setBodyParam :: (Consumes UpdateUser contentType, MimeRender contentType User) => SwaggerPetstoreRequest UpdateUser contentType res -> User -> SwaggerPetstoreRequest UpdateUser contentType res Source #
HasBodyParam CreateUser User Source #	Body Param "body" - Created user object
Methods setBodyParam :: (Consumes CreateUser contentType, MimeRender contentType User) => SwaggerPetstoreRequest CreateUser contentType res -> User -> SwaggerPetstoreRequest CreateUser contentType res Source #
HasBodyParam CreateUsersWithListInput [User] Source #	Body Param "body" - List of user object
Methods setBodyParam :: (Consumes CreateUsersWithListInput contentType, MimeRender contentType [User]) => SwaggerPetstoreRequest CreateUsersWithListInput contentType res -> [User] -> SwaggerPetstoreRequest CreateUsersWithListInput contentType res Source #
HasBodyParam CreateUsersWithArrayInput [User] Source #	Body Param "body" - List of user object
Methods setBodyParam :: (Consumes CreateUsersWithArrayInput contentType, MimeRender contentType [User]) => SwaggerPetstoreRequest CreateUsersWithArrayInput contentType res -> [User] -> SwaggerPetstoreRequest CreateUsersWithArrayInput contentType res Source #

mkUser :: User Source #

Construct a value of type User (by applying it's required fields, if any)

Utils

_omitNulls :: [(Text, Value)] -> Value Source #

Removes Null fields. (OpenAPI-Specification 2.0 does not allow Null in JSON)

_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text]) Source #

_emptyToNothing :: Maybe String -> Maybe String Source #

_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a Source #

DateTime Formatting

_readDateTime :: (ParseTime t, Monad m, Alternative m) => String -> m t Source #

_parseISO8601

_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String Source #

TI.formatISO8601Millis

_parseISO8601 :: (ParseTime t, Monad m, Alternative m) => String -> m t Source #

Date Formatting

_readDate :: (ParseTime t, Monad m) => String -> m t Source #

TI.parseTimeM True TI.defaultTimeLocale ""

_showDate :: FormatTime t => t -> String Source #

TI.formatTime TI.defaultTimeLocale ""

Eq Category Source #
Methods (==) :: Category -> Category -> Bool # (/=) :: Category -> Category -> Bool #
Show Category Source #
Methods showsPrec :: Int -> Category -> ShowS # show :: Category -> String # showList :: [Category] -> ShowS #
ToJSON Category Source #
Methods toJSON :: Category -> Value # toEncoding :: Category -> Encoding # toJSONList :: [Category] -> Value # toEncodingList :: [Category] -> Encoding #
FromJSON Category Source #
Methods parseJSON :: Value -> Parser Category # parseJSONList :: Value -> Parser [Category] #

Category
Fields categoryId :: Maybe Integer "id" categoryName :: Maybe Text "name"

Models

ApiResponse

Category

Order

Pet

Tag

User

Utils

DateTime Formatting

Date Formatting