# Pets

## Create

`pets.create(PetCreateParams**kwargs)  -> Pet`

**post** `/pets`

### Parameters

- `name: str`

- `photo_urls: SequenceNotStr[str]`

- `category: Optional[CategoryParam]`

  - `id: Optional[float]`

  - `name: Optional[str]`

- `status: Optional[Literal["available", "pending", "sold"]]`

  - `"available"`

  - `"pending"`

  - `"sold"`

- `tags: Optional[Iterable[TagParam]]`

  - `id: Optional[float]`

  - `name: Optional[str]`

### Returns

- `class Pet: …`

  - `name: str`

  - `photo_urls: List[str]`

  - `id: Optional[float]`

  - `category: Optional[Category]`

    - `id: Optional[float]`

    - `name: Optional[str]`

  - `status: Optional[Literal["available", "pending", "sold"]]`

    - `"available"`

    - `"pending"`

    - `"sold"`

  - `tags: Optional[List[Tag]]`

    - `id: Optional[float]`

    - `name: Optional[str]`

### Example

```python
import os
from barkend import Barkend

client = Barkend(
    bearer_token=os.environ.get("BARKEND_BEARER_TOKEN"),  # This is the default and can be omitted
)
pet = client.pets.create(
    name="name",
    photo_urls=["string"],
)
print(pet.id)
```

## List

`pets.list()  -> PetListResponse`

**get** `/pets`

### Returns

- `List[Pet]`

  - `name: str`

  - `photo_urls: List[str]`

  - `id: Optional[float]`

  - `category: Optional[Category]`

    - `id: Optional[float]`

    - `name: Optional[str]`

  - `status: Optional[Literal["available", "pending", "sold"]]`

    - `"available"`

    - `"pending"`

    - `"sold"`

  - `tags: Optional[List[Tag]]`

    - `id: Optional[float]`

    - `name: Optional[str]`

### Example

```python
import os
from barkend import Barkend

client = Barkend(
    bearer_token=os.environ.get("BARKEND_BEARER_TOKEN"),  # This is the default and can be omitted
)
pets = client.pets.list()
print(pets)
```

## Retrieve

`pets.retrieve(floatpet_id)  -> Pet`

**get** `/pets/{petId}`

### Parameters

- `pet_id: float`

### Returns

- `class Pet: …`

  - `name: str`

  - `photo_urls: List[str]`

  - `id: Optional[float]`

  - `category: Optional[Category]`

    - `id: Optional[float]`

    - `name: Optional[str]`

  - `status: Optional[Literal["available", "pending", "sold"]]`

    - `"available"`

    - `"pending"`

    - `"sold"`

  - `tags: Optional[List[Tag]]`

    - `id: Optional[float]`

    - `name: Optional[str]`

### Example

```python
import os
from barkend import Barkend

client = Barkend(
    bearer_token=os.environ.get("BARKEND_BEARER_TOKEN"),  # This is the default and can be omitted
)
pet = client.pets.retrieve(
    0,
)
print(pet.id)
```

## Delete

`pets.delete(floatpet_id, PetDeleteParams**kwargs)  -> PetDeleteResponse`

**delete** `/pets/{petId}`

### Parameters

- `pet_id: float`

- `body: Optional[Body]`

### Returns

- `class PetDeleteResponse: …`

  - `message: str`

### Example

```python
import os
from barkend import Barkend

client = Barkend(
    bearer_token=os.environ.get("BARKEND_BEARER_TOKEN"),  # This is the default and can be omitted
)
pet = client.pets.delete(
    pet_id=0,
)
print(pet.message)
```

## Domain Types

### Category

- `class Category: …`

  - `id: Optional[float]`

  - `name: Optional[str]`

### Pet

- `class Pet: …`

  - `name: str`

  - `photo_urls: List[str]`

  - `id: Optional[float]`

  - `category: Optional[Category]`

    - `id: Optional[float]`

    - `name: Optional[str]`

  - `status: Optional[Literal["available", "pending", "sold"]]`

    - `"available"`

    - `"pending"`

    - `"sold"`

  - `tags: Optional[List[Tag]]`

    - `id: Optional[float]`

    - `name: Optional[str]`

### Tag

- `class Tag: …`

  - `id: Optional[float]`

  - `name: Optional[str]`