PhoneNumberInstances - Documentation

Constructor

new PhoneNumberInstances(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new PhoneNumberInstances service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {PhoneNumberInstances}

Creates new PhoneNumberInstances service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
PhoneNumberInstances	RPC service. Useful where requests and/or responses are streamed.

createPhoneNumberInstance(request, callback) → {undefined}

Calls CreatePhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.ICreatePhoneNumberInstanceRequest	CreatePhoneNumberInstanceRequest message or plain object
`callback`	enfonica.numbering.v1beta1.PhoneNumberInstances.CreatePhoneNumberInstanceCallback	Node-style callback called with the error, if any, and PhoneNumberInstance

Returns:

Type	Description
undefined

createPhoneNumberInstance(request) → {Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>}

Calls CreatePhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.ICreatePhoneNumberInstanceRequest	CreatePhoneNumberInstanceRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>	Promise

deletePhoneNumberInstance(request, callback) → {undefined}

Calls DeletePhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IDeletePhoneNumberInstanceRequest	DeletePhoneNumberInstanceRequest message or plain object
`callback`	enfonica.numbering.v1beta1.PhoneNumberInstances.DeletePhoneNumberInstanceCallback	Node-style callback called with the error, if any, and PhoneNumberInstance

Returns:

Type	Description
undefined

deletePhoneNumberInstance(request) → {Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>}

Calls DeletePhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IDeletePhoneNumberInstanceRequest	DeletePhoneNumberInstanceRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>	Promise

getPhoneNumberInstance(request, callback) → {undefined}

Calls GetPhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IGetPhoneNumberInstanceRequest	GetPhoneNumberInstanceRequest message or plain object
`callback`	enfonica.numbering.v1beta1.PhoneNumberInstances.GetPhoneNumberInstanceCallback	Node-style callback called with the error, if any, and PhoneNumberInstance

Returns:

Type	Description
undefined

getPhoneNumberInstance(request) → {Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>}

Calls GetPhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IGetPhoneNumberInstanceRequest	GetPhoneNumberInstanceRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>	Promise

listPhoneNumberInstances(request, callback) → {undefined}

Calls ListPhoneNumberInstances.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IListPhoneNumberInstancesRequest	ListPhoneNumberInstancesRequest message or plain object
`callback`	enfonica.numbering.v1beta1.PhoneNumberInstances.ListPhoneNumberInstancesCallback	Node-style callback called with the error, if any, and ListPhoneNumberInstancesResponse

Returns:

Type	Description
undefined

listPhoneNumberInstances(request) → {Promise.<enfonica.numbering.v1beta1.ListPhoneNumberInstancesResponse>}

Calls ListPhoneNumberInstances.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IListPhoneNumberInstancesRequest	ListPhoneNumberInstancesRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.numbering.v1beta1.ListPhoneNumberInstancesResponse>	Promise

updatePhoneNumberInstance(request, callback) → {undefined}

Calls UpdatePhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IUpdatePhoneNumberInstanceRequest	UpdatePhoneNumberInstanceRequest message or plain object
`callback`	enfonica.numbering.v1beta1.PhoneNumberInstances.UpdatePhoneNumberInstanceCallback	Node-style callback called with the error, if any, and PhoneNumberInstance

Returns:

Type	Description
undefined

updatePhoneNumberInstance(request) → {Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>}

Calls UpdatePhoneNumberInstance.

Parameters:

Name	Type	Description
`request`	enfonica.numbering.v1beta1.IUpdatePhoneNumberInstanceRequest	UpdatePhoneNumberInstanceRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.numbering.v1beta1.PhoneNumberInstance>	Promise

Type Definitions

CreatePhoneNumberInstanceCallback(error, responseopt)

Callback as used by enfonica.numbering.v1beta1.PhoneNumberInstances#createPhoneNumberInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.numbering.v1beta1.PhoneNumberInstance	<optional>	PhoneNumberInstance

DeletePhoneNumberInstanceCallback(error, responseopt)

Callback as used by enfonica.numbering.v1beta1.PhoneNumberInstances#deletePhoneNumberInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.numbering.v1beta1.PhoneNumberInstance	<optional>	PhoneNumberInstance

GetPhoneNumberInstanceCallback(error, responseopt)

Callback as used by enfonica.numbering.v1beta1.PhoneNumberInstances#getPhoneNumberInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.numbering.v1beta1.PhoneNumberInstance	<optional>	PhoneNumberInstance

ListPhoneNumberInstancesCallback(error, responseopt)

Callback as used by enfonica.numbering.v1beta1.PhoneNumberInstances#listPhoneNumberInstances.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.numbering.v1beta1.ListPhoneNumberInstancesResponse	<optional>	ListPhoneNumberInstancesResponse

UpdatePhoneNumberInstanceCallback(error, responseopt)

Callback as used by enfonica.numbering.v1beta1.PhoneNumberInstances#updatePhoneNumberInstance.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.numbering.v1beta1.PhoneNumberInstance	<optional>	PhoneNumberInstance