1. class
  2. Ally
  3. \
  4. PetStore
  5. \
  6. Api
  7. \
  8. UserApi

UserApi

class UserApi

UserApi Class Doc Comment

Properties

protected ClientInterface $client
protected Configuration $config
protected HeaderSelector $headerSelector
protected int $hostIndex

Methods

__construct(ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null, int $hostIndex = 0)

No description

void
setHostIndex(int $hostIndex)

Set the host index

int
getHostIndex()

Get the host index

Configuration
getConfig()

No description

void
createUser(User $user)

Operation createUser

array
createUserWithHttpInfo(User $user)

Operation createUserWithHttpInfo

PromiseInterface
createUserAsync(User $user)

Operation createUserAsync

PromiseInterface
createUserAsyncWithHttpInfo(User $user)

Operation createUserAsyncWithHttpInfo

Request
createUserRequest(User $user)

Create request for operation 'createUser'

void
createUsersWithArrayInput(User[] $user)

Operation createUsersWithArrayInput

array
createUsersWithArrayInputWithHttpInfo(User[] $user)

Operation createUsersWithArrayInputWithHttpInfo

PromiseInterface
createUsersWithArrayInputAsync(User[] $user)

Operation createUsersWithArrayInputAsync

PromiseInterface
createUsersWithArrayInputAsyncWithHttpInfo(User[] $user)

Operation createUsersWithArrayInputAsyncWithHttpInfo

Request
createUsersWithArrayInputRequest(User[] $user)

Create request for operation 'createUsersWithArrayInput'

void
createUsersWithListInput(User[] $user)

Operation createUsersWithListInput

array
createUsersWithListInputWithHttpInfo(User[] $user)

Operation createUsersWithListInputWithHttpInfo

PromiseInterface
createUsersWithListInputAsync(User[] $user)

Operation createUsersWithListInputAsync

PromiseInterface
createUsersWithListInputAsyncWithHttpInfo(User[] $user)

Operation createUsersWithListInputAsyncWithHttpInfo

Request
createUsersWithListInputRequest(User[] $user)

Create request for operation 'createUsersWithListInput'

void
deleteUser(string $username)

Operation deleteUser

array
deleteUserWithHttpInfo(string $username)

Operation deleteUserWithHttpInfo

PromiseInterface
deleteUserAsync(string $username)

Operation deleteUserAsync

PromiseInterface
deleteUserAsyncWithHttpInfo(string $username)

Operation deleteUserAsyncWithHttpInfo

Request
deleteUserRequest(string $username)

Create request for operation 'deleteUser'

User
getUserByName(string $username)

Operation getUserByName

array
getUserByNameWithHttpInfo(string $username)

Operation getUserByNameWithHttpInfo

PromiseInterface
getUserByNameAsync(string $username)

Operation getUserByNameAsync

PromiseInterface
getUserByNameAsyncWithHttpInfo(string $username)

Operation getUserByNameAsyncWithHttpInfo

Request
getUserByNameRequest(string $username)

Create request for operation 'getUserByName'

string
loginUser(string $username, string $password)

Operation loginUser

array
loginUserWithHttpInfo(string $username, string $password)

Operation loginUserWithHttpInfo

PromiseInterface
loginUserAsync(string $username, string $password)

Operation loginUserAsync

PromiseInterface
loginUserAsyncWithHttpInfo(string $username, string $password)

Operation loginUserAsyncWithHttpInfo

Request
loginUserRequest(string $username, string $password)

Create request for operation 'loginUser'

void
logoutUser()

Operation logoutUser

array
logoutUserWithHttpInfo()

Operation logoutUserWithHttpInfo

PromiseInterface
logoutUserAsync()

Operation logoutUserAsync

PromiseInterface
logoutUserAsyncWithHttpInfo()

Operation logoutUserAsyncWithHttpInfo

Request
logoutUserRequest()

Create request for operation 'logoutUser'

void
updateUser(string $username, User $user)

Operation updateUser

array
updateUserWithHttpInfo(string $username, User $user)

Operation updateUserWithHttpInfo

PromiseInterface
updateUserAsync(string $username, User $user)

Operation updateUserAsync

