@azure/communication-react 1.3.2-alpha-202207240017.0 → 1.3.2-alpha-202208040020.0

package/dist/communication-react.d.ts

@@ -255,7 +255,7 @@ export declare type AzureCommunicationCallAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAdapterLocator;
-    alternativeCallerId?: string;
+    alternateCallerId?: string;
 };
 
 /**
@@ -269,6 +269,7 @@ export declare type AzureCommunicationCallWithChatAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     locator: CallAndChatLocator | TeamsMeetingLinkLocator;
+    alternateCallerId?: string;
 };
 
 /**
@@ -501,7 +502,7 @@ export declare type CallAdapterClientState = {
     /**
      * Azure communications Phone number to make PSTN calls with.
      */
-    alternativeCallerId?: string;
+    alternateCallerId?: string;
 };
 
 /**
@@ -852,9 +853,11 @@ export declare interface CallClientState {
      */
     latestErrors: CallErrors;
     /**
-     * Stores an ACS aquired phone number for making PSTN calls.
+     * A phone number in E.164 format that will be used to represent callers identity.
+     * For example, using the alternateCallerId to add a participant using PSTN, this number will
+     * be used as the caller id in the PSTN call.
      */
-    alternativeCallerId?: string;
+    alternateCallerId?: string;
 }
 
 /**
@@ -3379,7 +3382,7 @@ export declare interface ControlBarProps {
  *
  * @public
  */
-export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternativeCallerId }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
+export declare const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, alternateCallerId }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
 
 /**
  * Create a {@link CallAdapter} using the provided {@link StatefulCallClient}.
@@ -3397,7 +3400,7 @@ export declare const createAzureCommunicationCallAdapterFromClient: (callClient:
  *
  * @public
  */
-export declare const createAzureCommunicationCallWithChatAdapter: ({ userId, displayName, credential, endpoint, locator }: AzureCommunicationCallWithChatAdapterArgs) => Promise<CallWithChatAdapter>;
+export declare const createAzureCommunicationCallWithChatAdapter: ({ userId, displayName, credential, endpoint, locator, alternateCallerId }: AzureCommunicationCallWithChatAdapterArgs) => Promise<CallWithChatAdapter>;
 
 /**
  * Create a {@link CallWithChatAdapter} using the provided {@link StatefulChatClient} and {@link StatefulCallClient}.
@@ -6455,7 +6458,7 @@ export declare type StatefulCallClientArgs = {
      *
      * This is not a cached value from the headless calling client.
      */
-    alternativeCallerId?: string;
+    alternateCallerId?: string;
 };
 
 /**