Interface IPhoneControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IPhoneControllerApiSync : IApiAccessor

Methods

View Source

CreateEmergencyAddress(CreateEmergencyAddressOptions, int)

Declaration
EmergencyAddress CreateEmergencyAddress(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateEmergencyAddressOptions createEmergencyAddressOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
EmergencyAddress

EmergencyAddress
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions, int)

Declaration
ApiResponse<EmergencyAddress> CreateEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateEmergencyAddressOptions createEmergencyAddressOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmergencyAddress>

ApiResponse of EmergencyAddress
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteEmergencyAddress(Guid, int)

Declaration
EmptyResponseDto DeleteEmergencyAddress(Guid addressId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid addressId
int operationIndex

Index associated with the operation.
Returns
Type Description
EmptyResponseDto

EmptyResponseDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteEmergencyAddressWithHttpInfo(Guid, int)

Declaration
ApiResponse<EmptyResponseDto> DeleteEmergencyAddressWithHttpInfo(Guid addressId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid addressId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmptyResponseDto>

ApiResponse of EmptyResponseDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeletePhoneNumber(Guid, int)

Declaration
void DeletePhoneNumber(Guid phoneNumberId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeletePhoneNumberWithHttpInfo(Guid, int)

Declaration
ApiResponse<object> DeletePhoneNumberWithHttpInfo(Guid phoneNumberId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
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

GetEmergencyAddress(Guid, int)

Declaration
EmergencyAddress GetEmergencyAddress(Guid addressId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid addressId
int operationIndex

Index associated with the operation.
Returns
Type Description
EmergencyAddress

EmergencyAddress
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmergencyAddresses(int)

Declaration
List<EmergencyAddressDto> GetEmergencyAddresses(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
System.Collections.Generic.List<T><EmergencyAddressDto>

List<EmergencyAddressDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmergencyAddressesWithHttpInfo(int)

Declaration
ApiResponse<List<EmergencyAddressDto>> GetEmergencyAddressesWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<System.Collections.Generic.List<T><EmergencyAddressDto>>

ApiResponse of List<EmergencyAddressDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmergencyAddressWithHttpInfo(Guid, int)

Declaration
ApiResponse<EmergencyAddress> GetEmergencyAddressWithHttpInfo(Guid addressId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid addressId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<EmergencyAddress>

ApiResponse of EmergencyAddress
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumber(Guid, int)

Declaration
PhoneNumberDto GetPhoneNumber(Guid phoneNumberId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
int operationIndex

Index associated with the operation.
Returns
Type Description
PhoneNumberDto

PhoneNumberDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumbers(string, int?, int?, string, DateTime?, DateTime?, int)

Declaration
PagePhoneNumberProjection GetPhoneNumbers(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
string phoneCountry

Optional phone country (optional)
int? page

Optional page index for list pagination (optional, default to 0)
int? size

Optional page size for list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PagePhoneNumberProjection

PagePhoneNumberProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumbersWithHttpInfo(string, int?, int?, string, DateTime?, DateTime?, int)

Declaration
ApiResponse<PagePhoneNumberProjection> GetPhoneNumbersWithHttpInfo(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
string phoneCountry

Optional phone country (optional)
int? page

Optional page index for list pagination (optional, default to 0)
int? size

Optional page size for list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PagePhoneNumberProjection>

ApiResponse of PagePhoneNumberProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberWithHttpInfo(Guid, int)

Declaration
ApiResponse<PhoneNumberDto> GetPhoneNumberWithHttpInfo(Guid phoneNumberId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PhoneNumberDto>

ApiResponse of PhoneNumberDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhonePlans(int)

Declaration
List<PhonePlanDto> GetPhonePlans(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
System.Collections.Generic.List<T><PhonePlanDto>

List<PhonePlanDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhonePlansWithHttpInfo(int)

Declaration
ApiResponse<List<PhonePlanDto>> GetPhonePlansWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<System.Collections.Generic.List<T><PhonePlanDto>>

ApiResponse of List<PhonePlanDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestPhoneNumberSendSms(Guid, TestPhoneNumberOptions, string, int)

Declaration
void TestPhoneNumberSendSms(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
TestPhoneNumberOptions testPhoneNumberOptions
string xTestId

(optional)
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestPhoneNumberSendSmsWithHttpInfo(Guid, TestPhoneNumberOptions, string, int)

Declaration
ApiResponse<object> TestPhoneNumberSendSmsWithHttpInfo(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
TestPhoneNumberOptions testPhoneNumberOptions
string xTestId

(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