Interface IContactControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IContactControllerApiAsync : IApiAccessor

Methods

View Source

CreateContactAsync(CreateContactOptions, int, CancellationToken)

Create a contact

Declaration

Task<ContactDto> CreateContactAsync(CreateContactOptions createContactOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ContactDto>	Task of ContactDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateContactWithHttpInfoAsync(CreateContactOptions, int, CancellationToken)

Create a contact

Declaration

Task<ApiResponse<ContactDto>> CreateContactWithHttpInfoAsync(CreateContactOptions createContactOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteContactAsync(Guid, int, CancellationToken)

Delete contact

Declaration

Task DeleteContactAsync(Guid contactId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	contactId
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

DeleteContactWithHttpInfoAsync(Guid, int, CancellationToken)

Delete contact

Declaration

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

Parameters

Type	Name	Description
System.Guid	contactId
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

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

Get all contacts

Declaration

Task<PageContactProjection> GetAllContactsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = 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)
string	search	Search terms (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

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

Get all contacts

Declaration

Task<ApiResponse<PageContactProjection>> GetAllContactsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = 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)
string	search	Search terms (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

GetContactAsync(Guid, int, CancellationToken)

Get contact

Declaration

Task<ContactDto> GetContactAsync(Guid contactId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ContactDto>	Task of ContactDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetContactsAsync(int, CancellationToken)

Get all contacts

Declaration

Task<List<ContactProjection>> GetContactsAsync(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<System.Collections.Generic.List<T><ContactProjection>>	Task of List<ContactProjection>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetContactsWithHttpInfoAsync(int, CancellationToken)

Get all contacts

Declaration

Task<ApiResponse<List<ContactProjection>>> GetContactsWithHttpInfoAsync(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<System.Collections.Generic.List<T><ContactProjection>>>	Task of ApiResponse (List<ContactProjection>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetContactVCardAsync(Guid, int, CancellationToken)

Get contact vCard vcf file

Declaration

[Obsolete]
Task GetContactVCardAsync(Guid contactId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	contactId
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

GetContactVCardWithHttpInfoAsync(Guid, int, CancellationToken)

Get contact vCard vcf file

Declaration

[Obsolete]
Task<ApiResponse<object>> GetContactVCardWithHttpInfoAsync(Guid contactId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	contactId
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

GetContactWithHttpInfoAsync(Guid, int, CancellationToken)

Get contact

Declaration

Task<ApiResponse<ContactDto>> GetContactWithHttpInfoAsync(Guid contactId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call