@azure/communication-call-automation 1.5.0 → 1.6.0-alpha.20250901.2

package/dist/commonjs/models/events.d.ts

@@ -1,15 +1,9 @@
 import type { CommunicationIdentifier } from "@azure/communication-common";
-import { AddParticipantSucceeded as RestAddParticipantSucceeded, AddParticipantFailed as RestAddParticipantFailed, RemoveParticipantSucceeded as RestRemoveParticipantSucceeded, RemoveParticipantFailed as RestRemoveParticipantFailed, CallConnected as RestCallConnected, CallDisconnected as RestCallDisconnected, CallTransferAccepted as RestCallTransferAccepted, CallTransferFailed as RestCallTransferFailed, ParticipantsUpdated as RestParticipantsUpdated, RecordingStateChanged as RestRecordingStateChanged, PlayStarted as RestPlayStarted, PlayCompleted as RestPlayCompleted, PlayFailed as RestPlayFailed, PlayCanceled as RestPlayCanceled, RecognizeCompleted as RestRecognizeCompleted, RecognizeFailed as RestRecognizeFailed, RecognizeCanceled as RestRecognizeCanceled, ResultInformation as RestResultInformation, ContinuousDtmfRecognitionToneReceived as RestContinuousDtmfRecognitionToneReceived, ContinuousDtmfRecognitionToneFailed as RestContinuousDtmfRecognitionToneFailed, ContinuousDtmfRecognitionStopped as RestContinuousDtmfRecognitionStopped, SendDtmfTonesCompleted as RestSendDtmfTonesCompleted, SendDtmfTonesFailed as RestSendDtmfTonesFailed, Tone, CancelAddParticipantSucceeded as RestCancelAddParticipantSucceeded, CancelAddParticipantFailed as RestCancelAddParticipantFailed, ConnectFailed as RestConnectFailed, HoldFailed as RestHoldFailed, AnswerFailed as RestAnswerFailed, CreateCallFailed as RestCreateCallFailed, TranscriptionStarted as RestTranscriptionStarted, TranscriptionStopped as RestTranscriptionStopped, TranscriptionUpdated as RestTranscriptionUpdated, TranscriptionFailed as RestTranscriptionFailed, MediaStreamingStarted as RestMediaStreamingStarted, MediaStreamingStopped as RestMediaStreamingStopped, MediaStreamingFailed as RestMediaStreamingFailed } from "../generated/src/models/index.js";
-import type { CallParticipant } from "./models.js";
+import type { Tone, ChoiceResult, DtmfResult, RecognitionType, SpeechResult, MediaStreamingUpdate, TranscriptionUpdate, RecordingKind } from "../generated/src/models/index.js";
+import type { CallParticipant, RecordingState, CustomCallingContext } from "./models.js";
 /** Callback events for Call Automation */
