Class SmsControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance
object
SmsControllerApi
Implements
Inherited Members
object.Equals(object, object)
object.MemberwiseClone()
object.ToString()
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class SmsControllerApi : ISmsControllerApi, ISmsControllerApiSync, ISmsControllerApiAsync, IApiAccessor

Constructors

View Source

SmsControllerApi()

Initializes a new instance of the SmsControllerApi class.

Declaration
public SmsControllerApi()
View Source

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
View Source

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.
View Source

SmsControllerApi(string)

Initializes a new instance of the SmsControllerApi class.

Declaration
public SmsControllerApi(string basePath)
Parameters
Type Name Description
string basePath

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

DeleteSmsMessage(Guid, int)

Delete SMS message. Delete an SMS message

Declaration
public void DeleteSmsMessage(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid smsId
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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
System.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
View Source

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
System.Guid? phoneNumberId

(optional)
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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
System.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
View Source

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
System.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
View Source

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
System.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
View Source

DeleteSmsMessageWithHttpInfo(Guid, int)

Delete SMS message. Delete an SMS message

Declaration
public ApiResponse<object> DeleteSmsMessageWithHttpInfo(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
System.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
View Source

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
System.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
View Source

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
string

The base path
View Source

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
System.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
View Source

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
System.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
View Source

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
System.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
View Source

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
System.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
View Source

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
View Source

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
View Source

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
View Source

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
View Source

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
System.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
View Source

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
System.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
View Source

GetSmsMessagesPaginated(Guid?, int?, int?, string, bool?, DateTime?, DateTime?, 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 PageSmsProjection GetSmsMessagesPaginated(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.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)
bool? unreadOnly

Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime? since

Optional filter SMSs received after given date time (optional)
DateTime? before

Optional filter SMSs received before given date time (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageSmsProjection

PageSmsProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSmsMessagesPaginatedAsync(Guid?, int?, int?, string, bool?, DateTime?, DateTime?, 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<PageSmsProjection> GetSmsMessagesPaginatedAsync(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.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)
bool? unreadOnly

Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime? since

Optional filter SMSs received after given date time (optional)
DateTime? before

Optional filter SMSs received before given date time (optional)
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
View Source

GetSmsMessagesPaginatedWithHttpInfo(Guid?, int?, int?, string, bool?, DateTime?, DateTime?, 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<PageSmsProjection> GetSmsMessagesPaginatedWithHttpInfo(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.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)
bool? unreadOnly

Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime? since

Optional filter SMSs received after given date time (optional)
DateTime? before

Optional filter SMSs received before given date time (optional)
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
View Source

GetSmsMessagesPaginatedWithHttpInfoAsync(Guid?, int?, int?, string, bool?, DateTime?, DateTime?, 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<PageSmsProjection>> GetSmsMessagesPaginatedWithHttpInfoAsync(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.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)
bool? unreadOnly

Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime? since

Optional filter SMSs received after given date time (optional)
DateTime? before

Optional filter SMSs received before given date time (optional)
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
View Source

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
System.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
View Source

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
System.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
View Source

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
View Source

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
View Source

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
View Source

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
View Source

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
System.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
View Source

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
System.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
View Source

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
System.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
View Source

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
System.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

Implements