Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-phone-numbers

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

FinalStateVia

FinalStateVia: "azure-async-operation" | "location" | "original-uri"

GetPurchasedPhoneNumberOptions

GetPurchasedPhoneNumberOptions: OperationOptions

Additional options for the get phone number request.

LROOperation

LROOperation<TResult>: PollOperation<LROOperationState<TResult>, TResult>

Type parameters

LROOperationResponse

LROOperationResponse: HttpOperationResponse & { __computed?: LROResponseInfo }

Extended operation response for LROs

PhoneNumberAssignmentType

PhoneNumberAssignmentType: "person" | "application"

Defines values for PhoneNumberAssignmentType.

PhoneNumberCapabilityType

PhoneNumberCapabilityType: "none" | "inbound" | "outbound" | "inbound+outbound"

Defines values for PhoneNumberCapabilityType.

PhoneNumberOperationStatus

PhoneNumberOperationStatus: "notStarted" | "running" | "succeeded" | "failed"

Defines values for PhoneNumberOperationStatus.

PhoneNumberOperationType

PhoneNumberOperationType: "purchase" | "releasePhoneNumber" | "search" | "updatePhoneNumberCapabilities"

Defines values for PhoneNumberOperationType.

PhoneNumberType

PhoneNumberType: "geographic" | "tollFree"

Defines values for PhoneNumberType.

PhoneNumbersGetByNumberResponse

PhoneNumbersGetByNumberResponse: PurchasedPhoneNumber & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PurchasedPhoneNumber } }

Contains response data for the getByNumber operation.

PhoneNumbersGetOperationResponse

PhoneNumbersGetOperationResponse: PhoneNumbersGetOperationHeaders & PhoneNumberOperation & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhoneNumberOperation; parsedHeaders: PhoneNumbersGetOperationHeaders } }

Contains response data for the getOperation operation.

PhoneNumbersGetSearchResultResponse

PhoneNumbersGetSearchResultResponse: PhoneNumberSearchResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PhoneNumberSearchResult } }

Contains response data for the getSearchResult operation.

PhoneNumbersListPhoneNumbersNextResponse

PhoneNumbersListPhoneNumbersNextResponse: PurchasedPhoneNumbers & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PurchasedPhoneNumbers } }

Contains response data for the listPhoneNumbersNext operation.

PhoneNumbersListPhoneNumbersResponse

PhoneNumbersListPhoneNumbersResponse: PurchasedPhoneNumbers & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PurchasedPhoneNumbers } }

Contains response data for the listPhoneNumbers operation.

PhoneNumbersPurchasePhoneNumbersResponse

PhoneNumbersPurchasePhoneNumbersResponse: PhoneNumbersPurchasePhoneNumbersHeaders & { _response: coreHttp.HttpResponse & { __computed: LROResponseInfo; parsedHeaders: PhoneNumbersPurchasePhoneNumbersHeaders } }

Contains response data for the purchasePhoneNumbers operation.

PhoneNumbersReleasePhoneNumberResponse

PhoneNumbersReleasePhoneNumberResponse: PhoneNumbersReleasePhoneNumberHeaders & { _response: coreHttp.HttpResponse & { __computed: LROResponseInfo; parsedHeaders: PhoneNumbersReleasePhoneNumberHeaders } }

Contains response data for the releasePhoneNumber operation.

PhoneNumbersSearchAvailablePhoneNumbersResponse

PhoneNumbersSearchAvailablePhoneNumbersResponse: PhoneNumbersSearchAvailablePhoneNumbersHeaders & PhoneNumberSearchResult & { _response: coreHttp.HttpResponse & { __computed: LROResponseInfo; bodyAsText: string; parsedBody: PhoneNumberSearchResult; parsedHeaders: PhoneNumbersSearchAvailablePhoneNumbersHeaders } }

Contains response data for the searchAvailablePhoneNumbers operation.

PhoneNumbersUpdateCapabilitiesResponse

PhoneNumbersUpdateCapabilitiesResponse: PhoneNumbersUpdateCapabilitiesHeaders & PurchasedPhoneNumber & { _response: coreHttp.HttpResponse & { __computed: LROResponseInfo; bodyAsText: string; parsedBody: PurchasedPhoneNumber; parsedHeaders: PhoneNumbersUpdateCapabilitiesHeaders } }

Contains response data for the updateCapabilities operation.

SendOperationFn

SendOperationFn<TResult>: (args: OperationArguments, spec: OperationSpec) => Promise<TResult>