-export type CallAutomationEvent = AddParticipantSucceeded | AddParticipantFailed | RemoveParticipantSucceeded | RemoveParticipantFailed | CallConnected | CallDisconnected | CallTransferAccepted | CallTransferFailed | ParticipantsUpdated | RecordingStateChanged | PlayCompleted | PlayFailed | PlayCanceled | RecognizeCompleted | RecognizeCanceled | RecognizeFailed | ContinuousDtmfRecognitionToneReceived | ContinuousDtmfRecognitionToneFailed | ContinuousDtmfRecognitionStopped | SendDtmfTonesCompleted | SendDtmfTonesFailed | CancelAddParticipantSucceeded | CancelAddParticipantFailed | TranscriptionStarted | TranscriptionStopped | TranscriptionUpdated | TranscriptionFailed | CreateCallFailed | AnswerFailed | HoldFailed | ConnectFailed | MediaStreamingStarted | MediaStreamingStopped | MediaStreamingFailed | PlayStarted | StartRecordingFailed;
-export { RestAddParticipantSucceeded, RestAddParticipantFailed, RestRemoveParticipantSucceeded, RestRemoveParticipantFailed, RestCallConnected, RestCallDisconnected, RestCallTransferAccepted, RestCallTransferFailed, RestParticipantsUpdated, RestRecordingStateChanged, RestPlayStarted, RestPlayCompleted, RestPlayFailed, RestPlayCanceled, RestRecognizeCompleted, RestRecognizeFailed, RestRecognizeCanceled, RestResultInformation, RestContinuousDtmfRecognitionToneReceived, RestContinuousDtmfRecognitionToneFailed, RestContinuousDtmfRecognitionStopped, RestSendDtmfTonesCompleted, RestSendDtmfTonesFailed, RestCancelAddParticipantSucceeded, RestCancelAddParticipantFailed, RestConnectFailed, RestTranscriptionStarted, RestTranscriptionStopped, RestTranscriptionUpdated, RestTranscriptionFailed, RestHoldFailed, RestMediaStreamingStarted, RestMediaStreamingStopped, RestMediaStreamingFailed, RestCreateCallFailed, RestAnswerFailed, };
-export interface ResultInformation
-/**
- * @deprecated RestResultInformation is deprecated.
- * Use ResultInformation instead.
- */
- extends Omit<RestResultInformation, "code" | "subCode" | "message"> {
+export type CallAutomationEvent = AddParticipantSucceeded | AddParticipantFailed | RemoveParticipantSucceeded | RemoveParticipantFailed | MoveParticipantSucceeded | MoveParticipantFailed | CallConnected | CallDisconnected | CallTransferAccepted | CallTransferFailed | ParticipantsUpdated | RecordingStateChanged | PlayCompleted | PlayFailed | PlayCanceled | RecognizeCompleted | RecognizeCanceled | RecognizeFailed | ContinuousDtmfRecognitionToneReceived | ContinuousDtmfRecognitionToneFailed | ContinuousDtmfRecognitionStopped | SendDtmfTonesCompleted | SendDtmfTonesFailed | CancelAddParticipantSucceeded | CancelAddParticipantFailed | TranscriptionStarted | TranscriptionStopped | TranscriptionUpdated | TranscriptionFailed | CreateCallFailed | AnswerFailed | HoldFailed | ConnectFailed | MediaStreamingStarted | MediaStreamingStopped | MediaStreamingFailed | StartRecordingFailed | PlayStarted | PlayPaused | PlayResumed | HoldAudioStarted | HoldAudioPaused | HoldAudioResumed | HoldAudioCompleted | IncomingCall;
+export interface ResultInformation {
     /** The error code. */
     code: number;
     /** The sub code of error. */
@@ -18,19 +12,16 @@ export interface ResultInformation
     message: string;
 }
 /** The participant successfully added event. */
-export interface AddParticipantSucceeded
-/**
- * @deprecated RestAddParticipantSucceeded is deprecated.
- * Use AddParticipantSucceeded instead.
- */
- extends Omit<RestAddParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
+export interface AddParticipantSucceeded {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** The participant in the call. */
     participant?: CommunicationIdentifier;
@@ -38,19 +29,16 @@ export interface AddParticipantSucceeded
     kind: "AddParticipantSucceeded";
 }
 /** The failed to add participant event. */
-export interface AddParticipantFailed
-/**
- * @deprecated RestAddParticipantFailed is deprecated.
- * Use AddParticipantFailed instead.
- */
- extends Omit<RestAddParticipantFailed, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
+export interface AddParticipantFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** The participant in the call. */
     participant?: CommunicationIdentifier;
@@ -58,19 +46,16 @@ export interface AddParticipantFailed
     kind: "AddParticipantFailed";
 }
 /** The participant successfully removed event. */
-export interface RemoveParticipantSucceeded
-/**
- * @deprecated RestRemoveParticipantSucceeded is deprecated.
- * Use RemoveParticipantSucceeded instead.
- */
- extends Omit<RestRemoveParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
+export interface RemoveParticipantSucceeded {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** The participant in the call. */
     participant?: CommunicationIdentifier;
@@ -78,287 +63,290 @@ export interface RemoveParticipantSucceeded
     kind: "RemoveParticipantSucceeded";
 }
 /** The failed to remove participant event. */
