Search Results for

    Show / Hide Table of Contents

    Class PhoneControllerApi

    Represents a collection of functions to interact with the API endpoints

    Inheritance
    object
    PhoneControllerApi
    Implements
    IPhoneControllerApi
    IPhoneControllerApiSync
    IPhoneControllerApiAsync
    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 PhoneControllerApi : IPhoneControllerApi, IPhoneControllerApiSync, IPhoneControllerApiAsync, IApiAccessor

    Constructors

    View Source

    PhoneControllerApi()

    Initializes a new instance of the PhoneControllerApi class.

    Declaration
    public PhoneControllerApi()
    View Source

    PhoneControllerApi(Configuration)

    Initializes a new instance of the PhoneControllerApi class using Configuration object

    Declaration
    public PhoneControllerApi(Configuration configuration)
    Parameters
    Type Name Description
    Configuration configuration

    An instance of Configuration

    View Source

    PhoneControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

    Declaration
    public PhoneControllerApi(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

    PhoneControllerApi(string)

    Initializes a new instance of the PhoneControllerApi class.

    Declaration
    public PhoneControllerApi(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

    CreateEmergencyAddress(CreateEmergencyAddressOptions, int)

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

    CreateEmergencyAddressAsync(CreateEmergencyAddressOptions, int, CancellationToken)

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

    CreateEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions, int)

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

    CreateEmergencyAddressWithHttpInfoAsync(CreateEmergencyAddressOptions, int, CancellationToken)

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

    DeleteEmergencyAddress(Guid, int)

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

    DeleteEmergencyAddressAsync(Guid, int, CancellationToken)

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

    DeleteEmergencyAddressWithHttpInfo(Guid, int)

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

    DeleteEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

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

    DeletePhoneNumber(Guid, int)

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

    DeletePhoneNumberAsync(Guid, int, CancellationToken)

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

    DeletePhoneNumberWithHttpInfo(Guid, int)

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

    DeletePhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

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

    GetBasePath()

    Gets the base path of the API client.

    Declaration
    public string GetBasePath()
    Returns
    Type Description
    string

    The base path

    View Source

    GetEmergencyAddress(Guid, int)

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

    GetEmergencyAddressAsync(Guid, int, CancellationToken)

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

    GetEmergencyAddresses(int)

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

    GetEmergencyAddressesAsync(int, CancellationToken)

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

    GetEmergencyAddressesWithHttpInfo(int)

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

    GetEmergencyAddressesWithHttpInfoAsync(int, CancellationToken)

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

    GetEmergencyAddressWithHttpInfo(Guid, int)

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

    GetEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

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

    GetPhoneNumber(Guid, int)

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

    GetPhoneNumberAsync(Guid, int, CancellationToken)

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

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

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

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

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

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

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

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

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

    GetPhoneNumberWithHttpInfo(Guid, int)

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

    GetPhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

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

    GetPhonePlans(int)

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

    GetPhonePlansAsync(int, CancellationToken)

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

    GetPhonePlansWithHttpInfo(int)

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

    GetPhonePlansWithHttpInfoAsync(int, CancellationToken)

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

    TestPhoneNumberSendSms(Guid, TestPhoneNumberOptions, string, int)

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

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

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

    TestPhoneNumberSendSmsWithHttpInfo(Guid, TestPhoneNumberOptions, string, int)

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

    View Source

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

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

    Implements

    IPhoneControllerApi
    IPhoneControllerApiSync
    IPhoneControllerApiAsync
    IApiAccessor
    • View Source
    In This Article
    Back to top See MailSlurp website for more information.