@azure/communication-phone-numbers 1.3.0-alpha.20250122.7 → 1.3.0-alpha.20250127.1

package/dist/browser/phoneNumbersClient.d.ts

@@ -59,10 +59,18 @@ export declare class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientListPurchasedPhoneNumbers
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * const phoneNumbers = client.listPurchasedPhoneNumbers();
+     *
+     * for await (const phoneNumber of phoneNumbers) {
+     *   console.log(`The id is the same as the phone number: ${phoneNumber.id}`);
+     *   console.log(`Phone number type is ${phoneNumber.phoneNumberType}`);
      * }
      * ```
      * List all purchased phone numbers.
@@ -75,16 +83,20 @@ export declare class PhoneNumbersClient {
      * 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");
+     * ```ts snippet:PhoneNumbersClientReleasePhoneNumber
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
      *
-     * // Serializing the poller
-     * const serialized = releasePoller.toString();
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
      *
-     * // Waiting until it's done
-     * const results = await releasePoller.pollUntilDone();
-     * console.log(results);
+     * const phoneNumberToRelease = "<phone-number-to-release>";
+     *
+     * const releasePoller = await client.beginReleasePhoneNumber(phoneNumberToRelease);
+     *
+     * // Release is underway.
+     * await releasePoller.pollUntilDone();
+     * console.log("Successfully release phone number.");
      * ```
      * @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.
@@ -97,16 +109,33 @@ export declare class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientSearchAvailablePhoneNumbers
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import {
+     *   PhoneNumbersClient,
+     *   SearchAvailablePhoneNumbersRequest,
+     * } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
      *
-     * // Serializing the poller
-     * const serialized = searchPoller.toString();
+     * const searchRequest: SearchAvailablePhoneNumbersRequest = {
+     *   countryCode: "US",
+     *   phoneNumberType: "tollFree",
+     *   assignmentType: "application",
+     *   capabilities: {
+     *     sms: "outbound",
+     *     calling: "none",
+     *   },
+     *   quantity: 1,
+     * };
      *
-     * // Waiting until it's done
-     * const results = await searchPoller.pollUntilDone();
-     * console.log(results);
+     * const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);
+     *
+     * // The search is underway. Wait to receive searchId.
+     * const searchResults = await searchPoller.pollUntilDone();
+     * console.log(`Found phone number: ${searchResults.phoneNumbers[0]}`);
+     * console.log(`searchId: ${searchResults.searchId}`);
      * ```
      *
      * @param search - Request properties to constraint the search scope.
@@ -119,16 +148,37 @@ export declare class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientPurchasePhoneNumbers
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import {
+     *   PhoneNumbersClient,
+     *   SearchAvailablePhoneNumbersRequest,
+     * } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * const searchRequest: SearchAvailablePhoneNumbersRequest = {
+     *   countryCode: "US",
+     *   phoneNumberType: "tollFree",
+     *   assignmentType: "application",
+     *   capabilities: {
+     *     sms: "outbound",
+     *     calling: "none",
+     *   },
+     *   quantity: 1,
+     * };
      *
-     * // Serializing the poller
-     * const serialized = purchasePoller.toString();
+     * const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);
      *