-export interface RemoveParticipantFailed
-/**
- * @deprecated RestRemoveParticipantFailed is deprecated.
- * Use RemoveParticipantFailed instead.
- */
- extends Omit<RestRemoveParticipantFailed, "callConnectionId" | "serverCallId" | "correlationId" | "participant" | "resultInformation"> {
+export interface RemoveParticipantFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** The participant in the call. */
     participant?: CommunicationIdentifier;
     /** kind of this event. */
     kind: "RemoveParticipantFailed";
 }
-/** Event when call was established. */
-export interface CallConnected
-/**
- * @deprecated RestCallConnected is deprecated.
- * Use CallConnected instead.
- */
- extends Omit<RestCallConnected, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+/** The participant successfully moved event. */
+export interface MoveParticipantSucceeded {
+    /** The CallConnectionId for the call you want to move the participant from */
+    fromCall?: string;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
+    /** The participant in the call. */
+    participant?: CommunicationIdentifier;
     /** kind of this event. */
-    kind: "CallConnected";
+    kind: "MoveParticipantSucceeded";
 }
-/** Event when all participants left and call was terminated. */
-export interface CallDisconnected
-/**
- * @deprecated RestCallDisconnected is deprecated.
- * Use CallDisconnected instead.
- */
- extends Omit<RestCallDisconnected, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+/** The failed to move participant event. */
+export interface MoveParticipantFailed {
+    /** The CallConnectionId for the call you want to move the participant from */
+    fromCall?: string;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
+    /** The participant in the call. */
+    participant?: CommunicationIdentifier;
     /** kind of this event. */
-    kind: "CallDisconnected";
+    kind: "MoveParticipantFailed";
 }
-/** Event when transfer request was successful. */
-export interface CallTransferAccepted
-/**
- * @deprecated RestCallTransferAccepted is deprecated.
- * Use CallTransferAccepted instead.
- */
- extends Omit<RestCallTransferAccepted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation" | "transferee" | "transferTarget"> {
+/** Event when call was established. */
+export interface CallConnected {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
-    /** Participant that was transferred away */
-    transferee: CommunicationIdentifier;
-    /** Target that transferee is transferred to */
-    transferTarget: CommunicationIdentifier;
     /** kind of this event. */
-    kind: "CallTransferAccepted";
+    kind: "CallConnected";
 }
-/** Event when transfer request was failed. */
-export interface CallTransferFailed
-/**
- * @deprecated RestCallTransferFailed is deprecated.
- * Use CallTransferFailed instead.
- */
- extends Omit<RestCallTransferFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+/** Event when call was initiated. */
+export interface IncomingCall {
+    /** Call connection ID. */
+    callConnectionId: string;
+    /** The communication identifier of the target user.*/
+    to?: CommunicationIdentifier;
+    /** The communication identifier of the user who initiated the call.*/
+    from?: CommunicationIdentifier;
+    /** Display name of caller.*/
+    callerDisplayName?: string;
+    /** Custom Context of Incoming Call */
+    customContext?: CustomCallingContext;
+    /** Incoming call context.*/
+    incomingCallContext?: string;
+    /** The communication identifier of the user on behalf of whom the call is made.*/
+    onBehalfOfCallee?: CommunicationIdentifier;
+    /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
+    correlationId: string;
+    /** Contains the resulting SIP code/sub-code and message. */
+    resultInformation?: ResultInformation;
+    /** kind of this event. */
+    kind: "IncomingCall";
+}
+/** Event when all participants left and call was terminated. */
+export interface CallDisconnected {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "CallTransferFailed";
+    kind: "CallDisconnected";
 }
