UserControllerApi
in package
UserControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getEntityAutomations' => ['application/json'], 'getEntityEvents' => ['application/json'], 'getEntityFavorites' => ['application/json'], 'getJsonPropertyAsString' => ['application/json'], 'getUserInfo' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getConfig() : Configuration
- getEntityAutomations() : PageEntityAutomationItems
- Operation getEntityAutomations
- getEntityAutomationsAsync() : PromiseInterface
- Operation getEntityAutomationsAsync
- getEntityAutomationsAsyncWithHttpInfo() : PromiseInterface
- Operation getEntityAutomationsAsyncWithHttpInfo
- getEntityAutomationsRequest() : Request
- Create request for operation 'getEntityAutomations'
- getEntityAutomationsWithHttpInfo() : array<string|int, mixed>
- Operation getEntityAutomationsWithHttpInfo
- getEntityEvents() : PageEntityEventItems
- Operation getEntityEvents
- getEntityEventsAsync() : PromiseInterface
- Operation getEntityEventsAsync
- getEntityEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getEntityEventsAsyncWithHttpInfo
- getEntityEventsRequest() : Request
- Create request for operation 'getEntityEvents'
- getEntityEventsWithHttpInfo() : array<string|int, mixed>
- Operation getEntityEventsWithHttpInfo
- getEntityFavorites() : PageEntityFavouriteItems
- Operation getEntityFavorites
- getEntityFavoritesAsync() : PromiseInterface
- Operation getEntityFavoritesAsync
- getEntityFavoritesAsyncWithHttpInfo() : PromiseInterface
- Operation getEntityFavoritesAsyncWithHttpInfo
- getEntityFavoritesRequest() : Request
- Create request for operation 'getEntityFavorites'
- getEntityFavoritesWithHttpInfo() : array<string|int, mixed>
- Operation getEntityFavoritesWithHttpInfo
- 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
= ['getEntityAutomations' => ['application/json'], 'getEntityEvents' => ['application/json'], 'getEntityFavorites' => ['application/json'], '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 —getEntityAutomations()
Operation getEntityAutomations
public
getEntityAutomations(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : PageEntityAutomationItems
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
PageEntityAutomationItems —getEntityAutomationsAsync()
Operation getEntityAutomationsAsync
public
getEntityAutomationsAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityAutomationsAsyncWithHttpInfo()
Operation getEntityAutomationsAsyncWithHttpInfo
public
getEntityAutomationsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityAutomationsRequest()
Create request for operation 'getEntityAutomations'
public
getEntityAutomationsRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
Request —getEntityAutomationsWithHttpInfo()
Operation getEntityAutomationsWithHttpInfo
public
getEntityAutomationsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEntityAutomationItems, HTTP status code, HTTP response headers (array of strings)
getEntityEvents()
Operation getEntityEvents
public
getEntityEvents(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : PageEntityEventItems
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
PageEntityEventItems —getEntityEventsAsync()
Operation getEntityEventsAsync
public
getEntityEventsAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityEventsAsyncWithHttpInfo()
Operation getEntityEventsAsyncWithHttpInfo
public
getEntityEventsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityEventsRequest()
Create request for operation 'getEntityEvents'
public
getEntityEventsRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
Request —getEntityEventsWithHttpInfo()
Operation getEntityEventsWithHttpInfo
public
getEntityEventsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEntityEventItems, HTTP status code, HTTP response headers (array of strings)
getEntityFavorites()
Operation getEntityFavorites
public
getEntityFavorites(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : PageEntityFavouriteItems
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
PageEntityFavouriteItems —getEntityFavoritesAsync()
Operation getEntityFavoritesAsync
public
getEntityFavoritesAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityFavoritesAsyncWithHttpInfo()
Operation getEntityFavoritesAsyncWithHttpInfo
public
getEntityFavoritesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityFavoritesRequest()
Create request for operation 'getEntityFavorites'
public
getEntityFavoritesRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
Request —getEntityFavoritesWithHttpInfo()
Operation getEntityFavoritesWithHttpInfo
public
getEntityFavoritesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEntityFavouriteItems, HTTP status code, HTTP response headers (array of strings)
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