Interface IGroupControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IGroupControllerApiAsync : IApiAccessor

Methods

View Source

AddContactsToGroupAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Add contacts to a group

Declaration

Task<GroupContactsDto> AddContactsToGroupAsync(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
UpdateGroupContacts	updateGroupContacts
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GroupContactsDto>	Task of GroupContactsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

AddContactsToGroupWithHttpInfoAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Add contacts to a group

Declaration

Task<ApiResponse<GroupContactsDto>> AddContactsToGroupWithHttpInfoAsync(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
UpdateGroupContacts	updateGroupContacts
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GroupContactsDto>>	Task of ApiResponse (GroupContactsDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGroupAsync(CreateGroupOptions, int, CancellationToken)

Create a group

Declaration

Task<GroupDto> CreateGroupAsync(CreateGroupOptions createGroupOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateGroupOptions	createGroupOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GroupDto>	Task of GroupDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGroupWithHttpInfoAsync(CreateGroupOptions, int, CancellationToken)

Create a group

Declaration

Task<ApiResponse<GroupDto>> CreateGroupWithHttpInfoAsync(CreateGroupOptions createGroupOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateGroupOptions	createGroupOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GroupDto>>	Task of ApiResponse (GroupDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteGroupAsync(Guid, int, CancellationToken)

Delete group

Declaration

Task DeleteGroupAsync(Guid groupId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteGroupWithHttpInfoAsync(Guid, int, CancellationToken)

Delete group

Declaration

Task<ApiResponse<object>> DeleteGroupWithHttpInfoAsync(Guid groupId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGroupsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all Contact Groups in paginated format

Declaration

Task<PageGroupProjection> GetAllGroupsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageGroupProjection>	Task of PageGroupProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGroupsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all Contact Groups in paginated format

Declaration

Task<ApiResponse<PageGroupProjection>> GetAllGroupsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageGroupProjection>>	Task of ApiResponse (PageGroupProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupAsync(Guid, int, CancellationToken)

Get group

Declaration

Task<GroupDto> GetGroupAsync(Guid groupId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GroupDto>	Task of GroupDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupWithContactsAsync(Guid, int, CancellationToken)

Get group and contacts belonging to it

Declaration

Task<GroupContactsDto> GetGroupWithContactsAsync(Guid groupId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GroupContactsDto>	Task of GroupContactsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupWithContactsPaginatedAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

Task<PageContactProjection> GetGroupWithContactsPaginatedAsync(Guid groupId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int?	page	Optional page index in group contact pagination (optional, default to 0)
int?	size	Optional page size in group contact pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageContactProjection>	Task of PageContactProjection

Remarks

Get group and paginated contacts belonging to it

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupWithContactsPaginatedWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

Task<ApiResponse<PageContactProjection>> GetGroupWithContactsPaginatedWithHttpInfoAsync(Guid groupId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int?	page	Optional page index in group contact pagination (optional, default to 0)
int?	size	Optional page size in group contact pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageContactProjection>>	Task of ApiResponse (PageContactProjection)

Remarks

Get group and paginated contacts belonging to it

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupWithContactsWithHttpInfoAsync(Guid, int, CancellationToken)

Get group and contacts belonging to it

Declaration

Task<ApiResponse<GroupContactsDto>> GetGroupWithContactsWithHttpInfoAsync(Guid groupId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GroupContactsDto>>	Task of ApiResponse (GroupContactsDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupWithHttpInfoAsync(Guid, int, CancellationToken)

Get group

Declaration

Task<ApiResponse<GroupDto>> GetGroupWithHttpInfoAsync(Guid groupId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GroupDto>>	Task of ApiResponse (GroupDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupsAsync(int, CancellationToken)

Get all groups

Declaration

Task<List<GroupProjection>> GetGroupsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<GroupProjection>>	Task of List<GroupProjection>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupsWithHttpInfoAsync(int, CancellationToken)

Get all groups

Declaration

Task<ApiResponse<List<GroupProjection>>> GetGroupsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<GroupProjection>>>	Task of ApiResponse (List<GroupProjection>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RemoveContactsFromGroupAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Remove contacts from a group

Declaration

Task<GroupContactsDto> RemoveContactsFromGroupAsync(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
UpdateGroupContacts	updateGroupContacts
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GroupContactsDto>	Task of GroupContactsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RemoveContactsFromGroupWithHttpInfoAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Remove contacts from a group

Declaration

Task<ApiResponse<GroupContactsDto>> RemoveContactsFromGroupWithHttpInfoAsync(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	groupId
UpdateGroupContacts	updateGroupContacts
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GroupContactsDto>>	Task of ApiResponse (GroupContactsDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call