PromiseInterface
updateUserAsyncWithHttpInfo(string $username, User $user)

Operation updateUserAsyncWithHttpInfo

Request
updateUserRequest(string $username, User $user)

Create request for operation 'updateUser'

array
createHttpClientOption()

Create http client option

Details

at line 78
__construct(ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null, int $hostIndex = 0)

No description

Parameters

ClientInterface $client
Configuration $config
HeaderSelector $selector
int $hostIndex

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

at line 95
void setHostIndex(int $hostIndex)

Set the host index

Parameters

int $hostIndex

Host index (required)

Return Value

void

at line 105
int getHostIndex()

Get the host index

Return Value

int

Host index

at line 113
Configuration getConfig()

No description

Return Value

Configuration

at line 129
void createUser(User $user)

Operation createUser

Create user

Parameters

User $user

Created user object (required)

Return Value

void

Exceptions

ApiException
InvalidArgumentException

at line 145
array createUserWithHttpInfo(User $user)

Operation createUserWithHttpInfo

Create user

Parameters

User $user

Created user object (required)

Return Value

array

of null, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 203
PromiseInterface createUserAsync(User $user)

Operation createUserAsync

Create user

Parameters

User $user

Created user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 223
PromiseInterface createUserAsyncWithHttpInfo(User $user)

Operation createUserAsyncWithHttpInfo

Create user

Parameters

User $user

Created user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 259
Request createUserRequest(User $user)

Create request for operation 'createUser'

Parameters

User $user

