Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-administration

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActivationState

ActivationState: "Activated" | "AssignmentPending" | "AssignmentFailed" | "UpdatePending" | "UpdateFailed"

Defines values for ActivationState. Possible values include: 'Activated', 'AssignmentPending', 'AssignmentFailed', 'UpdatePending', 'UpdateFailed'

readonly

AssignmentStatus

AssignmentStatus: "Unassigned" | "Unknown" | "UserAssigned" | "ConferenceAssigned" | "FirstPartyAppAssigned" | "ThirdPartyAppAssigned"

Defines values for AssignmentStatus. Possible values include: 'Unassigned', 'Unknown', 'UserAssigned', 'ConferenceAssigned', 'FirstPartyAppAssigned', 'ThirdPartyAppAssigned'

readonly

CancelSearchOptions

CancelSearchOptions: OperationOptions

Additional request option for cancel search operations.

CapabilitiesUpdateStatus

CapabilitiesUpdateStatus: "Pending" | "InProgress" | "Complete" | "Error"

Defines values for CapabilitiesUpdateStatus. Possible values include: 'Pending', 'InProgress', 'Complete', 'Error'

readonly

Capability

Capability: "UserAssignment" | "FirstPartyVoiceAppAssignment" | "ConferenceAssignment" | "P2PSmsEnabled" | "Geographic" | "NonGeographic" | "TollCalling" | "TollFreeCalling" | "Premium" | "P2PSmsCapable" | "A2PSmsCapable" | "A2PSmsEnabled" | "Calling" | "TollFree" | "FirstPartyAppAssignment" | "ThirdPartyAppAssignment" | "Azure" | "Office365" | "InboundCalling" | "OutboundCalling" | "InboundA2PSms" | "OutboundA2PSms" | "InboundP2PSms" | "OutboundP2PSms"

Defines values for Capability. Possible values include: 'UserAssignment', 'FirstPartyVoiceAppAssignment', 'ConferenceAssignment', 'P2PSmsEnabled', 'Geographic', 'NonGeographic', 'TollCalling', 'TollFreeCalling', 'Premium', 'P2PSmsCapable', 'A2PSmsCapable', 'A2PSmsEnabled', 'Calling', 'TollFree', 'FirstPartyAppAssignment', 'ThirdPartyAppAssignment', 'Azure', 'Office365', 'InboundCalling', 'OutboundCalling', 'InboundA2PSms', 'OutboundA2PSms', 'InboundP2PSms', 'OutboundP2PSms'

readonly

CommunicationIdentityCreateResponse

CommunicationIdentityCreateResponse: CommunicationIdentity & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CommunicationIdentity } }

Contains response data for the create operation.

CommunicationIdentityIssueTokenResponse

CommunicationIdentityIssueTokenResponse: CommunicationIdentityToken & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CommunicationIdentityToken } }

Contains response data for the issueToken operation.

CreatePhoneNumberSearchResponse

CreatePhoneNumberSearchResponse: WithResponse<CreateSearchResponse>

Represents the response from starting a search for phone numbers.

CreateUserResponse

CreateUserResponse: WithResponse<CommunicationUser>

Represents the response from creating a user

CurrencyType

CurrencyType: "USD"

Defines values for CurrencyType. Possible values include: 'USD'

readonly

GetAreaCodesOptions

GetAreaCodesOptions: OperationOptions

Options for querying available area codes.

GetAreaCodesResponse

GetAreaCodesResponse: WithResponse<AreaCodes>

Represents the response from getting a list of the supported area codes.

GetCapabilitiesUpdateOptions

GetCapabilitiesUpdateOptions: OperationOptions

Additional request options for getting the update capabilities request.

GetCapabilitiesUpdateResponse

GetCapabilitiesUpdateResponse: WithResponse<UpdatePhoneNumberCapabilitiesResponse>

Represents the response from getting the update capabilities request associated with a given id.

GetPhoneNumberConfigurationOptions

GetPhoneNumberConfigurationOptions: OperationOptions

Additional request options for getting the configuration of a phone number.

GetPhoneNumberConfigurationResponse

GetPhoneNumberConfigurationResponse: WithResponse<NumberConfigurationResponse>

Represents the response from getting the configuration for a given number.

GetPhonePlanLocationOptionsOptions

GetPhonePlanLocationOptionsOptions: PageableLocalizationOptions

Options for getting a plan location options

GetPhonePlanLocationOptionsResponse

GetPhonePlanLocationOptionsResponse: WithResponse<LocationOptionsResponse>

Represents the response from getting the location options for a given phone plan.

GetReleaseOptions

GetReleaseOptions: OperationOptions

Additional request options for getting a release.

GetReleaseResponse

GetReleaseResponse: WithResponse<PhoneNumberRelease>

Represents the response from getting the release associated with a given id.

GetSearchOptions

GetSearchOptions: OperationOptions

Additional request option for get search operations.

GetSearchResponse

GetSearchResponse: WithResponse<PhoneNumberSearch>

Represents the response from getting the search associated with a given id.

IssueTokenResponse

