UserApi
in package
UserApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createUser() : void
- Operation createUser
- createUserAsync() : PromiseInterface
- Operation createUserAsync
- createUserAsyncWithHttpInfo() : PromiseInterface
- Operation createUserAsyncWithHttpInfo
- createUserRequest() : Request
- Create request for operation 'createUser'
- createUsersWithArrayInput() : void
- Operation createUsersWithArrayInput
- createUsersWithArrayInputAsync() : PromiseInterface
- Operation createUsersWithArrayInputAsync
- createUsersWithArrayInputAsyncWithHttpInfo() : PromiseInterface
- Operation createUsersWithArrayInputAsyncWithHttpInfo
- createUsersWithArrayInputRequest() : Request
- Create request for operation 'createUsersWithArrayInput'
- createUsersWithArrayInputWithHttpInfo() : array<string|int, mixed>
- Operation createUsersWithArrayInputWithHttpInfo
- createUsersWithListInput() : void
- Operation createUsersWithListInput
- createUsersWithListInputAsync() : PromiseInterface
- Operation createUsersWithListInputAsync
- createUsersWithListInputAsyncWithHttpInfo() : PromiseInterface
- Operation createUsersWithListInputAsyncWithHttpInfo
- createUsersWithListInputRequest() : Request
- Create request for operation 'createUsersWithListInput'
- createUsersWithListInputWithHttpInfo() : array<string|int, mixed>
- Operation createUsersWithListInputWithHttpInfo
- createUserWithHttpInfo() : array<string|int, mixed>
- Operation createUserWithHttpInfo
- deleteUser() : void
- Operation deleteUser
- deleteUserAsync() : PromiseInterface
- Operation deleteUserAsync
- deleteUserAsyncWithHttpInfo() : PromiseInterface
- Operation deleteUserAsyncWithHttpInfo
- deleteUserRequest() : Request
- Create request for operation 'deleteUser'
- deleteUserWithHttpInfo() : array<string|int, mixed>
- Operation deleteUserWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getUserByName() : User
- Operation getUserByName
- getUserByNameAsync() : PromiseInterface
- Operation getUserByNameAsync
- getUserByNameAsyncWithHttpInfo() : PromiseInterface
- Operation getUserByNameAsyncWithHttpInfo
- getUserByNameRequest() : Request
- Create request for operation 'getUserByName'
- getUserByNameWithHttpInfo() : array<string|int, mixed>
- Operation getUserByNameWithHttpInfo
- loginUser() : string
- Operation loginUser
- loginUserAsync() : PromiseInterface
- Operation loginUserAsync
- loginUserAsyncWithHttpInfo() : PromiseInterface
- Operation loginUserAsyncWithHttpInfo
- loginUserRequest() : Request
- Create request for operation 'loginUser'
- loginUserWithHttpInfo() : array<string|int, mixed>
- Operation loginUserWithHttpInfo
- logoutUser() : void
- Operation logoutUser
- logoutUserAsync() : PromiseInterface
- Operation logoutUserAsync
- logoutUserAsyncWithHttpInfo() : PromiseInterface
- Operation logoutUserAsyncWithHttpInfo
- logoutUserRequest() : Request
- Create request for operation 'logoutUser'
- logoutUserWithHttpInfo() : array<string|int, mixed>
- Operation logoutUserWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateUser() : void
- Operation updateUser
- updateUserAsync() : PromiseInterface
- Operation updateUserAsync
- updateUserAsyncWithHttpInfo() : PromiseInterface
- Operation updateUserAsyncWithHttpInfo
- updateUserRequest() : Request
- Create request for operation 'updateUser'
- updateUserWithHttpInfo() : array<string|int, mixed>
- Operation updateUserWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Properties
$client
protected
ClientInterface
$client
Tags
$config
protected
Configuration
$config
Tags
$headerSelector
protected
HeaderSelector
$headerSelector
Tags
$hostIndex
protected
int
$hostIndex
Host index
Tags
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int = 0
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Tags
Return values
mixed —createUser()
Operation createUser
public
createUser(User $user) : void
Create user
Parameters
- $user : User
-
Created user object (required)
Tags
Return values
void —createUserAsync()
Operation createUserAsync
public
createUserAsync(User $user) : PromiseInterface
Create user
Parameters
- $user : User
-
Created user object (required)
Tags
Return values
PromiseInterface —createUserAsyncWithHttpInfo()
Operation createUserAsyncWithHttpInfo
public
createUserAsyncWithHttpInfo(User $user) : PromiseInterface
Create user
Parameters
- $user : User
-
Created user object (required)
Tags
Return values
PromiseInterface —createUserRequest()
Create request for operation 'createUser'
public
createUserRequest(User $user) : Request
Parameters
- $user : User
-
Created user object (required)
Tags
Return values
Request —createUsersWithArrayInput()
Operation createUsersWithArrayInput
public
createUsersWithArrayInput(array<string|int, User> $user) : void
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
void —createUsersWithArrayInputAsync()
Operation createUsersWithArrayInputAsync
public
createUsersWithArrayInputAsync(array<string|int, User> $user) : PromiseInterface
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
PromiseInterface —createUsersWithArrayInputAsyncWithHttpInfo()
Operation createUsersWithArrayInputAsyncWithHttpInfo
public
createUsersWithArrayInputAsyncWithHttpInfo(array<string|int, User> $user) : PromiseInterface
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
PromiseInterface —createUsersWithArrayInputRequest()
Create request for operation 'createUsersWithArrayInput'
public
createUsersWithArrayInputRequest(array<string|int, User> $user) : Request
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
Request —createUsersWithArrayInputWithHttpInfo()
Operation createUsersWithArrayInputWithHttpInfo
public
createUsersWithArrayInputWithHttpInfo(array<string|int, User> $user) : array<string|int, mixed>
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
createUsersWithListInput()
Operation createUsersWithListInput
public
createUsersWithListInput(array<string|int, User> $user) : void
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
void —createUsersWithListInputAsync()
Operation createUsersWithListInputAsync
public
createUsersWithListInputAsync(array<string|int, User> $user) : PromiseInterface
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
PromiseInterface —createUsersWithListInputAsyncWithHttpInfo()
Operation createUsersWithListInputAsyncWithHttpInfo
public
createUsersWithListInputAsyncWithHttpInfo(array<string|int, User> $user) : PromiseInterface
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
PromiseInterface —createUsersWithListInputRequest()
Create request for operation 'createUsersWithListInput'
public
createUsersWithListInputRequest(array<string|int, User> $user) : Request
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
Request —createUsersWithListInputWithHttpInfo()
Operation createUsersWithListInputWithHttpInfo
public
createUsersWithListInputWithHttpInfo(array<string|int, User> $user) : array<string|int, mixed>
Creates list of users with given input array
Parameters
- $user : array<string|int, User>
-
List of user object (required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
createUserWithHttpInfo()
Operation createUserWithHttpInfo
public
createUserWithHttpInfo(User $user) : array<string|int, mixed>
Create user
Parameters
- $user : User
-
Created user object (required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteUser()
Operation deleteUser
public
deleteUser(string $username) : void
Delete user
Parameters
- $username : string
-
The name that needs to be deleted (required)
Tags
Return values
void —deleteUserAsync()
Operation deleteUserAsync
public
deleteUserAsync(string $username) : PromiseInterface
Delete user
Parameters
- $username : string
-
The name that needs to be deleted (required)
Tags
Return values
PromiseInterface —deleteUserAsyncWithHttpInfo()
Operation deleteUserAsyncWithHttpInfo
public
deleteUserAsyncWithHttpInfo(string $username) : PromiseInterface
Delete user
Parameters
- $username : string
-
The name that needs to be deleted (required)
Tags
Return values
PromiseInterface —deleteUserRequest()
Create request for operation 'deleteUser'
public
deleteUserRequest(string $username) : Request
Parameters
- $username : string
-
The name that needs to be deleted (required)
Tags
Return values
Request —deleteUserWithHttpInfo()
Operation deleteUserWithHttpInfo
public
deleteUserWithHttpInfo(string $username) : array<string|int, mixed>
Delete user
Parameters
- $username : string
-
The name that needs to be deleted (required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Tags
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Tags
Return values
int —Host index
getUserByName()
Operation getUserByName
public
getUserByName(string $username) : User
Get user by user name
Parameters
- $username : string
-
The name that needs to be fetched. Use user1 for testing. (required)
Tags
Return values
User —getUserByNameAsync()
Operation getUserByNameAsync
public
getUserByNameAsync(string $username) : PromiseInterface
Get user by user name
Parameters
- $username : string
-
The name that needs to be fetched. Use user1 for testing. (required)
Tags
Return values
PromiseInterface —getUserByNameAsyncWithHttpInfo()
Operation getUserByNameAsyncWithHttpInfo
public
getUserByNameAsyncWithHttpInfo(string $username) : PromiseInterface
Get user by user name
Parameters
- $username : string
-
The name that needs to be fetched. Use user1 for testing. (required)
Tags
Return values
PromiseInterface —getUserByNameRequest()
Create request for operation 'getUserByName'
public
getUserByNameRequest(string $username) : Request
Parameters
- $username : string
-
The name that needs to be fetched. Use user1 for testing. (required)
Tags
Return values
Request —getUserByNameWithHttpInfo()
Operation getUserByNameWithHttpInfo
public
getUserByNameWithHttpInfo(string $username) : array<string|int, mixed>
Get user by user name
Parameters
- $username : string
-
The name that needs to be fetched. Use user1 for testing. (required)
Tags
Return values
array<string|int, mixed> —of \Ally\PetStore\Schema\User, HTTP status code, HTTP response headers (array of strings)
loginUser()
Operation loginUser
public
loginUser(string $username, string $password) : string
Logs user into the system
Parameters
- $username : string
-
The user name for login (required)
- $password : string
-
The password for login in clear text (required)
Tags
Return values
string —loginUserAsync()
Operation loginUserAsync
public
loginUserAsync(string $username, string $password) : PromiseInterface
Logs user into the system
Parameters
- $username : string
-
The user name for login (required)
- $password : string
-
The password for login in clear text (required)
Tags
Return values
PromiseInterface —loginUserAsyncWithHttpInfo()
Operation loginUserAsyncWithHttpInfo
public
loginUserAsyncWithHttpInfo(string $username, string $password) : PromiseInterface
Logs user into the system
Parameters
- $username : string
-
The user name for login (required)
- $password : string
-
The password for login in clear text (required)
Tags
Return values
PromiseInterface —loginUserRequest()
Create request for operation 'loginUser'
public
loginUserRequest(string $username, string $password) : Request
Parameters
- $username : string
-
The user name for login (required)
- $password : string
-
The password for login in clear text (required)
Tags
Return values
Request —loginUserWithHttpInfo()
Operation loginUserWithHttpInfo
public
loginUserWithHttpInfo(string $username, string $password) : array<string|int, mixed>
Logs user into the system
Parameters
- $username : string
-
The user name for login (required)
- $password : string
-
The password for login in clear text (required)
Tags
Return values
array<string|int, mixed> —of string, HTTP status code, HTTP response headers (array of strings)
logoutUser()
Operation logoutUser
public
logoutUser() : void
Logs out current logged in user session
Tags
Return values
void —logoutUserAsync()
Operation logoutUserAsync
public
logoutUserAsync() : PromiseInterface
Logs out current logged in user session
Tags
Return values
PromiseInterface —logoutUserAsyncWithHttpInfo()
Operation logoutUserAsyncWithHttpInfo
public
logoutUserAsyncWithHttpInfo() : PromiseInterface
Logs out current logged in user session
Tags
Return values
PromiseInterface —logoutUserRequest()
Create request for operation 'logoutUser'
public
logoutUserRequest() : Request
Tags
Return values
Request —logoutUserWithHttpInfo()
Operation logoutUserWithHttpInfo
public
logoutUserWithHttpInfo() : array<string|int, mixed>
Logs out current logged in user session
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Tags
Return values
void —updateUser()
Operation updateUser
public
updateUser(string $username, User $user) : void
Updated user
Parameters
- $username : string
-
name that need to be deleted (required)
- $user : User
-
Updated user object (required)
Tags
Return values
void —updateUserAsync()
Operation updateUserAsync
public
updateUserAsync(string $username, User $user) : PromiseInterface
Updated user
Parameters
- $username : string
-
name that need to be deleted (required)
- $user : User
-
Updated user object (required)
Tags
Return values
PromiseInterface —updateUserAsyncWithHttpInfo()
Operation updateUserAsyncWithHttpInfo
public
updateUserAsyncWithHttpInfo(string $username, User $user) : PromiseInterface
Updated user
Parameters
- $username : string
-
name that need to be deleted (required)
- $user : User
-
Updated user object (required)
Tags
Return values
PromiseInterface —updateUserRequest()
Create request for operation 'updateUser'
public
updateUserRequest(string $username, User $user) : Request
Parameters
- $username : string
-
name that need to be deleted (required)
- $user : User
-
Updated user object (required)
Tags
Return values
Request —updateUserWithHttpInfo()
Operation updateUserWithHttpInfo
public
updateUserWithHttpInfo(string $username, User $user) : array<string|int, mixed>
Updated user
Parameters
- $username : string
-
name that need to be deleted (required)
- $user : User
-
Updated user object (required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options