GroupControllerApi
in package
GroupControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['addContactsToGroup' => ['application/json'], 'createGroup1' => ['application/json'], 'deleteGroup1' => ['application/json'], 'getAllGroups' => ['application/json'], 'getGroup1' => ['application/json'], 'getGroupWithContacts' => ['application/json'], 'getGroupWithContactsPaginated' => ['application/json'], 'getGroups' => ['application/json'], 'removeContactsFromGroup' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- addContactsToGroup() : GroupContactsDto
- Operation addContactsToGroup
- addContactsToGroupAsync() : PromiseInterface
- Operation addContactsToGroupAsync
- addContactsToGroupAsyncWithHttpInfo() : PromiseInterface
- Operation addContactsToGroupAsyncWithHttpInfo
- addContactsToGroupRequest() : Request
- Create request for operation 'addContactsToGroup'
- addContactsToGroupWithHttpInfo() : array<string|int, mixed>
- Operation addContactsToGroupWithHttpInfo
- createGroup1() : GroupDto
- Operation createGroup1
- createGroup1Async() : PromiseInterface
- Operation createGroup1Async
- createGroup1AsyncWithHttpInfo() : PromiseInterface
- Operation createGroup1AsyncWithHttpInfo
- createGroup1Request() : Request
- Create request for operation 'createGroup1'
- createGroup1WithHttpInfo() : array<string|int, mixed>
- Operation createGroup1WithHttpInfo
- deleteGroup1() : void
- Operation deleteGroup1
- deleteGroup1Async() : PromiseInterface
- Operation deleteGroup1Async
- deleteGroup1AsyncWithHttpInfo() : PromiseInterface
- Operation deleteGroup1AsyncWithHttpInfo
- deleteGroup1Request() : Request
- Create request for operation 'deleteGroup1'
- deleteGroup1WithHttpInfo() : array<string|int, mixed>
- Operation deleteGroup1WithHttpInfo
- getAllGroups() : PageGroupProjection
- Operation getAllGroups
- getAllGroupsAsync() : PromiseInterface
- Operation getAllGroupsAsync
- getAllGroupsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllGroupsAsyncWithHttpInfo
- getAllGroupsRequest() : Request
- Create request for operation 'getAllGroups'
- getAllGroupsWithHttpInfo() : array<string|int, mixed>
- Operation getAllGroupsWithHttpInfo
- getConfig() : Configuration
- getGroup1() : GroupDto
- Operation getGroup1
- getGroup1Async() : PromiseInterface
- Operation getGroup1Async
- getGroup1AsyncWithHttpInfo() : PromiseInterface
- Operation getGroup1AsyncWithHttpInfo
- getGroup1Request() : Request
- Create request for operation 'getGroup1'
- getGroup1WithHttpInfo() : array<string|int, mixed>
- Operation getGroup1WithHttpInfo
- getGroups() : array<string|int, GroupProjection>
- Operation getGroups
- getGroupsAsync() : PromiseInterface
- Operation getGroupsAsync
- getGroupsAsyncWithHttpInfo() : PromiseInterface
- Operation getGroupsAsyncWithHttpInfo
- getGroupsRequest() : Request
- Create request for operation 'getGroups'
- getGroupsWithHttpInfo() : array<string|int, mixed>
- Operation getGroupsWithHttpInfo
- getGroupWithContacts() : GroupContactsDto
- Operation getGroupWithContacts
- getGroupWithContactsAsync() : PromiseInterface
- Operation getGroupWithContactsAsync
- getGroupWithContactsAsyncWithHttpInfo() : PromiseInterface
- Operation getGroupWithContactsAsyncWithHttpInfo
- getGroupWithContactsPaginated() : PageContactProjection
- Operation getGroupWithContactsPaginated
- getGroupWithContactsPaginatedAsync() : PromiseInterface
- Operation getGroupWithContactsPaginatedAsync
- getGroupWithContactsPaginatedAsyncWithHttpInfo() : PromiseInterface
- Operation getGroupWithContactsPaginatedAsyncWithHttpInfo
- getGroupWithContactsPaginatedRequest() : Request
- Create request for operation 'getGroupWithContactsPaginated'
- getGroupWithContactsPaginatedWithHttpInfo() : array<string|int, mixed>
- Operation getGroupWithContactsPaginatedWithHttpInfo
- getGroupWithContactsRequest() : Request
- Create request for operation 'getGroupWithContacts'
- getGroupWithContactsWithHttpInfo() : array<string|int, mixed>
- Operation getGroupWithContactsWithHttpInfo
- getHostIndex() : int
- Get the host index
- removeContactsFromGroup() : GroupContactsDto
- Operation removeContactsFromGroup
- removeContactsFromGroupAsync() : PromiseInterface
- Operation removeContactsFromGroupAsync
- removeContactsFromGroupAsyncWithHttpInfo() : PromiseInterface
- Operation removeContactsFromGroupAsyncWithHttpInfo
- removeContactsFromGroupRequest() : Request
- Create request for operation 'removeContactsFromGroup'
- removeContactsFromGroupWithHttpInfo() : array<string|int, mixed>
- Operation removeContactsFromGroupWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['addContactsToGroup' => ['application/json'], 'createGroup1' => ['application/json'], 'deleteGroup1' => ['application/json'], 'getAllGroups' => ['application/json'], 'getGroup1' => ['application/json'], 'getGroupWithContacts' => ['application/json'], 'getGroupWithContactsPaginated' => ['application/json'], 'getGroups' => ['application/json'], 'removeContactsFromGroup' => ['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 —addContactsToGroup()
Operation addContactsToGroup
public
addContactsToGroup(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['addContactsToGroup'][0] ]) : GroupContactsDto
Add contacts to a group
Parameters
- $group_id : string
-
group_id (required)
- $update_group_contacts : UpdateGroupContacts
-
update_group_contacts (required)
- $contentType : string = self::contentTypes['addContactsToGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['addContactsToGroup'] to see the possible values for this operation
Tags
Return values
GroupContactsDto —addContactsToGroupAsync()
Operation addContactsToGroupAsync
public
addContactsToGroupAsync(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['addContactsToGroup'][0] ]) : PromiseInterface
Add contacts to a group
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['addContactsToGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['addContactsToGroup'] to see the possible values for this operation
Tags
Return values
PromiseInterface —addContactsToGroupAsyncWithHttpInfo()
Operation addContactsToGroupAsyncWithHttpInfo
public
addContactsToGroupAsyncWithHttpInfo(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['addContactsToGroup'][0] ]) : PromiseInterface
Add contacts to a group
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['addContactsToGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['addContactsToGroup'] to see the possible values for this operation
Tags
Return values
PromiseInterface —addContactsToGroupRequest()
Create request for operation 'addContactsToGroup'
public
addContactsToGroupRequest(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['addContactsToGroup'][0] ]) : Request
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['addContactsToGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['addContactsToGroup'] to see the possible values for this operation
Tags
Return values
Request —addContactsToGroupWithHttpInfo()
Operation addContactsToGroupWithHttpInfo
public
addContactsToGroupWithHttpInfo(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['addContactsToGroup'][0] ]) : array<string|int, mixed>
Add contacts to a group
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['addContactsToGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['addContactsToGroup'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GroupContactsDto, HTTP status code, HTTP response headers (array of strings)
createGroup1()
Operation createGroup1
public
createGroup1(CreateGroupOptions $create_group_options[, string $contentType = self::contentTypes['createGroup1'][0] ]) : GroupDto
Create a group
Parameters
- $create_group_options : CreateGroupOptions
-
create_group_options (required)
- $contentType : string = self::contentTypes['createGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGroup1'] to see the possible values for this operation
Tags
Return values
GroupDto —createGroup1Async()
Operation createGroup1Async
public
createGroup1Async(CreateGroupOptions $create_group_options[, string $contentType = self::contentTypes['createGroup1'][0] ]) : PromiseInterface
Create a group
Parameters
- $create_group_options : CreateGroupOptions
-
(required)
- $contentType : string = self::contentTypes['createGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGroup1'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createGroup1AsyncWithHttpInfo()
Operation createGroup1AsyncWithHttpInfo
public
createGroup1AsyncWithHttpInfo(CreateGroupOptions $create_group_options[, string $contentType = self::contentTypes['createGroup1'][0] ]) : PromiseInterface
Create a group
Parameters
- $create_group_options : CreateGroupOptions
-
(required)
- $contentType : string = self::contentTypes['createGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGroup1'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createGroup1Request()
Create request for operation 'createGroup1'
public
createGroup1Request(CreateGroupOptions $create_group_options[, string $contentType = self::contentTypes['createGroup1'][0] ]) : Request
Parameters
- $create_group_options : CreateGroupOptions
-
(required)
- $contentType : string = self::contentTypes['createGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGroup1'] to see the possible values for this operation
Tags
Return values
Request —createGroup1WithHttpInfo()
Operation createGroup1WithHttpInfo
public
createGroup1WithHttpInfo(CreateGroupOptions $create_group_options[, string $contentType = self::contentTypes['createGroup1'][0] ]) : array<string|int, mixed>
Create a group
Parameters
- $create_group_options : CreateGroupOptions
-
(required)
- $contentType : string = self::contentTypes['createGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['createGroup1'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GroupDto, HTTP status code, HTTP response headers (array of strings)
deleteGroup1()
Operation deleteGroup1
public
deleteGroup1(string $group_id[, string $contentType = self::contentTypes['deleteGroup1'][0] ]) : void
Delete group
Parameters
- $group_id : string
-
group_id (required)
- $contentType : string = self::contentTypes['deleteGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteGroup1'] to see the possible values for this operation
Tags
Return values
void —deleteGroup1Async()
Operation deleteGroup1Async
public
deleteGroup1Async(string $group_id[, string $contentType = self::contentTypes['deleteGroup1'][0] ]) : PromiseInterface
Delete group
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteGroup1'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteGroup1AsyncWithHttpInfo()
Operation deleteGroup1AsyncWithHttpInfo
public
deleteGroup1AsyncWithHttpInfo(string $group_id[, string $contentType = self::contentTypes['deleteGroup1'][0] ]) : PromiseInterface
Delete group
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteGroup1'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteGroup1Request()
Create request for operation 'deleteGroup1'
public
deleteGroup1Request(string $group_id[, string $contentType = self::contentTypes['deleteGroup1'][0] ]) : Request
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteGroup1'] to see the possible values for this operation
Tags
Return values
Request —deleteGroup1WithHttpInfo()
Operation deleteGroup1WithHttpInfo
public
deleteGroup1WithHttpInfo(string $group_id[, string $contentType = self::contentTypes['deleteGroup1'][0] ]) : array<string|int, mixed>
Delete group
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteGroup1'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getAllGroups()
Operation getAllGroups
public
getAllGroups(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGroups'][0] ]) : PageGroupProjection
Get all Contact Groups in paginated format
Parameters
- $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['getAllGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGroups'] to see the possible values for this operation
Tags
Return values
PageGroupProjection —getAllGroupsAsync()
Operation getAllGroupsAsync
public
getAllGroupsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGroups'][0] ]) : PromiseInterface
Get all Contact Groups in paginated format
Parameters
- $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['getAllGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGroups'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllGroupsAsyncWithHttpInfo()
Operation getAllGroupsAsyncWithHttpInfo
public
getAllGroupsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGroups'][0] ]) : PromiseInterface
Get all Contact Groups in paginated format
Parameters
- $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['getAllGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGroups'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllGroupsRequest()
Create request for operation 'getAllGroups'
public
getAllGroupsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGroups'][0] ]) : Request
Parameters
- $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['getAllGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGroups'] to see the possible values for this operation
Tags
Return values
Request —getAllGroupsWithHttpInfo()
Operation getAllGroupsWithHttpInfo
public
getAllGroupsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllGroups'][0] ]) : array<string|int, mixed>
Get all Contact Groups in paginated format
Parameters
- $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['getAllGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllGroups'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageGroupProjection, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getGroup1()
Operation getGroup1
public
getGroup1(string $group_id[, string $contentType = self::contentTypes['getGroup1'][0] ]) : GroupDto
Get group
Parameters
- $group_id : string
-
group_id (required)
- $contentType : string = self::contentTypes['getGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroup1'] to see the possible values for this operation
Tags
Return values
GroupDto —getGroup1Async()
Operation getGroup1Async
public
getGroup1Async(string $group_id[, string $contentType = self::contentTypes['getGroup1'][0] ]) : PromiseInterface
Get group
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroup1'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroup1AsyncWithHttpInfo()
Operation getGroup1AsyncWithHttpInfo
public
getGroup1AsyncWithHttpInfo(string $group_id[, string $contentType = self::contentTypes['getGroup1'][0] ]) : PromiseInterface
Get group
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroup1'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroup1Request()
Create request for operation 'getGroup1'
public
getGroup1Request(string $group_id[, string $contentType = self::contentTypes['getGroup1'][0] ]) : Request
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroup1'] to see the possible values for this operation
Tags
Return values
Request —getGroup1WithHttpInfo()
Operation getGroup1WithHttpInfo
public
getGroup1WithHttpInfo(string $group_id[, string $contentType = self::contentTypes['getGroup1'][0] ]) : array<string|int, mixed>
Get group
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroup1'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroup1'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GroupDto, HTTP status code, HTTP response headers (array of strings)
getGroups()
Operation getGroups
public
getGroups([string $contentType = self::contentTypes['getGroups'][0] ]) : array<string|int, GroupProjection>
Get all groups
Parameters
- $contentType : string = self::contentTypes['getGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroups'] to see the possible values for this operation
Tags
Return values
array<string|int, GroupProjection> —getGroupsAsync()
Operation getGroupsAsync
public
getGroupsAsync([string $contentType = self::contentTypes['getGroups'][0] ]) : PromiseInterface
Get all groups
Parameters
- $contentType : string = self::contentTypes['getGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroups'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroupsAsyncWithHttpInfo()
Operation getGroupsAsyncWithHttpInfo
public
getGroupsAsyncWithHttpInfo([string $contentType = self::contentTypes['getGroups'][0] ]) : PromiseInterface
Get all groups
Parameters
- $contentType : string = self::contentTypes['getGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroups'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroupsRequest()
Create request for operation 'getGroups'
public
getGroupsRequest([string $contentType = self::contentTypes['getGroups'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroups'] to see the possible values for this operation
Tags
Return values
Request —getGroupsWithHttpInfo()
Operation getGroupsWithHttpInfo
public
getGroupsWithHttpInfo([string $contentType = self::contentTypes['getGroups'][0] ]) : array<string|int, mixed>
Get all groups
Parameters
- $contentType : string = self::contentTypes['getGroups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroups'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GroupProjection[], HTTP status code, HTTP response headers (array of strings)
getGroupWithContacts()
Operation getGroupWithContacts
public
getGroupWithContacts(string $group_id[, string $contentType = self::contentTypes['getGroupWithContacts'][0] ]) : GroupContactsDto
Get group and contacts belonging to it
Parameters
- $group_id : string
-
group_id (required)
- $contentType : string = self::contentTypes['getGroupWithContacts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContacts'] to see the possible values for this operation
Tags
Return values
GroupContactsDto —getGroupWithContactsAsync()
Operation getGroupWithContactsAsync
public
getGroupWithContactsAsync(string $group_id[, string $contentType = self::contentTypes['getGroupWithContacts'][0] ]) : PromiseInterface
Get group and contacts belonging to it
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroupWithContacts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContacts'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroupWithContactsAsyncWithHttpInfo()
Operation getGroupWithContactsAsyncWithHttpInfo
public
getGroupWithContactsAsyncWithHttpInfo(string $group_id[, string $contentType = self::contentTypes['getGroupWithContacts'][0] ]) : PromiseInterface
Get group and contacts belonging to it
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroupWithContacts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContacts'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroupWithContactsPaginated()
Operation getGroupWithContactsPaginated
public
getGroupWithContactsPaginated(string $group_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGroupWithContactsPaginated'][0] ]) : PageContactProjection
Parameters
- $group_id : string
-
group_id (required)
- $page : int
-
Optional page index in group contact pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in group contact 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['getGroupWithContactsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContactsPaginated'] to see the possible values for this operation
Tags
Return values
PageContactProjection —getGroupWithContactsPaginatedAsync()
Operation getGroupWithContactsPaginatedAsync
public
getGroupWithContactsPaginatedAsync(string $group_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGroupWithContactsPaginated'][0] ]) : PromiseInterface
Parameters
- $group_id : string
-
(required)
- $page : int
-
Optional page index in group contact pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in group contact 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['getGroupWithContactsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContactsPaginated'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroupWithContactsPaginatedAsyncWithHttpInfo()
Operation getGroupWithContactsPaginatedAsyncWithHttpInfo
public
getGroupWithContactsPaginatedAsyncWithHttpInfo(string $group_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGroupWithContactsPaginated'][0] ]) : PromiseInterface
Parameters
- $group_id : string
-
(required)
- $page : int
-
Optional page index in group contact pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in group contact 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['getGroupWithContactsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContactsPaginated'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getGroupWithContactsPaginatedRequest()
Create request for operation 'getGroupWithContactsPaginated'
public
getGroupWithContactsPaginatedRequest(string $group_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGroupWithContactsPaginated'][0] ]) : Request
Parameters
- $group_id : string
-
(required)
- $page : int
-
Optional page index in group contact pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in group contact 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['getGroupWithContactsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContactsPaginated'] to see the possible values for this operation
Tags
Return values
Request —getGroupWithContactsPaginatedWithHttpInfo()
Operation getGroupWithContactsPaginatedWithHttpInfo
public
getGroupWithContactsPaginatedWithHttpInfo(string $group_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getGroupWithContactsPaginated'][0] ]) : array<string|int, mixed>
Parameters
- $group_id : string
-
(required)
- $page : int
-
Optional page index in group contact pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in group contact 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['getGroupWithContactsPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContactsPaginated'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageContactProjection, HTTP status code, HTTP response headers (array of strings)
getGroupWithContactsRequest()
Create request for operation 'getGroupWithContacts'
public
getGroupWithContactsRequest(string $group_id[, string $contentType = self::contentTypes['getGroupWithContacts'][0] ]) : Request
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroupWithContacts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContacts'] to see the possible values for this operation
Tags
Return values
Request —getGroupWithContactsWithHttpInfo()
Operation getGroupWithContactsWithHttpInfo
public
getGroupWithContactsWithHttpInfo(string $group_id[, string $contentType = self::contentTypes['getGroupWithContacts'][0] ]) : array<string|int, mixed>
Get group and contacts belonging to it
Parameters
- $group_id : string
-
(required)
- $contentType : string = self::contentTypes['getGroupWithContacts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getGroupWithContacts'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GroupContactsDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
removeContactsFromGroup()
Operation removeContactsFromGroup
public
removeContactsFromGroup(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['removeContactsFromGroup'][0] ]) : GroupContactsDto
Remove contacts from a group
Parameters
- $group_id : string
-
group_id (required)
- $update_group_contacts : UpdateGroupContacts
-
update_group_contacts (required)
- $contentType : string = self::contentTypes['removeContactsFromGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['removeContactsFromGroup'] to see the possible values for this operation
Tags
Return values
GroupContactsDto —removeContactsFromGroupAsync()
Operation removeContactsFromGroupAsync
public
removeContactsFromGroupAsync(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['removeContactsFromGroup'][0] ]) : PromiseInterface
Remove contacts from a group
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['removeContactsFromGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['removeContactsFromGroup'] to see the possible values for this operation
Tags
Return values
PromiseInterface —removeContactsFromGroupAsyncWithHttpInfo()
Operation removeContactsFromGroupAsyncWithHttpInfo
public
removeContactsFromGroupAsyncWithHttpInfo(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['removeContactsFromGroup'][0] ]) : PromiseInterface
Remove contacts from a group
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['removeContactsFromGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['removeContactsFromGroup'] to see the possible values for this operation
Tags
Return values
PromiseInterface —removeContactsFromGroupRequest()
Create request for operation 'removeContactsFromGroup'
public
removeContactsFromGroupRequest(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['removeContactsFromGroup'][0] ]) : Request
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['removeContactsFromGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['removeContactsFromGroup'] to see the possible values for this operation
Tags
Return values
Request —removeContactsFromGroupWithHttpInfo()
Operation removeContactsFromGroupWithHttpInfo
public
removeContactsFromGroupWithHttpInfo(string $group_id, UpdateGroupContacts $update_group_contacts[, string $contentType = self::contentTypes['removeContactsFromGroup'][0] ]) : array<string|int, mixed>
Remove contacts from a group
Parameters
- $group_id : string
-
(required)
- $update_group_contacts : UpdateGroupContacts
-
(required)
- $contentType : string = self::contentTypes['removeContactsFromGroup'][0]
-
The value for the Content-Type header. Check self::contentTypes['removeContactsFromGroup'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\GroupContactsDto, 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