acme-python-sdk 1.0.0
Client for OpenAPI Petstore
License: MIT
Requires Python: >=3.7,<4.0

# acme-python-sdk@1.0.0
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.


## Requirements

Python >=3.7

## Installing

```sh
pip install acme-python-sdk==1.0.0
```

## Getting Started

```python
from pprint import pprint
from acme_client import Acme, ApiException

acme = Acme(
    # Defining the host is optional and defaults to http://petstore.swagger.io/v2
    # See configuration.py for a list of all supported configuration parameters.
    host="http://petstore.swagger.io/v2",
)

try:
    # Pagination sandbox
    paginate_response = acme.miscellaneous.paginate(
        first=1,  # optional
        after="string_example",  # optional
    )
    pprint(paginate_response.body)
    pprint(paginate_response.body["edges"])
    pprint(paginate_response.body["page_info"])
    pprint(paginate_response.headers)
    pprint(paginate_response.status)
    pprint(paginate_response.round_trip_time)
except ApiException as e:
    print("Exception when calling MiscellaneousApi.paginate: %s\n" % e)
    pprint(e.body)
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)
```

## Async

`async` support is available by prepending `a` to any method.

```python
import asyncio
from pprint import pprint
from acme_client import Acme, ApiException

acme = Acme(
    # Defining the host is optional and defaults to http://petstore.swagger.io/v2
    # See configuration.py for a list of all supported configuration parameters.
    host="http://petstore.swagger.io/v2",
)


async def main():
    try:
        # Pagination sandbox
        paginate_response = await acme.miscellaneous.apaginate(
            first=1,  # optional
            after="string_example",  # optional
        )
        pprint(paginate_response.body)
        pprint(paginate_response.body["edges"])
        pprint(paginate_response.body["page_info"])
        pprint(paginate_response.headers)
        pprint(paginate_response.status)
        pprint(paginate_response.round_trip_time)
    except ApiException as e:
        print("Exception when calling MiscellaneousApi.paginate: %s\n" % e)
        pprint(e.body)
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)


asyncio.run(main())
```


## Documentation for API Endpoints

All URIs are relative to *http://petstore.swagger.io/v2*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*MiscellaneousApi* | [**paginate**](docs/apis/tags/MiscellaneousApi.md#paginate) | **get** /pagination | Pagination sandbox
*PetApi* | [**add**](docs/apis/tags/PetApi.md#add) | **post** /pet | Add a new pet to the store
*PetApi* | [**delete**](docs/apis/tags/PetApi.md#delete) | **delete** /pet/{petId} | Deletes a pet
*PetApi* | [**find_by_status**](docs/apis/tags/PetApi.md#find_by_status) | **get** /pet/findByStatus | Finds Pets by status
*PetApi* | [**find_by_tags**](docs/apis/tags/PetApi.md#find_by_tags) | **get** /pet/findByTags | Finds Pets by tags
*PetApi* | [**get_by_id**](docs/apis/tags/PetApi.md#get_by_id) | **get** /pet/{petId} | Find pet by ID
*PetApi* | [**update**](docs/apis/tags/PetApi.md#update) | **put** /pet | Update an existing pet
*PetApi* | [**update_with_form**](docs/apis/tags/PetApi.md#update_with_form) | **post** /pet/{petId} | Updates a pet in the store with form data
*PetApi* | [**upload_image**](docs/apis/tags/PetApi.md#upload_image) | **post** /pet/{petId}/uploadImage | uploads an image
*StoreApi* | [**delete_order**](docs/apis/tags/StoreApi.md#delete_order) | **delete** /store/order/{orderId} | Delete purchase order by ID
*StoreApi* | [**get_inventory**](docs/apis/tags/StoreApi.md#get_inventory) | **get** /store/inventory | Returns pet inventories by status
*StoreApi* | [**get_order_by_id**](docs/apis/tags/StoreApi.md#get_order_by_id) | **get** /store/order/{orderId} | Find purchase order by ID
*StoreApi* | [**place_order**](docs/apis/tags/StoreApi.md#place_order) | **post** /store/order | Place an order for a pet
*UserApi* | [**create**](docs/apis/tags/UserApi.md#create) | **post** /user | Create user
*UserApi* | [**create_with_array**](docs/apis/tags/UserApi.md#create_with_array) | **post** /user/createWithArray | Creates list of users with given input array
*UserApi* | [**create_with_list**](docs/apis/tags/UserApi.md#create_with_list) | **post** /user/createWithList | Creates list of users with given input array
*UserApi* | [**delete**](docs/apis/tags/UserApi.md#delete) | **delete** /user/{username} | Delete user
*UserApi* | [**get_by_name**](docs/apis/tags/UserApi.md#get_by_name) | **get** /user/{username} | Get user by user name
*UserApi* | [**login**](docs/apis/tags/UserApi.md#login) | **get** /user/login | Logs user into the system
*UserApi* | [**logout**](docs/apis/tags/UserApi.md#logout) | **get** /user/logout | Logs out current logged in user session
*UserApi* | [**update**](docs/apis/tags/UserApi.md#update) | **put** /user/{username} | Updated user

## Documentation For Models

 - [ApiResponse](docs/models/ApiResponse.md)
 - [Category](docs/models/Category.md)
 - [CreateWithArrayRequest](docs/models/CreateWithArrayRequest.md)
 - [FindByStatus200Response](docs/models/FindByStatus200Response.md)
 - [FindByStatusResponse](docs/models/FindByStatusResponse.md)
 - [FindByTags200Response](docs/models/FindByTags200Response.md)
 - [FindByTagsResponse](docs/models/FindByTagsResponse.md)
 - [GetInventoryResponse](docs/models/GetInventoryResponse.md)
 - [Login200Response](docs/models/Login200Response.md)
 - [LoginResponse](docs/models/LoginResponse.md)
 - [Order](docs/models/Order.md)
 - [PaginateRequest](docs/models/PaginateRequest.md)
 - [PaginateResponse](docs/models/PaginateResponse.md)
 - [Pet](docs/models/Pet.md)
 - [Tag](docs/models/Tag.md)
 - [UpdateWithFormRequest](docs/models/UpdateWithFormRequest.md)
 - [UploadImageRequest](docs/models/UploadImageRequest.md)
 - [User](docs/models/User.md)
 - [UserCreateRequest](docs/models/UserCreateRequest.md)


## Author
This Python package is automatically generated by [Konfig](https://konfigthis.com)