openapi-petstore-0.0.4.0: Auto-generated openapi-petstore API Client

Safe HaskellNone
LanguageHaskell2010

OpenAPIPetstore.API.User

Contents

Description

 
Synopsis

Operations

User

createUser

createUser Source #

Arguments

:: (Consumes CreateUser contentType, MimeRender contentType User) 
=> ContentType contentType

request content-type (MimeType)

-> User

"body" - Created user object

-> OpenAPIPetstoreRequest CreateUser contentType NoContent MimeNoContent 
POST /user

Create user

This can only be done by the logged in user.

data CreateUser Source #

Instances
Produces CreateUser MimeNoContent Source # 
Instance details

Defined in OpenAPIPetstore.API.User

MimeType mtype => Consumes CreateUser mtype Source #
*/*
Instance details

Defined in OpenAPIPetstore.API.User

HasBodyParam CreateUser User Source #

Body Param "body" - Created user object

Instance details

Defined in OpenAPIPetstore.API.User

Methods

setBodyParam :: (Consumes CreateUser contentType, MimeRender contentType User) => OpenAPIPetstoreRequest CreateUser contentType res accept -> User -> OpenAPIPetstoreRequest CreateUser contentType res accept Source #

createUsersWithArrayInput

createUsersWithArrayInput Source #

Arguments

:: (Consumes CreateUsersWithArrayInput contentType, MimeRender contentType Body) 
=> ContentType contentType

request content-type (MimeType)

-> Body

"body" - List of user object

-> OpenAPIPetstoreRequest CreateUsersWithArrayInput contentType NoContent MimeNoContent 
POST /user/createWithArray

Creates list of users with given input array

createUsersWithListInput

createUsersWithListInput Source #

Arguments

:: (Consumes CreateUsersWithListInput contentType, MimeRender contentType Body) 
=> ContentType contentType

request content-type (MimeType)

-> Body

"body" - List of user object

-> OpenAPIPetstoreRequest CreateUsersWithListInput contentType NoContent MimeNoContent 
POST /user/createWithList

Creates list of users with given input array

data CreateUsersWithListInput Source #

Instances
Produces CreateUsersWithListInput MimeNoContent Source # 
Instance details

Defined in OpenAPIPetstore.API.User

MimeType mtype => Consumes CreateUsersWithListInput mtype Source #
*/*
Instance details

Defined in OpenAPIPetstore.API.User

HasBodyParam CreateUsersWithListInput Body Source #

Body Param "body" - List of user object

Instance details

Defined in OpenAPIPetstore.API.User

deleteUser

deleteUser Source #

Arguments

:: Username

"username" - The name that needs to be deleted

-> OpenAPIPetstoreRequest DeleteUser MimeNoContent NoContent MimeNoContent 
DELETE /user/{username}

Delete user

This can only be done by the logged in user.

getUserByName

getUserByName Source #

Arguments

:: Accept accept

request accept (MimeType)

-> Username

"username" - The name that needs to be fetched. Use user1 for testing.

-> OpenAPIPetstoreRequest GetUserByName MimeNoContent User accept 
GET /user/{username}

Get user by user name

data GetUserByName Source #

Instances
Produces GetUserByName MimeXML Source #
application/xml
Instance details

Defined in OpenAPIPetstore.API.User

Produces GetUserByName MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.User

loginUser

loginUser Source #

Arguments

:: Accept accept

request accept (MimeType)

-> Username

"username" - The user name for login

-> Password

"password" - The password for login in clear text

-> OpenAPIPetstoreRequest LoginUser MimeNoContent Text accept 
GET /user/login

Logs user into the system

data LoginUser Source #

Instances
Produces LoginUser MimeXML Source #
application/xml
Instance details

Defined in OpenAPIPetstore.API.User

Produces LoginUser MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.User

logoutUser

logoutUser :: OpenAPIPetstoreRequest LogoutUser MimeNoContent NoContent MimeNoContent Source #

GET /user/logout

Logs out current logged in user session

updateUser

updateUser Source #

Arguments

:: (Consumes UpdateUser contentType, MimeRender contentType User) 
=> ContentType contentType

request content-type (MimeType)

-> User

"body" - Updated user object

-> Username

"username" - name that need to be deleted

-> OpenAPIPetstoreRequest UpdateUser contentType NoContent MimeNoContent 
PUT /user/{username}

Updated user

This can only be done by the logged in user.

data UpdateUser Source #

Instances
Produces UpdateUser MimeNoContent Source # 
Instance details

Defined in OpenAPIPetstore.API.User

MimeType mtype => Consumes UpdateUser mtype Source #
*/*
Instance details

Defined in OpenAPIPetstore.API.User

HasBodyParam UpdateUser User Source #

Body Param "body" - Updated user object

Instance details

Defined in OpenAPIPetstore.API.User

Methods

setBodyParam :: (Consumes UpdateUser contentType, MimeRender contentType User) => OpenAPIPetstoreRequest UpdateUser contentType res accept -> User -> OpenAPIPetstoreRequest UpdateUser contentType res accept Source #