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

WWW::OpenAPIClient::PetApi

Load the API package

use WWW::OpenAPIClient::Object::PetApi;

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

Method	HTTP request	Description
add_pet	POST /pet	Add a new pet to the store
delete_pet	DELETE /pet/{petId}	Deletes a pet
find_pets_by_status	GET /pet/findByStatus	Finds Pets by status
find_pets_by_tags	GET /pet/findByTags	Finds Pets by tags
get_pet_by_id	GET /pet/{petId}	Find pet by ID
update_pet	PUT /pet	Update an existing pet
update_pet_with_form	POST /pet/{petId}	Updates a pet in the store with form data
upload_file	POST /pet/{petId}/uploadImage	uploads an image
upload_file_with_required_file	POST /fake/{petId}/uploadImageWithRequiredFile	uploads an image (required)

add_pet

add_pet(body => $body)

Add a new pet to the store

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $body = WWW::OpenAPIClient::Object::Pet->new(); # Pet | Pet object that needs to be added to the store

eval { 
    $api_instance->add_pet(body => $body);
};
if ($@) {
    warn "Exception when calling PetApi->add_pet: $@\n";
}

Parameters

Name	Type	Description	Notes
body	Pet	Pet object that needs to be added to the store

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

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

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

delete_pet

delete_pet(pet_id => $pet_id, api_key => $api_key)

Deletes a pet

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $pet_id = 789; # int | Pet id to delete
my $api_key = "api_key_example"; # string | 

eval { 
    $api_instance->delete_pet(pet_id => $pet_id, api_key => $api_key);
};
if ($@) {
    warn "Exception when calling PetApi->delete_pet: $@\n";
}

Parameters

Name	Type	Description	Notes
pet_id	int	Pet id to delete
api_key	string		[optional]

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

find_pets_by_status

ARRAY[Pet] find_pets_by_status(status => $status)

Finds Pets by status

Multiple status values can be provided with comma separated strings

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $status = [("'available'")]; # ARRAY[string] | Status values that need to be considered for filter

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

Parameters

Name	Type	Description	Notes
status	ARRAY[string]	Status values that need to be considered for filter

Return type

ARRAY[Pet]

Authorization

petstore_auth

HTTP request headers

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

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

find_pets_by_tags

ARRAY[Pet] find_pets_by_tags(tags => $tags)

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $tags = [("null")]; # ARRAY[string] | Tags to filter by

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

Parameters

Name	Type	Description	Notes
tags	ARRAY[string]	Tags to filter by

Return type

ARRAY[Pet]

Authorization

petstore_auth

HTTP request headers

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

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

get_pet_by_id

Pet get_pet_by_id(pet_id => $pet_id)

Find pet by ID

Returns a single pet

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

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

my $pet_id = 789; # int | ID of pet to return

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

Parameters

Name	Type	Description	Notes
pet_id	int	ID of pet to return

Return type

Pet

Authorization

api_key

HTTP request headers

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

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

update_pet

update_pet(body => $body)

Update an existing pet

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $body = WWW::OpenAPIClient::Object::Pet->new(); # Pet | Pet object that needs to be added to the store

eval { 
    $api_instance->update_pet(body => $body);
};
if ($@) {
    warn "Exception when calling PetApi->update_pet: $@\n";
}

Parameters

Name	Type	Description	Notes
body	Pet	Pet object that needs to be added to the store

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

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

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

update_pet_with_form

update_pet_with_form(pet_id => $pet_id, name => $name, status => $status)

Updates a pet in the store with form data

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $pet_id = 789; # int | ID of pet that needs to be updated
my $name = "name_example"; # string | Updated name of the pet
my $status = "status_example"; # string | Updated status of the pet

eval { 
    $api_instance->update_pet_with_form(pet_id => $pet_id, name => $name, status => $status);
};
if ($@) {
    warn "Exception when calling PetApi->update_pet_with_form: $@\n";
}

Parameters

Name	Type	Description	Notes
pet_id	int	ID of pet that needs to be updated
name	string	Updated name of the pet	[optional]
status	string	Updated status of the pet	[optional]

Return type

void (empty response body)

Authorization

petstore_auth

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

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

upload_file

ApiResponse upload_file(pet_id => $pet_id, additional_metadata => $additional_metadata, file => $file)

uploads an image

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $pet_id = 789; # int | ID of pet to update
my $additional_metadata = "additional_metadata_example"; # string | Additional data to pass to server
my $file = "/path/to/file"; # string | file to upload

eval { 
    my $result = $api_instance->upload_file(pet_id => $pet_id, additional_metadata => $additional_metadata, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PetApi->upload_file: $@\n";
}

Parameters

Name	Type	Description	Notes
pet_id	int	ID of pet to update
additional_metadata	string	Additional data to pass to server	[optional]
file	string****string	file to upload	[optional]

Return type

ApiResponse

Authorization

petstore_auth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

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

upload_file_with_required_file

ApiResponse upload_file_with_required_file(pet_id => $pet_id, required_file => $required_file, additional_metadata => $additional_metadata)

uploads an image (required)

Example

use Data::Dumper;
use WWW::OpenAPIClient::PetApi;
my $api_instance = WWW::OpenAPIClient::PetApi->new(

    # Configure OAuth2 access token for authorization: petstore_auth
    access_token => 'YOUR_ACCESS_TOKEN',
);

my $pet_id = 789; # int | ID of pet to update
my $required_file = "/path/to/file"; # string | file to upload
my $additional_metadata = "additional_metadata_example"; # string | Additional data to pass to server

eval { 
    my $result = $api_instance->upload_file_with_required_file(pet_id => $pet_id, required_file => $required_file, additional_metadata => $additional_metadata);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PetApi->upload_file_with_required_file: $@\n";
}

Parameters

Name	Type	Description	Notes
pet_id	int	ID of pet to update
required_file	string****string	file to upload
additional_metadata	string	Additional data to pass to server	[optional]

Return type

ApiResponse

Authorization

petstore_auth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

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