Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-phone-numbers

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

GetPurchasedPhoneNumberOptions

GetPurchasedPhoneNumberOptions: OperationOptions

Additional options for the get phone number request.

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

Contains response data for the getByNumber operation.

PhoneNumbersGetOperationResponse

PhoneNumbersGetOperationResponse: PhoneNumbersGetOperationHeaders & PhoneNumberOperation

Contains response data for the getOperation operation.

PhoneNumbersGetSearchResultResponse

PhoneNumbersGetSearchResultResponse: PhoneNumberSearchResult

Contains response data for the getSearchResult operation.

PhoneNumbersListPhoneNumbersNextResponse

PhoneNumbersListPhoneNumbersNextResponse: PurchasedPhoneNumbers

Contains response data for the listPhoneNumbersNext operation.

PhoneNumbersListPhoneNumbersResponse

PhoneNumbersListPhoneNumbersResponse: PurchasedPhoneNumbers

Contains response data for the listPhoneNumbers operation.

PhoneNumbersPurchasePhoneNumbersResponse

PhoneNumbersPurchasePhoneNumbersResponse: PhoneNumbersPurchasePhoneNumbersHeaders

Contains response data for the purchasePhoneNumbers operation.

PhoneNumbersReleasePhoneNumberResponse

PhoneNumbersReleasePhoneNumberResponse: PhoneNumbersReleasePhoneNumberHeaders

Contains response data for the releasePhoneNumber operation.

PhoneNumbersSearchAvailablePhoneNumbersResponse

PhoneNumbersSearchAvailablePhoneNumbersResponse: PhoneNumbersSearchAvailablePhoneNumbersHeaders & PhoneNumberSearchResult

Contains response data for the searchAvailablePhoneNumbers operation.

PhoneNumbersUpdateCapabilitiesResponse

PhoneNumbersUpdateCapabilitiesResponse: PhoneNumbersUpdateCapabilitiesHeaders & PurchasedPhoneNumber

Contains response data for the updateCapabilities operation.

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.2.0-beta.3"

Const logger

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

The @azure/logger configuration for this package.

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Functions

createPhoneNumbersPagingPolicy

  • createPhoneNumbersPagingPolicy(host: string): PipelinePolicy

  • Creates a PipelinePolicy that converts relative URL values in the nextLink property to absolute URLs.

    This is necessary because the Core V2 library does not support paging with relative links at time of writing.

    Parameters

    • host: string

      The base URL of the resource.

    Returns PipelinePolicy

    the PipelinePolicy that addresses the issue.

Const isPhoneNumbersClientOptions

  • isPhoneNumbersClientOptions(options: any): options is PhoneNumbersClientOptions

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

name

name: string = "String"

sms

sms: object

required

required: boolean = true

serializedName

serializedName: string = "sms"

type

type: object

name

name: string = "String"

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

name

name: string = "String"

sms

sms: object

serializedName

serializedName: string = "sms"

type

type: object

name

name: string = "String"

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

name

name: string = "String"

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

name

name: string = "String"

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

name

name: string = "String"

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

name

name: string = "String"

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

name

name: string = "String"

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

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

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

name

name: string = "String"

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

name

name: string = "String"

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

defaultValue

defaultValue: number = 0

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