C# Class IO.Swagger.Api.UserApi

Represents a collection of functions to interact with the API endpoints
Inheritance: IUserApi
Show file Open project: QualityUnit/swagger-codegen Class Usage Examples

Public Methods

Method Description
CreateUser ( User body ) : void

Create user This can only be done by the logged in user.

CreateUserAsync ( User body ) : System.Threading.Tasks.Task

Create user This can only be done by the logged in user.

CreateUserAsyncWithHttpInfo ( User body ) : System.Threading.Tasks.Task>

Create user This can only be done by the logged in user.

CreateUserWithHttpInfo ( User body ) : ApiResponse

Create user This can only be done by the logged in user.

CreateUsersWithArrayInput ( List body ) : void

Creates list of users with given input array

CreateUsersWithArrayInputAsync ( List body ) : System.Threading.Tasks.Task

Creates list of users with given input array

CreateUsersWithArrayInputAsyncWithHttpInfo ( List body ) : System.Threading.Tasks.Task>

Creates list of users with given input array

CreateUsersWithArrayInputWithHttpInfo ( List body ) : ApiResponse

Creates list of users with given input array

CreateUsersWithListInput ( List body ) : void

Creates list of users with given input array

CreateUsersWithListInputAsync ( List body ) : System.Threading.Tasks.Task

Creates list of users with given input array

CreateUsersWithListInputAsyncWithHttpInfo ( List body ) : System.Threading.Tasks.Task>

Creates list of users with given input array

CreateUsersWithListInputWithHttpInfo ( List body ) : ApiResponse

Creates list of users with given input array

DeleteUser ( string username ) : void

Delete user This can only be done by the logged in user.

DeleteUserAsync ( string username ) : System.Threading.Tasks.Task

Delete user This can only be done by the logged in user.

DeleteUserAsyncWithHttpInfo ( string username ) : System.Threading.Tasks.Task>

Delete user This can only be done by the logged in user.

DeleteUserWithHttpInfo ( string username ) : ApiResponse

Delete user This can only be done by the logged in user.

GetBasePath ( ) : String

Gets the base path of the API client.

GetUserByName ( string username ) : User

Get user by user name

GetUserByNameAsync ( string username ) : System.Threading.Tasks.Task

Get user by user name

GetUserByNameAsyncWithHttpInfo ( string username ) : System.Threading.Tasks.Task>

Get user by user name

GetUserByNameWithHttpInfo ( string username ) : ApiResponse

Get user by user name

LoginUser ( string username, string password ) : string

Logs user into the system

LoginUserAsync ( string username, string password ) : System.Threading.Tasks.Task

Logs user into the system

LoginUserAsyncWithHttpInfo ( string username, string password ) : System.Threading.Tasks.Task>

Logs user into the system

LoginUserWithHttpInfo ( string username, string password ) : ApiResponse

Logs user into the system

LogoutUser ( ) : void

Logs out current logged in user session

LogoutUserAsync ( ) : System.Threading.Tasks.Task

Logs out current logged in user session

LogoutUserAsyncWithHttpInfo ( ) : System.Threading.Tasks.Task>

Logs out current logged in user session

LogoutUserWithHttpInfo ( ) : ApiResponse

Logs out current logged in user session

UpdateUser ( string username, User body ) : void

Updated user This can only be done by the logged in user.

UpdateUserAsync ( string username, User body ) : System.Threading.Tasks.Task

Updated user This can only be done by the logged in user.

UpdateUserAsyncWithHttpInfo ( string username, User body ) : System.Threading.Tasks.Task>

Updated user This can only be done by the logged in user.

UpdateUserWithHttpInfo ( string username, User body ) : ApiResponse

Updated user This can only be done by the logged in user.

UserApi ( Configuration configuration = null ) : System

Initializes a new instance of the UserApi class using Configuration object

UserApi ( String basePath ) : System

Initializes a new instance of the UserApi class.

Private Methods

