Class SmsControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

SmsControllerApi

Implements

ISmsControllerApi

ISmsControllerApiSync

ISmsControllerApiAsync

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 SmsControllerApi : ISmsControllerApi, ISmsControllerApiSync, ISmsControllerApiAsync, IApiAccessor

Constructors

SmsControllerApi()

Initializes a new instance of the SmsControllerApi class.

Declaration

public SmsControllerApi()

SmsControllerApi(string)

Initializes a new instance of the SmsControllerApi class.

Declaration

public SmsControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

SmsControllerApi(Configuration)

Initializes a new instance of the SmsControllerApi class using Configuration object

Declaration

public SmsControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

SmsControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

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

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

DeleteSentSmsMessage(Guid, int)

Delete sent SMS message. Delete a sent SMS message

Declaration

public void DeleteSentSmsMessage(Guid sentSmsId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSentSmsMessageAsync(Guid, int, CancellationToken)

Delete sent SMS message. Delete a sent SMS message

Declaration

public Task DeleteSentSmsMessageAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

DeleteSentSmsMessageWithHttpInfo(Guid, int)

Delete sent SMS message. Delete a sent SMS message

Declaration

public ApiResponse<object> DeleteSentSmsMessageWithHttpInfo(Guid sentSmsId, int operationIndex = 0)

Parameters

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

DeleteSentSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Delete sent SMS message. Delete a sent SMS message

Declaration

public Task<ApiResponse<object>> DeleteSentSmsMessageWithHttpInfoAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

DeleteSentSmsMessages(Guid?, int)

Delete all sent SMS messages Delete all sent SMS messages or all messages for a given phone number

Declaration

public void DeleteSentSmsMessages(Guid? phoneNumberId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSentSmsMessagesAsync(Guid?, int, CancellationToken)

Delete all sent SMS messages Delete all sent SMS messages or all messages for a given phone number

Declaration

public Task DeleteSentSmsMessagesAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
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

DeleteSentSmsMessagesWithHttpInfo(Guid?, int)

Delete all sent SMS messages Delete all sent SMS messages or all messages for a given phone number

Declaration

public ApiResponse<object> DeleteSentSmsMessagesWithHttpInfo(Guid? phoneNumberId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
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

DeleteSentSmsMessagesWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete all sent SMS messages Delete all sent SMS messages or all messages for a given phone number

Declaration

public Task<ApiResponse<object>> DeleteSentSmsMessagesWithHttpInfoAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
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

DeleteSmsMessage(Guid, int)

Delete SMS message. Delete an SMS message

Declaration

public void DeleteSmsMessage(Guid smsId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSmsMessageAsync(Guid, int, CancellationToken)

Delete SMS message. Delete an SMS message

Declaration

public Task DeleteSmsMessageAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

DeleteSmsMessageWithHttpInfo(Guid, int)

Delete SMS message. Delete an SMS message

Declaration

public ApiResponse<object> DeleteSmsMessageWithHttpInfo(Guid smsId, int operationIndex = 0)

Parameters

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

DeleteSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Delete SMS message. Delete an SMS message

Declaration

public Task<ApiResponse<object>> DeleteSmsMessageWithHttpInfoAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

DeleteSmsMessages(Guid?, int)

Delete all SMS messages Delete all SMS messages or all messages for a given phone number

Declaration

public void DeleteSmsMessages(Guid? phoneNumberId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteSmsMessagesAsync(Guid?, int, CancellationToken)

Delete all SMS messages Delete all SMS messages or all messages for a given phone number

Declaration

public Task DeleteSmsMessagesAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
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

DeleteSmsMessagesWithHttpInfo(Guid?, int)

Delete all SMS messages Delete all SMS messages or all messages for a given phone number

Declaration

public ApiResponse<object> DeleteSmsMessagesWithHttpInfo(Guid? phoneNumberId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
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

DeleteSmsMessagesWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete all SMS messages Delete all SMS messages or all messages for a given phone number

Declaration

public Task<ApiResponse<object>> DeleteSmsMessagesWithHttpInfoAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(optional)
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

GetAllSmsMessages(Guid?, int?, int?, string, DateTime?, DateTime?, string, bool?, int)

Declaration

public PageSmsProjection GetAllSmsMessages(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	phoneNumber	Optional receiving phone number to filter SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSmsProjection	PageSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllSmsMessagesAsync(Guid?, int?, int?, string, DateTime?, DateTime?, string, bool?, int, CancellationToken)

Declaration

public Task<PageSmsProjection> GetAllSmsMessagesAsync(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumber	Optional receiving phone number to filter SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageSmsProjection>	Task of PageSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllSmsMessagesWithHttpInfo(Guid?, int?, int?, string, DateTime?, DateTime?, string, bool?, int)

Declaration

public ApiResponse<PageSmsProjection> GetAllSmsMessagesWithHttpInfo(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	phoneNumber	Optional receiving phone number to filter SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSmsProjection>	ApiResponse of PageSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllSmsMessagesWithHttpInfoAsync(Guid?, int?, int?, string, DateTime?, DateTime?, string, bool?, int, CancellationToken)

Declaration

public Task<ApiResponse<PageSmsProjection>> GetAllSmsMessagesWithHttpInfoAsync(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumber	Optional receiving phone number to filter SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetReplyForSmsMessage(Guid, int)

Get reply for an SMS message Get reply for an SMS message.

Declaration

public ReplyForSms GetReplyForSmsMessage(Guid smsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ReplyForSms	ReplyForSms

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetReplyForSmsMessageAsync(Guid, int, CancellationToken)

Get reply for an SMS message Get reply for an SMS message.

Declaration

public Task<ReplyForSms> GetReplyForSmsMessageAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ReplyForSms>	Task of ReplyForSms

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetReplyForSmsMessageWithHttpInfo(Guid, int)

Get reply for an SMS message Get reply for an SMS message.

Declaration

public ApiResponse<ReplyForSms> GetReplyForSmsMessageWithHttpInfo(Guid smsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ReplyForSms>	ApiResponse of ReplyForSms

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetReplyForSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get reply for an SMS message Get reply for an SMS message.

Declaration

public Task<ApiResponse<ReplyForSms>> GetReplyForSmsMessageWithHttpInfoAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsCount(int)

Get sent SMS count Get number of sent SMS

Declaration

public CountDto GetSentSmsCount(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

GetSentSmsCountAsync(int, CancellationToken)

Get sent SMS count Get number of sent SMS

Declaration

public Task<CountDto> GetSentSmsCountAsync(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

GetSentSmsCountWithHttpInfo(int)

Get sent SMS count Get number of sent SMS

Declaration

public ApiResponse<CountDto> GetSentSmsCountWithHttpInfo(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

GetSentSmsCountWithHttpInfoAsync(int, CancellationToken)

Get sent SMS count Get number of sent SMS

Declaration

public Task<ApiResponse<CountDto>> GetSentSmsCountWithHttpInfoAsync(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

GetSentSmsMessage(Guid, int)

Get sent SMS content including body. Expects sent SMS to exist by ID. Returns an SMS summary object with content.

Declaration

public SentSmsDto GetSentSmsMessage(Guid sentSmsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
SentSmsDto	SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsMessageAsync(Guid, int, CancellationToken)

Get sent SMS content including body. Expects sent SMS to exist by ID. Returns an SMS summary object with content.

Declaration

public Task<SentSmsDto> GetSentSmsMessageAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<SentSmsDto>	Task of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsMessageWithHttpInfo(Guid, int)

Get sent SMS content including body. Expects sent SMS to exist by ID. Returns an SMS summary object with content.

Declaration

public ApiResponse<SentSmsDto> GetSentSmsMessageWithHttpInfo(Guid sentSmsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<SentSmsDto>	ApiResponse of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get sent SMS content including body. Expects sent SMS to exist by ID. Returns an SMS summary object with content.

Declaration

public Task<ApiResponse<SentSmsDto>> GetSentSmsMessageWithHttpInfoAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Declaration

public PageSentSmsProjection GetSentSmsMessagesPaginated(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 phone number to filter sent SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSentSmsProjection	PageSentSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Declaration

public Task<PageSentSmsProjection> GetSentSmsMessagesPaginatedAsync(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 phone number to filter sent SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received 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<PageSentSmsProjection>	Task of PageSentSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Declaration

public ApiResponse<PageSentSmsProjection> GetSentSmsMessagesPaginatedWithHttpInfo(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 phone number to filter sent SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSentSmsProjection>	ApiResponse of PageSentSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Declaration

public Task<ApiResponse<PageSentSmsProjection>> GetSentSmsMessagesPaginatedWithHttpInfoAsync(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 phone number to filter sent SMS messages for (optional)
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received 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<PageSentSmsProjection>>	Task of ApiResponse (PageSentSmsProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsCount(int)

Get SMS count Get number of SMS

Declaration

public CountDto GetSmsCount(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

GetSmsCountAsync(int, CancellationToken)

Get SMS count Get number of SMS

Declaration

public Task<CountDto> GetSmsCountAsync(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

GetSmsCountWithHttpInfo(int)

Get SMS count Get number of SMS

Declaration

public ApiResponse<CountDto> GetSmsCountWithHttpInfo(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

GetSmsCountWithHttpInfoAsync(int, CancellationToken)

Get SMS count Get number of SMS

Declaration

public Task<ApiResponse<CountDto>> GetSmsCountWithHttpInfoAsync(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

GetSmsMessage(Guid, int)

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

Declaration

public SmsDto GetSmsMessage(Guid smsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
SmsDto	SmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsMessageAsync(Guid, int, CancellationToken)

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

Declaration

public Task<SmsDto> GetSmsMessageAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<SmsDto>	Task of SmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsMessageWithHttpInfo(Guid, int)

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

Declaration

public ApiResponse<SmsDto> GetSmsMessageWithHttpInfo(Guid smsId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<SmsDto>	ApiResponse of SmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

Declaration

public Task<ApiResponse<SmsDto>> GetSmsMessageWithHttpInfoAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadSmsCount(int)

Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public UnreadCount GetUnreadSmsCount(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
UnreadCount	UnreadCount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadSmsCountAsync(int, CancellationToken)

Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public Task<UnreadCount> GetUnreadSmsCountAsync(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<UnreadCount>	Task of UnreadCount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadSmsCountWithHttpInfo(int)

Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public ApiResponse<UnreadCount> GetUnreadSmsCountWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<UnreadCount>	ApiResponse of UnreadCount

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetUnreadSmsCountWithHttpInfoAsync(int, CancellationToken)

Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Declaration

public Task<ApiResponse<UnreadCount>> GetUnreadSmsCountWithHttpInfoAsync(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<UnreadCount>>	Task of ApiResponse (UnreadCount)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToSmsMessage(Guid, SmsReplyOptions, int)

Send a reply to a received SMS message. Replies are sent from the receiving number. Reply to an SMS message.

Declaration

public SentSmsDto ReplyToSmsMessage(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	smsId
SmsReplyOptions	smsReplyOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SentSmsDto	SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToSmsMessageAsync(Guid, SmsReplyOptions, int, CancellationToken)

Send a reply to a received SMS message. Replies are sent from the receiving number. Reply to an SMS message.

Declaration

public Task<SentSmsDto> ReplyToSmsMessageAsync(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<SentSmsDto>	Task of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToSmsMessageWithHttpInfo(Guid, SmsReplyOptions, int)

Send a reply to a received SMS message. Replies are sent from the receiving number. Reply to an SMS message.

Declaration

public ApiResponse<SentSmsDto> ReplyToSmsMessageWithHttpInfo(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	smsId
SmsReplyOptions	smsReplyOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SentSmsDto>	ApiResponse of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReplyToSmsMessageWithHttpInfoAsync(Guid, SmsReplyOptions, int, CancellationToken)

Send a reply to a received SMS message. Replies are sent from the receiving number. Reply to an SMS message.

Declaration

public Task<ApiResponse<SentSmsDto>> ReplyToSmsMessageWithHttpInfoAsync(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSms(SmsSendOptions, string, Guid?, int)

Declaration

public SentSmsDto SendSms(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0)

Parameters

Type	Name	Description
SmsSendOptions	smsSendOptions
string	fromPhoneNumber	Phone number to send from in E.164 format (optional)
Guid?	fromPhoneId	Phone number ID to send from in UUID form (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SentSmsDto	SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSmsAsync(SmsSendOptions, string, Guid?, int, CancellationToken)

Declaration

public Task<SentSmsDto> SendSmsAsync(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SmsSendOptions	smsSendOptions
string	fromPhoneNumber	Phone number to send from in E.164 format (optional)
Guid?	fromPhoneId	Phone number ID to send from in UUID form (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SentSmsDto>	Task of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSmsWithHttpInfo(SmsSendOptions, string, Guid?, int)

Declaration

public ApiResponse<SentSmsDto> SendSmsWithHttpInfo(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0)

Parameters

Type	Name	Description
SmsSendOptions	smsSendOptions
string	fromPhoneNumber	Phone number to send from in E.164 format (optional)
Guid?	fromPhoneId	Phone number ID to send from in UUID form (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SentSmsDto>	ApiResponse of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSmsWithHttpInfoAsync(SmsSendOptions, string, Guid?, int, CancellationToken)

Declaration

public Task<ApiResponse<SentSmsDto>> SendSmsWithHttpInfoAsync(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SmsSendOptions	smsSendOptions
string	fromPhoneNumber	Phone number to send from in E.164 format (optional)
Guid?	fromPhoneId	Phone number ID to send from in UUID form (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetSmsFavourited(Guid, bool, int)

Declaration

public SmsDto SetSmsFavourited(Guid smsId, bool favourited, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	smsId	ID of SMS to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SmsDto	SmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetSmsFavouritedAsync(Guid, bool, int, CancellationToken)

Declaration

public Task<SmsDto> SetSmsFavouritedAsync(Guid smsId, bool favourited, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	smsId	ID of SMS to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SmsDto>	Task of SmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetSmsFavouritedWithHttpInfo(Guid, bool, int)

Declaration

public ApiResponse<SmsDto> SetSmsFavouritedWithHttpInfo(Guid smsId, bool favourited, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	smsId	ID of SMS to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SmsDto>	ApiResponse of SmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetSmsFavouritedWithHttpInfoAsync(Guid, bool, int, CancellationToken)

Declaration

public Task<ApiResponse<SmsDto>> SetSmsFavouritedWithHttpInfoAsync(Guid smsId, bool favourited, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	smsId	ID of SMS to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

ISmsControllerApi

ISmsControllerApiSync

ISmsControllerApiAsync

IApiAccessor