GroupControllerAPI
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
addContactsToGroup | PUT /groups/{groupId}/contacts | Add contacts to a group |
createGroup | POST /groups | Create a group |
deleteGroup | DELETE /groups/{groupId} | Delete group |
getAllGroups | GET /groups/paginated | Get all Contact Groups in paginated format |
getGroup | GET /groups/{groupId} | Get group |
getGroupWithContacts | GET /groups/{groupId}/contacts | Get group and contacts belonging to it |
getGroupWithContactsPaginated | GET /groups/{groupId}/contacts-paginated | |
getGroups | GET /groups | Get all groups |
removeContactsFromGroup | DELETE /groups/{groupId}/contacts | Remove contacts from a group |
open class func addContactsToGroup( groupId: UUID, updateGroupContacts: UpdateGroupContacts) -> Promise<GroupContactsDto>
Add contacts to a group
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let groupId = 987 // UUID |
let updateGroupContacts = UpdateGroupContacts(contactIds: [123]) // UpdateGroupContacts |
// Add contacts to a group
GroupControllerAPI.addContactsToGroup(groupId: groupId, updateGroupContacts: updateGroupContacts).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
groupId | UUID | ||
updateGroupContacts | UpdateGroupContacts |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Create a group
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let createGroupOptions = CreateGroupOptions(name: "name_example", _description: "_description_example") // CreateGroupOptions |
// Create a group
GroupControllerAPI.createGroup(createGroupOptions: createGroupOptions).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
createGroupOptions | CreateGroupOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Delete group
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let groupId = 987 // UUID |
// Delete group
GroupControllerAPI.deleteGroup(groupId: groupId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
groupId | UUID |
Return type
Void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getAllGroups( page: Int? = nil, size: Int? = nil, sort: Sort_getAllGroups? = nil, since: Date? = nil, before: Date? = nil) -> Promise<PageGroupProjection>
Get all Contact Groups in paginated format
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let page = 987 // Int | Optional page in list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
// Get all Contact Groups in paginated format
GroupControllerAPI.getAllGroups(page: page, size: size, sort: sort, since: since, before: before).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page in list pagination | [optional] [default to 0] |
size | Int | Optional page size in list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Get group
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let groupId = 987 // UUID |
// Get group
GroupControllerAPI.getGroup(groupId: groupId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
groupId | UUID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Get group and contacts belonging to it
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let groupId = 987 // UUID |
// Get group and contacts belonging to it
GroupControllerAPI.getGroupWithContacts(groupId: groupId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
groupId | UUID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getGroupWithContactsPaginated( groupId: UUID, page: Int? = nil, size: Int? = nil, sort: Sort_getGroupWithContactsPaginated? = nil, since: Date? = nil, before: Date? = nil) -> Promise<PageContactProjection>
Get group and paginated contacts belonging to it
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let groupId = 987 // UUID |
let page = 987 // Int | Optional page in group contact pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in group contact pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
GroupControllerAPI.getGroupWithContactsPaginated(groupId: groupId, page: page, size: size, sort: sort, since: since, before: before).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
groupId | UUID | ||
page | Int | Optional page in group contact pagination | [optional] [default to 0] |
size | Int | Optional page size in group contact pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Get all groups
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
// Get all groups
GroupControllerAPI.getGroups().then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func removeContactsFromGroup( groupId: UUID, updateGroupContacts: UpdateGroupContacts) -> Promise<GroupContactsDto>
Remove contacts from a group
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let groupId = 987 // UUID |
let updateGroupContacts = UpdateGroupContacts(contactIds: [123]) // UpdateGroupContacts |
// Remove contacts from a group
GroupControllerAPI.removeContactsFromGroup(groupId: groupId, updateGroupContacts: updateGroupContacts).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
groupId | UUID | ||
updateGroupContacts | UpdateGroupContacts |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]