Interface IMissedSmsControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IMissedSmsControllerApiSync : IApiAccessor

Methods

View Source

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

Get all missed SMS messages in paginated format

Declaration

PageMissedSmsProjection GetAllMissedSmsMessages(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0)

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.

Returns

Type	Description
PageMissedSmsProjection	PageMissedSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all missed SMS messages in paginated format

Declaration

ApiResponse<PageMissedSmsProjection> GetAllMissedSmsMessagesWithHttpInfo(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<PageMissedSmsProjection>	ApiResponse of PageMissedSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsCount(int)

Get missed SMS count

Declaration

CountDto GetMissedSmsCount(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CountDto	CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsCountWithHttpInfo(int)

Get missed SMS count

Declaration

ApiResponse<CountDto> GetMissedSmsCountWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CountDto>	ApiResponse of CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsMessage(Guid, int)

Get missed SMS content

Declaration

MissedSmsDto GetMissedSmsMessage(Guid missedSmsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
MissedSmsDto	MissedSmsDto

Remarks

Returns a missed SMS with full content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsMessageWithHttpInfo(Guid, int)

Get missed SMS content

Declaration

ApiResponse<MissedSmsDto> GetMissedSmsMessageWithHttpInfo(Guid missedSmsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<MissedSmsDto>	ApiResponse of MissedSmsDto

Remarks

Returns a missed SMS with full content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call