UserControllerApi
in package
UserControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getJsonPropertyAsString' => ['application/json'], 'getUserInfo' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getJsonPropertyAsString() : string
- Operation getJsonPropertyAsString
- getJsonPropertyAsStringAsync() : PromiseInterface
- Operation getJsonPropertyAsStringAsync
- getJsonPropertyAsStringAsyncWithHttpInfo() : PromiseInterface
- Operation getJsonPropertyAsStringAsyncWithHttpInfo
- getJsonPropertyAsStringRequest() : Request
- Create request for operation 'getJsonPropertyAsString'
- getJsonPropertyAsStringWithHttpInfo() : array<string|int, mixed>
- Operation getJsonPropertyAsStringWithHttpInfo
- getUserInfo() : UserInfoDto
- Operation getUserInfo
- getUserInfoAsync() : PromiseInterface
- Operation getUserInfoAsync
- getUserInfoAsyncWithHttpInfo() : PromiseInterface
- Operation getUserInfoAsyncWithHttpInfo
- getUserInfoRequest() : Request
- Create request for operation 'getUserInfo'
- getUserInfoWithHttpInfo() : array<string|int, mixed>
- Operation getUserInfoWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['getJsonPropertyAsString' => ['application/json'], 'getUserInfo' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getJsonPropertyAsString()
Operation getJsonPropertyAsString
public
getJsonPropertyAsString(string $property, object $body[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : string
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $body : object
-
body (required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
string —getJsonPropertyAsStringAsync()
Operation getJsonPropertyAsStringAsync
public
getJsonPropertyAsStringAsync(string $property, object $body[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : PromiseInterface
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $body : object
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getJsonPropertyAsStringAsyncWithHttpInfo()
Operation getJsonPropertyAsStringAsyncWithHttpInfo
public
getJsonPropertyAsStringAsyncWithHttpInfo(string $property, object $body[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : PromiseInterface
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $body : object
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getJsonPropertyAsStringRequest()
Create request for operation 'getJsonPropertyAsString'
public
getJsonPropertyAsStringRequest(string $property, object $body[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : Request
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $body : object
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
Request —getJsonPropertyAsStringWithHttpInfo()
Operation getJsonPropertyAsStringWithHttpInfo
public
getJsonPropertyAsStringWithHttpInfo(string $property, object $body[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : array<string|int, mixed>
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $body : object
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of string, HTTP status code, HTTP response headers (array of strings)
getUserInfo()
Operation getUserInfo
public
getUserInfo([string $contentType = self::contentTypes['getUserInfo'][0] ]) : UserInfoDto
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
UserInfoDto —getUserInfoAsync()
Operation getUserInfoAsync
public
getUserInfoAsync([string $contentType = self::contentTypes['getUserInfo'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUserInfoAsyncWithHttpInfo()
Operation getUserInfoAsyncWithHttpInfo
public
getUserInfoAsyncWithHttpInfo([string $contentType = self::contentTypes['getUserInfo'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUserInfoRequest()
Create request for operation 'getUserInfo'
public
getUserInfoRequest([string $contentType = self::contentTypes['getUserInfo'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
Request —getUserInfoWithHttpInfo()
Operation getUserInfoWithHttpInfo
public
getUserInfoWithHttpInfo([string $contentType = self::contentTypes['getUserInfo'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\UserInfoDto, 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)
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options