MailSlurpAPI.Api.PhoneController (mailslurp v15.17.22)
API calls for all endpoints tagged PhoneController.
Summary
Functions
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- create_emergency_address_options (CreateEmergencyAddressOptions):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- address_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- phone_number_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- address_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
, ...]} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- phone_number_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :phone_country (String.t): Optional phone country
- :page (integer()): Optional page index for list pagination
- :size (integer()): Optional page size for list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
Returns
} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
, ...]} on success {:error, info} on failure
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- phone_number_id (String.t):
- test_phone_number_options (TestPhoneNumberOptions):
- opts (KeywordList): [optional] Optional parameters
- :x_test_id (String.t):
Returns
} on success {:error, info} on failure
Functions
Link to this function
create_emergency_address(connection, create_emergency_address_options, opts \\ [])
@spec create_emergency_address( Tesla.Env.client(), MailSlurpAPI.Model.CreateEmergencyAddressOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.EmergencyAddress.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- create_emergency_address_options (CreateEmergencyAddressOptions):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
delete_emergency_address(connection, address_id, opts \\ [])
@spec delete_emergency_address(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.EmptyResponseDto.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- address_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
delete_phone_number(connection, phone_number_id, opts \\ [])
@spec delete_phone_number(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- phone_number_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_emergency_address(connection, address_id, opts \\ [])
@spec get_emergency_address(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.EmergencyAddress.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- address_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_emergency_addresses(connection, opts \\ [])
@spec get_emergency_addresses(Tesla.Env.client(), keyword()) :: {:ok, [MailSlurpAPI.Model.EmergencyAddressDto.t()]} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
, ...]} on success {:error, info} on failure
Link to this function
get_phone_number(connection, phone_number_id, opts \\ [])
@spec get_phone_number(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.PhoneNumberDto.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- phone_number_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_phone_numbers(connection, opts \\ [])
@spec get_phone_numbers(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PagePhoneNumberProjection.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :phone_country (String.t): Optional phone country
- :page (integer()): Optional page index for list pagination
- :size (integer()): Optional page size for list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
Returns
} on success {:error, info} on failure
Link to this function
get_phone_plans(connection, opts \\ [])
@spec get_phone_plans(Tesla.Env.client(), keyword()) :: {:ok, [MailSlurpAPI.Model.PhonePlanDto.t()]} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
, ...]} on success {:error, info} on failure
Link to this function
test_phone_number_send_sms(connection, phone_number_id, test_phone_number_options, opts \\ [])
@spec test_phone_number_send_sms( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.TestPhoneNumberOptions.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- phone_number_id (String.t):
- test_phone_number_options (TestPhoneNumberOptions):
- opts (KeywordList): [optional] Optional parameters
- :x_test_id (String.t):
Returns
} on success {:error, info} on failure