[communication] update new phone numbers client

sdk/communication/communication-phone-numbers/karma.conf.js

@@ -60,6 +60,7 @@ module.exports = function(config) {
       "TEST_MODE",
       "COMMUNICATION_CONNECTION_STRING",
       "INCLUDE_PHONENUMBER_TESTS",
+      "AZURE_PHONE_NUMBER",
       "COMMUNICATION_ENDPOINT"
     ],
 

sdk/communication/communication-phone-numbers/package.json

@@ -30,7 +30,7 @@
     "lint": "eslint package.json tsconfig.json api-extractor.json src test --ext .ts -f html -o communication-phone-numbers-lintReport.html || exit 0",
     "pack": "npm pack 2>&1",
     "prebuild": "npm run clean",
-    "test": "npm run build:test && npm run unit-test && npm run integration-test",
+    "test": "rimraf dist-test && npm run build:test && npm run unit-test && npm run integration-test",
     "test:browser": "npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
     "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
     "test:watch": "npm run test -- --watch --reporter min",

sdk/communication/communication-phone-numbers/review/communication-phone-numbers.api.md

@@ -8,29 +8,24 @@ import { HttpResponse } from '@azure/core-http';
 import { KeyCredential } from '@azure/core-auth';
 import { OperationOptions } from '@azure/core-http';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PageSettings } from '@azure/core-paging';
 import { PipelineOptions } from '@azure/core-http';
 import { PollerLike } from '@azure/core-lro';
 import { PollOperationState } from '@azure/core-lro';
 import { TokenCredential } from '@azure/core-auth';
 
 // @public
 export interface AcquiredPhoneNumber {
-    applicationId: string;
+    applicationId?: string;
     assignmentType: PhoneNumberAssignmentType;
-    callbackUri: string;
+    callbackUri?: string;
     capabilities: PhoneNumberCapabilities;
-    cost: PhoneNumberCost;
+    cost?: PhoneNumberCost;
     countryCode: string;
     id: string;
     phoneNumber: string;
     phoneNumberType: PhoneNumberType;
-    purchaseDate: Date;
-}
-
-// @public
-export interface AcquiredPhoneNumberUpdate {
-    applicationId?: string;
-    callbackUri?: string;
+    purchaseDate?: Date;
 }
 
 // @public (undocumented)
@@ -49,17 +44,57 @@ export interface BeginSearchAvailablePhoneNumbersOptions extends PhoneNumberPoll
 export interface BeginUpdatePhoneNumberOptions extends PhoneNumberPollerOptionsBase, OperationOptions {
 }
 
+// @public
+export type BillingFrequency = string;
+
 // @public (undocumented)
 export type GetPhoneNumberOptions = OperationOptions;
 
 // @public (undocumented)
 export type GetPhoneNumberResponse = WithResponse<AcquiredPhoneNumber>;
 
-// @public (undocumented)
-export type ListPhoneNumbersOptions = OperationOptions;
+// @public
+export const enum KnownBillingFrequency {
+    // (undocumented)
+    Monthly = "monthly"
+}
 
 // @public