IssueTokenResponse: WithResponse<CommunicationUserToken>

Represents the response from issuing a token

ListPhoneNumbersOptions

ListPhoneNumbersOptions: PageableLocalizationOptions

Options for listing acquired phone numbers.

ListPhonePlansOptions

ListPhonePlansOptions: PageableLocalizationOptions

Options for listing phone plans.

ListSupportedCountriesOptions

ListSupportedCountriesOptions: PageableLocalizationOptions

Options for querying supported countries.

LocationType

LocationType: "CivicAddress" | "NotRequired" | "Selection"

Defines values for LocationType. Possible values include: 'CivicAddress', 'NotRequired', 'Selection'

readonly

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

PhoneNumberAdministrationCreateSearchResponse

PhoneNumberAdministrationCreateSearchResponse: CreateSearchResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CreateSearchResponse } }

Contains response data for the createSearch operation.

PhoneNumberAdministrationGetAllAreaCodesResponse

PhoneNumberAdministrationGetAllAreaCodesResponse: AreaCodes & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AreaCodes } }

Contains response data for the getAllAreaCodes operation.

PhoneNumberAdministrationGetAllPhoneNumbersResponse

PhoneNumberAdministrationGetAllPhoneNumbersResponse: AcquiredPhoneNumbers & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AcquiredPhoneNumbers } }

Contains response data for the getAllPhoneNumbers operation.

PhoneNumberAdministrationGetAllReleasesResponse

PhoneNumberAdministrationGetAllReleasesResponse: PhoneNumberEntities & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhoneNumberEntities } }

Contains response data for the getAllReleases operation.

PhoneNumberAdministrationGetAllSearchesResponse

PhoneNumberAdministrationGetAllSearchesResponse: PhoneNumberEntities & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhoneNumberEntities } }

Contains response data for the getAllSearches operation.

PhoneNumberAdministrationGetAllSupportedCountriesResponse

PhoneNumberAdministrationGetAllSupportedCountriesResponse: PhoneNumberCountries & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhoneNumberCountries } }

Contains response data for the getAllSupportedCountries operation.

PhoneNumberAdministrationGetCapabilitiesUpdateResponse

PhoneNumberAdministrationGetCapabilitiesUpdateResponse: UpdatePhoneNumberCapabilitiesResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: UpdatePhoneNumberCapabilitiesResponse } }

Contains response data for the getCapabilitiesUpdate operation.

PhoneNumberAdministrationGetNumberConfigurationResponse

PhoneNumberAdministrationGetNumberConfigurationResponse: NumberConfigurationResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: NumberConfigurationResponse } }

Contains response data for the getNumberConfiguration operation.

PhoneNumberAdministrationGetPhonePlanGroupsResponse

PhoneNumberAdministrationGetPhonePlanGroupsResponse: PhonePlanGroups & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhonePlanGroups } }

Contains response data for the getPhonePlanGroups operation.

PhoneNumberAdministrationGetPhonePlanLocationOptionsResponse

PhoneNumberAdministrationGetPhonePlanLocationOptionsResponse: LocationOptionsResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: LocationOptionsResponse } }

Contains response data for the getPhonePlanLocationOptions operation.

PhoneNumberAdministrationGetPhonePlansResponse

PhoneNumberAdministrationGetPhonePlansResponse: PhonePlansResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhonePlansResponse } }

Contains response data for the getPhonePlans operation.

PhoneNumberAdministrationGetReleaseByIdResponse

PhoneNumberAdministrationGetReleaseByIdResponse: PhoneNumberRelease & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhoneNumberRelease } }

Contains response data for the getReleaseById operation.

PhoneNumberAdministrationGetSearchByIdResponse

PhoneNumberAdministrationGetSearchByIdResponse: PhoneNumberSearch & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhoneNumberSearch } }

Contains response data for the getSearchById operation.

PhoneNumberAdministrationReleasePhoneNumbersResponse

PhoneNumberAdministrationReleasePhoneNumbersResponse: ReleaseResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ReleaseResponse } }

Contains response data for the releasePhoneNumbers operation.

PhoneNumberAdministrationUpdateCapabilitiesResponse

PhoneNumberAdministrationUpdateCapabilitiesResponse: UpdateNumberCapabilitiesResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: UpdateNumberCapabilitiesResponse } }

Contains response data for the updateCapabilities operation.

PhoneNumberCapabilitiesUpdates

PhoneNumberCapabilitiesUpdates: {}

The capabilities update for each of a set of phone numbers.

Type declaration

PhoneNumberReleaseStatus

PhoneNumberReleaseStatus: "Pending" | "Success" | "Error" | "InProgress"

Defines values for PhoneNumberReleaseStatus. Possible values include: 'Pending', 'Success', 'Error', 'InProgress'

readonly

PhoneNumberType

PhoneNumberType: "Unknown" | "Geographic" | "TollFree" | "Indirect"

Defines values for PhoneNumberType. Possible values include: 'Unknown', 'Geographic', 'TollFree', 'Indirect'

readonly

PurchaseSearchOptions

PurchaseSearchOptions: OperationOptions

