PhoneNumbersClient

PhoneNumbersClient

Manages PhoneNumbers.

Constructor

new PhoneNumbersClient(optionsopt)

Construct an instance of PhoneNumbersClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

matchPhoneNumberFromPhoneNumberName(phoneNumberName) → {string}

Parse the phone_number from PhoneNumber resource.

Parameters:
Name Type Description
phoneNumberName string

A fully-qualified path representing PhoneNumber resource.
Returns:
Type Description
string

A string representing the phone_number.

matchPhoneNumberInstanceFromPhoneNumberInstanceName(phoneNumberInstanceName) → {string}

Parse the phone_number_instance from PhoneNumberInstance resource.

Parameters:
Name Type Description
phoneNumberInstanceName string

A fully-qualified path representing PhoneNumberInstance resource.
Returns:
Type Description
string

A string representing the phone_number_instance.

matchProjectFromPhoneNumberInstanceName(phoneNumberInstanceName) → {string}

Parse the project from PhoneNumberInstance resource.

Parameters:
Name Type Description
phoneNumberInstanceName string

A fully-qualified path representing PhoneNumberInstance resource.
Returns:
Type Description
string

A string representing the project.

phoneNumberInstancePath(project, phone_number_instance) → {string}

Return a fully-qualified phoneNumberInstance resource name string.

Parameters:
Name Type Description
project string
phone_number_instance string
Returns:
Type Description
string

Resource name string.

phoneNumberPath(phone_number) → {string}

Return a fully-qualified phoneNumber resource name string.

Parameters:
Name Type Description
phone_number string
Returns:
Type Description
string

Resource name string.

searchPhoneNumbers(request, optionsopt) → {Promise}

Searches available phone numbers with the specified filters.

Search returns phone numbers sorted by create_time descending.

The caller must be authenticated.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
pageSize number

The maximum number of PhoneNumbers to return in the response. Default value of 10 and maximum value of 100.
pageToken string

A pagination token returned from a previous call to SearchPhoneNumbers that indicates where this listing should continue from.
numberType enfonica.numbering.v1beta1.PhoneNumber.PhoneNumberType

The type of phone number.
countryCode string

The alpha-2 country code that identifies the country associated with the phone number. (-- api-linter: core::0143::standardized-codes=disabled aip.dev/not-precedent: Country code is used in this beta. --)
prefix string

The prefix that the number must have after the country code. If the prefix starts with '0', it will be automatically removed.
supportsVoice boolean

If true, the phone number must support voice.
supportsSms boolean

If true, the phone number must support SMS.
supportsMms boolean

If true, the phone number must support MMS.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise

  • The promise which resolves to an array. The first element of the array is Array of PhoneNumber. The client library support auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of PhoneNumber that corresponds to the one page received from the API server. If the second element is not null it contains the request object of type SearchPhoneNumbersRequest that can be used to obtain the next page of the results. If it is null, the next page does not exist. The third element contains the raw response received from the API server. Its type is SearchPhoneNumbersResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

searchPhoneNumbersAsync(request, optionsopt) → {Object}

Equivalent to searchPhoneNumbers, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
pageSize number

The maximum number of PhoneNumbers to return in the response. Default value of 10 and maximum value of 100.
pageToken string

A pagination token returned from a previous call to SearchPhoneNumbers that indicates where this listing should continue from.
numberType enfonica.numbering.v1beta1.PhoneNumber.PhoneNumberType

The type of phone number.
countryCode string

The alpha-2 country code that identifies the country associated with the phone number. (-- api-linter: core::0143::standardized-codes=disabled aip.dev/not-precedent: Country code is used in this beta. --)
prefix string

The prefix that the number must have after the country code. If the prefix starts with '0', it will be automatically removed.
supportsVoice boolean

If true, the phone number must support voice.
supportsSms boolean

If true, the phone number must support SMS.
supportsMms boolean

If true, the phone number must support MMS.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

searchPhoneNumbersStream(request, optionsopt) → {Stream}

Equivalent to searchPhoneNumbers, but returns a NodeJS Stream object.

This fetches the paged responses for searchPhoneNumbers continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
pageSize number

The maximum number of PhoneNumbers to return in the response. Default value of 10 and maximum value of 100.
pageToken string

A pagination token returned from a previous call to SearchPhoneNumbers that indicates where this listing should continue from.
numberType enfonica.numbering.v1beta1.PhoneNumber.PhoneNumberType

The type of phone number.
countryCode string

The alpha-2 country code that identifies the country associated with the phone number. (-- api-linter: core::0143::standardized-codes=disabled aip.dev/not-precedent: Country code is used in this beta. --)
prefix string

The prefix that the number must have after the country code. If the prefix starts with '0', it will be automatically removed.
supportsVoice boolean

If true, the phone number must support voice.
supportsSms boolean

If true, the phone number must support SMS.
supportsMms boolean

If true, the phone number must support MMS.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing PhoneNumber on 'data' event.
See: