Class MissedSmsControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

MissedSmsControllerApi

Implements

IMissedSmsControllerApi

IMissedSmsControllerApiSync

IMissedSmsControllerApiAsync

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 MissedSmsControllerApi : IMissedSmsControllerApi, IMissedSmsControllerApiSync, IMissedSmsControllerApiAsync, IApiAccessor

Constructors

View Source

MissedSmsControllerApi()

Initializes a new instance of the MissedSmsControllerApi class.

Declaration

public MissedSmsControllerApi()

View Source

MissedSmsControllerApi(string)

Initializes a new instance of the MissedSmsControllerApi class.

Declaration

public MissedSmsControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

MissedSmsControllerApi(Configuration)

Initializes a new instance of the MissedSmsControllerApi class using Configuration object

Declaration

public MissedSmsControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

MissedSmsControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

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

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

Get all missed SMS messages in paginated format

Declaration

public 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

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

Get all missed SMS messages in paginated format

Declaration

public 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

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

Get all missed SMS messages in paginated format

Declaration

public 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

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

Get all missed SMS messages in paginated format

Declaration

public 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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetMissedSmsCount(int)

Get missed SMS count

Declaration

public 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

GetMissedSmsCountAsync(int, CancellationToken)

Get missed SMS count

Declaration

public 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

GetMissedSmsCountWithHttpInfo(int)

Get missed SMS count

Declaration

public 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

GetMissedSmsCountWithHttpInfoAsync(int, CancellationToken)

Get missed SMS count

Declaration

public 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

GetMissedSmsMessage(Guid, int)

Get missed SMS content Returns a missed SMS with full content.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsMessageAsync(Guid, int, CancellationToken)

Get missed SMS content Returns a missed SMS with full content.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsMessageWithHttpInfo(Guid, int)

Get missed SMS content Returns a missed SMS with full content.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetMissedSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get missed SMS content Returns a missed SMS with full content.

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IMissedSmsControllerApi

IMissedSmsControllerApiSync

IMissedSmsControllerApiAsync

IApiAccessor