Additional request option for get search operations.

RefreshSearchOptions

RefreshSearchOptions: OperationOptions

Additional request option for refresh search operations.

ReleasePhoneNumberOptions

ReleasePhoneNumberOptions: OperationOptions

Additional request options for requesting the release of a list of phone numbers.

ReleasePhoneNumbersResponse

ReleasePhoneNumbersResponse: WithResponse<ReleaseResponse>

Represents the response from requesting the release of a list of acquired phone numbers.

ReleaseStatus

ReleaseStatus: "Pending" | "InProgress" | "Complete" | "Failed" | "Expired"

Defines values for ReleaseStatus. Possible values include: 'Pending', 'InProgress', 'Complete', 'Failed', 'Expired'

readonly

SearchStatus

SearchStatus: "Pending" | "InProgress" | "Reserved" | "Expired" | "Expiring" | "Completing" | "Refreshing" | "Success" | "Manual" | "Cancelled" | "Cancelling" | "Error" | "PurchasePending"

Defines values for SearchStatus. Possible values include: 'Pending', 'InProgress', 'Reserved', 'Expired', 'Expiring', 'Completing', 'Refreshing', 'Success', 'Manual', 'Cancelled', 'Cancelling', 'Error', 'PurchasePending'

readonly

TokenScope

TokenScope: "chat" | "voip" | "pstn"

Represents the scope of the token.

UnconfigurePhoneNumberOptions

UnconfigurePhoneNumberOptions: OperationOptions

Additional request options for unconfiguring a phone number.

UpdateNumbersCapabilitiesResponse

UpdateNumbersCapabilitiesResponse: WithResponse<UpdateNumberCapabilitiesResponse>

Represents the response from updating the capabilities for a list of phone numbers.

VoidResponse

VoidResponse: WithResponse<{}>

Represents a generic HTTP response

WithResponse

WithResponse<T>: T & { _response: HttpResponse }

Represents an object with a non-enumerable _response property which provides information about the HTTP response.

Type parameters

  • T

Variables

Const SDK_VERSION

SDK_VERSION: string = apiVersion.mapper.defaultValue

Const logger

logger: any = createClientLogger("communication-administration")

The @azure/logger configuration for this package.

Const packageName

packageName: "azure-communication-administration-phoneNumber" = "azure-communication-administration-phoneNumber"

Const packageVersion

packageVersion: "1.0.0-beta.1" = "1.0.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers)

Functions

Const attachHttpResponse

  • attachHttpResponse<T>(model: T, httpResponse: any | HttpOperationResponse): WithResponse<T>

  • Attach http response to a model

    Type parameters

    • T

    Parameters

    • model: T
    • httpResponse: any | HttpOperationResponse

    Returns WithResponse<T>

Const getDefaultLocale

  • getDefaultLocale(): string
  • getDefaultLocale(): string

Const isCommunicationIdentityOptions

  • isCommunicationIdentityOptions(options: any): options is CommunicationIdentityOptions

Const isPhoneNumberAdministrationClientOptions

  • isPhoneNumberAdministrationClientOptions(options: any): options is PhoneNumberAdministrationClientOptions

Object literals

Const AcquiredPhoneNumber

AcquiredPhoneNumber: object

serializedName

serializedName: string = "AcquiredPhoneNumber"

type

type: object

className

className: string = "AcquiredPhoneNumber"

name

name: string = "Composite"

modelProperties

modelProperties: object

acquiredCapabilities

acquiredCapabilities: object

required

required: boolean = true

serializedName

serializedName: string = "acquiredCapabilities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

activationState

activationState: object

serializedName

serializedName: string = "activationState"

type

type: object

name

name: string = "String"

assignmentStatus

assignmentStatus: object

serializedName

serializedName: string = "assignmentStatus"

type

type: object

name

name: string = "String"

availableCapabilities

availableCapabilities: object

required

required: boolean = true

serializedName

serializedName: string = "availableCapabilities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

phoneNumber

phoneNumber: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumber"

type

type: object

name

name: string = "String"

placeName

placeName: object

serializedName

serializedName: string = "placeName"

type

type: object

name

name: string = "String"

Const AcquiredPhoneNumbers

AcquiredPhoneNumbers: object

serializedName

serializedName: string = "AcquiredPhoneNumbers"

type

type: object

className

className: string = "AcquiredPhoneNumbers"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

phoneNumbers

phoneNumbers: object

serializedName

serializedName: string = "phoneNumbers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AcquiredPhoneNumber"

name

name: string = "Composite"

Const AreaCodes

AreaCodes: object

serializedName

serializedName: string = "AreaCodes"

type

type: object

className

className: string = "AreaCodes"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

primaryAreaCodes

primaryAreaCodes: object

serializedName

serializedName: string = "primaryAreaCodes"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

secondaryAreaCodes

secondaryAreaCodes: object

serializedName

serializedName: string = "secondaryAreaCodes"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const CarrierDetails

CarrierDetails: object

serializedName

serializedName: string = "CarrierDetails"

type

type: object

className

className: string = "CarrierDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

localizedName

localizedName: object

serializedName

serializedName: string = "localizedName"

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const CommunicationIdentity

CommunicationIdentity: object

serializedName

serializedName: string = "CommunicationIdentity"

type

type: object

className

className: string = "CommunicationIdentity"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const CommunicationIdentityToken

CommunicationIdentityToken: object

serializedName

serializedName: string = "CommunicationIdentityToken"

type

type: object

className

className: string = "CommunicationIdentityToken"

name

name: string = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "expiresOn"

type

type: object

name

name: string = "DateTime"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

token

token: object

required

required: boolean = true

serializedName

serializedName: string = "token"

type

type: object

name

name: string = "String"

Const CommunicationIdentityUpdateRequest

CommunicationIdentityUpdateRequest: object

serializedName

serializedName: string = "CommunicationIdentityUpdateRequest"

type

type: object

className

className: string = "CommunicationIdentityUpdateRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

tokensValidFrom

tokensValidFrom: object

serializedName

serializedName: string = "tokensValidFrom"

type

type: object

name

name: string = "DateTime"

Const CommunicationTokenRequest

CommunicationTokenRequest: object

serializedName

serializedName: string = "CommunicationTokenRequest"

type

type: object

className

className: string = "CommunicationTokenRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

scopes

scopes: object

required

required: boolean = true

serializedName

serializedName: string = "scopes"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const CreateSearchOptions

CreateSearchOptions: object

serializedName

serializedName: string = "CreateSearchOptions"

type

type: object

className

className: string = "CreateSearchOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

areaCode

areaCode: object

required

required: boolean = true

serializedName

serializedName: string = "areaCode"

type

type: object

name

name: string = "String"

description

description: object

required

required: boolean = true

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

displayName

displayName: object

required

required: boolean = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

locationOptions

locationOptions: object

serializedName

serializedName: string = "locationOptions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LocationOptionsDetails"

name

name: string = "Composite"

phonePlanIds

phonePlanIds: object

required

required: boolean = true

serializedName

serializedName: string = "phonePlanIds"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

quantity

quantity: object

serializedName

serializedName: string = "quantity"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 2147483647

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const CreateSearchResponse

CreateSearchResponse: object

serializedName

serializedName: string = "CreateSearchResponse"

type

type: object

className

className: string = "CreateSearchResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

searchId

searchId: object

required

required: boolean = true

serializedName

serializedName: string = "searchId"

type

type: object

name

name: string = "String"

Const ErrorBody

ErrorBody: object

serializedName

serializedName: string = "ErrorBody"

type

type: object

className

className: string = "ErrorBody"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

serializedName

serializedName: string = "ErrorResponse"

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorBody"

name

name: string = "Composite"

Const LocationOptions

LocationOptions: object

serializedName

serializedName: string = "LocationOptions"

type

type: object

className

className: string = "LocationOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

labelId

labelId: object

serializedName

serializedName: string = "labelId"

type

type: object

name

name: string = "String"

labelName

labelName: object

serializedName

serializedName: string = "labelName"

type

type: object

name

name: string = "String"

options

options: object

serializedName

serializedName: string = "options"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LocationOptionsDetails"

name

name: string = "Composite"

Const LocationOptionsDetails

LocationOptionsDetails: object

serializedName

serializedName: string = "LocationOptionsDetails"

type

type: object

className

className: string = "LocationOptionsDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

locationOptions

locationOptions: object

serializedName

serializedName: string = "locationOptions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LocationOptions"

name

name: string = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

Const LocationOptionsQueries

LocationOptionsQueries: object

serializedName

serializedName: string = "LocationOptionsQueries"

type

type: object

className

className: string = "LocationOptionsQueries"

name

name: string = "Composite"

modelProperties

modelProperties: object

locationOptions

locationOptions: object

serializedName

serializedName: string = "locationOptions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LocationOptionsQuery"

name

name: string = "Composite"

Const LocationOptionsQuery

LocationOptionsQuery: object

serializedName

serializedName: string = "LocationOptionsQuery"

type

type: object

className

className: string = "LocationOptionsQuery"

name

name: string = "Composite"

modelProperties

modelProperties: object

labelId

labelId: object

serializedName

serializedName: string = "labelId"

type

type: object

name

name: string = "String"

optionsValue

optionsValue: object

serializedName

serializedName: string = "optionsValue"

type

type: object

name

name: string = "String"

Const LocationOptionsResponse

LocationOptionsResponse: object

serializedName

serializedName: string = "LocationOptionsResponse"

type

type: object

className

className: string = "LocationOptionsResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

locationOptions

locationOptions: object

serializedName

serializedName: string = "locationOptions"

type

type: object

className

className: string = "LocationOptions"

name

name: string = "Composite"

Const NumberConfiguration

NumberConfiguration: object

serializedName

serializedName: string = "NumberConfiguration"

type

type: object

className

className: string = "NumberConfiguration"

name

name: string = "Composite"

modelProperties

modelProperties: object

phoneNumber

phoneNumber: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumber"

type

type: object

name

name: string = "String"

pstnConfiguration

