-
public final class PhoneControllerApi extends ApiClient
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classPhoneControllerApi.Companion
-
Constructor Summary
Constructors Constructor Description PhoneControllerApi(String xApiKey, String basePath)
-
Method Summary
Modifier and Type Method Description final StringgetBaseUrl()final EmergencyAddresscreateEmergencyAddress(CreateEmergencyAddressOptions createEmergencyAddressOptions)final RequestConfigcreateEmergencyAddressRequestConfig(CreateEmergencyAddressOptions createEmergencyAddressOptions)To obtain the request config of the operation createEmergencyAddress final EmptyResponseDtodeleteEmergencyAddress(UUID addressId)final RequestConfigdeleteEmergencyAddressRequestConfig(UUID addressId)To obtain the request config of the operation deleteEmergencyAddress final UnitdeletePhoneNumber(UUID phoneNumberId)final RequestConfigdeletePhoneNumberRequestConfig(UUID phoneNumberId)To obtain the request config of the operation deletePhoneNumber final EmergencyAddressgetEmergencyAddress(UUID addressId)final RequestConfiggetEmergencyAddressRequestConfig(UUID addressId)To obtain the request config of the operation getEmergencyAddress final List<EmergencyAddressDto>getEmergencyAddresses()final RequestConfiggetEmergencyAddressesRequestConfig()To obtain the request config of the operation getEmergencyAddresses final PhoneNumberDtogetPhoneNumber(UUID phoneNumberId)final RequestConfiggetPhoneNumberRequestConfig(UUID phoneNumberId)To obtain the request config of the operation getPhoneNumber final PagePhoneNumberProjectiongetPhoneNumbers(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)final RequestConfiggetPhoneNumbersRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)To obtain the request config of the operation getPhoneNumbers final List<PhonePlanDto>getPhonePlans()final RequestConfiggetPhonePlansRequestConfig()To obtain the request config of the operation getPhonePlans final UnittestPhoneNumberSendSms(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions)final RequestConfigtestPhoneNumberSendSmsRequestConfig(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions)To obtain the request config of the operation testPhoneNumberSendSms -
-
Method Detail
-
getBaseUrl
final String getBaseUrl()
-
createEmergencyAddress
final EmergencyAddress createEmergencyAddress(CreateEmergencyAddressOptions createEmergencyAddressOptions)
-
createEmergencyAddressRequestConfig
final RequestConfig createEmergencyAddressRequestConfig(CreateEmergencyAddressOptions createEmergencyAddressOptions)
To obtain the request config of the operation createEmergencyAddress
-
deleteEmergencyAddress
final EmptyResponseDto deleteEmergencyAddress(UUID addressId)
-
deleteEmergencyAddressRequestConfig
final RequestConfig deleteEmergencyAddressRequestConfig(UUID addressId)
To obtain the request config of the operation deleteEmergencyAddress
-
deletePhoneNumber
final Unit deletePhoneNumber(UUID phoneNumberId)
-
deletePhoneNumberRequestConfig
final RequestConfig deletePhoneNumberRequestConfig(UUID phoneNumberId)
To obtain the request config of the operation deletePhoneNumber
-
getEmergencyAddress
final EmergencyAddress getEmergencyAddress(UUID addressId)
-
getEmergencyAddressRequestConfig
final RequestConfig getEmergencyAddressRequestConfig(UUID addressId)
To obtain the request config of the operation getEmergencyAddress
-
getEmergencyAddresses
final List<EmergencyAddressDto> getEmergencyAddresses()
-
getEmergencyAddressesRequestConfig
final RequestConfig getEmergencyAddressesRequestConfig()
To obtain the request config of the operation getEmergencyAddresses
-
getPhoneNumber
final PhoneNumberDto getPhoneNumber(UUID phoneNumberId)
-
getPhoneNumberRequestConfig
final RequestConfig getPhoneNumberRequestConfig(UUID phoneNumberId)
To obtain the request config of the operation getPhoneNumber
-
getPhoneNumbers
final PagePhoneNumberProjection getPhoneNumbers(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
- Parameters:
page- Optional page index for list pagination (optional, default to 0)size- Optional page size for list pagination (optional, default to 20)sort- Optional createdAt sort direction ASC or DESC (optional, default to ASC)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getPhoneNumbersRequestConfig
final RequestConfig getPhoneNumbersRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
To obtain the request config of the operation getPhoneNumbers
- Parameters:
page- Optional page index for list pagination (optional, default to 0)size- Optional page size for list pagination (optional, default to 20)sort- Optional createdAt sort direction ASC or DESC (optional, default to ASC)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getPhonePlans
final List<PhonePlanDto> getPhonePlans()
-
getPhonePlansRequestConfig
final RequestConfig getPhonePlansRequestConfig()
To obtain the request config of the operation getPhonePlans
-
testPhoneNumberSendSms
final Unit testPhoneNumberSendSms(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions)
-
testPhoneNumberSendSmsRequestConfig
final RequestConfig testPhoneNumberSendSmsRequestConfig(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions)
To obtain the request config of the operation testPhoneNumberSendSms
-
-
-
-