Interface IGroupControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IGroupControllerApiSync : IApiAccessor
Methods
View SourceAddContactsToGroup(Guid, UpdateGroupContacts, int)
Add contacts to a group
Declaration
GroupContactsDto AddContactsToGroup(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
UpdateGroupContacts | updateGroupContacts | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
GroupContactsDto | GroupContactsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
AddContactsToGroupWithHttpInfo(Guid, UpdateGroupContacts, int)
Add contacts to a group
Declaration
ApiResponse<GroupContactsDto> AddContactsToGroupWithHttpInfo(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
UpdateGroupContacts | updateGroupContacts | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<GroupContactsDto> | ApiResponse of GroupContactsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
CreateGroup(CreateGroupOptions, int)
Create a group
Declaration
GroupDto CreateGroup(CreateGroupOptions createGroupOptions, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
CreateGroupOptions | createGroupOptions | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
GroupDto | GroupDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
CreateGroupWithHttpInfo(CreateGroupOptions, int)
Create a group
Declaration
ApiResponse<GroupDto> CreateGroupWithHttpInfo(CreateGroupOptions createGroupOptions, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
CreateGroupOptions | createGroupOptions | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<GroupDto> | ApiResponse of GroupDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteGroup(Guid, int)
Delete group
Declaration
void DeleteGroup(Guid groupId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
int | operationIndex | Index associated with the operation. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteGroupWithHttpInfo(Guid, int)
Delete group
Declaration
ApiResponse<object> DeleteGroupWithHttpInfo(Guid groupId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAllGroups(int?, int?, string, DateTime?, DateTime?, int)
Get all Contact Groups in paginated format
Declaration
PageGroupProjection GetAllGroups(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
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. |
Returns
Type | Description |
---|---|
PageGroupProjection | PageGroupProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAllGroupsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)
Get all Contact Groups in paginated format
Declaration
ApiResponse<PageGroupProjection> GetAllGroupsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
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. |
Returns
Type | Description |
---|---|
ApiResponse<PageGroupProjection> | ApiResponse of PageGroupProjection |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroup(Guid, int)
Get group
Declaration
GroupDto GetGroup(Guid groupId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
GroupDto | GroupDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroups(int)
Get all groups
Declaration
List<GroupProjection> GetGroups(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<T><GroupProjection> | List<GroupProjection> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroupsWithHttpInfo(int)
Get all groups
Declaration
ApiResponse<List<GroupProjection>> GetGroupsWithHttpInfo(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<System.Collections.Generic.List<T><GroupProjection>> | ApiResponse of List<GroupProjection> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroupWithContacts(Guid, int)
Get group and contacts belonging to it
Declaration
GroupContactsDto GetGroupWithContacts(Guid groupId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
GroupContactsDto | GroupContactsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroupWithContactsPaginated(Guid, int?, int?, string, DateTime?, DateTime?, int)
Declaration
PageContactProjection GetGroupWithContactsPaginated(Guid groupId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.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. |
Returns
Type | Description |
---|---|
PageContactProjection | PageContactProjection |
Remarks
Get group and paginated contacts belonging to it
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroupWithContactsPaginatedWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, int)
Declaration
ApiResponse<PageContactProjection> GetGroupWithContactsPaginatedWithHttpInfo(Guid groupId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.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. |
Returns
Type | Description |
---|---|
ApiResponse<PageContactProjection> | ApiResponse of PageContactProjection |
Remarks
Get group and paginated contacts belonging to it
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroupWithContactsWithHttpInfo(Guid, int)
Get group and contacts belonging to it
Declaration
ApiResponse<GroupContactsDto> GetGroupWithContactsWithHttpInfo(Guid groupId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<GroupContactsDto> | ApiResponse of GroupContactsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetGroupWithHttpInfo(Guid, int)
Get group
Declaration
ApiResponse<GroupDto> GetGroupWithHttpInfo(Guid groupId, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<GroupDto> | ApiResponse of GroupDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RemoveContactsFromGroup(Guid, UpdateGroupContacts, int)
Remove contacts from a group
Declaration
GroupContactsDto RemoveContactsFromGroup(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
UpdateGroupContacts | updateGroupContacts | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
GroupContactsDto | GroupContactsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RemoveContactsFromGroupWithHttpInfo(Guid, UpdateGroupContacts, int)
Remove contacts from a group
Declaration
ApiResponse<GroupContactsDto> RemoveContactsFromGroupWithHttpInfo(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | groupId | |
UpdateGroupContacts | updateGroupContacts | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<GroupContactsDto> | ApiResponse of GroupContactsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |