Skip to content

Class: PhoneControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new PhoneControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

• Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createEmergencyAddress

▸ createEmergencyAddress(requestParameters, initOverrides?): Promise<EmergencyAddress>

Parameters

Name Type
requestParameters CreateEmergencyAddressRequest
initOverrides? RequestInit

Returns

Promise<EmergencyAddress>

createEmergencyAddressRaw

▸ createEmergencyAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<EmergencyAddress>>

Parameters

Name Type
requestParameters CreateEmergencyAddressRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<EmergencyAddress>>

deleteEmergencyAddress

▸ deleteEmergencyAddress(requestParameters, initOverrides?): Promise<EmptyResponseDto>

Parameters

Name Type
requestParameters DeleteEmergencyAddressRequest
initOverrides? RequestInit

Returns

Promise<EmptyResponseDto>

deleteEmergencyAddressRaw

▸ deleteEmergencyAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<EmptyResponseDto>>

Parameters

Name Type
requestParameters DeleteEmergencyAddressRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<EmptyResponseDto>>

deletePhoneNumber

▸ deletePhoneNumber(requestParameters, initOverrides?): Promise<void>

Parameters

Name Type
requestParameters DeletePhoneNumberRequest
initOverrides? RequestInit

Returns

Promise<void>

deletePhoneNumberRaw

▸ deletePhoneNumberRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Parameters

Name Type
requestParameters DeletePhoneNumberRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

getEmergencyAddress

▸ getEmergencyAddress(requestParameters, initOverrides?): Promise<EmergencyAddress>

Parameters

Name Type
requestParameters GetEmergencyAddressRequest
initOverrides? RequestInit

Returns

Promise<EmergencyAddress>

getEmergencyAddressRaw

▸ getEmergencyAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<EmergencyAddress>>

Parameters

Name Type
requestParameters GetEmergencyAddressRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<EmergencyAddress>>

getEmergencyAddresses

▸ getEmergencyAddresses(initOverrides?): Promise<EmergencyAddressDto[]>

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<EmergencyAddressDto[]>

getEmergencyAddressesRaw

▸ getEmergencyAddressesRaw(initOverrides?): Promise<ApiResponse<EmergencyAddressDto[]>>

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<EmergencyAddressDto[]>>

getPhoneNumber

▸ getPhoneNumber(requestParameters, initOverrides?): Promise<PhoneNumberDto>

Parameters

Name Type
requestParameters GetPhoneNumberRequest
initOverrides? RequestInit

Returns

Promise<PhoneNumberDto>

getPhoneNumberRaw

▸ getPhoneNumberRaw(requestParameters, initOverrides?): Promise<ApiResponse<PhoneNumberDto>>

Parameters

Name Type
requestParameters GetPhoneNumberRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PhoneNumberDto>>

getPhoneNumbers

▸ getPhoneNumbers(requestParameters, initOverrides?): Promise<PagePhoneNumberProjection>

Parameters

Name Type
requestParameters GetPhoneNumbersRequest
initOverrides? RequestInit

Returns

Promise<PagePhoneNumberProjection>

getPhoneNumbersRaw

▸ getPhoneNumbersRaw(requestParameters, initOverrides?): Promise<ApiResponse<PagePhoneNumberProjection>>

Parameters

Name Type
requestParameters GetPhoneNumbersRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PagePhoneNumberProjection>>

getPhonePlans

▸ getPhonePlans(initOverrides?): Promise<PhonePlanDto[]>

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<PhonePlanDto[]>

getPhonePlansRaw

▸ getPhonePlansRaw(initOverrides?): Promise<ApiResponse<PhonePlanDto[]>>

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<PhonePlanDto[]>>

request

▸ Protected request(context, initOverrides?): Promise<Response>

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request

testPhoneNumberSendSms

▸ testPhoneNumberSendSms(requestParameters, initOverrides?): Promise<void>

Parameters

Name Type
requestParameters TestPhoneNumberSendSmsRequest
initOverrides? RequestInit

Returns

Promise<void>

testPhoneNumberSendSmsRaw

▸ testPhoneNumberSendSmsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Parameters

Name Type
requestParameters TestPhoneNumberSendSmsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

withMiddleware

▸ withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware

withPostMiddleware

▸ withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware

withPreMiddleware

▸ withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware