api.md

Shared Types

from idealj.types import Order

Pets

Types:

from idealj.types import (
    Category,
    Pet,
    Tag,
    PetFindByStatusResponse,
    PetFindByTagsResponse,
    PetUploadImageResponse,
)

Methods:

• client.pets.create(**params) -> Pet
• client.pets.retrieve(pet_id) -> Pet
• client.pets.update(**params) -> Pet
• client.pets.delete(pet_id) -> None
• client.pets.find_by_status(**params) -> PetFindByStatusResponse
• client.pets.find_by_tags(**params) -> PetFindByTagsResponse
• client.pets.update_by_id(pet_id, **params) -> None
• client.pets.upload_image(pet_id, image, **params) -> PetUploadImageResponse

Store

Types:

from idealj.types import StoreListInventoryResponse

Methods:

• client.store.list_inventory() -> StoreListInventoryResponse

Orders

Methods:

• client.store.orders.create(**params) -> Order
• client.store.orders.retrieve(order_id) -> Order
• client.store.orders.delete(order_id) -> None

Users

Types:

from idealj.types import User, UserLoginResponse

Methods:

• client.users.create(**params) -> User
• client.users.retrieve(username) -> User
• client.users.update(existing_username, **params) -> None
• client.users.delete(username) -> None
• client.users.create_with_list(**params) -> User
• client.users.login(**params) -> str
• client.users.logout() -> None