swagger-petstore-0.1.0.0: Auto-generated swagger-petstore API Client

Safe Haskell | None
Language | Haskell2010

SwaggerPetstore.API.Pet

Contents

- Operations
  - Pet
    - addPet
    - deletePet
    - findPetsByStatus
    - findPetsByTags
    - getPetById
    - updatePet
    - updatePetWithForm
    - uploadFile

Description

Synopsis

- addPet :: (Consumes AddPet contentType, MimeRender contentType Pet) => ContentType contentType -> Accept accept -> Pet -> SwaggerPetstoreRequest AddPet contentType res accept
- data AddPet
- deletePet :: Accept accept -> PetId -> SwaggerPetstoreRequest DeletePet MimeNoContent res accept
- data DeletePet
- findPetsByStatus :: Accept accept -> Status -> SwaggerPetstoreRequest FindPetsByStatus MimeNoContent [Pet] accept
- data FindPetsByStatus
- findPetsByTags :: Accept accept -> Tags -> SwaggerPetstoreRequest FindPetsByTags MimeNoContent [Pet] accept
- data FindPetsByTags
- getPetById :: Accept accept -> PetId -> SwaggerPetstoreRequest GetPetById MimeNoContent Pet accept
- data GetPetById
- updatePet :: (Consumes UpdatePet contentType, MimeRender contentType Pet) => ContentType contentType -> Accept accept -> Pet -> SwaggerPetstoreRequest UpdatePet contentType res accept
- data UpdatePet
- updatePetWithForm :: Consumes UpdatePetWithForm MimeFormUrlEncoded => Accept accept -> PetId -> SwaggerPetstoreRequest UpdatePetWithForm MimeFormUrlEncoded res accept
- data UpdatePetWithForm
- uploadFile :: Consumes UploadFile MimeMultipartFormData => PetId -> SwaggerPetstoreRequest UploadFile MimeMultipartFormData ApiResponse MimeJSON
- data UploadFile

# Operations

## Pet

### addPet

addPet Source #

Arguments

:: (Consumes AddPet contentType, MimeRender contentType Pet) |
=> ContentType contentType | request content-type (`MimeType`)
-> Accept accept | request accept (`MimeType`)
-> Pet | "body" - Pet object that needs to be added to the store
-> SwaggerPetstoreRequest AddPet contentType res accept |

    POST /pet

Add a new pet to the store

AuthMethod: `AuthOAuthPetstoreAuth`

Note: Has `Produces` instances, but no response schema

data AddPet Source #

Instances

Produces AddPet MimeXML Source # |
    application/xml
Produces AddPet MimeJSON Source # |
    application/json
Consumes AddPet MimeXML Source # |
    application/xml
Consumes AddPet MimeJSON Source # |
    application/json
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 accept -> Pet -> SwaggerPetstoreRequest AddPet contentType res accept Source #

### deletePet

deletePet Source #

Arguments

:: Accept accept | request accept (`MimeType`)
-> PetId | "petId" - Pet id to delete
-> SwaggerPetstoreRequest DeletePet MimeNoContent res accept |

    DELETE /pet/{petId}

Deletes a pet

AuthMethod: `AuthOAuthPetstoreAuth`

Note: Has `Produces` instances, but no response schema

data DeletePet Source #

Instances

Produces DeletePet MimeXML Source # |
    application/xml
Produces DeletePet MimeJSON Source # |
    application/json
HasOptionalParam DeletePet ApiKey Source # |
Methods applyOptionalParam :: SwaggerPetstoreRequest DeletePet contentType res accept -> ApiKey -> SwaggerPetstoreRequest DeletePet contentType res accept Source # (-&-) :: SwaggerPetstoreRequest DeletePet contentType res accept -> ApiKey -> SwaggerPetstoreRequest DeletePet contentType res accept Source #

### findPetsByStatus

findPetsByStatus Source #

Arguments

:: Accept accept | request accept (`MimeType`)
-> Status | "status" - Status values that need to be considered for filter
-> SwaggerPetstoreRequest FindPetsByStatus MimeNoContent [Pet] accept |

    GET /pet/findByStatus

Finds Pets by status

Multiple status values can be provided with comma separated strings

AuthMethod: `AuthOAuthPetstoreAuth`

data FindPetsByStatus Source #

Instances

Produces FindPetsByStatus MimeXML Source # |
    application/xml
Produces FindPetsByStatus MimeJSON Source # |
    application/json

### findPetsByTags

findPetsByTags Source #

Arguments

