GuestPortalControllerApi
in package
GuestPortalControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createGuestPortal' => ['application/json'], 'createGuestPortalUser' => ['application/json'], 'getAllGuestPortalUsers' => ['application/json'], 'getGuestPortal' => ['application/json'], 'getGuestPortalUser' => ['application/json'], 'getGuestPortalUserById' => ['application/json'], 'getGuestPortalUsers' => ['application/json'], 'getGuestPortals' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createGuestPortal() : GuestPortalDto
- Operation createGuestPortal
- createGuestPortalAsync() : PromiseInterface
- Operation createGuestPortalAsync
- createGuestPortalAsyncWithHttpInfo() : PromiseInterface
- Operation createGuestPortalAsyncWithHttpInfo
- createGuestPortalRequest() : Request
- Create request for operation 'createGuestPortal'
- createGuestPortalUser() : GuestPortalUserCreateDto
- Operation createGuestPortalUser
- createGuestPortalUserAsync() : PromiseInterface
- Operation createGuestPortalUserAsync
- createGuestPortalUserAsyncWithHttpInfo() : PromiseInterface
- Operation createGuestPortalUserAsyncWithHttpInfo
- createGuestPortalUserRequest() : Request
- Create request for operation 'createGuestPortalUser'
- createGuestPortalUserWithHttpInfo() : array<string|int, mixed>
- Operation createGuestPortalUserWithHttpInfo
- createGuestPortalWithHttpInfo() : array<string|int, mixed>
- Operation createGuestPortalWithHttpInfo
- getAllGuestPortalUsers() : PageGuestPortalUsers
- Operation getAllGuestPortalUsers
- getAllGuestPortalUsersAsync() : PromiseInterface
- Operation getAllGuestPortalUsersAsync
- getAllGuestPortalUsersAsyncWithHttpInfo() : PromiseInterface
- Operation getAllGuestPortalUsersAsyncWithHttpInfo
- getAllGuestPortalUsersRequest() : Request
- Create request for operation 'getAllGuestPortalUsers'
- getAllGuestPortalUsersWithHttpInfo() : array<string|int, mixed>
- Operation getAllGuestPortalUsersWithHttpInfo
- getConfig() : Configuration
- getGuestPortal() : GuestPortalDto
- Operation getGuestPortal
- getGuestPortalAsync() : PromiseInterface
- Operation getGuestPortalAsync
- getGuestPortalAsyncWithHttpInfo() : PromiseInterface
- Operation getGuestPortalAsyncWithHttpInfo
- getGuestPortalRequest() : Request
- Create request for operation 'getGuestPortal'
- getGuestPortals() : array<string|int, GuestPortalDto>
- Operation getGuestPortals
- getGuestPortalsAsync() : PromiseInterface
- Operation getGuestPortalsAsync
- getGuestPortalsAsyncWithHttpInfo() : PromiseInterface
- Operation getGuestPortalsAsyncWithHttpInfo
- getGuestPortalsRequest() : Request
- Create request for operation 'getGuestPortals'
- getGuestPortalsWithHttpInfo() : array<string|int, mixed>
- Operation getGuestPortalsWithHttpInfo
- getGuestPortalUser() : GuestPortalUserDto
- Operation getGuestPortalUser
- getGuestPortalUserAsync() : PromiseInterface
- Operation getGuestPortalUserAsync
- getGuestPortalUserAsyncWithHttpInfo() : PromiseInterface
- Operation getGuestPortalUserAsyncWithHttpInfo
- getGuestPortalUserById() : GuestPortalUserDto
- Operation getGuestPortalUserById
- getGuestPortalUserByIdAsync() : PromiseInterface
- Operation getGuestPortalUserByIdAsync
- getGuestPortalUserByIdAsyncWithHttpInfo() : PromiseInterface
- Operation getGuestPortalUserByIdAsyncWithHttpInfo
- getGuestPortalUserByIdRequest() : Request
- Create request for operation 'getGuestPortalUserById'
- getGuestPortalUserByIdWithHttpInfo() : array<string|int, mixed>
- Operation getGuestPortalUserByIdWithHttpInfo
- getGuestPortalUserRequest() : Request
- Create request for operation 'getGuestPortalUser'
- getGuestPortalUsers() : PageGuestPortalUsers
- Operation getGuestPortalUsers
- getGuestPortalUsersAsync() : PromiseInterface
- Operation getGuestPortalUsersAsync
- getGuestPortalUsersAsyncWithHttpInfo() : PromiseInterface
- Operation getGuestPortalUsersAsyncWithHttpInfo
- getGuestPortalUsersRequest() : Request
- Create request for operation 'getGuestPortalUsers'
- getGuestPortalUsersWithHttpInfo() : array<string|int, mixed>
- Operation getGuestPortalUsersWithHttpInfo
- getGuestPortalUserWithHttpInfo() : array<string|int, mixed>
- Operation getGuestPortalUserWithHttpInfo
- getGuestPortalWithHttpInfo() : array<string|int, mixed>
- Operation getGuestPortalWithHttpInfo
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createGuestPortal' => ['application/json'], 'createGuestPortalUser' => ['application/json'], 'getAllGuestPortalUsers' => ['application/json'], 'getGuestPortal' => ['application/json'], 'getGuestPortalUser' => ['application/json'], 'getGuestPortalUserById' => ['application/json'], 'getGuestPortalUsers' => ['application/json'], 'getGuestPortals' => ['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 —createGuestPortal()
Operation createGuestPortal
public
createGuestPortal(CreatePortalOptions $create_portal_options[, string $contentType = self::contentTypes['createGuestPortal'][0] ]) : GuestPortalDto
Create a portal page for your customers or clients to log into email accounts and view emails.
Parameters
- $create_portal_options : CreatePortalOptions
-
create_portal_options (required)
- $contentType : string = self::contentTypes['createGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortal'] to see the possible values for this operation
Tags
Return values
GuestPortalDto —createGuestPortalAsync()
Operation createGuestPortalAsync
public
createGuestPortalAsync(CreatePortalOptions $create_portal_options[, string $contentType = self::contentTypes['createGuestPortal'][0] ]) : PromiseInterface
Create a portal page for your customers or clients to log into email accounts and view emails.
Parameters
- $create_portal_options : CreatePortalOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortal'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createGuestPortalAsyncWithHttpInfo()
Operation createGuestPortalAsyncWithHttpInfo
public
createGuestPortalAsyncWithHttpInfo(CreatePortalOptions $create_portal_options[, string $contentType = self::contentTypes['createGuestPortal'][0] ]) : PromiseInterface
Create a portal page for your customers or clients to log into email accounts and view emails.
Parameters
- $create_portal_options : CreatePortalOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortal'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createGuestPortalRequest()
Create request for operation 'createGuestPortal'
public
createGuestPortalRequest(CreatePortalOptions $create_portal_options[, string $contentType = self::contentTypes['createGuestPortal'][0] ]) : Request
Parameters
- $create_portal_options : CreatePortalOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortal'] to see the possible values for this operation
Tags
Return values
Request —createGuestPortalUser()
Operation createGuestPortalUser
public
createGuestPortalUser(string $portal_id, CreatePortalUserOptions $create_portal_user_options[, string $contentType = self::contentTypes['createGuestPortalUser'][0] ]) : GuestPortalUserCreateDto
Create a portal guest user
Parameters
- $portal_id : string
-
portal_id (required)
- $create_portal_user_options : CreatePortalUserOptions
-
create_portal_user_options (required)
- $contentType : string = self::contentTypes['createGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortalUser'] to see the possible values for this operation
Tags
Return values
GuestPortalUserCreateDto —createGuestPortalUserAsync()
Operation createGuestPortalUserAsync
public
createGuestPortalUserAsync(string $portal_id, CreatePortalUserOptions $create_portal_user_options[, string $contentType = self::contentTypes['createGuestPortalUser'][0] ]) : PromiseInterface
Create a portal guest user
Parameters
- $portal_id : string
-
(required)
- $create_portal_user_options : CreatePortalUserOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortalUser'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createGuestPortalUserAsyncWithHttpInfo()
Operation createGuestPortalUserAsyncWithHttpInfo
public
createGuestPortalUserAsyncWithHttpInfo(string $portal_id, CreatePortalUserOptions $create_portal_user_options[, string $contentType = self::contentTypes['createGuestPortalUser'][0] ]) : PromiseInterface
Create a portal guest user
Parameters
- $portal_id : string
-
(required)
- $create_portal_user_options : CreatePortalUserOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortalUser'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createGuestPortalUserRequest()
Create request for operation 'createGuestPortalUser'
public
createGuestPortalUserRequest(string $portal_id, CreatePortalUserOptions $create_portal_user_options[, string $contentType = self::contentTypes['createGuestPortalUser'][0] ]) : Request
Parameters
- $portal_id : string
-
(required)
- $create_portal_user_options : CreatePortalUserOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortalUser'] to see the possible values for this operation
Tags
Return values
Request —createGuestPortalUserWithHttpInfo()
Operation createGuestPortalUserWithHttpInfo
public
createGuestPortalUserWithHttpInfo(string $portal_id, CreatePortalUserOptions $create_portal_user_options[, string $contentType = self::contentTypes['createGuestPortalUser'][0] ]) : array<string|int, mixed>
Create a portal guest user
Parameters
- $portal_id : string
-
(required)
- $create_portal_user_options : CreatePortalUserOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortalUser'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GuestPortalUserCreateDto, HTTP status code, HTTP response headers (array of strings)
createGuestPortalWithHttpInfo()
Operation createGuestPortalWithHttpInfo
public
createGuestPortalWithHttpInfo(CreatePortalOptions $create_portal_options[, string $contentType = self::contentTypes['createGuestPortal'][0] ]) : array<string|int, mixed>
Create a portal page for your customers or clients to log into email accounts and view emails.
Parameters
- $create_portal_options : CreatePortalOptions
-
(required)
- $contentType : string = self::contentTypes['createGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGuestPortal'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GuestPortalDto, HTTP status code, HTTP response headers (array of strings)
getAllGuestPortalUsers()
Operation getAllGuestPortalUsers
public
getAllGuestPortalUsers([string $portal_id = null ][, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGuestPortalUsers'][0] ]) : PageGuestPortalUsers
Get all guest users for portal
Parameters
- $portal_id : string = null
-
Optional portal ID (optional)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
PageGuestPortalUsers —getAllGuestPortalUsersAsync()
Operation getAllGuestPortalUsersAsync
public
getAllGuestPortalUsersAsync([string $portal_id = null ][, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGuestPortalUsers'][0] ]) : PromiseInterface
Get all guest users for portal
Parameters
- $portal_id : string = null
-
Optional portal ID (optional)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllGuestPortalUsersAsyncWithHttpInfo()
Operation getAllGuestPortalUsersAsyncWithHttpInfo
public
getAllGuestPortalUsersAsyncWithHttpInfo([string $portal_id = null ][, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGuestPortalUsers'][0] ]) : PromiseInterface
Get all guest users for portal
Parameters
- $portal_id : string = null
-
Optional portal ID (optional)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllGuestPortalUsersRequest()
Create request for operation 'getAllGuestPortalUsers'
public
getAllGuestPortalUsersRequest([string $portal_id = null ][, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGuestPortalUsers'][0] ]) : Request
Parameters
- $portal_id : string = null
-
Optional portal ID (optional)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
Request —getAllGuestPortalUsersWithHttpInfo()
Operation getAllGuestPortalUsersWithHttpInfo
public
getAllGuestPortalUsersWithHttpInfo([string $portal_id = null ][, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGuestPortalUsers'][0] ]) : array<string|int, mixed>
Get all guest users for portal
Parameters
- $portal_id : string = null
-
Optional portal ID (optional)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageGuestPortalUsers, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getGuestPortal()
Operation getGuestPortal
public
getGuestPortal(string $portal_id[, string $contentType = self::contentTypes['getGuestPortal'][0] ]) : GuestPortalDto
Get a client email portal
Parameters
- $portal_id : string
-
portal_id (required)
- $contentType : string = self::contentTypes['getGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortal'] to see the possible values for this operation
Tags
Return values
GuestPortalDto —getGuestPortalAsync()
Operation getGuestPortalAsync
public
getGuestPortalAsync(string $portal_id[, string $contentType = self::contentTypes['getGuestPortal'][0] ]) : PromiseInterface
Get a client email portal
Parameters
- $portal_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortal'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalAsyncWithHttpInfo()
Operation getGuestPortalAsyncWithHttpInfo
public
getGuestPortalAsyncWithHttpInfo(string $portal_id[, string $contentType = self::contentTypes['getGuestPortal'][0] ]) : PromiseInterface
Get a client email portal
Parameters
- $portal_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortal'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalRequest()
Create request for operation 'getGuestPortal'
public
getGuestPortalRequest(string $portal_id[, string $contentType = self::contentTypes['getGuestPortal'][0] ]) : Request
Parameters
- $portal_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortal'] to see the possible values for this operation
Tags
Return values
Request —getGuestPortals()
Operation getGuestPortals
public
getGuestPortals([string $contentType = self::contentTypes['getGuestPortals'][0] ]) : array<string|int, GuestPortalDto>
Get guest portals
Parameters
- $contentType : string = self::contentTypes['getGuestPortals'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortals'] to see the possible values for this operation
Tags
Return values
array<string|int, GuestPortalDto> —getGuestPortalsAsync()
Operation getGuestPortalsAsync
public
getGuestPortalsAsync([string $contentType = self::contentTypes['getGuestPortals'][0] ]) : PromiseInterface
Get guest portals
Parameters
- $contentType : string = self::contentTypes['getGuestPortals'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortals'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalsAsyncWithHttpInfo()
Operation getGuestPortalsAsyncWithHttpInfo
public
getGuestPortalsAsyncWithHttpInfo([string $contentType = self::contentTypes['getGuestPortals'][0] ]) : PromiseInterface
Get guest portals
Parameters
- $contentType : string = self::contentTypes['getGuestPortals'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortals'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalsRequest()
Create request for operation 'getGuestPortals'
public
getGuestPortalsRequest([string $contentType = self::contentTypes['getGuestPortals'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getGuestPortals'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortals'] to see the possible values for this operation
Tags
Return values
Request —getGuestPortalsWithHttpInfo()
Operation getGuestPortalsWithHttpInfo
public
getGuestPortalsWithHttpInfo([string $contentType = self::contentTypes['getGuestPortals'][0] ]) : array<string|int, mixed>
Get guest portals
Parameters
- $contentType : string = self::contentTypes['getGuestPortals'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortals'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GuestPortalDto[], HTTP status code, HTTP response headers (array of strings)
getGuestPortalUser()
Operation getGuestPortalUser
public
getGuestPortalUser(string $portal_id, string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUser'][0] ]) : GuestPortalUserDto
Get guest user for portal
Parameters
- $portal_id : string
-
portal_id (required)
- $guest_id : string
-
guest_id (required)
- $contentType : string = self::contentTypes['getGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUser'] to see the possible values for this operation
Tags
Return values
GuestPortalUserDto —getGuestPortalUserAsync()
Operation getGuestPortalUserAsync
public
getGuestPortalUserAsync(string $portal_id, string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUser'][0] ]) : PromiseInterface
Get guest user for portal
Parameters
- $portal_id : string
-
(required)
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUser'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalUserAsyncWithHttpInfo()
Operation getGuestPortalUserAsyncWithHttpInfo
public
getGuestPortalUserAsyncWithHttpInfo(string $portal_id, string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUser'][0] ]) : PromiseInterface
Get guest user for portal
Parameters
- $portal_id : string
-
(required)
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUser'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalUserById()
Operation getGuestPortalUserById
public
getGuestPortalUserById(string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUserById'][0] ]) : GuestPortalUserDto
Get guest user
Parameters
- $guest_id : string
-
guest_id (required)
- $contentType : string = self::contentTypes['getGuestPortalUserById'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUserById'] to see the possible values for this operation
Tags
Return values
GuestPortalUserDto —getGuestPortalUserByIdAsync()
Operation getGuestPortalUserByIdAsync
public
getGuestPortalUserByIdAsync(string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUserById'][0] ]) : PromiseInterface
Get guest user
Parameters
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUserById'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUserById'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalUserByIdAsyncWithHttpInfo()
Operation getGuestPortalUserByIdAsyncWithHttpInfo
public
getGuestPortalUserByIdAsyncWithHttpInfo(string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUserById'][0] ]) : PromiseInterface
Get guest user
Parameters
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUserById'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUserById'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalUserByIdRequest()
Create request for operation 'getGuestPortalUserById'
public
getGuestPortalUserByIdRequest(string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUserById'][0] ]) : Request
Parameters
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUserById'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUserById'] to see the possible values for this operation
Tags
Return values
Request —getGuestPortalUserByIdWithHttpInfo()
Operation getGuestPortalUserByIdWithHttpInfo
public
getGuestPortalUserByIdWithHttpInfo(string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUserById'][0] ]) : array<string|int, mixed>
Get guest user
Parameters
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUserById'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUserById'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GuestPortalUserDto, HTTP status code, HTTP response headers (array of strings)
getGuestPortalUserRequest()
Create request for operation 'getGuestPortalUser'
public
getGuestPortalUserRequest(string $portal_id, string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUser'][0] ]) : Request
Parameters
- $portal_id : string
-
(required)
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUser'] to see the possible values for this operation
Tags
Return values
Request —getGuestPortalUsers()
Operation getGuestPortalUsers
public
getGuestPortalUsers(string $portal_id[, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGuestPortalUsers'][0] ]) : PageGuestPortalUsers
Get all guest users for portal
Parameters
- $portal_id : string
-
portal_id (required)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
PageGuestPortalUsers —getGuestPortalUsersAsync()
Operation getGuestPortalUsersAsync
public
getGuestPortalUsersAsync(string $portal_id[, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGuestPortalUsers'][0] ]) : PromiseInterface
Get all guest users for portal
Parameters
- $portal_id : string
-
(required)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalUsersAsyncWithHttpInfo()
Operation getGuestPortalUsersAsyncWithHttpInfo
public
getGuestPortalUsersAsyncWithHttpInfo(string $portal_id[, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGuestPortalUsers'][0] ]) : PromiseInterface
Get all guest users for portal
Parameters
- $portal_id : string
-
(required)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGuestPortalUsersRequest()
Create request for operation 'getGuestPortalUsers'
public
getGuestPortalUsersRequest(string $portal_id[, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGuestPortalUsers'][0] ]) : Request
Parameters
- $portal_id : string
-
(required)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
Request —getGuestPortalUsersWithHttpInfo()
Operation getGuestPortalUsersWithHttpInfo
public
getGuestPortalUsersWithHttpInfo(string $portal_id[, string $search = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGuestPortalUsers'][0] ]) : array<string|int, mixed>
Get all guest users for portal
Parameters
- $portal_id : string
-
(required)
- $search : string = null
-
Optional search term (optional)
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getGuestPortalUsers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUsers'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageGuestPortalUsers, HTTP status code, HTTP response headers (array of strings)
getGuestPortalUserWithHttpInfo()
Operation getGuestPortalUserWithHttpInfo
public
getGuestPortalUserWithHttpInfo(string $portal_id, string $guest_id[, string $contentType = self::contentTypes['getGuestPortalUser'][0] ]) : array<string|int, mixed>
Get guest user for portal
Parameters
- $portal_id : string
-
(required)
- $guest_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortalUser'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortalUser'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GuestPortalUserDto, HTTP status code, HTTP response headers (array of strings)
getGuestPortalWithHttpInfo()
Operation getGuestPortalWithHttpInfo
public
getGuestPortalWithHttpInfo(string $portal_id[, string $contentType = self::contentTypes['getGuestPortal'][0] ]) : array<string|int, mixed>
Get a client email portal
Parameters
- $portal_id : string
-
(required)
- $contentType : string = self::contentTypes['getGuestPortal'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGuestPortal'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GuestPortalDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
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