@azure/communication-phone-numbers 1.3.0-alpha.20241112.1 → 1.3.0-alpha.20241113.1

package/dist/commonjs/phoneNumbersClient.d.ts

@@ -0,0 +1,244 @@
+import type { KeyCredential, TokenCredential } from "@azure/core-auth";
+import type { PollOperationState, PollerLike } from "@azure/core-lro";
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { OperatorInformationResult, PhoneNumberAreaCode, PhoneNumberCapabilitiesRequest, PhoneNumberCountry, PhoneNumberLocality, PhoneNumberOffering, PhoneNumberSearchResult, PurchasedPhoneNumber } from "./generated/src/models/index.js";
+import type { GetPurchasedPhoneNumberOptions, ListAvailableCountriesOptions, ListGeographicAreaCodesOptions, ListLocalitiesOptions, ListOfferingsOptions, ListPurchasedPhoneNumbersOptions, ListTollFreeAreaCodesOptions, PurchasePhoneNumbersResult, ReleasePhoneNumberResult, SearchAvailablePhoneNumbersRequest, SearchOperatorInformationOptions } from "./models.js";
+import type { BeginPurchasePhoneNumbersOptions, BeginReleasePhoneNumberOptions, BeginSearchAvailablePhoneNumbersOptions, BeginUpdatePhoneNumberCapabilitiesOptions } from "./lroModels.js";
+import type { CommonClientOptions } from "@azure/core-client";
+/**
+ * Client options used to configure the PhoneNumbersClient API requests.
+ */
+export interface PhoneNumbersClientOptions extends CommonClientOptions {
+    /**
+     * The accept language parameter to be used in the request header's "accept-language" property.
+     */
+    acceptLanguage?: string;
+}
+/**
+ * Client class for interacting with Azure Communication Services Phone Number Administration.
+ */
+export declare class PhoneNumbersClient {
+    /**
+     * A reference to the auto-generated PhoneNumber HTTP client.
+     */
+    private readonly client;
+    /**
+     * The accept language parameter to be used in the request header's "accept-language" property.
+     */
+    private acceptLanguage;
+    /**
+     * Initializes a new instance of the PhoneNumberAdministrationClient class using a connection string.
+     *
+     * @param connectionString - Connection string to connect to an Azure Communication Service resource. (eg: endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret)
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     */
+    constructor(connectionString: string, options?: PhoneNumbersClientOptions);
+    /**
+     * Initializes a new instance of the PhoneNumberAdministrationClient class using an Azure KeyCredential.
+     *
+     * @param url - The endpoint of the service (eg: https://contoso.eastus.communications.azure.net)
+     * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     */
+    constructor(url: string, credential: KeyCredential, options?: PhoneNumbersClientOptions);
+    /**
+     * Initializes a new instance of the PhoneNumberAdministrationClient class using a TokenCredential.
+     * @param url - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
+     * @param credential - TokenCredential that is used to authenticate requests to the service.
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     */
+    constructor(url: string, credential: TokenCredential, options?: PhoneNumbersClientOptions);
+    /**
+     * Gets the details of a purchased phone number. Includes phone number, cost, country code, etc.
+     *
+     * @param phoneNumber - The E.164 formatted phone number being fetched. The leading plus can be either + or encoded as %2B.
+     * @param options - Additional request options.
+     */
+    getPurchasedPhoneNumber(phoneNumber: string, options?: GetPurchasedPhoneNumberOptions): Promise<PurchasedPhoneNumber>;
+    /**
+     * Iterates the purchased phone numbers.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const purchased of client.listPhoneNumbers()) {
+     *   console.log("phone number: ", purchased.phoneNumber);
+     * }
+     * ```
+     * List all purchased phone numbers.
+     * @param options - The optional parameters.
+     */
+    listPurchasedPhoneNumbers(options?: ListPurchasedPhoneNumbersOptions): PagedAsyncIterableIterator<PurchasedPhoneNumber>;
+    /**
+     * Starts the release of a purchased phone number.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumbersClient(CONNECTION_STRING);
+     * const releasePoller = await client.beginReleasePhoneNumber("+14125550100");
+     *
+     * // Serializing the poller
+     * const serialized = releasePoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await releasePoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     * @param phoneNumber - The E.164 formatted phone number being released. The leading plus can be either + or encoded as %2B.
+     * @param options - Additional request options.
+     */
+    beginReleasePhoneNumber(phoneNumber: string, options?: BeginReleasePhoneNumberOptions): Promise<PollerLike<PollOperationState<ReleasePhoneNumberResult>, ReleasePhoneNumberResult>>;
+    /**
+     * Starts a search for phone numbers given some constraints such as name or area code.
+     * The phone numbers that are found are reserved until you cancel, purchase or the reservation expires.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
+     * const searchPoller = await client.beginSearchAvailablePhoneNumbers(SEARCH_REQUEST);
+     *
+     * // Serializing the poller
+     * const serialized = searchPoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await searchPoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     *
+     * @param search - Request properties to constraint the search scope.
+     * @param options - Additional request options.
+     */
+    beginSearchAvailablePhoneNumbers(search: SearchAvailablePhoneNumbersRequest, options?: BeginSearchAvailablePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PhoneNumberSearchResult>, PhoneNumberSearchResult>>;
+    /**
+     * Starts the purchase of the phone number(s) in the search associated with a given id.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumbersClient(CONNECTION_STRING);
+     * const purchasePoller = await client.beginPurchasePhoneNumbers(SEARCH_ID);
+     *
+     * // Serializing the poller
+     * const serialized = purchasePoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await purchasePoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     *
+     * @param searchId - The id of the search to purchase. Returned from `beginSearchAvailablePhoneNumbers`
+     * @param options - Additional request options.
+     */
+    beginPurchasePhoneNumbers(searchId: string, options?: BeginPurchasePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PurchasePhoneNumbersResult>, PurchasePhoneNumbersResult>>;
+    /**
+     * Starts the update of a purchased phone number's capabilities.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumbersClient(CONNECTION_STRING);
+     * const updatePoller = await client.beginUpdatePhoneNumberCapabilities("+14125550100", UPDATE_REQUEST);
+     *
+     * // Serializing the poller
+     * const serialized = updatePoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await updatePoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     *
+     * @param phoneNumber - The E.164 formatted phone number being updated. The leading plus can be either + or encoded as %2B.
+     * @param request - The updated properties which will be applied to the phone number.
+     * @param options - Additional request options.
+     */
+    beginUpdatePhoneNumberCapabilities(phoneNumber: string, request: PhoneNumberCapabilitiesRequest, options?: BeginUpdatePhoneNumberCapabilitiesOptions): Promise<PollerLike<PollOperationState<PurchasedPhoneNumber>, PurchasedPhoneNumber>>;
+    /**
+     * Iterates the available countries.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const country of client.listAvailableCountries()) {
+     *   console.log("country: ", country.localizedName);
+     * }
+     * ```
+     * List all available countries.
+     * @param options - The optional parameters.
+     */
+    listAvailableCountries(options?: ListAvailableCountriesOptions): PagedAsyncIterableIterator<PhoneNumberCountry>;
+    /**
+     * Iterates the available Toll-Free area codes.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const areaCodeItem of client.listTollFreeAreaCodes()) {
+     *   console.log("area code: ", areaCodeItem.areaCode);
+     * }
+     * ```
+     * List all available Toll-Free area codes.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableTollFreeAreaCodes(countryCode: string, options?: ListTollFreeAreaCodesOptions): PagedAsyncIterableIterator<PhoneNumberAreaCode>;
+    /**
+     * Iterates the available Geographic area codes.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const areaCodeItem of client.listGeographicAreaCodes()) {
+     *   console.log("area code: ", areaCodeItem.areaCode);
+     * }
+     * ```
+     * List all available Geographic area codes.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableGeographicAreaCodes(countryCode: string, options?: ListGeographicAreaCodesOptions): PagedAsyncIterableIterator<PhoneNumberAreaCode>;
+    /**
+     * Iterates the available localities.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const locality of client.listAvailableLocalities()) {
+     *   console.log("locality: ", locality.localizedName);
+     * }
+     * ```
+     * List all available localities.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableLocalities(countryCode: string, options?: ListLocalitiesOptions): PagedAsyncIterableIterator<PhoneNumberLocality>;
+    /**
+     * Iterates the available offerings.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const offering of client.listAvailableOfferings()) {
+     *   console.log("phone number type: ", offering.phoneNumberType);
+     *   console.log("cost: ", offering.cost.amount);
+     * }
+     * ```
+     * List all available offerings.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableOfferings(countryCode: string, options?: ListOfferingsOptions): PagedAsyncIterableIterator<PhoneNumberOffering>;
+    /**
+     * Search for operator information about specified phone numbers.
+     *
+     * @param phoneNumbers - The phone numbers to search.
+     * @param options - Additional request options.
+     */
+    searchOperatorInformation(phoneNumbers: string[], options?: SearchOperatorInformationOptions): Promise<OperatorInformationResult>;
+}
+//# sourceMappingURL=phoneNumbersClient.d.ts.map

package/dist/commonjs/phoneNumbersClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phoneNumbersClient.d.ts","sourceRoot":"","sources":["../../src/phoneNumbersClient.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAErE,OAAO,KAAK,EACV,yBAAyB,EACzB,mBAAmB,EACnB,8BAA8B,EAC9B,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,8BAA8B,EAC9B,6BAA6B,EAC7B,8BAA8B,EAC9B,qBAAqB,EACrB,oBAAoB,EACpB,gCAAgC,EAChC,4BAA4B,EAC5B,0BAA0B,EAC1B,wBAAwB,EACxB,kCAAkC,EAClC,gCAAgC,EACjC,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EACV,gCAAgC,EAChC,8BAA8B,EAC9B,uCAAuC,EACvC,yCAAyC,EAC1C,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAI9D;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAKD;;GAEG;AACH,qBAAa,kBAAkB;IAC7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA8B;IAErD;;OAEG;IACH,OAAO,CAAC,cAAc,CAAqB;IAE3C;;;;;OAKG;gBACgB,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAEhF;;;;;;OAMG;gBACgB,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAE9F;;;;;OAKG;gBACgB,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,yBAAyB;IAkChG;;;;;OAKG;IACI,uBAAuB,CAC5B,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,8BAAmC,GAC3C,OAAO,CAAC,oBAAoB,CAAC;IAYhC;;;;;;;;;;;;OAYG;IACI,yBAAyB,CAC9B,OAAO,GAAE,gCAAqC,GAC7C,0BAA0B,CAAC,oBAAoB,CAAC;IAsBnD;;;;;;;;;;;;;;;;;;;OAmBG;IACI,uBAAuB,CAC5B,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,8BAAmC,GAC3C,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EAAE,wBAAwB,CAAC,CAAC;IAU9F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,gCAAgC,CACrC,MAAM,EAAE,kCAAkC,EAC1C,OAAO,GAAE,uCAA4C,GACpD,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,EAAE,uBAAuB,CAAC,CAAC;IAoB5F;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,yBAAyB,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CACR,UAAU,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,EAAE,0BAA0B,CAAC,CACvF;IAUD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,kCAAkC,CACvC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,8BAA8B,EACvC,OAAO,GAAE,yCAA8C,GACtD,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAgBtF;;;;;;;;;;;;OAYG;IACI,sBAAsB,CAC3B,OAAO,GAAE,6BAAkC,GAC1C,0BAA0B,CAAC,kBAAkB,CAAC;IAuBjD;;;;;;;;;;;;;OAaG;IACI,8BAA8B,CACnC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,4BAAiC,GACzC,0BAA0B,CAAC,mBAAmB,CAAC;IAuBlD;;;;;;;;;;;;;OAaG;IACI,gCAAgC,CACrC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,8BAAmC,GAC3C,0BAA0B,CAAC,mBAAmB,CAAC;IAsBlD;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAC5B,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,qBAA0B,GAClC,0BAA0B,CAAC,mBAAmB,CAAC;IAuBlD;;;;;;;;;;;;;;OAcG;IACI,sBAAsB,CAC3B,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,oBAAyB,GACjC,0BAA0B,CAAC,mBAAmB,CAAC;IAsBlD;;;;;OAKG;IACI,yBAAyB,CAC9B,YAAY,EAAE,MAAM,EAAE,EACtB,OAAO,GAAE,gCAA8E,GACtF,OAAO,CAAC,yBAAyB,CAAC;CAsBtC"}

package/dist/commonjs/phoneNumbersClient.js

@@ -0,0 +1,361 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/// <reference lib="esnext.asynciterable" />
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhoneNumbersClient = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable @azure/azure-sdk/ts-naming-options */
+const communication_common_1 = require("@azure/communication-common");
+const core_auth_1 = require("@azure/core-auth");
+const index_js_1 = require("./generated/src/index.js");
+const customPipelinePolicies_js_1 = require("./utils/customPipelinePolicies.js");
+const index_js_2 = require("./utils/index.js");
+const tracing_js_1 = require("./generated/src/tracing.js");
+const isPhoneNumbersClientOptions = (options) => options && !(0, communication_common_1.isKeyCredential)(options) && !(0, core_auth_1.isTokenCredential)(options);
+/**
+ * Client class for interacting with Azure Communication Services Phone Number Administration.
+ */
+class PhoneNumbersClient {
+    constructor(connectionStringOrUrl, credentialOrOptions, maybeOptions = {}) {
+        const { url, credential } = (0, communication_common_1.parseClientArguments)(connectionStringOrUrl, credentialOrOptions);
+        const options = isPhoneNumbersClientOptions(credentialOrOptions)
+            ? credentialOrOptions
+            : maybeOptions;
+        const internalPipelineOptions = Object.assign(Object.assign({}, options), {
+            loggingOptions: {
+                logger: index_js_2.logger.info,
+            },
+        });
+        this.client = new index_js_1.PhoneNumbersClient(url, Object.assign({ endpoint: url }, internalPipelineOptions));
+        const authPolicy = (0, communication_common_1.createCommunicationAuthPolicy)(credential);
+        this.client.pipeline.addPolicy(authPolicy);
+        // This policy is temporary workarounds to address compatibility issues with Azure Core V2.
+        const phoneNumbersPagingPolicy = (0, customPipelinePolicies_js_1.createPhoneNumbersPagingPolicy)(url);
+        this.client.pipeline.addPolicy(phoneNumbersPagingPolicy);
+        this.acceptLanguage = maybeOptions.acceptLanguage;
+    }
+    /**
+     * Gets the details of a purchased phone number. Includes phone number, cost, country code, etc.
+     *
+     * @param phoneNumber - The E.164 formatted phone number being fetched. The leading plus can be either + or encoded as %2B.
+     * @param options - Additional request options.
+     */
+    getPurchasedPhoneNumber(phoneNumber, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("PhoneNumbersClient-getPurchasedPhoneNumber", options, (updatedOptions) => {
+            return this.client.phoneNumbers.getByNumber(phoneNumber, Object.assign({}, updatedOptions));
+        });
+    }
+    /**
+     * Iterates the purchased phone numbers.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const purchased of client.listPhoneNumbers()) {
+     *   console.log("phone number: ", purchased.phoneNumber);
+     * }
+     * ```
+     * List all purchased phone numbers.
+     * @param options - The optional parameters.
+     */
+    listPurchasedPhoneNumbers(options = {}) {
+        const { span, updatedOptions } = tracing_js_1.tracingClient.startSpan("PhoneNumbersClient-listPurchasedPhoneNumbers", options);
+        try {
+            return this.client.phoneNumbers.listPhoneNumbers(Object.assign({}, updatedOptions));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Starts the release of a purchased phone number.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumbersClient(CONNECTION_STRING);
+     * const releasePoller = await client.beginReleasePhoneNumber("+14125550100");
+     *
+     * // Serializing the poller
+     * const serialized = releasePoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await releasePoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     * @param phoneNumber - The E.164 formatted phone number being released. The leading plus can be either + or encoded as %2B.
+     * @param options - Additional request options.
+     */
+    beginReleasePhoneNumber(phoneNumber, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("PhoneNumbersClient-beginReleasePhoneNumber", options, (updatedOptions) => {
+            return this.client.phoneNumbers.beginReleasePhoneNumber(phoneNumber, updatedOptions);
+        });
+    }
+    /**
+     * Starts a search for phone numbers given some constraints such as name or area code.
+     * The phone numbers that are found are reserved until you cancel, purchase or the reservation expires.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
+     * const searchPoller = await client.beginSearchAvailablePhoneNumbers(SEARCH_REQUEST);
+     *
+     * // Serializing the poller
+     * const serialized = searchPoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await searchPoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     *
+     * @param search - Request properties to constraint the search scope.
+     * @param options - Additional request options.
+     */
+    beginSearchAvailablePhoneNumbers(search, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("PhoneNumbersClient-beginSearchAvailablePhoneNumbers", options, (updatedOptions) => {
+            const { countryCode, phoneNumberType, assignmentType, capabilities } = search, rest = tslib_1.__rest(search, ["countryCode", "phoneNumberType", "assignmentType", "capabilities"]);
+            return this.client.phoneNumbers.beginSearchAvailablePhoneNumbers(countryCode, phoneNumberType, assignmentType, capabilities, Object.assign(Object.assign({}, updatedOptions), rest));
+        });
+    }
+    /**
+     * Starts the purchase of the phone number(s) in the search associated with a given id.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumbersClient(CONNECTION_STRING);
+     * const purchasePoller = await client.beginPurchasePhoneNumbers(SEARCH_ID);
+     *
+     * // Serializing the poller
+     * const serialized = purchasePoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await purchasePoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     *
+     * @param searchId - The id of the search to purchase. Returned from `beginSearchAvailablePhoneNumbers`
+     * @param options - Additional request options.
+     */
+    beginPurchasePhoneNumbers(searchId, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("PhoneNumbersClient-beginPurchasePhoneNumbers", options, (updatedOptions) => {
+            return this.client.phoneNumbers.beginPurchasePhoneNumbers(Object.assign(Object.assign({}, updatedOptions), { searchId }));
+        });
+    }
+    /**
+     * Starts the update of a purchased phone number's capabilities.
+     *
+     * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.
+     *
+     * Example usage:
+     * ```ts
+     * const client = new PhoneNumbersClient(CONNECTION_STRING);
+     * const updatePoller = await client.beginUpdatePhoneNumberCapabilities("+14125550100", UPDATE_REQUEST);
+     *
+     * // Serializing the poller
+     * const serialized = updatePoller.toString();
+     *
+     * // Waiting until it's done
+     * const results = await updatePoller.pollUntilDone();
+     * console.log(results);
+     * ```
+     *
+     * @param phoneNumber - The E.164 formatted phone number being updated. The leading plus can be either + or encoded as %2B.
+     * @param request - The updated properties which will be applied to the phone number.
+     * @param options - Additional request options.
+     */
+    beginUpdatePhoneNumberCapabilities(phoneNumber, request, options = {}) {
+        if (!phoneNumber) {
+            throw Error("phone number can't be empty");
+        }
+        return tracing_js_1.tracingClient.withSpan("PhoneNumbersClient-beginUpdatePhoneNumberCapabilities", options, (updatedOptions) => {
+            return this.client.phoneNumbers.beginUpdateCapabilities(phoneNumber, Object.assign(Object.assign({}, updatedOptions), request));
+        });
+    }
+    /**
+     * Iterates the available countries.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const country of client.listAvailableCountries()) {
+     *   console.log("country: ", country.localizedName);
+     * }
+     * ```
+     * List all available countries.
+     * @param options - The optional parameters.
+     */
+    listAvailableCountries(options = {}) {
+        const { span, updatedOptions } = tracing_js_1.tracingClient.startSpan("PhoneNumbersClient-listAvailableCountries", options);
+        try {
+            return this.client.phoneNumbers.listAvailableCountries(Object.assign(Object.assign({}, updatedOptions), { acceptLanguage: this.acceptLanguage }));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Iterates the available Toll-Free area codes.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const areaCodeItem of client.listTollFreeAreaCodes()) {
+     *   console.log("area code: ", areaCodeItem.areaCode);
+     * }
+     * ```
+     * List all available Toll-Free area codes.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableTollFreeAreaCodes(countryCode, options = {}) {
+        const { span, updatedOptions } = tracing_js_1.tracingClient.startSpan("PhoneNumbersClient-listAvailableTollFreeAreaCodes", options);
+        try {
+            return this.client.phoneNumbers.listAreaCodes(countryCode, "tollFree", Object.assign(Object.assign({}, updatedOptions), { assignmentType: "application" }));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Iterates the available Geographic area codes.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const areaCodeItem of client.listGeographicAreaCodes()) {
+     *   console.log("area code: ", areaCodeItem.areaCode);
+     * }
+     * ```
+     * List all available Geographic area codes.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableGeographicAreaCodes(countryCode, options = {}) {
+        const { span, updatedOptions } = tracing_js_1.tracingClient.startSpan("PhoneNumbersClient-listAvailableGeographicFreeAreaCodes", options);
+        try {
+            return this.client.phoneNumbers.listAreaCodes(countryCode, "geographic", Object.assign({}, updatedOptions));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Iterates the available localities.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const locality of client.listAvailableLocalities()) {
+     *   console.log("locality: ", locality.localizedName);
+     * }
+     * ```
+     * List all available localities.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableLocalities(countryCode, options = {}) {
+        const { span, updatedOptions } = tracing_js_1.tracingClient.startSpan("PhoneNumbersClient-listAvailableLocalities", options);
+        try {
+            return this.client.phoneNumbers.listAvailableLocalities(countryCode, Object.assign(Object.assign({}, updatedOptions), { acceptLanguage: this.acceptLanguage }));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Iterates the available offerings.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new PhoneNumbersClient(credentials);
+     * for await (const offering of client.listAvailableOfferings()) {
+     *   console.log("phone number type: ", offering.phoneNumberType);
+     *   console.log("cost: ", offering.cost.amount);
+     * }
+     * ```
+     * List all available offerings.
+     * @param countryCode - The ISO 3166-2 country code.
+     * @param options - The optional parameters.
+     */
+    listAvailableOfferings(countryCode, options = {}) {
+        const { span, updatedOptions } = tracing_js_1.tracingClient.startSpan("PhoneNumbersClient-listOfferings", options);
+        try {
+            return this.client.phoneNumbers.listOfferings(countryCode, Object.assign({}, updatedOptions));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Search for operator information about specified phone numbers.
+     *
+     * @param phoneNumbers - The phone numbers to search.
+     * @param options - Additional request options.
+     */
+    searchOperatorInformation(phoneNumbers, options = { includeAdditionalOperatorDetails: false }) {
+        const { span, updatedOptions } = tracing_js_1.tracingClient.startSpan("PhoneNumbersClient-searchOperatorInformation", options);
+        try {
+            return this.client.phoneNumbers.operatorInformationSearch(phoneNumbers, Object.assign(Object.assign({}, updatedOptions), { options: { includeAdditionalOperatorDetails: options.includeAdditionalOperatorDetails } }));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+}
+exports.PhoneNumbersClient = PhoneNumbersClient;
+//# sourceMappingURL=phoneNumbersClient.js.map

package/dist/commonjs/phoneNumbersClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"phoneNumbersClient.js","sourceRoot":"","sources":["../../src/phoneNumbersClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,4CAA4C;;;;AAE5C,uDAAuD;AACvD,sEAIqC;AAErC,gDAAqD;AAIrD,uDAA6F;AA8B7F,iFAAmF;AAEnF,+CAA0C;AAC1C,2DAA2D;AAY3D,MAAM,2BAA2B,GAAG,CAAC,OAAY,EAAwC,EAAE,CACzF,OAAO,IAAI,CAAC,IAAA,sCAAe,EAAC,OAAO,CAAC,IAAI,CAAC,IAAA,6BAAiB,EAAC,OAAO,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAa,kBAAkB;IAoC7B,YACE,qBAA6B,EAC7B,mBAAiF,EACjF,eAA0C,EAAE;QAE5C,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,IAAA,2CAAoB,EAAC,qBAAqB,EAAE,mBAAmB,CAAC,CAAC;QAC7F,MAAM,OAAO,GAAG,2BAA2B,CAAC,mBAAmB,CAAC;YAC9D,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,YAAY,CAAC;QAEjB,MAAM,uBAAuB,mCACxB,OAAO,GACP;YACD,cAAc,EAAE;gBACd,MAAM,EAAE,iBAAM,CAAC,IAAI;aACpB;SACF,CACF,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAI,6BAA2B,CAAC,GAAG,kBAC/C,QAAQ,EAAE,GAAG,IACV,uBAAuB,EAC1B,CAAC;QACH,MAAM,UAAU,GAAG,IAAA,oDAA6B,EAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAE3C,2FAA2F;QAC3F,MAAM,wBAAwB,GAAG,IAAA,0DAA8B,EAAC,GAAG,CAAC,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;QACzD,IAAI,CAAC,cAAc,GAAG,YAAY,CAAC,cAAc,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAC5B,WAAmB,EACnB,UAA0C,EAAE;QAE5C,OAAO,0BAAa,CAAC,QAAQ,CAC3B,4CAA4C,EAC5C,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,oBAClD,cAAc,EACjB,CAAC;QACL,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,yBAAyB,CAC9B,UAA4C,EAAE;QAE9C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,0BAAa,CAAC,SAAS,CACtD,8CAA8C,EAC9C,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,gBAAgB,mBAC3C,cAAc,EACjB,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,uBAAuB,CAC5B,WAAmB,EACnB,UAA0C,EAAE;QAE5C,OAAO,0BAAa,CAAC,QAAQ,CAC3B,4CAA4C,EAC5C,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,uBAAuB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACvF,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,gCAAgC,CACrC,MAA0C,EAC1C,UAAmD,EAAE;QAErD,OAAO,0BAAa,CAAC,QAAQ,CAC3B,qDAAqD,EACrD,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,KAAc,MAAM,EAAf,IAAI,kBAAK,MAAM,EAAhF,oEAAuE,CAAS,CAAC;YACvF,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,gCAAgC,CAC9D,WAAW,EACX,eAAe,EACf,cAAc,EACd,YAAY,kCAEP,cAAc,GACd,IAAI,EAEV,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,yBAAyB,CAC9B,QAAgB,EAChB,UAA4C,EAAE;QAI9C,OAAO,0BAAa,CAAC,QAAQ,CAC3B,8CAA8C,EAC9C,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,yBAAyB,iCAAM,cAAc,KAAE,QAAQ,IAAG,CAAC;QAC7F,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,kCAAkC,CACvC,WAAmB,EACnB,OAAuC,EACvC,UAAqD,EAAE;QAEvD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,0BAAa,CAAC,QAAQ,CAC3B,uDAAuD,EACvD,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,uBAAuB,CAAC,WAAW,kCAC9D,cAAc,GACd,OAAO,EACV,CAAC;QACL,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,sBAAsB,CAC3B,UAAyC,EAAE;QAE3C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,0BAAa,CAAC,SAAS,CACtD,2CAA2C,EAC3C,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,sBAAsB,iCACjD,cAAc,KACjB,cAAc,EAAE,IAAI,CAAC,cAAc,IACnC,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,8BAA8B,CACnC,WAAmB,EACnB,UAAwC,EAAE;QAE1C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,0BAAa,CAAC,SAAS,CACtD,mDAAmD,EACnD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,WAAW,EAAE,UAAU,kCAChE,cAAc,KACjB,cAAc,EAAE,aAAa,IAC7B,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,gCAAgC,CACrC,WAAmB,EACnB,UAA0C,EAAE;QAE5C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,0BAAa,CAAC,SAAS,CACtD,yDAAyD,EACzD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,WAAW,EAAE,YAAY,oBAClE,cAAc,EACjB,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAC5B,WAAmB,EACnB,UAAiC,EAAE;QAEnC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,0BAAa,CAAC,SAAS,CACtD,4CAA4C,EAC5C,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,uBAAuB,CAAC,WAAW,kCAC9D,cAAc,KACjB,cAAc,EAAE,IAAI,CAAC,cAAc,IACnC,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,sBAAsB,CAC3B,WAAmB,EACnB,UAAgC,EAAE;QAElC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,0BAAa,CAAC,SAAS,CACtD,kCAAkC,EAClC,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,WAAW,oBACpD,cAAc,EACjB,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,yBAAyB,CAC9B,YAAsB,EACtB,UAA4C,EAAE,gCAAgC,EAAE,KAAK,EAAE;QAEvF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,0BAAa,CAAC,SAAS,CACtD,8CAA8C,EAC9C,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,yBAAyB,CAAC,YAAY,kCACjE,cAAc,KACjB,OAAO,EAAE,EAAE,gCAAgC,EAAE,OAAO,CAAC,gCAAgC,EAAE,IACvF,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;YAEH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;CACF;AA9fD,gDA8fC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n/// <reference lib=\"esnext.asynciterable\" />\n\n/* eslint-disable @azure/azure-sdk/ts-naming-options */\nimport {\n  createCommunicationAuthPolicy,\n  isKeyCredential,\n  parseClientArguments,\n} from \"@azure/communication-common\";\nimport type { KeyCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport type { InternalPipelineOptions } from \"@azure/core-rest-pipeline\";\nimport type { PollOperationState, PollerLike } from \"@azure/core-lro\";\nimport type { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport { PhoneNumbersClient as PhoneNumbersGeneratedClient } from \"./generated/src/index.js\";\nimport type {\n  OperatorInformationResult,\n  PhoneNumberAreaCode,\n  PhoneNumberCapabilitiesRequest,\n  PhoneNumberCountry,\n  PhoneNumberLocality,\n  PhoneNumberOffering,\n  PhoneNumberSearchResult,\n  PurchasedPhoneNumber,\n} from \"./generated/src/models/index.js\";\nimport type {\n  GetPurchasedPhoneNumberOptions,\n  ListAvailableCountriesOptions,\n  ListGeographicAreaCodesOptions,\n  ListLocalitiesOptions,\n  ListOfferingsOptions,\n  ListPurchasedPhoneNumbersOptions,\n  ListTollFreeAreaCodesOptions,\n  PurchasePhoneNumbersResult,\n  ReleasePhoneNumberResult,\n  SearchAvailablePhoneNumbersRequest,\n  SearchOperatorInformationOptions,\n} from \"./models.js\";\nimport type {\n  BeginPurchasePhoneNumbersOptions,\n  BeginReleasePhoneNumberOptions,\n  BeginSearchAvailablePhoneNumbersOptions,\n  BeginUpdatePhoneNumberCapabilitiesOptions,\n} from \"./lroModels.js\";\nimport { createPhoneNumbersPagingPolicy } from \"./utils/customPipelinePolicies.js\";\nimport type { CommonClientOptions } from \"@azure/core-client\";\nimport { logger } from \"./utils/index.js\";\nimport { tracingClient } from \"./generated/src/tracing.js\";\n\n/**\n * Client options used to configure the PhoneNumbersClient API requests.\n */\nexport interface PhoneNumbersClientOptions extends CommonClientOptions {\n  /**\n   * The accept language parameter to be used in the request header's \"accept-language\" property.\n   */\n  acceptLanguage?: string;\n}\n\nconst isPhoneNumbersClientOptions = (options: any): options is PhoneNumbersClientOptions =>\n  options && !isKeyCredential(options) && !isTokenCredential(options);\n\n/**\n * Client class for interacting with Azure Communication Services Phone Number Administration.\n */\nexport class PhoneNumbersClient {\n  /**\n   * A reference to the auto-generated PhoneNumber HTTP client.\n   */\n  private readonly client: PhoneNumbersGeneratedClient;\n\n  /**\n   * The accept language parameter to be used in the request header's \"accept-language\" property.\n   */\n  private acceptLanguage: string | undefined;\n\n  /**\n   * Initializes a new instance of the PhoneNumberAdministrationClient class using a connection string.\n   *\n   * @param connectionString - Connection string to connect to an Azure Communication Service resource. (eg: endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret)\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  public constructor(connectionString: string, options?: PhoneNumbersClientOptions);\n\n  /**\n   * Initializes a new instance of the PhoneNumberAdministrationClient class using an Azure KeyCredential.\n   *\n   * @param url - The endpoint of the service (eg: https://contoso.eastus.communications.azure.net)\n   * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  public constructor(url: string, credential: KeyCredential, options?: PhoneNumbersClientOptions);\n\n  /**\n   * Initializes a new instance of the PhoneNumberAdministrationClient class using a TokenCredential.\n   * @param url - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).\n   * @param credential - TokenCredential that is used to authenticate requests to the service.\n   * @param options - Optional. Options to configure the HTTP pipeline.\n   */\n  public constructor(url: string, credential: TokenCredential, options?: PhoneNumbersClientOptions);\n\n  public constructor(\n    connectionStringOrUrl: string,\n    credentialOrOptions?: KeyCredential | TokenCredential | PhoneNumbersClientOptions,\n    maybeOptions: PhoneNumbersClientOptions = {},\n  ) {\n    const { url, credential } = parseClientArguments(connectionStringOrUrl, credentialOrOptions);\n    const options = isPhoneNumbersClientOptions(credentialOrOptions)\n      ? credentialOrOptions\n      : maybeOptions;\n\n    const internalPipelineOptions: InternalPipelineOptions = {\n      ...options,\n      ...{\n        loggingOptions: {\n          logger: logger.info,\n        },\n      },\n    };\n\n    this.client = new PhoneNumbersGeneratedClient(url, {\n      endpoint: url,\n      ...internalPipelineOptions,\n    });\n    const authPolicy = createCommunicationAuthPolicy(credential);\n    this.client.pipeline.addPolicy(authPolicy);\n\n    // This policy is temporary workarounds to address compatibility issues with Azure Core V2.\n    const phoneNumbersPagingPolicy = createPhoneNumbersPagingPolicy(url);\n    this.client.pipeline.addPolicy(phoneNumbersPagingPolicy);\n    this.acceptLanguage = maybeOptions.acceptLanguage;\n  }\n\n  /**\n   * Gets the details of a purchased phone number. Includes phone number, cost, country code, etc.\n   *\n   * @param phoneNumber - The E.164 formatted phone number being fetched. The leading plus can be either + or encoded as %2B.\n   * @param options - Additional request options.\n   */\n  public getPurchasedPhoneNumber(\n    phoneNumber: string,\n    options: GetPurchasedPhoneNumberOptions = {},\n  ): Promise<PurchasedPhoneNumber> {\n    return tracingClient.withSpan(\n      \"PhoneNumbersClient-getPurchasedPhoneNumber\",\n      options,\n      (updatedOptions) => {\n        return this.client.phoneNumbers.getByNumber(phoneNumber, {\n          ...updatedOptions,\n        });\n      },\n    );\n  }\n\n  /**\n   * Iterates the purchased phone numbers.\n   *\n   * Example usage:\n   * ```ts\n   * let client = new PhoneNumbersClient(credentials);\n   * for await (const purchased of client.listPhoneNumbers()) {\n   *   console.log(\"phone number: \", purchased.phoneNumber);\n   * }\n   * ```\n   * List all purchased phone numbers.\n   * @param options - The optional parameters.\n   */\n  public listPurchasedPhoneNumbers(\n    options: ListPurchasedPhoneNumbersOptions = {},\n  ): PagedAsyncIterableIterator<PurchasedPhoneNumber> {\n    const { span, updatedOptions } = tracingClient.startSpan(\n      \"PhoneNumbersClient-listPurchasedPhoneNumbers\",\n      options,\n    );\n\n    try {\n      return this.client.phoneNumbers.listPhoneNumbers({\n        ...updatedOptions,\n      });\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e,\n      });\n\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Starts the release of a purchased phone number.\n   *\n   * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.\n   *\n   * Example usage:\n   * ```ts\n   * const client = new PhoneNumbersClient(CONNECTION_STRING);\n   * const releasePoller = await client.beginReleasePhoneNumber(\"+14125550100\");\n   *\n   * // Serializing the poller\n   * const serialized = releasePoller.toString();\n   *\n   * // Waiting until it's done\n   * const results = await releasePoller.pollUntilDone();\n   * console.log(results);\n   * ```\n   * @param phoneNumber - The E.164 formatted phone number being released. The leading plus can be either + or encoded as %2B.\n   * @param options - Additional request options.\n   */\n  public beginReleasePhoneNumber(\n    phoneNumber: string,\n    options: BeginReleasePhoneNumberOptions = {},\n  ): Promise<PollerLike<PollOperationState<ReleasePhoneNumberResult>, ReleasePhoneNumberResult>> {\n    return tracingClient.withSpan(\n      \"PhoneNumbersClient-beginReleasePhoneNumber\",\n      options,\n      (updatedOptions) => {\n        return this.client.phoneNumbers.beginReleasePhoneNumber(phoneNumber, updatedOptions);\n      },\n    );\n  }\n\n  /**\n   * Starts a search for phone numbers given some constraints such as name or area code.\n   * The phone numbers that are found are reserved until you cancel, purchase or the reservation expires.\n   *\n   * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.\n   *\n   * Example usage:\n   * ```ts\n   * const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);\n   * const searchPoller = await client.beginSearchAvailablePhoneNumbers(SEARCH_REQUEST);\n   *\n   * // Serializing the poller\n   * const serialized = searchPoller.toString();\n   *\n   * // Waiting until it's done\n   * const results = await searchPoller.pollUntilDone();\n   * console.log(results);\n   * ```\n   *\n   * @param search - Request properties to constraint the search scope.\n   * @param options - Additional request options.\n   */\n  public beginSearchAvailablePhoneNumbers(\n    search: SearchAvailablePhoneNumbersRequest,\n    options: BeginSearchAvailablePhoneNumbersOptions = {},\n  ): Promise<PollerLike<PollOperationState<PhoneNumberSearchResult>, PhoneNumberSearchResult>> {\n    return tracingClient.withSpan(\n      \"PhoneNumbersClient-beginSearchAvailablePhoneNumbers\",\n      options,\n      (updatedOptions) => {\n        const { countryCode, phoneNumberType, assignmentType, capabilities, ...rest } = search;\n        return this.client.phoneNumbers.beginSearchAvailablePhoneNumbers(\n          countryCode,\n          phoneNumberType,\n          assignmentType,\n          capabilities,\n          {\n            ...updatedOptions,\n            ...rest,\n          },\n        );\n      },\n    );\n  }\n\n  /**\n   * Starts the purchase of the phone number(s) in the search associated with a given id.\n   *\n   * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.\n   *\n   * Example usage:\n   * ```ts\n   * const client = new PhoneNumbersClient(CONNECTION_STRING);\n   * const purchasePoller = await client.beginPurchasePhoneNumbers(SEARCH_ID);\n   *\n   * // Serializing the poller\n   * const serialized = purchasePoller.toString();\n   *\n   * // Waiting until it's done\n   * const results = await purchasePoller.pollUntilDone();\n   * console.log(results);\n   * ```\n   *\n   * @param searchId - The id of the search to purchase. Returned from `beginSearchAvailablePhoneNumbers`\n   * @param options - Additional request options.\n   */\n  public beginPurchasePhoneNumbers(\n    searchId: string,\n    options: BeginPurchasePhoneNumbersOptions = {},\n  ): Promise<\n    PollerLike<PollOperationState<PurchasePhoneNumbersResult>, PurchasePhoneNumbersResult>\n  > {\n    return tracingClient.withSpan(\n      \"PhoneNumbersClient-beginPurchasePhoneNumbers\",\n      options,\n      (updatedOptions) => {\n        return this.client.phoneNumbers.beginPurchasePhoneNumbers({ ...updatedOptions, searchId });\n      },\n    );\n  }\n\n  /**\n   * Starts the update of a purchased phone number's capabilities.\n   *\n   * This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.\n   *\n   * Example usage:\n   * ```ts\n   * const client = new PhoneNumbersClient(CONNECTION_STRING);\n   * const updatePoller = await client.beginUpdatePhoneNumberCapabilities(\"+14125550100\", UPDATE_REQUEST);\n   *\n   * // Serializing the poller\n   * const serialized = updatePoller.toString();\n   *\n   * // Waiting until it's done\n   * const results = await updatePoller.pollUntilDone();\n   * console.log(results);\n   * ```\n   *\n   * @param phoneNumber - The E.164 formatted phone number being updated. The leading plus can be either + or encoded as %2B.\n   * @param request - The updated properties which will be applied to the phone number.\n   * @param options - Additional request options.\n   */\n  public beginUpdatePhoneNumberCapabilities(\n    phoneNumber: string,\n    request: PhoneNumberCapabilitiesRequest,\n    options: BeginUpdatePhoneNumberCapabilitiesOptions = {},\n  ): Promise<PollerLike<PollOperationState<PurchasedPhoneNumber>, PurchasedPhoneNumber>> {\n    if (!phoneNumber) {\n      throw Error(\"phone number can't be empty\");\n    }\n    return tracingClient.withSpan(\n      \"PhoneNumbersClient-beginUpdatePhoneNumberCapabilities\",\n      options,\n      (updatedOptions) => {\n        return this.client.phoneNumbers.beginUpdateCapabilities(phoneNumber, {\n          ...updatedOptions,\n          ...request,\n        });\n      },\n    );\n  }\n\n  /**\n   * Iterates the available countries.\n   *\n   * Example usage:\n   * ```ts\n   * let client = new PhoneNumbersClient(credentials);\n   * for await (const country of client.listAvailableCountries()) {\n   *   console.log(\"country: \", country.localizedName);\n   * }\n   * ```\n   * List all available countries.\n   * @param options - The optional parameters.\n   */\n  public listAvailableCountries(\n    options: ListAvailableCountriesOptions = {},\n  ): PagedAsyncIterableIterator<PhoneNumberCountry> {\n    const { span, updatedOptions } = tracingClient.startSpan(\n      \"PhoneNumbersClient-listAvailableCountries\",\n      options,\n    );\n\n    try {\n      return this.client.phoneNumbers.listAvailableCountries({\n        ...updatedOptions,\n        acceptLanguage: this.acceptLanguage,\n      });\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e,\n      });\n\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Iterates the available Toll-Free area codes.\n   *\n   * Example usage:\n   * ```ts\n   * let client = new PhoneNumbersClient(credentials);\n   * for await (const areaCodeItem of client.listTollFreeAreaCodes()) {\n   *   console.log(\"area code: \", areaCodeItem.areaCode);\n   * }\n   * ```\n   * List all available Toll-Free area codes.\n   * @param countryCode - The ISO 3166-2 country code.\n   * @param options - The optional parameters.\n   */\n  public listAvailableTollFreeAreaCodes(\n    countryCode: string,\n    options: ListTollFreeAreaCodesOptions = {},\n  ): PagedAsyncIterableIterator<PhoneNumberAreaCode> {\n    const { span, updatedOptions } = tracingClient.startSpan(\n      \"PhoneNumbersClient-listAvailableTollFreeAreaCodes\",\n      options,\n    );\n\n    try {\n      return this.client.phoneNumbers.listAreaCodes(countryCode, \"tollFree\", {\n        ...updatedOptions,\n        assignmentType: \"application\",\n      });\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e,\n      });\n\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Iterates the available Geographic area codes.\n   *\n   * Example usage:\n   * ```ts\n   * let client = new PhoneNumbersClient(credentials);\n   * for await (const areaCodeItem of client.listGeographicAreaCodes()) {\n   *   console.log(\"area code: \", areaCodeItem.areaCode);\n   * }\n   * ```\n   * List all available Geographic area codes.\n   * @param countryCode - The ISO 3166-2 country code.\n   * @param options - The optional parameters.\n   */\n  public listAvailableGeographicAreaCodes(\n    countryCode: string,\n    options: ListGeographicAreaCodesOptions = {},\n  ): PagedAsyncIterableIterator<PhoneNumberAreaCode> {\n    const { span, updatedOptions } = tracingClient.startSpan(\n      \"PhoneNumbersClient-listAvailableGeographicFreeAreaCodes\",\n      options,\n    );\n\n    try {\n      return this.client.phoneNumbers.listAreaCodes(countryCode, \"geographic\", {\n        ...updatedOptions,\n      });\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e,\n      });\n\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Iterates the available localities.\n   *\n   * Example usage:\n   * ```ts\n   * let client = new PhoneNumbersClient(credentials);\n   * for await (const locality of client.listAvailableLocalities()) {\n   *   console.log(\"locality: \", locality.localizedName);\n   * }\n   * ```\n   * List all available localities.\n   * @param countryCode - The ISO 3166-2 country code.\n   * @param options - The optional parameters.\n   */\n  public listAvailableLocalities(\n    countryCode: string,\n    options: ListLocalitiesOptions = {},\n  ): PagedAsyncIterableIterator<PhoneNumberLocality> {\n    const { span, updatedOptions } = tracingClient.startSpan(\n      \"PhoneNumbersClient-listAvailableLocalities\",\n      options,\n    );\n\n    try {\n      return this.client.phoneNumbers.listAvailableLocalities(countryCode, {\n        ...updatedOptions,\n        acceptLanguage: this.acceptLanguage,\n      });\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e,\n      });\n\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Iterates the available offerings.\n   *\n   * Example usage:\n   * ```ts\n   * let client = new PhoneNumbersClient(credentials);\n   * for await (const offering of client.listAvailableOfferings()) {\n   *   console.log(\"phone number type: \", offering.phoneNumberType);\n   *   console.log(\"cost: \", offering.cost.amount);\n   * }\n   * ```\n   * List all available offerings.\n   * @param countryCode - The ISO 3166-2 country code.\n   * @param options - The optional parameters.\n   */\n  public listAvailableOfferings(\n    countryCode: string,\n    options: ListOfferingsOptions = {},\n  ): PagedAsyncIterableIterator<PhoneNumberOffering> {\n    const { span, updatedOptions } = tracingClient.startSpan(\n      \"PhoneNumbersClient-listOfferings\",\n      options,\n    );\n\n    try {\n      return this.client.phoneNumbers.listOfferings(countryCode, {\n        ...updatedOptions,\n      });\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e,\n      });\n\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n\n  /**\n   * Search for operator information about specified phone numbers.\n   *\n   * @param phoneNumbers - The phone numbers to search.\n   * @param options - Additional request options.\n   */\n  public searchOperatorInformation(\n    phoneNumbers: string[],\n    options: SearchOperatorInformationOptions = { includeAdditionalOperatorDetails: false },\n  ): Promise<OperatorInformationResult> {\n    const { span, updatedOptions } = tracingClient.startSpan(\n      \"PhoneNumbersClient-searchOperatorInformation\",\n      options,\n    );\n\n    try {\n      return this.client.phoneNumbers.operatorInformationSearch(phoneNumbers, {\n        ...updatedOptions,\n        options: { includeAdditionalOperatorDetails: options.includeAdditionalOperatorDetails },\n      });\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e,\n      });\n\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n}\n"]}