Interface IMissedSmsControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IMissedSmsControllerApiAsync : IApiAccessor

Methods

View Source

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

Get all missed SMS messages in paginated format

Declaration

Task<PageMissedSmsProjection> GetAllMissedSmsMessagesAsync(Guid? phoneNumber = null, 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
Guid?	phoneNumber	Optional receiving phone number to filter missed SMS for (optional)
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	Optional filter missed SMS after given date time (optional)
DateTime?	before	Optional filter missed SMS before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageMissedSmsProjection>	Task of PageMissedSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all missed SMS messages in paginated format

Declaration

Task<ApiResponse<PageMissedSmsProjection>> GetAllMissedSmsMessagesWithHttpInfoAsync(Guid? phoneNumber = null, 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
Guid?	phoneNumber	Optional receiving phone number to filter missed SMS for (optional)
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	Optional filter missed SMS after given date time (optional)
DateTime?	before	Optional filter missed SMS before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsCountAsync(int, CancellationToken)

Get missed SMS count

Declaration

Task<CountDto> GetMissedSmsCountAsync(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<CountDto>	Task of CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsCountWithHttpInfoAsync(int, CancellationToken)

Get missed SMS count

Declaration

Task<ApiResponse<CountDto>> GetMissedSmsCountWithHttpInfoAsync(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<CountDto>>	Task of ApiResponse (CountDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsMessageAsync(Guid, int, CancellationToken)

Get missed SMS content

Declaration

Task<MissedSmsDto> GetMissedSmsMessageAsync(Guid missedSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<MissedSmsDto>	Task of MissedSmsDto

Remarks

Returns a missed SMS with full content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get missed SMS content

Declaration

Task<ApiResponse<MissedSmsDto>> GetMissedSmsMessageWithHttpInfoAsync(Guid missedSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Returns a missed SMS with full content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call