pstnConfiguration: object

required

required: boolean = true

serializedName

serializedName: string = "pstnConfiguration"

type

type: object

className

className: string = "PstnConfiguration"

name

name: string = "Composite"

Const NumberConfigurationPhoneNumber

NumberConfigurationPhoneNumber: object

serializedName

serializedName: string = "NumberConfigurationPhoneNumber"

type

type: object

className

className: string = "NumberConfigurationPhoneNumber"

name

name: string = "Composite"

modelProperties

modelProperties: object

phoneNumber

phoneNumber: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumber"

type

type: object

name

name: string = "String"

Const NumberConfigurationResponse

NumberConfigurationResponse: object

serializedName

serializedName: string = "NumberConfigurationResponse"

type

type: object

className

className: string = "NumberConfigurationResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

pstnConfiguration

pstnConfiguration: object

required

required: boolean = true

serializedName

serializedName: string = "pstnConfiguration"

type

type: object

className

className: string = "PstnConfiguration"

name

name: string = "Composite"

Const NumberUpdateCapabilities

NumberUpdateCapabilities: object

serializedName

serializedName: string = "NumberUpdateCapabilities"

type

type: object

className

className: string = "NumberUpdateCapabilities"

name

name: string = "Composite"

modelProperties

modelProperties: object

add

add: object

serializedName

serializedName: string = "add"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

remove

remove: object

serializedName

serializedName: string = "remove"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const PhoneNumberCountries

PhoneNumberCountries: object

serializedName

serializedName: string = "PhoneNumberCountries"

type

type: object

className

className: string = "PhoneNumberCountries"

name

name: string = "Composite"

modelProperties

modelProperties: object

countries

countries: object

serializedName

serializedName: string = "countries"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PhoneNumberCountry"

name

name: string = "Composite"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const PhoneNumberCountry

PhoneNumberCountry: object

serializedName

serializedName: string = "PhoneNumberCountry"

type

type: object

className

className: string = "PhoneNumberCountry"

name

name: string = "Composite"

modelProperties

modelProperties: object

countryCode

countryCode: object

required

required: boolean = true

serializedName

serializedName: string = "countryCode"

type

type: object

name

name: string = "String"

localizedName

localizedName: object

required

required: boolean = true

serializedName

serializedName: string = "localizedName"

type

type: object

name

name: string = "String"

Const PhoneNumberEntities

PhoneNumberEntities: object

serializedName

serializedName: string = "PhoneNumberEntities"

type

type: object

className

className: string = "PhoneNumberEntities"

name

name: string = "Composite"

modelProperties

modelProperties: object

entities

entities: object

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PhoneNumberEntity"

name

name: string = "Composite"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const PhoneNumberEntity

PhoneNumberEntity: object

serializedName

serializedName: string = "PhoneNumberEntity"

type

type: object

className

className: string = "PhoneNumberEntity"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdAt

createdAt: object

serializedName

serializedName: string = "createdAt"

type

type: object

name

name: string = "DateTime"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

focDate

focDate: object

serializedName

serializedName: string = "focDate"

type

type: object

name

name: string = "DateTime"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

quantity

quantity: object

serializedName

serializedName: string = "quantity"

type

type: object

name

name: string = "Number"

quantityObtained

quantityObtained: object

serializedName

serializedName: string = "quantityObtained"

type

type: object

name

name: string = "Number"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

Const PhoneNumberRelease

PhoneNumberRelease: object

serializedName

serializedName: string = "PhoneNumberRelease"

type

type: object

className

className: string = "PhoneNumberRelease"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdAt

createdAt: object

serializedName

serializedName: string = "createdAt"

type

type: object

name

name: string = "DateTime"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: string = "String"

phoneNumberReleaseStatusDetails

phoneNumberReleaseStatusDetails: object

serializedName

serializedName: string = "phoneNumberReleaseStatusDetails"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "PhoneNumberReleaseDetails"

name

name: string = "Composite"

releaseId

releaseId: object

serializedName

serializedName: string = "releaseId"

type

type: object

name

name: string = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

Const PhoneNumberReleaseDetails

PhoneNumberReleaseDetails: object

serializedName

serializedName: string = "PhoneNumberReleaseDetails"

type

type: object

className

className: string = "PhoneNumberReleaseDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: string = "Number"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

Const PhoneNumberSearch

PhoneNumberSearch: object

serializedName

serializedName: string = "PhoneNumberSearch"

type

type: object

className

className: string = "PhoneNumberSearch"

name

name: string = "Composite"

modelProperties

modelProperties: object

areaCode

areaCode: object

serializedName

serializedName: string = "areaCode"

type

type: object

name

name: string = "String"

createdAt

createdAt: object

serializedName

serializedName: string = "createdAt"

type

type: object

name

name: string = "DateTime"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: string = "Number"

locationOptions

locationOptions: object

serializedName

serializedName: string = "locationOptions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LocationOptionsDetails"

name

name: string = "Composite"

phoneNumbers

phoneNumbers: object

serializedName

serializedName: string = "phoneNumbers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

phonePlanIds

