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

WWW::SwaggerClient::UserApi

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

Method	HTTP request	Description
create_user	POST /user	Create user
create_users_with_array_input	POST /user/createWithArray	Creates list of users with given input array
create_users_with_list_input	POST /user/createWithList	Creates list of users with given input array
login_user	GET /user/login	Logs user into the system
logout_user	GET /user/logout	Logs out current logged in user session
get_user_by_name	GET /user/{username}	Get user by user name
update_user	PUT /user/{username}	Updated user
delete_user	DELETE /user/{username}	Delete user

create_user

create_user(body => $body)

Create user

This can only be done by the logged in user.

Example

my $api = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # [User] Created user object

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

Parameters

Name	Type	Description	Notes
body	User	Created user object	[optional]

Return type

void (empty response body)

HTTP headers

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

Authentication scheme

No authentiation required

create_users_with_array_input

create_users_with_array_input(body => $body)

Creates list of users with given input array

Example

my $api = WWW::SwaggerClient::UserApi->new();
my $body = (WWW::SwaggerClient::Object::ARRAY[User]->new()); # [ARRAY[User]] List of user object

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

Parameters

Name	Type	Description	Notes
body	ARRAY[User]	List of user object	[optional]

Return type

void (empty response body)

HTTP headers

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

Authentication scheme

No authentiation required

create_users_with_list_input

create_users_with_list_input(body => $body)

Creates list of users with given input array

Example

my $api = WWW::SwaggerClient::UserApi->new();
my $body = (WWW::SwaggerClient::Object::ARRAY[User]->new()); # [ARRAY[User]] List of user object

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

Parameters

Name	Type	Description	Notes
body	ARRAY[User]	List of user object	[optional]

Return type

void (empty response body)

HTTP headers

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

Authentication scheme

No authentiation required

login_user

string login_user(username => $username, password => $password)

Logs user into the system

Example

my $api = WWW::SwaggerClient::UserApi->new();
my $username = 'username_example'; # [string] The user name for login
my $password = 'password_example'; # [string] The password for login in clear text

eval { 
    my $result = $api->login_user(username => $username, password => $password);
};
if ($@) {
    warn "Exception when calling login_user: $@\n";
}

Parameters

Name	Type	Description	Notes
username	string	The user name for login	[optional]
password	string	The password for login in clear text	[optional]

Return type

string

HTTP headers

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

Authentication scheme

No authentiation required

logout_user

logout_user()

Logs out current logged in user session

Example

my $api = WWW::SwaggerClient::UserApi->new();

eval { 
    $api->logout_user();
};
if ($@) {
    warn "Exception when calling logout_user: $@\n";
}

Parameters

Name	Type	Description	Notes

Return type

void (empty response body)

HTTP headers

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

Authentication scheme

No authentiation required

get_user_by_name

User get_user_by_name(username => $username)

Get user by user name

Example

my $api = WWW::SwaggerClient::UserApi->new();
my $username = 'username_example'; # [string] The name that needs to be fetched. Use user1 for testing.

eval { 
    my $result = $api->get_user_by_name(username => $username);
};
if ($@) {
    warn "Exception when calling get_user_by_name: $@\n";
}

Parameters

Name	Type	Description	Notes
username	string	The name that needs to be fetched. Use user1 for testing.

Return type

User

HTTP headers

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

Authentication scheme

No authentiation required

update_user

update_user(username => $username, body => $body)

Updated user

This can only be done by the logged in user.

Example

my $api = WWW::SwaggerClient::UserApi->new();
my $username = 'username_example'; # [string] name that need to be deleted
my $body = WWW::SwaggerClient::Object::User->new(); # [User] Updated user object

eval { 
    $api->update_user(username => $username, body => $body);
};
if ($@) {
    warn "Exception when calling update_user: $@\n";
}

Parameters

Name	Type	Description	Notes
username	string	name that need to be deleted
body	User	Updated user object	[optional]

Return type

void (empty response body)

HTTP headers

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

Authentication scheme

No authentiation required

delete_user

delete_user(username => $username)

Delete user

This can only be done by the logged in user.

Example

my $api = WWW::SwaggerClient::UserApi->new();
my $username = 'username_example'; # [string] The name that needs to be deleted

eval { 
    $api->delete_user(username => $username);
};
if ($@) {
    warn "Exception when calling delete_user: $@\n";
}

Parameters

Name	Type	Description	Notes
username	string	The name that needs to be deleted

Return type

void (empty response body)

HTTP headers

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

Authentication scheme

No authentiation required