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

SwaggerPetstore.UserApi

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(opts)

Create user

This can only be done by the logged in user.

Example

var SwaggerPetstore = require('swagger-petstore');

var apiInstance = new SwaggerPetstore.UserApi()

var opts = { 
  'body': new SwaggerPetstore.User() // {User} Created user object
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUser(opts, callback);

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

createUsersWithArrayInput

createUsersWithArrayInput(opts)

Creates list of users with given input array

Example

var SwaggerPetstore = require('swagger-petstore');

var apiInstance = new SwaggerPetstore.UserApi()

var opts = { 
  'body': [new SwaggerPetstore.User()] // {[User]} List of user object
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUsersWithArrayInput(opts, callback);

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

createUsersWithListInput

createUsersWithListInput(opts)

Creates list of users with given input array

Example

var SwaggerPetstore = require('swagger-petstore');

var apiInstance = new SwaggerPetstore.UserApi()

var opts = { 
  'body': [new SwaggerPetstore.User()] // {[User]} List of user object
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUsersWithListInput(opts, callback);

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

deleteUser

deleteUser(username)

Delete user

This can only be done by the logged in user.

Example

var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;

// Configure HTTP basic authorization: test_http_basic
var test_http_basic = defaultClient.authentications['test_http_basic'];
test_http_basic.username = 'YOUR USERNAME'
test_http_basic.password = 'YOUR PASSWORD'

var apiInstance = new SwaggerPetstore.UserApi()

var username = "username_example"; // {String} The name that needs to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUser(username, callback);

Parameters

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

Return type

null (empty response body)

Authorization

test_http_basic

HTTP request headers

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

getUserByName

User getUserByName(username)

Get user by user name

Example

var SwaggerPetstore = require('swagger-petstore');

var apiInstance = new SwaggerPetstore.UserApi()

var username = "username_example"; // {String} The name that needs to be fetched. Use user1 for testing. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserByName(username, callback);

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/json, application/xml

loginUser

'String' loginUser(opts)

Logs user into the system

Example

var SwaggerPetstore = require('swagger-petstore');

var apiInstance = new SwaggerPetstore.UserApi()

var opts = { 
  'username': "username_example", // {String} The user name for login
  'password': "password_example" // {String} The password for login in clear text
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loginUser(opts, callback);

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'

Authorization

No authorization required

HTTP request headers

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

logoutUser

logoutUser

Logs out current logged in user session

Example

var SwaggerPetstore = require('swagger-petstore');

var apiInstance = new SwaggerPetstore.UserApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.logoutUser(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

updateUser

updateUser(username, opts)

Updated user

This can only be done by the logged in user.

Example

var SwaggerPetstore = require('swagger-petstore');

var apiInstance = new SwaggerPetstore.UserApi()

var username = "username_example"; // {String} name that need to be deleted

var opts = { 
  'body': new SwaggerPetstore.User() // {User} Updated user object
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUser(username, opts, callback);

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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