:: Accept accept | request accept (`MimeType`)
-> Tags | "tags" - Tags to filter by
-> SwaggerPetstoreRequest FindPetsByTags MimeNoContent [Pet] accept |

Deprecated:

    GET /pet/findByTags

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

AuthMethod: `AuthOAuthPetstoreAuth`

data FindPetsByTags Source #

Instances

Produces FindPetsByTags MimeXML Source # |
    application/xml
Produces FindPetsByTags MimeJSON Source # |
    application/json

### getPetById

getPetById Source #

Arguments

:: Accept accept | request accept (`MimeType`)
-> PetId | "petId" - ID of pet to return
-> SwaggerPetstoreRequest GetPetById MimeNoContent Pet accept |

    GET /pet/{petId}

Find pet by ID

Returns a single pet

AuthMethod: `AuthApiKeyApiKey`

data GetPetById Source #

Instances

Produces GetPetById MimeXML Source # |
    application/xml
Produces GetPetById MimeJSON Source # |
    application/json

### updatePet

updatePet Source #

Arguments

:: (Consumes UpdatePet contentType, MimeRender contentType Pet) |
=> ContentType contentType | request content-type (`MimeType`)
-> Accept accept | request accept (`MimeType`)
-> Pet | "body" - Pet object that needs to be added to the store
-> SwaggerPetstoreRequest UpdatePet contentType res accept |

    PUT /pet

Update an existing pet

AuthMethod: `AuthOAuthPetstoreAuth`

Note: Has `Produces` instances, but no response schema

data UpdatePet Source #

Instances

Produces UpdatePet MimeXML Source # |
    application/xml
Produces UpdatePet MimeJSON Source # |
    application/json
Consumes UpdatePet MimeXML Source # |
    application/xml
Consumes UpdatePet MimeJSON Source # |
    application/json
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 accept -> Pet -> SwaggerPetstoreRequest UpdatePet contentType res accept Source #

### updatePetWithForm

updatePetWithForm Source #

Arguments

:: Consumes UpdatePetWithForm MimeFormUrlEncoded |
=> Accept accept | request accept (`MimeType`)
-> PetId | "petId" - ID of pet that needs to be updated
-> SwaggerPetstoreRequest UpdatePetWithForm MimeFormUrlEncoded res accept |

    POST /pet/{petId}

Updates a pet in the store with form data

AuthMethod: `AuthOAuthPetstoreAuth`

Note: Has `Produces` instances, but no response schema

data UpdatePetWithForm Source #

Instances

Produces UpdatePetWithForm MimeXML Source # |
    application/xml
Produces UpdatePetWithForm MimeJSON Source # |
    application/json
Consumes UpdatePetWithForm MimeFormUrlEncoded Source # |
    application/x-www-form-urlencoded
HasOptionalParam UpdatePetWithForm StatusText Source # | Optional Param "status" - Updated status of the pet
Methods applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res accept -> StatusText -> SwaggerPetstoreRequest UpdatePetWithForm contentType res accept Source # (-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res accept -> StatusText -> SwaggerPetstoreRequest UpdatePetWithForm contentType res accept Source #
HasOptionalParam UpdatePetWithForm Name2 Source # | Optional Param "name" - Updated name of the pet
Methods applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res accept -> Name2 -> SwaggerPetstoreRequest UpdatePetWithForm contentType res accept Source # (-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res accept -> Name2 -> SwaggerPetstoreRequest UpdatePetWithForm contentType res accept Source #

### uploadFile

uploadFile Source #

Arguments

:: Consumes UploadFile MimeMultipartFormData |
=> PetId | "petId" - ID of pet to update
-> SwaggerPetstoreRequest UploadFile MimeMultipartFormData ApiResponse MimeJSON |

    POST /pet/{petId}/uploadImage

uploads an image

AuthMethod: `AuthOAuthPetstoreAuth`

data UploadFile Source #

Instances

Produces UploadFile MimeJSON Source # |
    application/json
Consumes UploadFile MimeMultipartFormData Source # |
    multipart/form-data
HasOptionalParam UploadFile File Source # | Optional Param "file" - file to upload
Methods applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res accept -> File -> SwaggerPetstoreRequest UploadFile contentType res accept Source # (-&-) :: SwaggerPetstoreRequest UploadFile contentType res accept -> File -> SwaggerPetstoreRequest UploadFile contentType res accept Source #
HasOptionalParam UploadFile AdditionalMetadata Source # | Optional Param "additionalMetadata" - Additional data to pass to server
Methods applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res accept -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res accept Source # (-&-) :: SwaggerPetstoreRequest UploadFile contentType res accept -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res accept Source #