Method Description
AddDefaultHeader ( string key, string value ) : void
DefaultHeader ( ) : String>.Dictionary
SetBasePath ( String basePath ) : void

Method Details

CreateUser() public method

Create user This can only be done by the logged in user.
Thrown when fails to make API call
public CreateUser ( User body ) : void
body IO.Swagger.Model.User Created user object
return void

CreateUserAsync() public method

Create user This can only be done by the logged in user.
Thrown when fails to make API call
public CreateUserAsync ( User body ) : System.Threading.Tasks.Task
body IO.Swagger.Model.User Created user object
return System.Threading.Tasks.Task

CreateUserAsyncWithHttpInfo() public method

Create user This can only be done by the logged in user.
Thrown when fails to make API call
public CreateUserAsyncWithHttpInfo ( User body ) : System.Threading.Tasks.Task>
body IO.Swagger.Model.User Created user object
return System.Threading.Tasks.Task>

CreateUserWithHttpInfo() public method

Create user This can only be done by the logged in user.
Thrown when fails to make API call
public CreateUserWithHttpInfo ( User body ) : ApiResponse
body IO.Swagger.Model.User Created user object
return ApiResponse

CreateUsersWithArrayInput() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithArrayInput ( List body ) : void
body List List of user object
return void

CreateUsersWithArrayInputAsync() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithArrayInputAsync ( List body ) : System.Threading.Tasks.Task
body List List of user object
return System.Threading.Tasks.Task

CreateUsersWithArrayInputAsyncWithHttpInfo() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithArrayInputAsyncWithHttpInfo ( List body ) : System.Threading.Tasks.Task>
body List List of user object
return System.Threading.Tasks.Task>

CreateUsersWithArrayInputWithHttpInfo() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithArrayInputWithHttpInfo ( List body ) : ApiResponse
body List List of user object
return ApiResponse

CreateUsersWithListInput() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithListInput ( List body ) : void
body List List of user object
return void

CreateUsersWithListInputAsync() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithListInputAsync ( List body ) : System.Threading.Tasks.Task
body List List of user object
return System.Threading.Tasks.Task

CreateUsersWithListInputAsyncWithHttpInfo() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithListInputAsyncWithHttpInfo ( List body ) : System.Threading.Tasks.Task>
body List List of user object
return System.Threading.Tasks.Task>

CreateUsersWithListInputWithHttpInfo() public method

Creates list of users with given input array
Thrown when fails to make API call
public CreateUsersWithListInputWithHttpInfo ( List body ) : ApiResponse
body List List of user object
return ApiResponse

DeleteUser() public method

Delete user This can only be done by the logged in user.
Thrown when fails to make API call
public DeleteUser ( string username ) : void
username string The name that needs to be deleted
return void

DeleteUserAsync() public method

Delete user This can only be done by the logged in user.
Thrown when fails to make API call
public DeleteUserAsync ( string username ) : System.Threading.Tasks.Task
username string The name that needs to be deleted
return System.Threading.Tasks.Task

DeleteUserAsyncWithHttpInfo() public method

Delete user This can only be done by the logged in user.
Thrown when fails to make API call
public DeleteUserAsyncWithHttpInfo ( string username ) : System.Threading.Tasks.Task>
username string The name that needs to be deleted
return System.Threading.Tasks.Task>

DeleteUserWithHttpInfo() public method

Delete user This can only be done by the logged in user.
Thrown when fails to make API call
public DeleteUserWithHttpInfo ( string username ) : ApiResponse
username string The name that needs to be deleted
return ApiResponse

GetBasePath() public method

Gets the base path of the API client.
public GetBasePath ( ) : String
return String

GetUserByName() public method

Get user by user name
Thrown when fails to make API call
public GetUserByName ( string username ) : User
username string The name that needs to be fetched. Use user1 for testing.
return IO.Swagger.Model.User

GetUserByNameAsync() public method