-     * // Waiting until it's done
-     * const results = await purchasePoller.pollUntilDone();
-     * console.log(results);
+     * // The search is underway. Wait to receive searchId.
+     * const { searchId, phoneNumbers } = await searchPoller.pollUntilDone();
+     *
+     * const purchasePoller = await client.beginPurchasePhoneNumbers(searchId);
+     *
+     * // Purchase is underway.
+     * await purchasePoller.pollUntilDone();
+     * console.log(`Successfully purchased ${phoneNumbers[0]}`);
      * ```
      *
      * @param searchId - The id of the search to purchase. Returned from `beginSearchAvailablePhoneNumbers`
@@ -141,16 +191,32 @@ export declare class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientUpdatePhoneNumberCapabilities
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import {
+     *   PhoneNumbersClient,
+     *   PhoneNumberCapabilitiesRequest,
+     * } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
      *
-     * // Serializing the poller
-     * const serialized = updatePoller.toString();
+     * const phoneNumberToUpdate = "<phone-number-to-update>";
      *
-     * // Waiting until it's done
-     * const results = await updatePoller.pollUntilDone();
-     * console.log(results);
+     * // This will update phone number to send and receive sms, but only send calls.
+     * const updateRequest: PhoneNumberCapabilitiesRequest = {
+     *   sms: "inbound+outbound",
+     *   calling: "outbound",
+     * };
+     *
+     * const updatePoller = await client.beginUpdatePhoneNumberCapabilities(
+     *   phoneNumberToUpdate,
+     *   updateRequest,
+     * );
+     *
+     * // Update is underway.
+     * const { capabilities } = await updatePoller.pollUntilDone();
+     * console.log(`These are the update capabilities: ${capabilities}`);
      * ```
      *
      * @param phoneNumber - The E.164 formatted phone number being updated. The leading plus can be either + or encoded as %2B.
@@ -162,8 +228,13 @@ export declare class PhoneNumbersClient {
      * Iterates the available countries.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
+     * ```ts snippet:PhoneNumbersClientListAvailableCountries
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
      * for await (const country of client.listAvailableCountries()) {
      *   console.log("country: ", country.localizedName);
      * }
@@ -176,9 +247,14 @@ export declare class PhoneNumbersClient {
      * Iterates the available Toll-Free area codes.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const areaCodeItem of client.listTollFreeAreaCodes()) {
+     * ```ts snippet:PhoneNumbersClientListTollFreeAreaCodes
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const areaCodeItem of client.listAvailableTollFreeAreaCodes("US")) {
      *   console.log("area code: ", areaCodeItem.areaCode);
      * }
      * ```
@@ -191,9 +267,14 @@ export declare class PhoneNumbersClient {
      * Iterates the available Geographic area codes.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const areaCodeItem of client.listGeographicAreaCodes()) {
+     * ```ts snippet:PhoneNumbersClientListGeographicAreaCodes
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const areaCodeItem of client.listAvailableGeographicAreaCodes("US")) {
      *   console.log("area code: ", areaCodeItem.areaCode);
      * }
      * ```
@@ -206,9 +287,14 @@ export declare class PhoneNumbersClient {
      * Iterates the available localities.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const locality of client.listAvailableLocalities()) {
+     * ```ts snippet:PhoneNumbersClientListAvailableLocalities
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const locality of client.listAvailableLocalities("US")) {
      *   console.log("locality: ", locality.localizedName);
      * }
      * ```
@@ -221,9 +307,14 @@ export declare class PhoneNumbersClient {
      * Iterates the available offerings.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const offering of client.listAvailableOfferings()) {
+     * ```ts snippet:PhoneNumbersClientListAvailableOfferings
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const offering of client.listAvailableOfferings("US")) {
      *   console.log("phone number type: ", offering.phoneNumberType);
      *   console.log("cost: ", offering.cost.amount);
      * }

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,yBAAyB,CAC9B,OAAO,GAAE,gCAAqC,GAC7C,0BAA0B,CAAC,oBAAoB,CAAC;IAsBnD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,uBAAuB,CAC5B,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,8BAAmC,GAC3C,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EAAE,wBAAwB,CAAC,CAAC;IAU9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,gCAAgC,CACrC,MAAM,EAAE,kCAAkC,EAC1C,OAAO,GAAE,uCAA4C,GACpD,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,EAAE,uBAAuB,CAAC,CAAC;IAoB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACI,yBAAyB,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CACR,UAAU,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,EAAE,0BAA0B,CAAC,CACvF;IAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;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;;;;;;;;;;;;;;;;;OAiBG;IACI,sBAAsB,CAC3B,OAAO,GAAE,6BAAkC,GAC1C,0BAA0B,CAAC,kBAAkB,CAAC;IAuBjD;;;;;;;;;;;;;;;;;;OAkBG;IACI,8BAA8B,CACnC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,4BAAiC,GACzC,0BAA0B,CAAC,mBAAmB,CAAC;IAuBlD;;;;;;;;;;;;;;;;;;OAkBG;IACI,gCAAgC,CACrC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,8BAAmC,GAC3C,0BAA0B,CAAC,mBAAmB,CAAC;IAsBlD;;;;;;;;;;;;;;;;;;OAkBG;IACI,uBAAuB,CAC5B,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,qBAA0B,GAClC,0BAA0B,CAAC,mBAAmB,CAAC;IAuBlD;;;;;;;;;;;;;;;;;;;OAmBG;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/browser/phoneNumbersClient.js

