openapi-generator/samples/client/petstore/dart/openapi-browser-client/docs/UserApi.md

openapi.api.UserApi

Load the API package

import 'package:openapi/api.dart';

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

Method	HTTP request	Description
createUser	POST /user	Create user
createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
deleteUser	DELETE /user/{username}	Delete user
getUserByName	GET /user/{username}	Get user by user name
loginUser	GET /user/login	Logs user into the system
logoutUser	GET /user/logout	Logs out current logged in user session
updateUser	PUT /user/{username}	Updated user

createUser

createUser(user)

Create user

This can only be done by the logged in user.

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();
var user = new User(); // User | Created user object

try { 
    api_instance.createUser(user);
} catch (e) {
    print("Exception when calling UserApi->createUser: $e\n");
}

Parameters

Name	Type	Description	Notes
user	User	Created user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

createUsersWithArrayInput

createUsersWithArrayInput(user)

Creates list of users with given input array

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();
var user = [new List&lt;User&gt;()]; // List<User> | List of user object

try { 
    api_instance.createUsersWithArrayInput(user);
} catch (e) {
    print("Exception when calling UserApi->createUsersWithArrayInput: $e\n");
}

Parameters

Name	Type	Description	Notes
user	List<User>	List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

createUsersWithListInput

createUsersWithListInput(user)

Creates list of users with given input array

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();
var user = [new List&lt;User&gt;()]; // List<User> | List of user object

try { 
    api_instance.createUsersWithListInput(user);
} catch (e) {
    print("Exception when calling UserApi->createUsersWithListInput: $e\n");
}

Parameters

Name	Type	Description	Notes
user	List<User>	List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

deleteUser

deleteUser(username)

Delete user

This can only be done by the logged in user.

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();
var username = username_example; // String | The name that needs to be deleted

try { 
    api_instance.deleteUser(username);
} catch (e) {
    print("Exception when calling UserApi->deleteUser: $e\n");
}

Parameters

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

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getUserByName

User getUserByName(username)

Get user by user name

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();
var username = username_example; // String | The name that needs to be fetched. Use user1 for testing.

try { 
    var result = api_instance.getUserByName(username);
    print(result);
} catch (e) {
    print("Exception when calling UserApi->getUserByName: $e\n");
}

Parameters

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

Return type

User

Authorization

No authorization required

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]

loginUser

String loginUser(username, password)

Logs user into the system

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();
var username = username_example; // String | The user name for login
var password = password_example; // String | The password for login in clear text

try { 
    var result = api_instance.loginUser(username, password);
    print(result);
} catch (e) {
    print("Exception when calling UserApi->loginUser: $e\n");
}

Parameters

Name	Type	Description	Notes
username	String	The user name for login
password	String	The password for login in clear text

Return type

String

Authorization

No authorization required

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]

logoutUser

logoutUser()

Logs out current logged in user session

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();

try { 
    api_instance.logoutUser();
} catch (e) {
    print("Exception when calling UserApi->logoutUser: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

updateUser

updateUser(username, user)

Updated user

This can only be done by the logged in user.

Example

import 'package:openapi/api.dart';

var api_instance = new UserApi();
var username = username_example; // String | name that need to be deleted
var user = new User(); // User | Updated user object

try { 
    api_instance.updateUser(username, user);
} catch (e) {
    print("Exception when calling UserApi->updateUser: $e\n");
}

Parameters

Name	Type	Description	Notes
username	String	name that need to be deleted
user	User	Updated user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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