Skip to content
Get started

Pets

Update an existing pet
client.pets.update(PetUpdateParams { name, photoUrls, id, 3 more } body, RequestOptionsoptions?): Pet { name, photoUrls, id, 3 more }
put/pet
Add a new pet to the store
client.pets.create(PetCreateParams { name, photoUrls, id, 3 more } body, RequestOptionsoptions?): Pet { name, photoUrls, id, 3 more }
post/pet
Finds Pets by status
client.pets.findByStatus(PetFindByStatusParams { status } query?, RequestOptionsoptions?): PetFindByStatusResponse { name, photoUrls, id, 3 more }
get/pet/findByStatus
Finds Pets by tags
client.pets.findByTags(PetFindByTagsParams { tags } query?, RequestOptionsoptions?): PetFindByTagsResponse { name, photoUrls, id, 3 more }
get/pet/findByTags
Find pet by ID
client.pets.retrieve(numberpetID, RequestOptionsoptions?): Pet { name, photoUrls, id, 3 more }
get/pet/{petId}
Updates a pet in the store with form data
client.pets.updateByID(numberpetID, PetUpdateByIDParams { name, status } params?, RequestOptionsoptions?): void
post/pet/{petId}
Deletes a pet
client.pets.delete(numberpetID, RequestOptionsoptions?): void
delete/pet/{petId}
uploads an image
client.pets.uploadImage(numberpetID, "string" | "ArrayBuffer" | "ArrayBufferView" | 2 moreimage, PetUploadImageParams { additionalMetadata } params?, RequestOptionsoptions?): PetUploadImageResponse { code, message, type }
post/pet/{petId}/uploadImage
ModelsExpand Collapse
Category { id, name }
id?: number
name?: string
Pet { name, photoUrls, id, 3 more }
name: string
photoUrls: Array<string>
id?: number
category?: Category { id, name }
id?: number
name?: string
status?: "available" | "pending" | "sold"

pet status in the store

Accepts one of the following:
"available"
"pending"
"sold"
tags?: Array<Tag>
id?: number
name?: string