@@ -47,10 +47,18 @@ export class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientListPurchasedPhoneNumbers
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * const phoneNumbers = client.listPurchasedPhoneNumbers();
+     *
+     * for await (const phoneNumber of phoneNumbers) {
+     *   console.log(`The id is the same as the phone number: ${phoneNumber.id}`);
+     *   console.log(`Phone number type is ${phoneNumber.phoneNumberType}`);
      * }
      * ```
      * List all purchased phone numbers.
@@ -78,16 +86,20 @@ export class PhoneNumbersClient {
      * 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");
+     * ```ts snippet:PhoneNumbersClientReleasePhoneNumber
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
      *
-     * // Serializing the poller
-     * const serialized = releasePoller.toString();
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
      *
-     * // Waiting until it's done
-     * const results = await releasePoller.pollUntilDone();
-     * console.log(results);
+     * const phoneNumberToRelease = "<phone-number-to-release>";
+     *
+     * const releasePoller = await client.beginReleasePhoneNumber(phoneNumberToRelease);
+     *
+     * // Release is underway.
+     * await releasePoller.pollUntilDone();
+     * console.log("Successfully release phone number.");
      * ```
      * @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.
@@ -104,16 +116,33 @@ export class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientSearchAvailablePhoneNumbers
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import {
+     *   PhoneNumbersClient,
+     *   SearchAvailablePhoneNumbersRequest,
+     * } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
      *
-     * // Serializing the poller
-     * const serialized = searchPoller.toString();
+     * const searchRequest: SearchAvailablePhoneNumbersRequest = {
+     *   countryCode: "US",
+     *   phoneNumberType: "tollFree",
+     *   assignmentType: "application",
+     *   capabilities: {
+     *     sms: "outbound",
+     *     calling: "none",
+     *   },
+     *   quantity: 1,
+     * };
      *
-     * // Waiting until it's done
-     * const results = await searchPoller.pollUntilDone();
-     * console.log(results);
+     * const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);
+     *
+     * // The search is underway. Wait to receive searchId.
+     * const searchResults = await searchPoller.pollUntilDone();
+     * console.log(`Found phone number: ${searchResults.phoneNumbers[0]}`);
+     * console.log(`searchId: ${searchResults.searchId}`);
      * ```
      *
      * @param search - Request properties to constraint the search scope.
@@ -131,16 +160,37 @@ export class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientPurchasePhoneNumbers
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import {
+     *   PhoneNumbersClient,
+     *   SearchAvailablePhoneNumbersRequest,
+     * } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * const searchRequest: SearchAvailablePhoneNumbersRequest = {
+     *   countryCode: "US",
+     *   phoneNumberType: "tollFree",
+     *   assignmentType: "application",
+     *   capabilities: {
+     *     sms: "outbound",
+     *     calling: "none",
+     *   },
+     *   quantity: 1,
+     * };
      *
-     * // Serializing the poller
-     * const serialized = purchasePoller.toString();
+     * const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);
      *