-/** Event when there was an update to participant(s). */
-export interface ParticipantsUpdated
-/**
- * @deprecated RestParticipantsUpdated is deprecated.
- * Use ParticipantsUpdated instead.
- */
- extends Omit<RestParticipantsUpdated, "callConnectionId" | "serverCallId" | "correlationId" | "participants" | "resultInformation"> {
+/** Event when transfer request was successful. */
+export interface CallTransferAccepted {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** The list of participants in the call. */
-    participants: CallParticipant[];
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
+    /** Participant that was transferred away */
+    transferee: CommunicationIdentifier;
+    /** Target that transferee is transferred to */
+    transferTarget: CommunicationIdentifier;
     /** kind of this event. */
-    kind: "ParticipantsUpdated";
+    kind: "CallTransferAccepted";
 }
-/** Event when Recording state has been changed. */
-export interface RecordingStateChanged
-/**
- * @deprecated RestRecordingStateChanged is deprecated.
- * Use RecordingStateChanged instead.
- */
- extends Omit<RestRecordingStateChanged, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+/** Event when transfer request was failed. */
+export interface CallTransferFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "RecordingStateChanged";
+    kind: "CallTransferFailed";
 }
-/** Event when StartRecording was failed. */
-export interface StartRecordingFailed {
+/** Event when there was an update to participant(s). */
+export interface ParticipantsUpdated {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** The list of participants in the call. */
+    participants: CallParticipant[];
+    /** The Sequence Number of the event */
+    sequenceNumber?: number;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
-    /** The call recording id */
-    recordingId?: string;
     /** kind of this event. */
-    kind: "StartRecordingFailed";
+    kind: "ParticipantsUpdated";
 }
-/** Event when Media play was successfully started. */
-export interface PlayStarted
-/**
- * @deprecated RestPlayStarted is deprecated.
- * Use PlayStarted instead.
- */
- extends Omit<RestPlayStarted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+/** Event when Recording state has been changed. */
+export interface RecordingStateChanged {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code, sub-code and message. */
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
+    /** The call recording id*/
+    recordingId?: string;
+    state?: RecordingState;
+    /** The time of the recording started*/
+    startDateTime?: Date;
+    recordingKind?: RecordingKind;
     /** kind of this event. */
-    kind: "PlayStarted";
+    kind: "RecordingStateChanged";
 }
 /** Event when Media play was successfully completed. */
-export interface PlayCompleted
-/**
- * @deprecated RestPlayCompleted is deprecated.
- * Use PlayCompleted instead.
- */
- extends Omit<RestPlayCompleted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface PlayCompleted {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** kind of this event. */
     kind: "PlayCompleted";
 }
 /** Event when Media play was failed. */
-export interface PlayFailed
-/**
- * @deprecated RestPlayFailed is deprecated.
- * Use PlayFailed instead.
- */
- extends Omit<RestPlayFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface PlayFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the index of the failed play source. */
+    failedPlaySourceIndex?: number;
     /** kind of this event. */
     kind: "PlayFailed";
 }
 /** Event when Media play was canceled by Cancel operation. */
-export interface PlayCanceled
-/**
- * @deprecated RestPlayCanceled is deprecated.
- * Use PlayCanceled instead.
- */
- extends Omit<RestPlayCanceled, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface PlayCanceled {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "PlayCanceled";
 }
 /** Event when Media recognize was successfully completed. */
-export interface RecognizeCompleted
-/**
- * @deprecated RestRecognizeCompleted is deprecated.
- * Use RecognizeCompleted instead.
- */
- extends Omit<RestRecognizeCompleted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface RecognizeCompleted {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /**
+     * Determines the sub-type of the recognize operation.
+     * In case of cancel operation the this field is not set and is returned empty
+     */
+    recognitionType?: RecognitionType;
+    /** Defines the result for RecognitionType = Dtmf */
+    dtmfResult?: DtmfResult;
+    /** Defines the result for RecognitionType = Choices */
+    choiceResult?: ChoiceResult;
+    /** Defines the result for RecognitionType = Speech and SpeechOrDtmf */
+    speechResult?: SpeechResult;
     /** kind of this event. */
     kind: "RecognizeCompleted";
 }
 /** Event when Media recognize was failed. */
-export interface RecognizeFailed
-/**
- * @deprecated RestRecognizeFailed is deprecated.
- * Use RecognizeFailed instead.
- */
- extends Omit<RestRecognizeFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface RecognizeFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the index of the failed play source. */
+    failedPlaySourceIndex?: number;
     /** kind of this event. */
     kind: "RecognizeFailed";
 }
 /** Event when Media recognize was canceled by Cancel operation. */
