Class GroupControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

GroupControllerApi

Implements

IGroupControllerApi

IGroupControllerApiSync

IGroupControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class GroupControllerApi : IGroupControllerApi, IGroupControllerApiSync, IGroupControllerApiAsync, IApiAccessor

Constructors

View Source

GroupControllerApi()

Initializes a new instance of the GroupControllerApi class.

Declaration

public GroupControllerApi()

View Source

GroupControllerApi(string)

Initializes a new instance of the GroupControllerApi class.

Declaration

public GroupControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

GroupControllerApi(Configuration)

Initializes a new instance of the GroupControllerApi class using Configuration object

Declaration

public GroupControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

GroupControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the GroupControllerApi class using a Configuration object and client instance.

Declaration

public GroupControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

AddContactsToGroup(Guid, UpdateGroupContacts, int)

Add contacts to a group

Declaration

public GroupContactsDto AddContactsToGroup(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

AddContactsToGroupAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Add contacts to a group

Declaration

public 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

AddContactsToGroupWithHttpInfo(Guid, UpdateGroupContacts, int)

Add contacts to a group

Declaration

public ApiResponse<GroupContactsDto> AddContactsToGroupWithHttpInfo(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

AddContactsToGroupWithHttpInfoAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Add contacts to a group

Declaration

public 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

CreateGroup(CreateGroupOptions, int)

Create a group

Declaration

public 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

View Source

CreateGroupAsync(CreateGroupOptions, int, CancellationToken)

Create a group

Declaration

public 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

CreateGroupWithHttpInfo(CreateGroupOptions, int)

Create a group

Declaration

public 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

View Source

CreateGroupWithHttpInfoAsync(CreateGroupOptions, int, CancellationToken)

Create a group

Declaration

public 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

DeleteGroup(Guid, int)

Delete group

Declaration

public void DeleteGroup(Guid groupId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	groupId
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteGroupAsync(Guid, int, CancellationToken)

Delete group

Declaration

public 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

DeleteGroupWithHttpInfo(Guid, int)

Delete group

Declaration

public ApiResponse<object> DeleteGroupWithHttpInfo(Guid groupId, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

DeleteGroupWithHttpInfoAsync(Guid, int, CancellationToken)

Delete group

Declaration

public 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

GetAllGroups(int?, int?, string, DateTime?, DateTime?, int)

Get all Contact Groups in paginated format

Declaration

public 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

View Source

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

Get all Contact Groups in paginated format

Declaration

public 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

GetAllGroupsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Get all Contact Groups in paginated format

Declaration

public 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

View Source

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

Get all Contact Groups in paginated format

Declaration

public 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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetGroup(Guid, int)

Get group

Declaration

public GroupDto GetGroup(Guid groupId, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

GetGroupAsync(Guid, int, CancellationToken)

Get group

Declaration

public 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

GetGroupWithContacts(Guid, int)

Get group and contacts belonging to it

Declaration

public GroupContactsDto GetGroupWithContacts(Guid groupId, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

GetGroupWithContactsAsync(Guid, int, CancellationToken)

Get group and contacts belonging to it

Declaration

public 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

GetGroupWithContactsPaginated(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get group and paginated contacts belonging to it

Declaration

public 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
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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get group and paginated contacts belonging to it

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupWithContactsPaginatedWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get group and paginated contacts belonging to it

Declaration

public 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
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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get group and paginated contacts belonging to it

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupWithContactsWithHttpInfo(Guid, int)

Get group and contacts belonging to it

Declaration

public ApiResponse<GroupContactsDto> GetGroupWithContactsWithHttpInfo(Guid groupId, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

GetGroupWithContactsWithHttpInfoAsync(Guid, int, CancellationToken)

Get group and contacts belonging to it

Declaration

public 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

GetGroupWithHttpInfo(Guid, int)

Get group

Declaration

public ApiResponse<GroupDto> GetGroupWithHttpInfo(Guid groupId, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

GetGroupWithHttpInfoAsync(Guid, int, CancellationToken)

Get group

Declaration

public 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

GetGroups(int)

Get all groups

Declaration

public List<GroupProjection> GetGroups(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<GroupProjection>	List<GroupProjection>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupsAsync(int, CancellationToken)

Get all groups

Declaration

public 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

GetGroupsWithHttpInfo(int)

Get all groups

Declaration

public ApiResponse<List<GroupProjection>> GetGroupsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<GroupProjection>>	ApiResponse of List<GroupProjection>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGroupsWithHttpInfoAsync(int, CancellationToken)

Get all groups

Declaration

public 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

RemoveContactsFromGroup(Guid, UpdateGroupContacts, int)

Remove contacts from a group

Declaration

public GroupContactsDto RemoveContactsFromGroup(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

RemoveContactsFromGroupAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Remove contacts from a group

Declaration

public 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

RemoveContactsFromGroupWithHttpInfo(Guid, UpdateGroupContacts, int)

Remove contacts from a group

Declaration

public ApiResponse<GroupContactsDto> RemoveContactsFromGroupWithHttpInfo(Guid groupId, UpdateGroupContacts updateGroupContacts, int operationIndex = 0)

Parameters

Type	Name	Description
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

View Source

RemoveContactsFromGroupWithHttpInfoAsync(Guid, UpdateGroupContacts, int, CancellationToken)

Remove contacts from a group

Declaration

public 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

Implements

IGroupControllerApi

IGroupControllerApiSync

IGroupControllerApiAsync

IApiAccessor