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

WWW::SwaggerClient::StoreApi

Load the API package

use WWW::SwaggerClient::Object::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 => $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

use Data::Dumper;

my $api_instance = WWW::SwaggerClient::StoreApi->new();
my $order_id = 'order_id_example'; # string | ID of the order that needs to be deleted

eval { 
    $api_instance->delete_order(order_id => $order_id);
};
if ($@) {
    warn "Exception when calling StoreApi->delete_order: $@\n";
}

Parameters

Name	Type	Description	Notes
order_id	string	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

ARRAY[Order] find_orders_by_status(status => $status)

Finds orders by status

A single status value can be provided as a string

Example

use Data::Dumper;

# Configure API key authorization: test_api_client_id
WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_id'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_id'} = "BEARER";
# Configure API key authorization: test_api_client_secret
WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_secret'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_secret'} = "BEARER";

my $api_instance = WWW::SwaggerClient::StoreApi->new();
my $status = 'status_example'; # string | Status value that needs to be considered for query

eval { 
    my $result = $api_instance->find_orders_by_status(status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreApi->find_orders_by_status: $@\n";
}

Parameters

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

Return type

ARRAY[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

HASH[string,int] get_inventory()

Returns pet inventories by status

Returns a map of status codes to quantities

Example

use Data::Dumper;

# Configure API key authorization: api_key
WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";

my $api_instance = WWW::SwaggerClient::StoreApi->new();

eval { 
    my $result = $api_instance->get_inventory();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreApi->get_inventory: $@\n";
}

Parameters

This endpoint does not need any parameter.

Return type

HASH[string,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

use Data::Dumper;

# Configure API key authorization: api_key
WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";

my $api_instance = WWW::SwaggerClient::StoreApi->new();

eval { 
    my $result = $api_instance->get_inventory_in_object();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreApi->get_inventory_in_object: $@\n";
}

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 => $order_id)

Find purchase order by ID

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

Example

use Data::Dumper;

# Configure API key authorization: test_api_key_header
WWW::SwaggerClient::Configuration::api_key->{'test_api_key_header'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'test_api_key_header'} = "BEARER";
# Configure API key authorization: test_api_key_query
WWW::SwaggerClient::Configuration::api_key->{'test_api_key_query'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'test_api_key_query'} = "BEARER";

my $api_instance = WWW::SwaggerClient::StoreApi->new();
my $order_id = 'order_id_example'; # string | ID of pet that needs to be fetched

eval { 
    my $result = $api_instance->get_order_by_id(order_id => $order_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreApi->get_order_by_id: $@\n";
}

Parameters

Name	Type	Description	Notes
order_id	string	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

use Data::Dumper;

# Configure API key authorization: test_api_client_id
WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_id'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_id'} = "BEARER";
# Configure API key authorization: test_api_client_secret
WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_secret'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. BEARER) for API key, if needed
#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_secret'} = "BEARER";

my $api_instance = WWW::SwaggerClient::StoreApi->new();
my $body = WWW::SwaggerClient::Object::Order->new(); # Order | order placed for purchasing the pet

eval { 
    my $result = $api_instance->place_order(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreApi->place_order: $@\n";
}

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]