-export interface RecognizeCanceled
-/**
- * @deprecated RestRecognizeCanceled is deprecated.
- * Use RecognizeCanceled instead.
- */
- extends Omit<RestRecognizeCanceled, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface RecognizeCanceled {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "RecognizeCanceled";
 }
 /** Event sent when Dtmf tone received from targeted participant in call. */
-export interface ContinuousDtmfRecognitionToneReceived
-/**
- * @deprecated RestContinuousDtmfRecognitionToneReceived is deprecated.
- * Use ContinuousDtmfRecognitionToneReceived instead.
- */
- extends Omit<RestContinuousDtmfRecognitionToneReceived, "sequenceId" | "tone" | "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface ContinuousDtmfRecognitionToneReceived {
     /** The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed. */
     sequenceId: number;
     /** Defines values for Tone. */
@@ -369,314 +357,276 @@ export interface ContinuousDtmfRecognitionToneReceived
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId or skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "ContinuousDtmfRecognitionToneReceived";
 }
 /** Event sent when failed to recognize continuous Dtmf tone. */
-export interface ContinuousDtmfRecognitionToneFailed
-/**
- * @deprecated RestContinuousDtmfRecognitionToneFailed is deprecated.
- * Use ContinuousDtmfRecognitionToneFailed instead.
- */
- extends Omit<RestContinuousDtmfRecognitionToneFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface ContinuousDtmfRecognitionToneFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "ContinuousDtmfRecognitionToneFailed";
 }
 /** Event sent when continuous Dtmf recognition stopped. */
-export interface ContinuousDtmfRecognitionStopped
-/**
- * @deprecated RestContinuousDtmfRecognitionStopped is deprecated.
- * Use ContinuousDtmfRecognitionStopped instead.
- */
- extends Omit<RestContinuousDtmfRecognitionStopped, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface ContinuousDtmfRecognitionStopped {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "ContinuousDtmfRecognitionStopped";
 }
 /** Event sent when Dtmf tones send successfully. */
-export interface SendDtmfTonesCompleted
-/**
- * @deprecated RestSendDtmfTonesCompleted is deprecated.
- * Use SendDtmfTonesCompleted instead.
- */
- extends Omit<RestSendDtmfTonesCompleted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface SendDtmfTonesCompleted {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "SendDtmfTonesCompleted";
 }
 /** Event sent when Dtmf tones send failed. */
-export interface SendDtmfTonesFailed
-/**
- * @deprecated RestSendDtmfTonesFailed is deprecated.
- * Use SendDtmfTonesFailed instead.
- */
- extends Omit<RestSendDtmfTonesFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface SendDtmfTonesFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "SendDtmfTonesFailed";
 }
 /** Successful cancel add participant event. */