phonePlanIds: object

serializedName

serializedName: string = "phonePlanIds"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

quantity

quantity: object

serializedName

serializedName: string = "quantity"

type

type: object

name

name: string = "Number"

reservationExpiryDate

reservationExpiryDate: object

serializedName

serializedName: string = "reservationExpiryDate"

type

type: object

name

name: string = "DateTime"

searchId

searchId: object

serializedName

serializedName: string = "searchId"

type

type: object

name

name: string = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

Const PhonePlan

PhonePlan: object

serializedName

serializedName: string = "PhonePlan"

type

type: object

className

className: string = "PhonePlan"

name

name: string = "Composite"

modelProperties

modelProperties: object

areaCodes

areaCodes: object

serializedName

serializedName: string = "areaCodes"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

capabilities

capabilities: object

serializedName

serializedName: string = "capabilities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

localizedName

localizedName: object

required

required: boolean = true

serializedName

serializedName: string = "localizedName"

type

type: object

name

name: string = "String"

locationType

locationType: object

required

required: boolean = true

serializedName

serializedName: string = "locationType"

type

type: object

name

name: string = "String"

maximumSearchSize

maximumSearchSize: object

serializedName

serializedName: string = "maximumSearchSize"

type

type: object

name

name: string = "Number"

phonePlanId

phonePlanId: object

required

required: boolean = true

serializedName

serializedName: string = "phonePlanId"

type

type: object

name

name: string = "String"

Const PhonePlanGroup

PhonePlanGroup: object

serializedName

serializedName: string = "PhonePlanGroup"

type

type: object

className

className: string = "PhonePlanGroup"

name

name: string = "Composite"

modelProperties

modelProperties: object

carrierDetails

carrierDetails: object

serializedName

serializedName: string = "carrierDetails"

type

type: object

className

className: string = "CarrierDetails"

name

name: string = "Composite"

localizedDescription

localizedDescription: object

required

required: boolean = true

serializedName

serializedName: string = "localizedDescription"

type

type: object

name

name: string = "String"

localizedName

localizedName: object

required

required: boolean = true

serializedName

serializedName: string = "localizedName"

type

type: object

name

name: string = "String"

phoneNumberType

phoneNumberType: object

serializedName

serializedName: string = "phoneNumberType"

type

type: object

name

name: string = "String"

phonePlanGroupId

phonePlanGroupId: object

required

required: boolean = true

serializedName

serializedName: string = "phonePlanGroupId"

type

type: object

name

name: string = "String"

rateInformation

rateInformation: object

serializedName

serializedName: string = "rateInformation"

type

type: object

className

className: string = "RateInformation"

name

name: string = "Composite"

Const PhonePlanGroups

PhonePlanGroups: object

serializedName

serializedName: string = "PhonePlanGroups"

type

type: object

className

className: string = "PhonePlanGroups"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

phonePlanGroups

phonePlanGroups: object

serializedName

serializedName: string = "phonePlanGroups"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PhonePlanGroup"

name

name: string = "Composite"

Const PhonePlansResponse

PhonePlansResponse: object

serializedName

serializedName: string = "PhonePlansResponse"

type

type: object

className

className: string = "PhonePlansResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

phonePlans

phonePlans: object

serializedName

serializedName: string = "phonePlans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PhonePlan"

name

name: string = "Composite"

Const PstnConfiguration

PstnConfiguration: object

serializedName

serializedName: string = "PstnConfiguration"

type

type: object

className

className: string = "PstnConfiguration"

name

name: string = "Composite"

modelProperties

modelProperties: object

applicationId

applicationId: object

serializedName

serializedName: string = "applicationId"

type

type: object

name

name: string = "String"

callbackUrl

callbackUrl: object

required

required: boolean = true

serializedName

serializedName: string = "callbackUrl"

type

type: object

name

name: string = "String"

Const RateInformation

RateInformation: object

serializedName

serializedName: string = "RateInformation"

type

type: object

className

className: string = "RateInformation"

name

name: string = "Composite"

modelProperties

modelProperties: object

currencyType

currencyType: object

serializedName

serializedName: string = "currencyType"

type

type: object

name

name: string = "String"

monthlyRate

monthlyRate: object

serializedName

serializedName: string = "monthlyRate"

type

type: object

name

name: string = "Number"

rateErrorMessage

rateErrorMessage: object

serializedName

serializedName: string = "rateErrorMessage"

type

type: object

name

name: string = "String"

Const ReleaseRequest

ReleaseRequest: object

serializedName

serializedName: string = "ReleaseRequest"

type

type: object

className

className: string = "ReleaseRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

phoneNumbers

phoneNumbers: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumbers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const ReleaseResponse

ReleaseResponse: object

serializedName

serializedName: string = "ReleaseResponse"

type

type: object

className

className: string = "ReleaseResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

releaseId

releaseId: object

required

required: boolean = true

serializedName

serializedName: string = "releaseId"

type

type: object

name

name: string = "String"

Const UpdateNumberCapabilitiesRequest

UpdateNumberCapabilitiesRequest: object

serializedName

