openapi-generator/samples/client/petstore/python/docs/StoreApi.md

swagger_client\StoreApi

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

Method	HTTP request	Description
delete_order	DELETE /store/order/{orderId}	Delete purchase order by ID
find_orders_by_status	GET /store/findByStatus	Finds orders by status
get_inventory	GET /store/inventory	Returns pet inventories by status
get_inventory_in_object	GET /store/inventory?response=arbitrary_object	Fake endpoint to test arbitrary object return by 'Get inventory'
get_order_by_id	GET /store/order/{orderId}	Find purchase order by ID
place_order	POST /store/order	Place an order for a pet

delete_order

delete_order(order_id)

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Example

import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
import time


# create an instance of the API class
api_instance = swagger_client.StoreApi()
order_id = 'order_id_example' # str | ID of the order that needs to be deleted

try: 
    # Delete purchase order by ID
    api_instance.delete_order(order_id);
except ApiException as e:
    print "Exception when calling StoreApi->delete_order: %s\n" % e

Parameters

Name	Type	Description	Notes
order_id	str	ID of the order that needs to be deleted

Return type

void (empty response body)

Authorization

No authorization required

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_orders_by_status

list[Order] find_orders_by_status(status=status)

Finds orders by status

A single status value can be provided as a string

Example

import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
import time


# Configure API key authorization: test_api_client_id
swagger_client.configuration.api_key['x-test_api_client_id'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-test_api_client_id'] = 'BEARER'
# Configure API key authorization: test_api_client_secret
swagger_client.configuration.api_key['x-test_api_client_secret'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-test_api_client_secret'] = 'BEARER'

# create an instance of the API class
api_instance = swagger_client.StoreApi()
status = 'placed' # str | Status value that needs to be considered for query (optional) (default to placed)

try: 
    # Finds orders by status
    api_response = api_instance.find_orders_by_status(status=status);
    pprint(api_response)
except ApiException as e:
    print "Exception when calling StoreApi->find_orders_by_status: %s\n" % e

Parameters

Name	Type	Description	Notes
status	str	Status value that needs to be considered for query	[optional] [default to placed]

Return type

list[Order]

Authorization

test_api_client_id, test_api_client_secret

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_inventory

dict(str, int) get_inventory()

Returns pet inventories by status

Returns a map of status codes to quantities

Example

import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
import time


# Configure API key authorization: api_key
swagger_client.configuration.api_key['api_key'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_key'] = 'BEARER'

# create an instance of the API class
api_instance = swagger_client.StoreApi()

try: 
    # Returns pet inventories by status
    api_response = api_instance.get_inventory();
    pprint(api_response)
except ApiException as e:
    print "Exception when calling StoreApi->get_inventory: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

dict(str, int)

Authorization

api_key

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_inventory_in_object

object get_inventory_in_object()

Fake endpoint to test arbitrary object return by 'Get inventory'

Returns an arbitrary object which is actually a map of status codes to quantities

Example

import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
import time


# Configure API key authorization: api_key
swagger_client.configuration.api_key['api_key'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_key'] = 'BEARER'

# create an instance of the API class
api_instance = swagger_client.StoreApi()

try: 
    # Fake endpoint to test arbitrary object return by 'Get inventory'
    api_response = api_instance.get_inventory_in_object();
    pprint(api_response)
except ApiException as e:
    print "Exception when calling StoreApi->get_inventory_in_object: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

api_key

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_order_by_id

Order get_order_by_id(order_id)

Find purchase order by ID

For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

Example

import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
import time


# Configure API key authorization: test_api_key_header
swagger_client.configuration.api_key['test_api_key_header'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['test_api_key_header'] = 'BEARER'
# Configure API key authorization: test_api_key_query
swagger_client.configuration.api_key['test_api_key_query'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['test_api_key_query'] = 'BEARER'

# create an instance of the API class
api_instance = swagger_client.StoreApi()
order_id = 'order_id_example' # str | ID of pet that needs to be fetched

try: 
    # Find purchase order by ID
    api_response = api_instance.get_order_by_id(order_id);
    pprint(api_response)
except ApiException as e:
    print "Exception when calling StoreApi->get_order_by_id: %s\n" % e

Parameters

Name	Type	Description	Notes
order_id	str	ID of pet that needs to be fetched

Return type

Order

Authorization

test_api_key_header, test_api_key_query

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

place_order

Order place_order(body=body)

Place an order for a pet

Example

import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
import time


# Configure API key authorization: test_api_client_id
swagger_client.configuration.api_key['x-test_api_client_id'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-test_api_client_id'] = 'BEARER'
# Configure API key authorization: test_api_client_secret
swagger_client.configuration.api_key['x-test_api_client_secret'] = 'YOUR_API_KEY';
# Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-test_api_client_secret'] = 'BEARER'

# create an instance of the API class
api_instance = swagger_client.StoreApi()
body = swagger_client.Order() # Order | order placed for purchasing the pet (optional)

try: 
    # Place an order for a pet
    api_response = api_instance.place_order(body=body);
    pprint(api_response)
except ApiException as e:
    print "Exception when calling StoreApi->place_order: %s\n" % e

Parameters

Name	Type	Description	Notes
body	Order	order placed for purchasing the pet	[optional]

Return type

Order

Authorization

test_api_client_id, test_api_client_secret

HTTP reuqest headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]