Type parameters

Type declaration

    • (args: OperationArguments, spec: OperationSpec): Promise<TResult>

    • Parameters

      • args: OperationArguments
      • spec: OperationSpec

      Returns Promise<TResult>

Variables

Const LROSYM

LROSYM: unique symbol = Symbol("LROData")

Const SDK_VERSION

SDK_VERSION: string = "1.0.1"

Const logger

logger: any = createClientLogger("communication-phone-numbers")

The @azure/logger configuration for this package.

Const packageName

packageName: "azure-communication-phone-numbers" = "azure-communication-phone-numbers"

Const packageVersion

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

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Const terminalStates

terminalStates: string[] = ["succeeded", "failed", "canceled", "cancelled"]

Functions

cancel

createAzureAsyncOperationStrategy

createBodyPollingStrategy

createLocationStrategy

createPassthroughStrategy

getCompositeMappers

  • getCompositeMappers(responses: {}): {}

  • Polling calls will always return a status object i.e. {"status": "success"} these intermediate responses are not described in the swagger so we need to pass custom mappers at runtime. This function replaces all the existing mappers to be able to deserialize a status object

    Parameters

    • responses: {}

      Original set of responses defined in the operation

      • [responseCode: string]: OperationResponse

    Returns {}

    • [responseCode: string]: OperationResponse

getLROData

getPollingStrategy

  • This function determines which strategy to use based on the response from the last operation executed, this last operation can be an initial operation or a polling operation. The 3 possible strategies are described below:

    A) Azure-AsyncOperation or Operation-Location B) Location C) BodyPolling (provisioningState)

    • This strategy is used when:
      • Response doesn't contain any of the following headers Location, Azure-AsyncOperation or Operation-Location
      • Last operation method is PUT

    Type parameters

    Parameters

    Returns LROStrategy<TResult>

isAsyncOperationFinalResponse

  • isAsyncOperationFinalResponse(response: HttpOperationResponse, initialOperationInfo: LROResponseInfo, finalStateVia?: undefined | string): boolean

isBodyPollingFinalResponse

  • isBodyPollingFinalResponse(response: HttpOperationResponse): boolean

isLocationFinalResponse

  • isLocationFinalResponse(response: HttpOperationResponse): boolean

Const isPhoneNumbersClientOptions

  • isPhoneNumbersClientOptions(options: any): options is PhoneNumbersClientOptions

lroPolicy

  • lroPolicy(): { create: any }

makeOperation

sendFinalGet

shouldDeserializeLRO

  • shouldDeserializeLRO(finalStateVia?: undefined | string): (Anonymous function)

  • We need to selectively deserialize our responses, only deserializing if we are in a final LRO response, not deserializing any polling non-terminal responses

    Parameters

    • Optional finalStateVia: undefined | string

    Returns (Anonymous function)

shouldPerformFinalGet

update

  • General update function for LROPoller, the general process is as follows

    1. Check initial operation result to determine the strategy to use
      • Strategies: Location, Azure-AsyncOperation, Original Uri
    2. Check if the operation result has a terminal state
      • Terminal state will be determined by each strategy
      2.1 If it is terminal state Check if a final GET request is required, if so send final GET request and return result from operation. If no final GET is required, just return the result from operation.
      • Determining what to call for final request is responsibility of each strategy 2.2 If it is not terminal state, call the polling operation call it and go to step 1
      • Determining what to call for polling is responsibility of each strategy
      • Strategies will always use the latest URI for polling if provided otherwise the last known one

    Type parameters

    Parameters

    Returns Promise<LROOperation<TResult>>

Object literals

Const CommunicationError

CommunicationError: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const CommunicationErrorResponse

CommunicationErrorResponse: object

type

type: object

className

className: string = "CommunicationErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

Const PhoneNumberCapabilities

PhoneNumberCapabilities: object

type

type: object

className

className: string = "PhoneNumberCapabilities"

name

name: string = "Composite"

modelProperties

modelProperties: object

calling

calling: object

required

required: boolean = true

serializedName

serializedName: string = "calling"

type

type: object

allowedValues

allowedValues: string[] = ["none", "inbound", "outbound", "inbound+outbound"]

name

name: string = "Enum"

sms

sms: object

required

required: boolean = true

serializedName

serializedName: string = "sms"

type

type: object

allowedValues

allowedValues: string[] = ["none", "inbound", "outbound", "inbound+outbound"]

name