serializedName: string = "UpdateNumberCapabilitiesRequest"

type

type: object

className

className: string = "UpdateNumberCapabilitiesRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

phoneNumberCapabilitiesUpdate

phoneNumberCapabilitiesUpdate: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumberCapabilitiesUpdate"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "NumberUpdateCapabilities"

name

name: string = "Composite"

Const UpdateNumberCapabilitiesResponse

UpdateNumberCapabilitiesResponse: object

serializedName

serializedName: string = "UpdateNumberCapabilitiesResponse"

type

type: object

className

className: string = "UpdateNumberCapabilitiesResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

capabilitiesUpdateId

capabilitiesUpdateId: object

required

required: boolean = true

serializedName

serializedName: string = "capabilitiesUpdateId"

type

type: object

name

name: string = "String"

Const UpdatePhoneNumberCapabilitiesResponse

UpdatePhoneNumberCapabilitiesResponse: object

serializedName

serializedName: string = "UpdatePhoneNumberCapabilitiesResponse"

type

type: object

className

className: string = "UpdatePhoneNumberCapabilitiesResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

capabilitiesUpdateId

capabilitiesUpdateId: object

serializedName

serializedName: string = "capabilitiesUpdateId"

type

type: object

name

name: string = "String"

capabilitiesUpdateStatus

capabilitiesUpdateStatus: object

serializedName

serializedName: string = "capabilitiesUpdateStatus"

type

type: object

name

name: string = "String"

createdAt

createdAt: object

serializedName

serializedName: string = "createdAt"

type

type: object

name

name: string = "DateTime"

phoneNumberCapabilitiesUpdates

phoneNumberCapabilitiesUpdates: object

serializedName

serializedName: string = "phoneNumberCapabilitiesUpdates"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "NumberUpdateCapabilities"

name

name: string = "Composite"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2020-07-20-preview1"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const cancelSearchOperationSpec

cancelSearchOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "administration/phonenumbers/searches/{searchId}/cancel"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.searchId]

responses

responses: object

202

202: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const capabilitiesUpdateId

capabilitiesUpdateId: object

parameterPath

parameterPath: string = "capabilitiesUpdateId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "capabilitiesUpdateId"

type

type: object

name

name: string = "String"

Const configureNumberOperationSpec

configureNumberOperationSpec: object

httpMethod

httpMethod: string = "PATCH"

path

path: string = "administration/phonenumbers/numberconfiguration/configure"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: any = Mappers.NumberConfiguration

parameterPath

parameterPath: object

phoneNumber

phoneNumber: string = "phoneNumber"

pstnConfiguration

pstnConfiguration: string = "pstnConfiguration"

responses

responses: object

200

200: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const countryCode

countryCode: object

parameterPath

parameterPath: string = "countryCode"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "countryCode"

type

type: object

name

name: string = "String"

Const createOperationSpec

createOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "identities"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.CommunicationIdentity

Const createSearchOperationSpec

createSearchOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "administration/phonenumbers/searches"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: any = Mappers.CreateSearchOptions

parameterPath

parameterPath: object

areaCode

areaCode: string = "areaCode"

description

description: string = "description"

displayName

displayName: string = "displayName"

locationOptions

locationOptions: string[] = ["options", "locationOptions"]

phonePlanIds

phonePlanIds: string = "phonePlanIds"

quantity

quantity: string[] = ["options", "quantity"]

responses

responses: object

201

201: object

bodyMapper

bodyMapper: any = Mappers.CreateSearchResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const deleteMethodOperationSpec

deleteMethodOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "identities/{id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.id]

responses

responses: object

204

204: {}

Type declaration

default

default: {}

Type declaration

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const getAllAreaCodesOperationSpec

getAllAreaCodesOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "administration/phonenumbers/countries/{countryCode}/areacodes"

queryParameters

queryParameters: any[] = [Parameters.locationType, Parameters.phonePlanId, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.countryCode]

requestBody

requestBody: object

mapper

mapper: any = Mappers.LocationOptionsQueries

parameterPath

parameterPath: object

locationOptions