-export type PhoneNumberAssignmentType = "person" | "application";
+export const enum KnownPhoneNumberAssignmentType {
+    // (undocumented)
+    Application = "application",
+    // (undocumented)
+    User = "user"
+}
+
+// @public
+export const enum KnownPhoneNumberCapabilityValue {
+    // (undocumented)
+    Inbound = "inbound",
+    // (undocumented)
+    InboundOutbound = "inbound+outbound",
+    // (undocumented)
+    None = "none",
+    // (undocumented)
+    Outbound = "outbound"
+}
+
+// @public
+export const enum KnownPhoneNumberType {
+    // (undocumented)
+    Geographic = "geographic",
+    // (undocumented)
+    TollFree = "tollFree"
+}
+
+// @public
+export interface ListPhoneNumbersOptions extends OperationOptions {
+    skip?: number;
+    top?: number;
+}
+
+// @public
+export type PhoneNumberAssignmentType = string;
 
 // @public
 export interface PhoneNumberCapabilities {
@@ -74,12 +109,12 @@ export interface PhoneNumberCapabilitiesRequest {
 }
 
 // @public
-export type PhoneNumberCapabilityValue = "inbound" | "outbound" | "inbound+outbound" | "none";
+export type PhoneNumberCapabilityValue = string;
 
 // @public
 export interface PhoneNumberCost {
     amount: number;
-    billingFrequency: "monthly";
+    billingFrequency: BillingFrequency;
     currencyCode: string;
 }
 
@@ -101,8 +136,7 @@ export class PhoneNumbersClient {
     beginSearchAvailablePhoneNumbers(countryCode: string, search: PhoneNumberSearchRequest, options?: BeginSearchAvailablePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PhoneNumberSearchResult>, PhoneNumberSearchResult>>;
     beginUpdatePhoneNumberCapabilities(phoneNumber: string, request: PhoneNumberCapabilitiesRequest, options?: BeginUpdatePhoneNumberOptions): Promise<PollerLike<PollOperationState<AcquiredPhoneNumber>, AcquiredPhoneNumber>>;
     getPhoneNumber(phoneNumber: string, options?: GetPhoneNumberOptions): Promise<GetPhoneNumberResponse>;
-    listPhoneNumbers(options?: ListPhoneNumbersOptions): PagedAsyncIterableIterator<AcquiredPhoneNumber>;
-    updatePhoneNumber(phoneNumber: string, update: AcquiredPhoneNumberUpdate, options?: UpdatePhoneNumberOptions): Promise<UpdatePhoneNumberResponse>;
+    listPhoneNumbers(options?: ListPhoneNumbersOptions): PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>;
 }
 
 // @public
@@ -111,9 +145,9 @@ export interface PhoneNumbersClientOptions extends PipelineOptions {
 
 // @public
 export interface PhoneNumberSearchRequest {
-    areaCode?: string;
+    areaCode: string;
     assignmentType: PhoneNumberAssignmentType;
-    capabilities: PhoneNumberCapabilitiesRequest;
+    capabilities: PhoneNumberCapabilities;
     phoneNumberType: PhoneNumberType;
     quantity?: number;
 }
@@ -122,21 +156,15 @@ export interface PhoneNumberSearchRequest {
 export interface PhoneNumberSearchResult {
     assignmentType: PhoneNumberAssignmentType;
     capabilities: PhoneNumberCapabilities;
-    cost: PhoneNumberCost;
-    id: string;
+    cost?: PhoneNumberCost;
     phoneNumbers: string[];
     phoneNumberType: PhoneNumberType;
-    searchExpiresBy: Date;
+    searchExpiresBy?: Date;
+    searchId: string;
 }
 
 // @public
-export type PhoneNumberType = "tollFree" | "geographic";
-
-// @public (undocumented)
-export type UpdatePhoneNumberOptions = OperationOptions;
-
-// @public (undocumented)
-export type UpdatePhoneNumberResponse = WithResponse<AcquiredPhoneNumber>;
+export type PhoneNumberType = string;
 
 // @public
 export type VoidResponse = WithResponse<{}>;

sdk/communication/communication-phone-numbers/src/generated/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { PhoneNumbersClient } from "./phoneNumbersClient";
+export { PhoneNumbersClientContext } from "./phoneNumbersClientContext";

sdk/communication/communication-phone-numbers/src/generated/src/lro/azureAsyncOperationStrategy.ts

@@ -11,9 +11,10 @@ import {
   BaseResult,
   LROOperationStep,
   LROResponseInfo,
-  FinalStateVia
+  FinalStateVia,
+  LROSYM
 } from "./models";
-import { OperationSpec, OperationArguments } from "@azure/core-http";
+import { OperationSpec, OperationArguments, OperationResponse } from "@azure/core-http";
 import { terminalStates } from "./constants";
 import { SendOperationFn } from ".";
 
@@ -22,7 +23,7 @@ export function createAzureAsyncOperationStrategy<TResult extends BaseResult>(
   sendOperationFn: SendOperationFn<TResult>,
   finalStateVia?: FinalStateVia
 ): LROStrategy<TResult> {
-  const lroData = initialOperation.result._lroData;
+  const lroData = initialOperation.result._response[LROSYM];
   if (!lroData) {
     throw new Error("Expected lroData to be defined for Azure-AsyncOperation strategy");
   }
@@ -32,7 +33,7 @@ export function createAzureAsyncOperationStrategy<TResult extends BaseResult>(
 
   return {
     isTerminal: () => {
-      const currentResult = currentOperation.result._lroData;
+      const currentResult = currentOperation.result._response[LROSYM];
 
       if (!currentResult) {
         throw new Error("Expected lroData to determine terminal status");
@@ -48,28 +49,28 @@ export function createAzureAsyncOperationStrategy<TResult extends BaseResult>(
       return terminalStates.includes(status.toLowerCase());
     },
     sendFinalRequest: async () => {
-      if (!initialOperation.result._lroData) {
+      if (!initialOperation.result._response[LROSYM]) {
         throw new Error("Expected lroData to determine terminal status");
       }
 
-      if (!currentOperation.result._lroData) {
+      if (!currentOperation.result._response[LROSYM]) {
         throw new Error("Expected lroData to determine terminal status");
       }
 
-      const initialOperationResult = initialOperation.result._lroData;
-      const currentOperationResult = currentOperation.result._lroData;
+      const initialOperationResult = initialOperation.result._response[LROSYM];
+      const currentOperationResult = currentOperation.result._response[LROSYM];
 
       if (!shouldPerformFinalGet(initialOperationResult, currentOperationResult)) {
         return currentOperation;
       }
 
-      if (initialOperationResult.requestMethod === "PUT") {
+      if (initialOperationResult?.requestMethod === "PUT") {
         currentOperation = await sendFinalGet(initialOperation, sendOperationFn);
 
         return currentOperation;
       }
 
-      if (initialOperationResult.location) {
+      if (initialOperationResult?.location) {
         switch (finalStateVia) {
           case "original-uri":
             currentOperation = await sendFinalGet(initialOperation, sendOperationFn);
@@ -79,7 +80,7 @@ export function createAzureAsyncOperationStrategy<TResult extends BaseResult>(
             return currentOperation;
           case "location":
           default:
-            const location = initialOperationResult.location || currentOperationResult.location;
+            const location = initialOperationResult.location || currentOperationResult?.location;
 
             if (!location) {
               throw new Error("Couldn't determine final GET URL from location");
@@ -99,9 +100,11 @@ export function createAzureAsyncOperationStrategy<TResult extends BaseResult>(
 
       const pollingArgs = currentOperation.args;
       // Make sure we don't send any body to the get request
-      const { requestBody, ...restSpec } = currentOperation.spec;
+      const { requestBody, responses, ...restSpec } = currentOperation.spec;
+
       const pollingSpec: OperationSpec = {
         ...restSpec,
+        responses: getCompositeMappers(responses),
         httpMethod: "GET",
         path: lastKnownPollingUrl
       };
@@ -110,8 +113,8 @@ export function createAzureAsyncOperationStrategy<TResult extends BaseResult>(
 
       // Update latest polling url
       lastKnownPollingUrl =
-        result._lroData?.azureAsyncOperation ||
-        result._lroData?.operationLocation ||
+        result._response[LROSYM]?.azureAsyncOperation ||
+        result._response[LROSYM]?.operationLocation ||
         lastKnownPollingUrl;
 
       // Update lastOperation result
@@ -126,9 +129,44 @@ export function createAzureAsyncOperationStrategy<TResult extends BaseResult>(
   };
 }
 
-function shouldPerformFinalGet(initialResult: LROResponseInfo, currentResult: LROResponseInfo) {
-  const { status } = currentResult;
-  const { requestMethod: initialRequestMethod, location } = initialResult;
+/**
+ * Polling calls will always return a status object i.e. {"status": "success"}
+ * these intermediate responses are not described in the swagger so we need to
+ * pass custom mappers at runtime.
+ * This function replaces all the existing mappers to be able to deserialize a status object
+ * @param responses Original set of responses defined in the operation
+ */
+function getCompositeMappers(responses: {
+  [responseCode: string]: OperationResponse;
+}): {
+  [responseCode: string]: OperationResponse;
+} {
+  return Object.keys(responses).reduce((acc, statusCode) => {
+    return {
+      ...acc,
+      [statusCode]: {
+        ...responses[statusCode],
+        bodyMapper: {
+          type: {
+            name: "Composite",
+            modelProperties: {
+              status: {
+                serializedName: "status",
+                type: {
+                  name: "String"
+                }
+              }
+            }
+          }
+        }
+      }
+    };
+  }, {} as { [responseCode: string]: OperationResponse });
+}
+
+function shouldPerformFinalGet(initialResult?: LROResponseInfo, currentResult?: LROResponseInfo) {
+  const { status } = currentResult || {};
+  const { requestMethod: initialRequestMethod, location } = initialResult || {};
   if (status && status.toLowerCase() !== "succeeded") {
     return false;
   }

sdk/communication/communication-phone-numbers/src/generated/src/lro/bodyPollingStrategy.ts

@@ -6,7 +6,7 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { LROStrategy, BaseResult, LROOperationStep } from "./models";
+import { LROStrategy, BaseResult, LROOperationStep, LROSYM } from "./models";
 import { OperationSpec } from "@azure/core-http";
 import { terminalStates } from "./constants";
 import { SendOperationFn } from "./lroPoller";
@@ -19,15 +19,15 @@ export function createBodyPollingStrategy<TResult extends BaseResult>(
   initialOperation: LROOperationStep<TResult>,
   sendOperation: SendOperationFn<TResult>
 ): LROStrategy<TResult> {
-  if (!initialOperation.result._lroData) {
+  if (!initialOperation.result._response[LROSYM]) {
     throw new Error("Expected lroData to be defined for BodyPolling strategy");
   }
 
   let currentOperation = initialOperation;
 
   return {
     isTerminal: () => {
-      const currentResult = currentOperation.result._lroData;
+      const currentResult = currentOperation.result._response[LROSYM];
       if (!currentResult) {
         throw new Error("Expected lroData to determine terminal status");
       }

sdk/communication/communication-phone-numbers/src/generated/src/lro/locationStrategy.ts

@@ -6,15 +6,15 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { BaseResult, LROOperationStep, LROStrategy } from "./models";
+import { BaseResult, LROOperationStep, LROStrategy, LROSYM } from "./models";
 import { SendOperationFn } from "./lroPoller";
 import { OperationSpec } from "@azure/core-http";
 
 export function createLocationStrategy<TResult extends BaseResult>(
   initialOperation: LROOperationStep<TResult>,
   sendOperationFn: SendOperationFn<TResult>
 ): LROStrategy<TResult> {
-  const lroData = initialOperation.result._lroData;
+  const lroData = initialOperation.result._response[LROSYM];
   if (!lroData) {
     throw new Error("Expected lroData to be defined for Azure-AsyncOperation strategy");
   }
@@ -24,7 +24,7 @@ export function createLocationStrategy<TResult extends BaseResult>(
 
   return {
     isTerminal: () => {
-      const currentResult = currentOperation.result._lroData;
+      const currentResult = currentOperation.result._response[LROSYM];
       if (!currentResult) {
         throw new Error("Expected lroData to determine terminal status");
       }
@@ -57,7 +57,7 @@ export function createLocationStrategy<TResult extends BaseResult>(
       const result = await sendOperationFn(pollingArgs, pollingSpec);
 
       // Update latest polling url
-      lastKnownPollingUrl = result._lroData?.location || lastKnownPollingUrl;
+      lastKnownPollingUrl = result._response[LROSYM]?.location || lastKnownPollingUrl;
 
       // Update lastOperation result
       currentOperation = {