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