locationOptions: string[] = ["options", "locationOptions"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AreaCodes

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAllPhoneNumbersOperationSpec

getAllPhoneNumbersOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/phonenumbers"

queryParameters

queryParameters: any[] = [Parameters.locale, Parameters.skip, Parameters.take, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AcquiredPhoneNumbers

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAllReleasesOperationSpec

getAllReleasesOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/releases"

queryParameters

queryParameters: any[] = [Parameters.skip, Parameters.take, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberEntities

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAllSearchesOperationSpec

getAllSearchesOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/searches"

queryParameters

queryParameters: any[] = [Parameters.skip, Parameters.take, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberEntities

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAllSupportedCountriesOperationSpec

getAllSupportedCountriesOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/countries"

queryParameters

queryParameters: any[] = [Parameters.locale, Parameters.skip, Parameters.take, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberCountries

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getCapabilitiesUpdateOperationSpec

getCapabilitiesUpdateOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/capabilities/{capabilitiesUpdateId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.capabilitiesUpdateId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.UpdatePhoneNumberCapabilitiesResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getNumberConfigurationOperationSpec

getNumberConfigurationOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "administration/phonenumbers/numberconfiguration"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: any = Mappers.NumberConfigurationPhoneNumber

parameterPath

parameterPath: object

phoneNumber

phoneNumber: string = "phoneNumber"

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.NumberConfigurationResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getPhonePlanGroupsOperationSpec

getPhonePlanGroupsOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/countries/{countryCode}/phoneplangroups"

queryParameters

queryParameters: any[] = [Parameters.locale,Parameters.includeRateInformation,Parameters.skip,Parameters.take,Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.countryCode]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhonePlanGroups

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getPhonePlanLocationOptionsOperationSpec

getPhonePlanLocationOptionsOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/countries/{countryCode}/phoneplangroups/{phonePlanGroupId}/phoneplans/{phonePlanId}/locationoptions"

queryParameters

queryParameters: any[] = [Parameters.locale, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.countryCode,Parameters.phonePlanGroupId,Parameters.phonePlanId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LocationOptionsResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getPhonePlansOperationSpec

getPhonePlansOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/countries/{countryCode}/phoneplangroups/{phonePlanGroupId}/phoneplans"

queryParameters

queryParameters: any[] = [Parameters.locale, Parameters.skip, Parameters.take, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.countryCode, Parameters.phonePlanGroupId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhonePlansResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getReleaseByIdOperationSpec

getReleaseByIdOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/releases/{releaseId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.releaseId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberRelease

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getSearchByIdOperationSpec

getSearchByIdOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "administration/phonenumbers/searches/{searchId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.searchId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberSearch

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const id

id: object

parameterPath

parameterPath: string = "id"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const includeRateInformation

includeRateInformation: object

parameterPath

parameterPath: string[] = ["options", "includeRateInformation"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "includeRateInformation"

type

type: object

name

name: string = "Boolean"

Const issueTokenOperationSpec

issueTokenOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "identities/{id}/token"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.id]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

scopes

scopes: string = "scopes"

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.CommunicationIdentityToken

Const locale

locale: object

parameterPath

parameterPath: string[] = ["options", "locale"]

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "locale"

type

type: object

name

name: string = "String"

Const locationType

locationType: object

parameterPath

parameterPath: string = "locationType"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "locationType"

type

type: object

name

name: string = "String"

Const phonePlanGroupId

phonePlanGroupId: object

parameterPath

parameterPath: string = "phonePlanGroupId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "phonePlanGroupId"

type

type: object

name

name: string = "String"

Const phonePlanId

phonePlanId: object

parameterPath

parameterPath: string = "phonePlanId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "phonePlanId"

type

type: object

name

name: string = "String"

Const purchaseSearchOperationSpec

purchaseSearchOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "administration/phonenumbers/searches/{searchId}/purchase"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.searchId]

responses

responses: object

202

202: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const releaseId

releaseId: object

parameterPath

parameterPath: string = "releaseId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "releaseId"

type

type: object

name

name: string = "String"

Const releasePhoneNumbersOperationSpec

releasePhoneNumbersOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "administration/phonenumbers/releases"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: any = Mappers.ReleaseRequest

parameterPath

parameterPath: object

phoneNumbers

phoneNumbers: string = "phoneNumbers"

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ReleaseResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const searchId

searchId: object

parameterPath

parameterPath: string = "searchId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "searchId"

type

type: object

name

name: string = "String"

Const skip

skip: object

parameterPath

parameterPath: string[] = ["options", "skip"]

mapper

mapper: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "skip"

type

type: object

name

name: string = "Number"

Const take

take: object

parameterPath

parameterPath: string[] = ["options", "take"]

mapper

mapper: object

defaultValue

defaultValue: number = 100

serializedName

serializedName: string = "take"

type

type: object

name

name: string = "Number"

Const unconfigureNumberOperationSpec

unconfigureNumberOperationSpec: object

httpMethod

httpMethod: string = "PATCH"

path

path: string = "administration/phonenumbers/numberconfiguration/unconfigure"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: any = Mappers.NumberConfigurationPhoneNumber

parameterPath

parameterPath: object

phoneNumber

phoneNumber: string = "phoneNumber"

responses

responses: object

200

200: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const updateCapabilitiesOperationSpec

updateCapabilitiesOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "administration/phonenumbers/capabilities"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: any = Mappers.UpdateNumberCapabilitiesRequest

parameterPath

parameterPath: object

phoneNumberCapabilitiesUpdate

phoneNumberCapabilitiesUpdate: string = "phoneNumberCapabilitiesUpdate"

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.UpdateNumberCapabilitiesResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const updateOperationSpec

updateOperationSpec: object

contentType

contentType: string = "application/merge-patch+json"

httpMethod

httpMethod: string = "PATCH"

path

path: string = "identities/{id}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.id]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

tokensValidFrom

tokensValidFrom: string[] = ["options", "tokensValidFrom"]

responses

responses: object

204

204: {}

Type declaration

default

default: {}

Type declaration

Generated using TypeDoc