Interface IPhoneControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IPhoneControllerApiAsync : IApiAccessor

Methods

View Source

CreateEmergencyAddressAsync(CreateEmergencyAddressOptions, int, CancellationToken)

Declaration

Task<EmergencyAddress> CreateEmergencyAddressAsync(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmergencyAddress>	Task of EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateEmergencyAddressWithHttpInfoAsync(CreateEmergencyAddressOptions, int, CancellationToken)

Declaration

Task<ApiResponse<EmergencyAddress>> CreateEmergencyAddressWithHttpInfoAsync(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmergencyAddressAsync(Guid, int, CancellationToken)

Declaration

Task<EmptyResponseDto> DeleteEmergencyAddressAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmptyResponseDto>	Task of EmptyResponseDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

Task<ApiResponse<EmptyResponseDto>> DeleteEmergencyAddressWithHttpInfoAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeletePhoneNumberAsync(Guid, int, CancellationToken)

Declaration

Task DeletePhoneNumberAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	phoneNumberId
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

DeletePhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

Task<ApiResponse<object>> DeletePhoneNumberWithHttpInfoAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	phoneNumberId
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

GetEmergencyAddressAsync(Guid, int, CancellationToken)

Declaration

Task<EmergencyAddress> GetEmergencyAddressAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmergencyAddress>	Task of EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmergencyAddressesAsync(int, CancellationToken)

Declaration

Task<List<EmergencyAddressDto>> GetEmergencyAddressesAsync(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<System.Collections.Generic.List<T><EmergencyAddressDto>>	Task of List<EmergencyAddressDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmergencyAddressesWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<List<EmergencyAddressDto>>> GetEmergencyAddressesWithHttpInfoAsync(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<System.Collections.Generic.List<T><EmergencyAddressDto>>>	Task of ApiResponse (List<EmergencyAddressDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

Task<ApiResponse<EmergencyAddress>> GetEmergencyAddressWithHttpInfoAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhoneNumberAsync(Guid, int, CancellationToken)

Declaration

Task<PhoneNumberDto> GetPhoneNumberAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<PhoneNumberDto>	Task of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhoneNumbersAsync(string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

Task<PagePhoneNumberProjection> GetPhoneNumbersAsync(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PagePhoneNumberProjection>	Task of PagePhoneNumberProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhoneNumbersWithHttpInfoAsync(string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

Task<ApiResponse<PagePhoneNumberProjection>> GetPhoneNumbersWithHttpInfoAsync(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

Task<ApiResponse<PhoneNumberDto>> GetPhoneNumberWithHttpInfoAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhonePlansAsync(int, CancellationToken)

Declaration

Task<List<PhonePlanDto>> GetPhonePlansAsync(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<System.Collections.Generic.List<T><PhonePlanDto>>	Task of List<PhonePlanDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhonePlansWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<List<PhonePlanDto>>> GetPhonePlansWithHttpInfoAsync(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<System.Collections.Generic.List<T><PhonePlanDto>>>	Task of ApiResponse (List<PhonePlanDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestPhoneNumberSendSmsAsync(Guid, TestPhoneNumberOptions, string, int, CancellationToken)

Declaration

Task TestPhoneNumberSendSmsAsync(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	phoneNumberId
TestPhoneNumberOptions	testPhoneNumberOptions
string	xTestId	(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

TestPhoneNumberSendSmsWithHttpInfoAsync(Guid, TestPhoneNumberOptions, string, int, CancellationToken)

Declaration

Task<ApiResponse<object>> TestPhoneNumberSendSmsWithHttpInfoAsync(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	phoneNumberId
TestPhoneNumberOptions	testPhoneNumberOptions
string	xTestId	(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