Created user object (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 360
void createUsersWithArrayInput(User[] $user)

Operation createUsersWithArrayInput

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

void

Exceptions

ApiException
InvalidArgumentException

at line 376
array createUsersWithArrayInputWithHttpInfo(User[] $user)

Operation createUsersWithArrayInputWithHttpInfo

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

array

of null, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 434
PromiseInterface createUsersWithArrayInputAsync(User[] $user)

Operation createUsersWithArrayInputAsync

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 454
PromiseInterface createUsersWithArrayInputAsyncWithHttpInfo(User[] $user)

Operation createUsersWithArrayInputAsyncWithHttpInfo

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 490
Request createUsersWithArrayInputRequest(User[] $user)

Create request for operation 'createUsersWithArrayInput'

Parameters

User[] $user

List of user object (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 591
void createUsersWithListInput(User[] $user)

Operation createUsersWithListInput

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

void

Exceptions

ApiException
InvalidArgumentException

at line 607
array createUsersWithListInputWithHttpInfo(User[] $user)

Operation createUsersWithListInputWithHttpInfo

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

array

of null, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 665
PromiseInterface createUsersWithListInputAsync(User[] $user)

Operation createUsersWithListInputAsync

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 685
PromiseInterface createUsersWithListInputAsyncWithHttpInfo(User[] $user)

Operation createUsersWithListInputAsyncWithHttpInfo

Creates list of users with given input array

Parameters

User[] $user

List of user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 721
Request createUsersWithListInputRequest(User[] $user)

Create request for operation 'createUsersWithListInput'

Parameters

User[] $user

List of user object (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 822
void deleteUser(string $username)

Operation deleteUser

Delete user

Parameters

string $username

The name that needs to be deleted (required)

Return Value

void

Exceptions

ApiException
InvalidArgumentException

at line 838
array deleteUserWithHttpInfo(string $username)

Operation deleteUserWithHttpInfo

Delete user

Parameters

string $username

The name that needs to be deleted (required)

Return Value

array

of null, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 896
PromiseInterface deleteUserAsync(string $username)

Operation deleteUserAsync

Delete user

Parameters

string $username

The name that needs to be deleted (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 916
PromiseInterface deleteUserAsyncWithHttpInfo(string $username)

Operation deleteUserAsyncWithHttpInfo

Delete user

Parameters

string $username

The name that needs to be deleted (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 952
Request deleteUserRequest(string $username)

Create request for operation 'deleteUser'

Parameters

string $username

The name that needs to be deleted (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 1055
User getUserByName(string $username)

Operation getUserByName

Get user by user name

Parameters

string $username

The name that needs to be fetched. Use user1 for testing. (required)

Return Value

User

Exceptions

ApiException
InvalidArgumentException

at line 1072
array getUserByNameWithHttpInfo(string $username)

Operation getUserByNameWithHttpInfo

Get user by user name

Parameters

string $username

The name that needs to be fetched. Use user1 for testing. (required)

Return Value

array

of \Ally\PetStore\Schema\User, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 1170
PromiseInterface getUserByNameAsync(string $username)

Operation getUserByNameAsync

Get user by user name

Parameters

string $username

The name that needs to be fetched. Use user1 for testing. (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1190
PromiseInterface getUserByNameAsyncWithHttpInfo(string $username)

Operation getUserByNameAsyncWithHttpInfo

Get user by user name

Parameters

string $username

The name that needs to be fetched. Use user1 for testing. (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1239
Request getUserByNameRequest(string $username)

Create request for operation 'getUserByName'

Parameters

string $username

The name that needs to be fetched. Use user1 for testing. (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 1338
string loginUser(string $username, string $password)

Operation loginUser

Logs user into the system

Parameters

string $username

The user name for login (required)
string $password

The password for login in clear text (required)

Return Value

string

Exceptions

ApiException
InvalidArgumentException

at line 1356
array loginUserWithHttpInfo(string $username, string $password)

Operation loginUserWithHttpInfo

Logs user into the system

Parameters

string $username

The user name for login (required)
string $password

The password for login in clear text (required)

Return Value

array

of string, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 1455
PromiseInterface loginUserAsync(string $username, string $password)

Operation loginUserAsync

Logs user into the system

Parameters

string $username

The user name for login (required)
string $password

The password for login in clear text (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1476
PromiseInterface loginUserAsyncWithHttpInfo(string $username, string $password)

Operation loginUserAsyncWithHttpInfo

Logs user into the system

Parameters

string $username

The user name for login (required)
string $password

The password for login in clear text (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1526
Request loginUserRequest(string $username, string $password)

Create request for operation 'loginUser'

Parameters

string $username

The user name for login (required)
string $password

The password for login in clear text (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 1644
void logoutUser()

Operation logoutUser

Logs out current logged in user session

Return Value

void

Exceptions

ApiException
InvalidArgumentException

at line 1659
array logoutUserWithHttpInfo()

Operation logoutUserWithHttpInfo

Logs out current logged in user session

Return Value

array

of null, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 1716
PromiseInterface logoutUserAsync()

Operation logoutUserAsync

Logs out current logged in user session

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1735
PromiseInterface logoutUserAsyncWithHttpInfo()

Operation logoutUserAsyncWithHttpInfo

Logs out current logged in user session

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1770
Request logoutUserRequest()

Create request for operation 'logoutUser'

Return Value

Request

Exceptions

InvalidArgumentException

at line 1859
void updateUser(string $username, User $user)

Operation updateUser

Updated user

Parameters

string $username

name that need to be deleted (required)
User $user

Updated user object (required)

Return Value

void

Exceptions

ApiException
InvalidArgumentException

at line 1876
array updateUserWithHttpInfo(string $username, User $user)

Operation updateUserWithHttpInfo

Updated user

Parameters

string $username

name that need to be deleted (required)
User $user

Updated user object (required)

Return Value

array

of null, HTTP status code, HTTP response headers (array of strings)

Exceptions

ApiException
InvalidArgumentException

at line 1935
PromiseInterface updateUserAsync(string $username, User $user)

Operation updateUserAsync

Updated user

Parameters

string $username

name that need to be deleted (required)
User $user

Updated user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1956
PromiseInterface updateUserAsyncWithHttpInfo(string $username, User $user)

Operation updateUserAsyncWithHttpInfo

Updated user

Parameters

string $username

name that need to be deleted (required)
User $user

Updated user object (required)

Return Value

PromiseInterface

Exceptions

InvalidArgumentException

at line 1993
Request updateUserRequest(string $username, User $user)

Create request for operation 'updateUser'

Parameters

string $username

name that need to be deleted (required)
User $user

Updated user object (required)

Return Value

Request

Exceptions

InvalidArgumentException

at line 2104
protected array createHttpClientOption()

Create http client option

Return Value

array

of http client options

Exceptions

RuntimeException