# Pets

## Create

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

**post** `/pets`

### Parameters

- `name: String`

- `photo_urls: Array[String]`

- `category: Category`

  - `id: Float`

  - `name: String`

- `status: :available | :pending | :sold`

  - `:available`

  - `:pending`

  - `:sold`

- `tags: Array[Tag]`

  - `id: Float`

  - `name: String`

### Returns

- `class Pet`

  - `name: String`

  - `photo_urls: Array[String]`

  - `id: Float`

  - `category: Category`

    - `id: Float`

    - `name: String`

  - `status: :available | :pending | :sold`

    - `:available`

    - `:pending`

    - `:sold`

  - `tags: Array[Tag]`

    - `id: Float`

    - `name: String`

### Example

```ruby
require "barkend"

barkend = Barkend::Client.new(bearer_token: "My Bearer Token")

pet = barkend.pets.create(name: "name", photo_urls: ["string"])

puts(pet)
```

## List

`pets.list() -> PetListResponse`

**get** `/pets`

### Returns

- `Array[Pet]`

  - `name: String`

  - `photo_urls: Array[String]`

  - `id: Float`

  - `category: Category`

    - `id: Float`

    - `name: String`

  - `status: :available | :pending | :sold`

    - `:available`

    - `:pending`

    - `:sold`

  - `tags: Array[Tag]`

    - `id: Float`

    - `name: String`

### Example

```ruby
require "barkend"

barkend = Barkend::Client.new(bearer_token: "My Bearer Token")

pets = barkend.pets.list

puts(pets)
```

## Retrieve

`pets.retrieve(pet_id) -> Pet`

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

### Parameters

- `pet_id: Float`

### Returns

- `class Pet`

  - `name: String`

  - `photo_urls: Array[String]`

  - `id: Float`

  - `category: Category`

    - `id: Float`

    - `name: String`

  - `status: :available | :pending | :sold`

    - `:available`

    - `:pending`

    - `:sold`

  - `tags: Array[Tag]`

    - `id: Float`

    - `name: String`

### Example

```ruby
require "barkend"

barkend = Barkend::Client.new(bearer_token: "My Bearer Token")

pet = barkend.pets.retrieve(0)

puts(pet)
```

## Delete

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

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

### Parameters

- `pet_id: Float`

- `body: { }`

### Returns

- `class PetDeleteResponse`

  - `message: String`

### Example

```ruby
require "barkend"

barkend = Barkend::Client.new(bearer_token: "My Bearer Token")

pet = barkend.pets.delete(0)

puts(pet)
```

## Domain Types

### Category

- `class Category`

  - `id: Float`

  - `name: String`

### Pet

- `class Pet`

  - `name: String`

  - `photo_urls: Array[String]`

  - `id: Float`

  - `category: Category`

    - `id: Float`

    - `name: String`

  - `status: :available | :pending | :sold`

    - `:available`

    - `:pending`

    - `:sold`

  - `tags: Array[Tag]`

    - `id: Float`

    - `name: String`

### Tag

- `class Tag`

  - `id: Float`

  - `name: String`