name: string = "Enum"

Const PhoneNumberCapabilitiesRequest

PhoneNumberCapabilitiesRequest: object

type

type: object

className

className: string = "PhoneNumberCapabilitiesRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

calling

calling: object

serializedName

serializedName: string = "calling"

type

type: object

allowedValues

allowedValues: string[] = ["none", "inbound", "outbound", "inbound+outbound"]

name

name: string = "Enum"

sms

sms: object

serializedName

serializedName: string = "sms"

type

type: object

allowedValues

allowedValues: string[] = ["none", "inbound", "outbound", "inbound+outbound"]

name

name: string = "Enum"

Const PhoneNumberCost

PhoneNumberCost: object

type

type: object

className

className: string = "PhoneNumberCost"

name

name: string = "Composite"

modelProperties

modelProperties: object

amount

amount: object

required

required: boolean = true

serializedName

serializedName: string = "amount"

type

type: object

name

name: string = "Number"

billingFrequency

billingFrequency: object

defaultValue

defaultValue: string = "monthly"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "billingFrequency"

type

type: object

name

name: string = "String"

currencyCode

currencyCode: object

required

required: boolean = true

serializedName

serializedName: string = "currencyCode"

type

type: object

name

name: string = "String"

Const PhoneNumberOperation

PhoneNumberOperation: object

type

type: object

className

className: string = "PhoneNumberOperation"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

lastActionDateTime

lastActionDateTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "lastActionDateTime"

type

type: object

name

name: string = "DateTime"

operationType

operationType: object

required

required: boolean = true

serializedName

serializedName: string = "operationType"

type

type: object

allowedValues

allowedValues: string[] = ["purchase","releasePhoneNumber","search","updatePhoneNumberCapabilities"]

name

name: string = "Enum"

resourceLocation

resourceLocation: object

serializedName

serializedName: string = "resourceLocation"

type

type: object

name

name: string = "String"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["notStarted", "running", "succeeded", "failed"]

name

name: string = "Enum"

Const PhoneNumberPurchaseRequest

PhoneNumberPurchaseRequest: object

type

type: object

className

className: string = "PhoneNumberPurchaseRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

searchId

searchId: object

serializedName

serializedName: string = "searchId"

type

type: object

name

name: string = "String"

Const PhoneNumberSearchRequest

PhoneNumberSearchRequest: object

type

type: object

className

className: string = "PhoneNumberSearchRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

areaCode

areaCode: object

serializedName

serializedName: string = "areaCode"

type

type: object

name

name: string = "String"

assignmentType

assignmentType: object

required

required: boolean = true

serializedName

serializedName: string = "assignmentType"

type

type: object

allowedValues

allowedValues: string[] = ["person", "application"]

name

name: string = "Enum"

capabilities

capabilities: object

serializedName

serializedName: string = "capabilities"

type

type: object

className

className: string = "PhoneNumberCapabilities"

name

name: string = "Composite"

phoneNumberType

phoneNumberType: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumberType"

type

type: object

allowedValues

allowedValues: string[] = ["geographic", "tollFree"]

name

name: string = "Enum"

quantity

quantity: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "quantity"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 2147483647

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const PhoneNumberSearchResult

PhoneNumberSearchResult: object

type

type: object

className

className: string = "PhoneNumberSearchResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

assignmentType

assignmentType: object

required

required: boolean = true

serializedName

serializedName: string = "assignmentType"

type

type: object

allowedValues

allowedValues: string[] = ["person", "application"]

name

name: string = "Enum"

capabilities

capabilities: object

serializedName

serializedName: string = "capabilities"

type

type: object

className

className: string = "PhoneNumberCapabilities"

name

name: string = "Composite"

cost

cost: object

serializedName

serializedName: string = "cost"

type

type: object

className

className: string = "PhoneNumberCost"

name

name: string = "Composite"

phoneNumberType

phoneNumberType: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumberType"

type

type: object

allowedValues

allowedValues: string[] = ["geographic", "tollFree"]

name

name: string = "Enum"

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"

searchExpiresBy

searchExpiresBy: object

required

required: boolean = true

serializedName

serializedName: string = "searchExpiresBy"

type

type: object

name

name: string = "DateTime"

searchId

searchId: object

required

required: boolean = true

serializedName

serializedName: string = "searchId"

type

type: object

name

name: string = "String"

Const PhoneNumbersGetOperationHeaders

PhoneNumbersGetOperationHeaders: object

type

type: object