-export interface CancelAddParticipantSucceeded
-/**
- * @deprecated RestCancelAddParticipantSucceeded is deprecated.
- * Use CancelAddParticipantSucceeded instead.
- */
- extends Omit<RestCancelAddParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "invitationId" | "resultInformation"> {
+export interface CancelAddParticipantSucceeded {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code/sub-code and message. */
+    resultInformation?: ResultInformation;
     /** Invitation ID used to cancel the add participant request. */
     invitationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
-    resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "CancelAddParticipantSucceeded";
 }
 /** The failed to cancel add participant event. */
-export interface CancelAddParticipantFailed
-/**
- * @deprecated RestCancelAddParticipantFailed is deprecated.
- * Use CancelAddParticipantFailed instead.
- */
- extends Omit<RestCancelAddParticipantFailed, "callConnectionId" | "serverCallId" | "correlationId" | "invitationId" | "resultInformation"> {
+export interface CancelAddParticipantFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Invitation ID used to cancel the add participant request. */
     invitationId: string;
-    /** Contains the resulting SIP code/sub-code and message from NGC services. */
+    /** Contains the resulting SIP code/sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "CancelAddParticipantFailed";
 }
-export interface ConnectFailed
-/**
- * @deprecated RestConnectFailed is deprecated.
- * Use ConnectFailed instead.
- */
- extends Omit<RestConnectFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface TranscriptionStarted {
+    /** Defines the result for TranscriptionUpdate with the current status and the details about the status */
+    transcriptionUpdate?: TranscriptionUpdate;
     /** Call connection ID. */
     callConnectionId: string;
+    /** Server call ID. */
+    serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "ConnectFailed";
+    kind: "TranscriptionStarted";
 }
-export interface HoldFailed
-/**
- * @deprecated RestHoldFailed is deprecated.
- * Use HoldFailed instead.
- */
- extends Omit<RestHoldFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface TranscriptionStopped {
+    /** Defines the result for TranscriptionUpdate with the current status and the details about the status */
+    transcriptionUpdate?: TranscriptionUpdate;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "HoldFailed";
+    kind: "TranscriptionStopped";
 }
-export interface AnswerFailed
-/**
- * @deprecated RestAnswerFailed is deprecated.
- * Use AnswerFailed instead.
- */
- extends Omit<RestAnswerFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface TranscriptionUpdated {
+    /** Defines the result for TranscriptionUpdate with the current status and the details about the status */
+    transcriptionUpdate?: TranscriptionUpdate;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "AnswerFailed";
+    kind: "TranscriptionUpdated";
 }
-export interface CreateCallFailed
-/**
- * @deprecated RestCreateCallFailed is deprecated.
- * Use CreateCallFailed instead.
- */
- extends Omit<RestCreateCallFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface TranscriptionFailed {
+    /** Defines the result for TranscriptionUpdate with the current status and the details about the status */
+    transcriptionUpdate?: TranscriptionUpdate;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "CreateCallFailed";
+    kind: "TranscriptionFailed";
 }
-export interface TranscriptionStarted
-/**
- * @deprecated RestTranscriptionStarted is deprecated.
- * Use TranscriptionStarted instead.
- */
- extends Omit<RestTranscriptionStarted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface CreateCallFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
-    resultInformation?: RestResultInformation;
+    resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "TranscriptionStarted";
+    kind: "CreateCallFailed";
 }
-export interface TranscriptionStopped
-/**
- * @deprecated RestTranscriptionStopped is deprecated.
- * Use TranscriptionStopped instead.
- */
- extends Omit<RestTranscriptionStopped, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface AnswerFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
-    resultInformation?: RestResultInformation;
+    resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "TranscriptionStopped";
+    kind: "AnswerFailed";
 }
-export interface TranscriptionUpdated
-/**
- * @deprecated RestTranscriptionUpdated is deprecated.
- * Use TranscriptionUpdated instead.
- */
- extends Omit<RestTranscriptionUpdated, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface HoldFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
-    resultInformation?: RestResultInformation;
+    resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "TranscriptionUpdated";
+    kind: "HoldFailed";
 }
-export interface TranscriptionFailed
-/**
- * @deprecated RestTranscriptionFailed is deprecated.
- * Use TranscriptionFailed instead.
- */
- extends Omit<RestTranscriptionFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface ConnectFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
-    resultInformation?: RestResultInformation;
+    resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "TranscriptionFailed";
+    kind: "ConnectFailed";
 }
-export interface MediaStreamingStarted
-/**
- * @deprecated RestMediaStreamingStarted is deprecated.
- * Use MediaStreamingStarted instead.
- */
- extends Omit<RestMediaStreamingStarted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface MediaStreamingStarted {
+    /** Defines the result for MediaStreamingUpdate with the current status and the details about the status */
+    mediaStreamingUpdate?: MediaStreamingUpdate;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "MediaStreamingStarted";
 }
-export interface MediaStreamingStopped
-/**
- * @deprecated RestMediaStreamingStopped is deprecated.
- * Use MediaStreamingStopped instead.
- */
- extends Omit<RestMediaStreamingStopped, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface MediaStreamingStopped {
+    /** Defines the result for MediaStreamingUpdate with the current status and the details about the status */
+    mediaStreamingUpdate?: MediaStreamingUpdate;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "MediaStreamingStopped";
 }