-     * // Waiting until it's done
-     * const results = await purchasePoller.pollUntilDone();
-     * console.log(results);
+     * // The search is underway. Wait to receive searchId.
+     * const { searchId, phoneNumbers } = await searchPoller.pollUntilDone();
+     *
+     * const purchasePoller = await client.beginPurchasePhoneNumbers(searchId);
+     *
+     * // Purchase is underway.
+     * await purchasePoller.pollUntilDone();
+     * console.log(`Successfully purchased ${phoneNumbers[0]}`);
      * ```
      *
      * @param searchId - The id of the search to purchase. Returned from `beginSearchAvailablePhoneNumbers`
@@ -157,16 +207,32 @@ export class PhoneNumbersClient {
      * 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);
+     * ```ts snippet:PhoneNumbersClientUpdatePhoneNumberCapabilities
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import {
+     *   PhoneNumbersClient,
+     *   PhoneNumberCapabilitiesRequest,
+     * } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
      *
-     * // Serializing the poller
-     * const serialized = updatePoller.toString();
+     * const phoneNumberToUpdate = "<phone-number-to-update>";
      *
-     * // Waiting until it's done
-     * const results = await updatePoller.pollUntilDone();
-     * console.log(results);
+     * // This will update phone number to send and receive sms, but only send calls.
+     * const updateRequest: PhoneNumberCapabilitiesRequest = {
+     *   sms: "inbound+outbound",
+     *   calling: "outbound",
+     * };
+     *
+     * const updatePoller = await client.beginUpdatePhoneNumberCapabilities(
+     *   phoneNumberToUpdate,
+     *   updateRequest,
+     * );
+     *
+     * // Update is underway.
+     * const { capabilities } = await updatePoller.pollUntilDone();
+     * console.log(`These are the update capabilities: ${capabilities}`);
      * ```
      *
      * @param phoneNumber - The E.164 formatted phone number being updated. The leading plus can be either + or encoded as %2B.
@@ -185,8 +251,13 @@ export class PhoneNumbersClient {
      * Iterates the available countries.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
+     * ```ts snippet:PhoneNumbersClientListAvailableCountries
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
      * for await (const country of client.listAvailableCountries()) {
      *   console.log("country: ", country.localizedName);
      * }
@@ -214,9 +285,14 @@ export class PhoneNumbersClient {
      * Iterates the available Toll-Free area codes.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const areaCodeItem of client.listTollFreeAreaCodes()) {
+     * ```ts snippet:PhoneNumbersClientListTollFreeAreaCodes
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const areaCodeItem of client.listAvailableTollFreeAreaCodes("US")) {
      *   console.log("area code: ", areaCodeItem.areaCode);
      * }
      * ```
@@ -244,9 +320,14 @@ export class PhoneNumbersClient {
      * Iterates the available Geographic area codes.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const areaCodeItem of client.listGeographicAreaCodes()) {
+     * ```ts snippet:PhoneNumbersClientListGeographicAreaCodes
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const areaCodeItem of client.listAvailableGeographicAreaCodes("US")) {
      *   console.log("area code: ", areaCodeItem.areaCode);
      * }
      * ```
@@ -274,9 +355,14 @@ export class PhoneNumbersClient {
      * Iterates the available localities.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const locality of client.listAvailableLocalities()) {
+     * ```ts snippet:PhoneNumbersClientListAvailableLocalities
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const locality of client.listAvailableLocalities("US")) {
      *   console.log("locality: ", locality.localizedName);
      * }
      * ```
@@ -304,9 +390,14 @@ export class PhoneNumbersClient {
      * Iterates the available offerings.
      *
      * Example usage:
-     * ```ts
-     * let client = new PhoneNumbersClient(credentials);
-     * for await (const offering of client.listAvailableOfferings()) {
+     * ```ts snippet:PhoneNumbersClientListAvailableOfferings
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { PhoneNumbersClient } from "@azure/communication-phone-numbers";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);
+     *
+     * for await (const offering of client.listAvailableOfferings("US")) {
      *   console.log("phone number type: ", offering.phoneNumberType);
      *   console.log("cost: ", offering.cost.amount);
      * }