Get user by user name
Thrown when fails to make API call
public GetUserByNameAsync ( string username ) : System.Threading.Tasks.Task
username string The name that needs to be fetched. Use user1 for testing.
return System.Threading.Tasks.Task

GetUserByNameAsyncWithHttpInfo() public method

Get user by user name
Thrown when fails to make API call
public GetUserByNameAsyncWithHttpInfo ( string username ) : System.Threading.Tasks.Task>
username string The name that needs to be fetched. Use user1 for testing.
return System.Threading.Tasks.Task>

GetUserByNameWithHttpInfo() public method

Get user by user name
Thrown when fails to make API call
public GetUserByNameWithHttpInfo ( string username ) : ApiResponse
username string The name that needs to be fetched. Use user1 for testing.
return ApiResponse

LoginUser() public method

Logs user into the system
Thrown when fails to make API call
public LoginUser ( string username, string password ) : string
username string The user name for login
password string The password for login in clear text
return string

LoginUserAsync() public method

Logs user into the system
Thrown when fails to make API call
public LoginUserAsync ( string username, string password ) : System.Threading.Tasks.Task
username string The user name for login
password string The password for login in clear text
return System.Threading.Tasks.Task

LoginUserAsyncWithHttpInfo() public method

Logs user into the system
Thrown when fails to make API call
public LoginUserAsyncWithHttpInfo ( string username, string password ) : System.Threading.Tasks.Task>
username string The user name for login
password string The password for login in clear text
return System.Threading.Tasks.Task>

LoginUserWithHttpInfo() public method

Logs user into the system
Thrown when fails to make API call
public LoginUserWithHttpInfo ( string username, string password ) : ApiResponse
username string The user name for login
password string The password for login in clear text
return ApiResponse

LogoutUser() public method

Logs out current logged in user session
Thrown when fails to make API call
public LogoutUser ( ) : void
return void

LogoutUserAsync() public method

Logs out current logged in user session
Thrown when fails to make API call
public LogoutUserAsync ( ) : System.Threading.Tasks.Task
return System.Threading.Tasks.Task

LogoutUserAsyncWithHttpInfo() public method

Logs out current logged in user session
Thrown when fails to make API call
public LogoutUserAsyncWithHttpInfo ( ) : System.Threading.Tasks.Task>
return System.Threading.Tasks.Task>

LogoutUserWithHttpInfo() public method

Logs out current logged in user session
Thrown when fails to make API call
public LogoutUserWithHttpInfo ( ) : ApiResponse
return ApiResponse

UpdateUser() public method

Updated user This can only be done by the logged in user.
Thrown when fails to make API call
public UpdateUser ( string username, User body ) : void
username string name that need to be deleted
body IO.Swagger.Model.User Updated user object
return void

UpdateUserAsync() public method

Updated user This can only be done by the logged in user.
Thrown when fails to make API call
public UpdateUserAsync ( string username, User body ) : System.Threading.Tasks.Task
username string name that need to be deleted
body IO.Swagger.Model.User Updated user object
return System.Threading.Tasks.Task

UpdateUserAsyncWithHttpInfo() public method

Updated user This can only be done by the logged in user.
Thrown when fails to make API call
public UpdateUserAsyncWithHttpInfo ( string username, User body ) : System.Threading.Tasks.Task>
username string name that need to be deleted
body IO.Swagger.Model.User Updated user object
return System.Threading.Tasks.Task>

UpdateUserWithHttpInfo() public method

Updated user This can only be done by the logged in user.
Thrown when fails to make API call
public UpdateUserWithHttpInfo ( string username, User body ) : ApiResponse
username string name that need to be deleted
body IO.Swagger.Model.User Updated user object
return ApiResponse

UserApi() public method

Initializes a new instance of the UserApi class using Configuration object
public UserApi ( Configuration configuration = null ) : System
configuration IO.Swagger.Client.Configuration An instance of Configuration
return System

UserApi() public method

Initializes a new instance of the UserApi class.
public UserApi ( String basePath ) : System
basePath String
return System