-export interface MediaStreamingFailed
-/**
- * @deprecated RestMediaStreamingFailed is deprecated.
- * Use MediaStreamingFailed instead.
- */
- extends Omit<RestMediaStreamingFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface MediaStreamingFailed {
+    /** Defines the result for MediaStreamingUpdate with the current status and the details about the status */
+    mediaStreamingUpdate?: MediaStreamingUpdate;
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
     kind: "MediaStreamingFailed";
 }
-export interface CreateCallFailed
-/**
- * @deprecated RestCreateCallFailed is deprecated.
- * Use CreateCallFailed instead.
- */
- extends Omit<RestCreateCallFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+export interface StartRecordingFailed {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
@@ -685,24 +635,114 @@ export interface CreateCallFailed
     correlationId: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
+    /** The call recording id */
+    recordingId?: string;
     /** kind of this event. */
-    kind: "CreateCallFailed";
+    kind: "StartRecordingFailed";
 }
-export interface AnswerFailed
-/**
- * @deprecated RestAnswerFailed is deprecated.
- * Use AnswerFailed instead.
- */
- extends Omit<RestAnswerFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
+/** Event when Media play was successfully started. */
+export interface PlayStarted {
     /** Call connection ID. */
     callConnectionId: string;
     /** Server call ID. */
     serverCallId: string;
     /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
     correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
     /** Contains the resulting SIP code, sub-code and message. */
     resultInformation?: ResultInformation;
     /** kind of this event. */
-    kind: "AnswerFailed";
+    kind: "PlayStarted";
+}
+/** Event when Media play was successfully paused. */
+export interface PlayPaused {
+    /** Call connection ID. */
+    callConnectionId: string;
+    /** Server call ID. */
+    serverCallId: string;
+    /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
+    correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code, sub-code and message. */
+    resultInformation?: ResultInformation;
+    /** kind of this event. */
+    kind: "PlayPaused";
+}
+/** Event when Media play was successfully paused. */
+export interface PlayResumed {
+    /** Call connection ID. */
+    callConnectionId: string;
+    /** Server call ID. */
+    serverCallId: string;
+    /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
+    correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code, sub-code and message. */
+    resultInformation?: ResultInformation;
+    /** kind of this event. */
+    kind: "PlayResumed";
+}
+/** Event when hold audio play was successfully started. */
+export interface HoldAudioStarted {
+    /** Call connection ID. */
+    callConnectionId: string;
+    /** Server call ID. */
+    serverCallId: string;
+    /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
+    correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code, sub-code and message. */
+    resultInformation?: ResultInformation;
+    /** kind of this event. */
+    kind: "HoldAudioStarted";
+}
+/** Event when hold audio play was successfully paused. */
+export interface HoldAudioPaused {
+    /** Call connection ID. */
+    callConnectionId: string;
+    /** Server call ID. */
+    serverCallId: string;
+    /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
+    correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code, sub-code and message. */
+    resultInformation?: ResultInformation;
+    /** kind of this event. */
+    kind: "HoldAudioPaused";
+}
+/** Event when hold audio play was successfully resumed. */
+export interface HoldAudioResumed {
+    /** Call connection ID. */
+    callConnectionId: string;
+    /** Server call ID. */
+    serverCallId: string;
+    /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
+    correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code, sub-code and message. */
+    resultInformation?: ResultInformation;
+    /** kind of this event. */
+    kind: "HoldAudioResumed";
+}
+/** Event when hold audio play was successfully completed. */
+export interface HoldAudioCompleted {
+    /** Call connection ID. */
+    callConnectionId: string;
+    /** Server call ID. */
+    serverCallId: string;
+    /** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
+    correlationId: string;
+    /** Used this to correlate the request to the response event. */
+    operationContext?: string;
+    /** Contains the resulting SIP code, sub-code and message. */
+    resultInformation?: ResultInformation;
+    /** kind of this event. */
+    kind: "HoldAudioCompleted";
 }
 //# sourceMappingURL=events.d.ts.map