className

className: string = "PhoneNumbersGetOperationHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const PhoneNumbersPurchasePhoneNumbersHeaders

PhoneNumbersPurchasePhoneNumbersHeaders: object

type

type: object

className

className: string = "PhoneNumbersPurchasePhoneNumbersHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationId

operationId: object

serializedName

serializedName: string = "operation-id"

type

type: object

name

name: string = "String"

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

purchaseId

purchaseId: object

serializedName

serializedName: string = "purchase-id"

type

type: object

name

name: string = "String"

Const PhoneNumbersReleasePhoneNumberHeaders

PhoneNumbersReleasePhoneNumberHeaders: object

type

type: object

className

className: string = "PhoneNumbersReleasePhoneNumberHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationId

operationId: object

serializedName

serializedName: string = "operation-id"

type

type: object

name

name: string = "String"

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

releaseId

releaseId: object

serializedName

serializedName: string = "release-id"

type

type: object

name

name: string = "String"

Const PhoneNumbersSearchAvailablePhoneNumbersHeaders

PhoneNumbersSearchAvailablePhoneNumbersHeaders: object

type

type: object

className

className: string = "PhoneNumbersSearchAvailablePhoneNumbersHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

operationId

operationId: object

serializedName

serializedName: string = "operation-id"

type

type: object

name

name: string = "String"

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

searchId

searchId: object

serializedName

serializedName: string = "search-id"

type

type: object

name

name: string = "String"

Const PhoneNumbersUpdateCapabilitiesHeaders

PhoneNumbersUpdateCapabilitiesHeaders: object

type

type: object

className

className: string = "PhoneNumbersUpdateCapabilitiesHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

capabilitiesId

capabilitiesId: object

serializedName

serializedName: string = "capabilities-id"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

operationId

operationId: object

serializedName

serializedName: string = "operation-id"

type

type: object

name

name: string = "String"

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const PurchasedPhoneNumber

PurchasedPhoneNumber: object

type

type: object

className

className: string = "PurchasedPhoneNumber"

name

name: string = "Composite"

modelProperties

modelProperties: object

assignmentType

assignmentType: object

required

required: boolean = true

serializedName

serializedName: string = "assignmentType"

type

type: object

allowedValues

allowedValues: string[] = ["person", "application"]

name

name: string = "Enum"

capabilities

capabilities: object

serializedName

serializedName: string = "capabilities"

type

type: object

className

className: string = "PhoneNumberCapabilities"

name

name: string = "Composite"

cost

cost: object

serializedName

serializedName: string = "cost"

type

type: object

className

className: string = "PhoneNumberCost"

name

name: string = "Composite"

countryCode

countryCode: object

required

required: boolean = true

serializedName

serializedName: string = "countryCode"

type

type: object

name

name: string = "String"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

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"

phoneNumberType

phoneNumberType: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumberType"

type

type: object

allowedValues

allowedValues: string[] = ["geographic", "tollFree"]

name

name: string = "Enum"

purchaseDate

purchaseDate: object

required

required: boolean = true

serializedName

serializedName: string = "purchaseDate"

type

type: object

name

name: string = "DateTime"

Const PurchasedPhoneNumbers

PurchasedPhoneNumbers: object

type

type: object

className

className: string = "PurchasedPhoneNumbers"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

phoneNumbers

phoneNumbers: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumbers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PurchasedPhoneNumber"

name

name: string = "Composite"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2022-01-11-preview2"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const areaCode

areaCode: object

mapper

mapper: any = PhoneNumberSearchRequestMapper

parameterPath

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

Const assignmentType

assignmentType: object

mapper

mapper: any = PhoneNumberSearchRequestMapper

parameterPath

parameterPath: string = "assignmentType"

Const calling

calling: object

mapper

mapper: any = PhoneNumberCapabilitiesRequestMapper

parameterPath

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

Const cancelOperationOperationSpec

cancelOperationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/phoneNumbers/operations/{operationId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const capabilities

capabilities: object

mapper

mapper: any = PhoneNumberSearchRequestMapper

parameterPath

parameterPath: string = "capabilities"

Const contentType

contentType: object

parameterPath

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

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const contentType1

contentType1: object

parameterPath

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

mapper

mapper: object

defaultValue

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

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

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 endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const getByNumberOperationSpec

getByNumberOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/phoneNumbers/{phoneNumber}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PurchasedPhoneNumber

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const getOperationOperationSpec

getOperationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/phoneNumbers/operations/{operationId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberOperation

headersMapper

headersMapper: any = Mappers.PhoneNumbersGetOperationHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const getSearchResultOperationSpec

getSearchResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/availablePhoneNumbers/searchResults/{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.PhoneNumberSearchResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const listPhoneNumbersNextOperationSpec

listPhoneNumbersNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

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

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PurchasedPhoneNumbers

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const listPhoneNumbersOperationSpec

listPhoneNumbersOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/phoneNumbers"

queryParameters

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

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PurchasedPhoneNumbers

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: string = "String"

Const phoneNumber

phoneNumber: object

parameterPath

parameterPath: string = "phoneNumber"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "phoneNumber"

type

type: object

name

name: string = "String"

Const phoneNumberType

phoneNumberType: object

mapper

mapper: any = PhoneNumberSearchRequestMapper

parameterPath

parameterPath: string = "phoneNumberType"

Const purchasePhoneNumbersOperationSpec

purchasePhoneNumbersOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/availablePhoneNumbers/:purchase"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

searchId

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

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersPurchasePhoneNumbersHeaders

201

201: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersPurchasePhoneNumbersHeaders

202

202: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersPurchasePhoneNumbersHeaders

204

204: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersPurchasePhoneNumbersHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const quantity

quantity: object

mapper

mapper: any = PhoneNumberSearchRequestMapper

parameterPath

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

Const releasePhoneNumberOperationSpec

releasePhoneNumberOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/phoneNumbers/{phoneNumber}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersReleasePhoneNumberHeaders

201

201: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersReleasePhoneNumberHeaders

202

202: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersReleasePhoneNumberHeaders

204

204: object

headersMapper

headersMapper: any = Mappers.PhoneNumbersReleasePhoneNumberHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Const searchAvailablePhoneNumbersOperationSpec

searchAvailablePhoneNumbersOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/availablePhoneNumbers/countries/{countryCode}/:search"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

areaCode

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

assignmentType

assignmentType: string[] = ["assignmentType"]

capabilities

capabilities: string[] = ["capabilities"]

phoneNumberType

phoneNumberType: string[] = ["phoneNumberType"]

quantity

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberSearchResult

headersMapper

headersMapper: any = Mappers.PhoneNumbersSearchAvailablePhoneNumbersHeaders

201

201: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberSearchResult

headersMapper

headersMapper: any = Mappers.PhoneNumbersSearchAvailablePhoneNumbersHeaders

202

202: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberSearchResult

headersMapper

headersMapper: any = Mappers.PhoneNumbersSearchAvailablePhoneNumbersHeaders

204

204: object

bodyMapper

bodyMapper: any = Mappers.PhoneNumberSearchResult

headersMapper

headersMapper: any = Mappers.PhoneNumbersSearchAvailablePhoneNumbersHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

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 searchId1

searchId1: object

mapper

mapper: any = PhoneNumberPurchaseRequestMapper

parameterPath

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

Const skip

skip: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "skip"

type

type: object

name

name: string = "Number"

Const sms

sms: object

mapper

mapper: any = PhoneNumberCapabilitiesRequestMapper

parameterPath

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

Const top

top: object

parameterPath

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

mapper

mapper: object

defaultValue

defaultValue: number = 100

serializedName

serializedName: string = "top"

type

type: object

name

name: string = "Number"

Const updateCapabilitiesOperationSpec

updateCapabilitiesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType1]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/phoneNumbers/{phoneNumber}/capabilities"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

requestBody

requestBody: object

mapper

mapper: any = Mappers.PhoneNumberCapabilitiesRequest

parameterPath

parameterPath: object

calling

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

sms

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PurchasedPhoneNumber

headersMapper

headersMapper: any = Mappers.PhoneNumbersUpdateCapabilitiesHeaders

201

201: object

bodyMapper

bodyMapper: any = Mappers.PurchasedPhoneNumber

headersMapper

headersMapper: any = Mappers.PhoneNumbersUpdateCapabilitiesHeaders

202

202: object

bodyMapper

bodyMapper: any = Mappers.PurchasedPhoneNumber

headersMapper

headersMapper: any = Mappers.PhoneNumbersUpdateCapabilitiesHeaders

204

204: object

bodyMapper

bodyMapper: any = Mappers.PurchasedPhoneNumber

headersMapper

headersMapper: any = Mappers.PhoneNumbersUpdateCapabilitiesHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

Generated using TypeDoc