@azure/communication-call-automation 1.3.0 → 1.3.1

package/dist/browser/models/models.d.ts

@@ -0,0 +1,188 @@
+import { CommunicationIdentifier, CommunicationUserIdentifier, MicrosoftTeamsUserIdentifier, MicrosoftTeamsAppIdentifier, PhoneNumberIdentifier } from "@azure/communication-common";
+import { CallConnectionStateModel } from "../generated/src/index.js";
+export { CallConnectionStateModel, CallRejectReason, KnownCallRejectReason, RecognitionType, ChoiceResult, DtmfResult, SpeechResult, RecordingState, Tone, } from "../generated/src/models/index.js";
+/** Properties of a call connection */
+export interface CallConnectionProperties {
+    /** The call connection id. */
+    callConnectionId?: string;
+    /** The server call id. */
+    serverCallId?: string;
+    /**
+     * The source caller Id, a phone number, that's shown to the PSTN participant being invited.
+     * Required only when calling a PSTN callee.
+     */
+    sourceCallerIdNumber?: PhoneNumberIdentifier;
+    /** Display name of the call if dialing out to a pstn number. */
+    sourceDisplayName?: string;
+    /** Source identity. */
+    source?: CommunicationIdentifier;
+    /** The targets of the call. */
+    targetParticipants?: CommunicationIdentifier[];
+    /** The state of the call connection. */
+    callConnectionState?: CallConnectionStateModel;
+    /** The callback URL. */
+    callbackUrl?: string;
+    /** The correlation ID. */
+    correlationId?: string;
+    /** Identity of the answering entity. Only populated when identity is provided in the request. */
+    answeredby?: CommunicationUserIdentifier;
+    /** Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number. */
+    answeredFor?: PhoneNumberIdentifier;
+}
+/** Contract model of an ACS call participant */
+export interface CallParticipant {
+    /** Communication identifier of the participant */
+    identifier?: CommunicationIdentifier;
+    /** Is participant muted */
+    isMuted?: boolean;
+    /** Is participant on hold. */
+    isOnHold?: boolean;
+}
+/** The locator used for joining or taking action on a call. */
+export interface CallLocator {
+    id: string;
+    kind: CallLocatorType;
+}
+/** Defines values for VoiceKind that the service accepts. */
+export declare enum VoiceKind {
+    /** Male */
+    Male = "male",
+    /** Female */
+    Female = "female"
+}
+/** The PlaySource model. */
+export interface PlaySource {
+    /** @deprecated Not in use, instead use playsourcecacheid for similar functionality*/
+    playsourcacheid?: string;
+}
+/** The FileSource model. */
+export interface FileSource extends PlaySource {
+    url: string;
+    readonly kind: "fileSource";
+}
+/** The TextSource model. */
+export interface TextSource extends PlaySource {
+    text: string;
+    sourceLocale?: string;
+    voiceKind?: VoiceKind;
+    voiceName?: string;
+    customVoiceEndpointId?: string;
+    readonly kind: "textSource";
+}
+/** The SsmlSource model. */
+export interface SsmlSource extends PlaySource {
+    ssmlText: string;
+    customVoiceEndpointId?: string;
+    readonly kind: "ssmlSource";
+}
+/** A Dtmf Tone. */
+export declare enum DtmfTone {
+    /** Zero */
+    Zero = "zero",
+    /** One */
+    One = "one",
+    /** Two */
+    Two = "two",
+    /** Three */
+    Three = "three",
+    /** Four */
+    Four = "four",
+    /** Five */
+    Five = "five",
+    /** Six */
+    Six = "six",
+    /** Seven */
+    Seven = "seven",
+    /** Eight */
+    Eight = "eight",
+    /** Nine */
+    Nine = "nine",
+    /** A */
+    A = "a",
+    /** B */
+    B = "b",
+    /** C */
+    C = "c",
+    /** D */
+    D = "d",
+    /** Pound */
+    Pound = "pound",
+    /** Asterisk */
+    Asterisk = "asterisk"
+}
+/** A Recognition Choice */
+export interface RecognitionChoice {
+    /** Identifier for a given choice */
+    label: string;
+    /** List of phrases to recognize */
+    phrases: string[];
+    tone?: DtmfTone;
+}
+/** The type of the recognition that the service accepts. */
+export declare enum RecognizeInputType {
+    /** Dtmf */
+    Dtmf = "dtmf"
+}
+/** Call invitee details. */
+export interface CallInvite {
+    /** The Target's PhoneNumberIdentifier, CommunicationUserIdentifier, MicrosoftTeamsUserIdentifier or MicrosoftTeamsAppIdentifier. */
+    readonly targetParticipant: PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier;
+    /** Caller's phone number identifier. */
+    readonly sourceCallIdNumber?: PhoneNumberIdentifier;
+    sourceDisplayName?: string;
+    /** Used by customer to send custom context to targets. */
+    customCallingContext?: CustomCallingContext;
+}
+/** The locator type of a call. */
+export type CallLocatorType = "serverCallLocator" | "groupCallLocator" | "roomCallLocator";
+/** The content type of a call recording. */
+export type RecordingContent = "audio" | "audioVideo";
+/** The channel type of a call recording. */
+export type RecordingChannel = "mixed" | "unmixed";
+/** The format type of a call recording. */
+export type RecordingFormat = "mp3" | "mp4" | "wav";
+/** The format type of a call recording. */
+export type RecordingKind = "azureCommunicationServices" | "teams" | "teamsCompliance";
+/** The storage type of a call recording. */
+export type RecordingStorageKind = "azureCommunicationServices" | "azureBlobStorage";
+/** Channel affinity for a participant */
+export interface ChannelAffinity {
+    /** Channel number to which bitstream from a particular participant will be written. */
+    channel?: number;
+    /**
+     * The identifier for the participant whose bitstream will be written to the channel
+     * represented by the channel number.
+     */
+    targetParticipant: CommunicationIdentifier;
+}
+/** The recording storage */
+export interface RecordingStorage {
+    /** Defines the kind of recording storage */
+    recordingStorageKind: RecordingStorageKind;
+    /** Uri of a container or a location within a container */
+    recordingDestinationContainerUrl?: string;
+}
+interface CustomCallingContextHeader {
+    key: string;
+    value: string;
+}
+/** VOIP header. */
+export interface VoipHeader extends CustomCallingContextHeader {
+    kind: "voip";
+}
+/** SIP User To User header. */
+export interface SipUserToUserHeader extends CustomCallingContextHeader {
+    kind: "sipuui";
+}
+/** SIP Custom header. */
+export interface SipCustomHeader extends CustomCallingContextHeader {
+    kind: "sipx";
+}
+/** Custom Calling Context */
+export type CustomCallingContext = (VoipHeader | SipUserToUserHeader | SipCustomHeader)[];
+/** AI options for the call. */
+export interface CallIntelligenceOptions {
+    /** The identifier of the Cognitive Service resource assigned to this call. */
+    cognitiveServicesEndpoint?: string;
+}
+//# sourceMappingURL=models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../src/models/models.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC3B,4BAA4B,EAC5B,2BAA2B,EAC3B,qBAAqB,EACtB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAErE,OAAO,EACL,wBAAwB,EACxB,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EACf,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,cAAc,EACd,IAAI,GACL,MAAM,kCAAkC,CAAC;AAE1C,sCAAsC;AACtC,MAAM,WAAW,wBAAwB;IACvC,8BAA8B;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,0BAA0B;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAC7C,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uBAAuB;IACvB,MAAM,CAAC,EAAE,uBAAuB,CAAC;IACjC,+BAA+B;IAC/B,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC/C,wCAAwC;IACxC,mBAAmB,CAAC,EAAE,wBAAwB,CAAC;IAC/C,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iGAAiG;IACjG,UAAU,CAAC,EAAE,2BAA2B,CAAC;IACzC,0HAA0H;IAC1H,WAAW,CAAC,EAAE,qBAAqB,CAAC;CACrC;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,UAAU,CAAC,EAAE,uBAAuB,CAAC;IACrC,2BAA2B;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,+DAA+D;AAC/D,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,6DAA6D;AAC7D,oBAAY,SAAS;IACnB,WAAW;IACX,IAAI,SAAS;IACb,aAAa;IACb,MAAM,WAAW;CAClB;AAED,4BAA4B;AAC5B,MAAM,WAAW,UAAU;IACzB,qFAAqF;IACrF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,4BAA4B;AAC5B,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC7B;AAED,4BAA4B;AAC5B,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC7B;AAED,4BAA4B;AAC5B,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC7B;AAED,mBAAmB;AACnB,oBAAY,QAAQ;IAClB,WAAW;IACX,IAAI,SAAS;IACb,UAAU;IACV,GAAG,QAAQ;IACX,UAAU;IACV,GAAG,QAAQ;IACX,YAAY;IACZ,KAAK,UAAU;IACf,WAAW;IACX,IAAI,SAAS;IACb,WAAW;IACX,IAAI,SAAS;IACb,UAAU;IACV,GAAG,QAAQ;IACX,YAAY;IACZ,KAAK,UAAU;IACf,YAAY;IACZ,KAAK,UAAU;IACf,WAAW;IACX,IAAI,SAAS;IACb,QAAQ;IACR,CAAC,MAAM;IACP,QAAQ;IACR,CAAC,MAAM;IACP,QAAQ;IACR,CAAC,MAAM;IACP,QAAQ;IACR,CAAC,MAAM;IACP,YAAY;IACZ,KAAK,UAAU;IACf,eAAe;IACf,QAAQ,aAAa;CACtB;AAED,2BAA2B;AAC3B,MAAM,WAAW,iBAAiB;IAChC,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,4DAA4D;AAC5D,oBAAY,kBAAkB;IAC5B,WAAW;IACX,IAAI,SAAS;CACd;AAED,4BAA4B;AAC5B,MAAM,WAAW,UAAU;IACzB,oIAAoI;IACpI,QAAQ,CAAC,iBAAiB,EACtB,qBAAqB,GACrB,2BAA2B,GAC3B,4BAA4B,GAC5B,2BAA2B,CAAC;IAChC,wCAAwC;IACxC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAC7C;AAED,kCAAkC;AAClC,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAE3F,4CAA4C;AAC5C,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,YAAY,CAAC;AAEtD,4CAA4C;AAC5C,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,SAAS,CAAC;AAEnD,2CAA2C;AAC3C,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAEpD,2CAA2C;AAC3C,MAAM,MAAM,aAAa,GAAG,4BAA4B,GAAG,OAAO,GAAG,iBAAiB,CAAC;AAEvF,4CAA4C;AAC5C,MAAM,MAAM,oBAAoB,GAAG,4BAA4B,GAAG,kBAAkB,CAAC;AAErF,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC9B,uFAAuF;IACvF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,iBAAiB,EAAE,uBAAuB,CAAC;CAC5C;AAED,4BAA4B;AAC5B,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,0DAA0D;IAC1D,gCAAgC,CAAC,EAAE,MAAM,CAAC;CAC3C;AAED,UAAU,0BAA0B;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,mBAAmB;AACnB,MAAM,WAAW,UAAW,SAAQ,0BAA0B;IAC5D,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+BAA+B;AAC/B,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACrE,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAyB;AACzB,MAAM,WAAW,eAAgB,SAAQ,0BAA0B;IACjE,IAAI,EAAE,MAAM,CAAC;CACd;AAED,6BAA6B;AAC7B,MAAM,MAAM,oBAAoB,GAAG,CAAC,UAAU,GAAG,mBAAmB,GAAG,eAAe,CAAC,EAAE,CAAC;AAE1F,+BAA+B;AAC/B,MAAM,WAAW,uBAAuB;IACtC,8EAA8E;IAC9E,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC"}

package/{dist-esm/src → dist/browser}/models/models.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-export { KnownCallRejectReason, } from "../generated/src/models/index";
+export { KnownCallRejectReason, } from "../generated/src/models/index.js";
 /** Defines values for VoiceKind that the service accepts. */
 export var VoiceKind;
 (function (VoiceKind) {

package/dist/browser/models/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/models/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAWlC,OAAO,EAGL,qBAAqB,GAOtB,MAAM,kCAAkC,CAAC;AA+C1C,6DAA6D;AAC7D,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,WAAW;IACX,0BAAa,CAAA;IACb,aAAa;IACb,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AA+BD,mBAAmB;AACnB,MAAM,CAAN,IAAY,QAiCX;AAjCD,WAAY,QAAQ;IAClB,WAAW;IACX,yBAAa,CAAA;IACb,UAAU;IACV,uBAAW,CAAA;IACX,UAAU;IACV,uBAAW,CAAA;IACX,YAAY;IACZ,2BAAe,CAAA;IACf,WAAW;IACX,yBAAa,CAAA;IACb,WAAW;IACX,yBAAa,CAAA;IACb,UAAU;IACV,uBAAW,CAAA;IACX,YAAY;IACZ,2BAAe,CAAA;IACf,YAAY;IACZ,2BAAe,CAAA;IACf,WAAW;IACX,yBAAa,CAAA;IACb,QAAQ;IACR,mBAAO,CAAA;IACP,QAAQ;IACR,mBAAO,CAAA;IACP,QAAQ;IACR,mBAAO,CAAA;IACP,QAAQ;IACR,mBAAO,CAAA;IACP,YAAY;IACZ,2BAAe,CAAA;IACf,eAAe;IACf,iCAAqB,CAAA;AACvB,CAAC,EAjCW,QAAQ,KAAR,QAAQ,QAiCnB;AAWD,4DAA4D;AAC5D,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,WAAW;IACX,mCAAa,CAAA;AACf,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  CommunicationIdentifier,\n  CommunicationUserIdentifier,\n  MicrosoftTeamsUserIdentifier,\n  MicrosoftTeamsAppIdentifier,\n  PhoneNumberIdentifier,\n} from \"@azure/communication-common\";\nimport { CallConnectionStateModel } from \"../generated/src/index.js\";\n\nexport {\n  CallConnectionStateModel,\n  CallRejectReason,\n  KnownCallRejectReason,\n  RecognitionType,\n  ChoiceResult,\n  DtmfResult,\n  SpeechResult,\n  RecordingState,\n  Tone,\n} from \"../generated/src/models/index.js\";\n\n/** Properties of a call connection */\nexport interface CallConnectionProperties {\n  /** The call connection id. */\n  callConnectionId?: string;\n  /** The server call id. */\n  serverCallId?: string;\n  /**\n   * The source caller Id, a phone number, that's shown to the PSTN participant being invited.\n   * Required only when calling a PSTN callee.\n   */\n  sourceCallerIdNumber?: PhoneNumberIdentifier;\n  /** Display name of the call if dialing out to a pstn number. */\n  sourceDisplayName?: string;\n  /** Source identity. */\n  source?: CommunicationIdentifier;\n  /** The targets of the call. */\n  targetParticipants?: CommunicationIdentifier[];\n  /** The state of the call connection. */\n  callConnectionState?: CallConnectionStateModel;\n  /** The callback URL. */\n  callbackUrl?: string;\n  /** The correlation ID. */\n  correlationId?: string;\n  /** Identity of the answering entity. Only populated when identity is provided in the request. */\n  answeredby?: CommunicationUserIdentifier;\n  /** Identity of the original Pstn target of an incoming Call. Only populated when the original target is a Pstn number. */\n  answeredFor?: PhoneNumberIdentifier;\n}\n\n/** Contract model of an ACS call participant */\nexport interface CallParticipant {\n  /** Communication identifier of the participant */\n  identifier?: CommunicationIdentifier;\n  /** Is participant muted */\n  isMuted?: boolean;\n  /** Is participant on hold. */\n  isOnHold?: boolean;\n}\n\n/** The locator used for joining or taking action on a call. */\nexport interface CallLocator {\n  id: string;\n  kind: CallLocatorType;\n}\n\n/** Defines values for VoiceKind that the service accepts. */\nexport enum VoiceKind {\n  /** Male */\n  Male = \"male\",\n  /** Female */\n  Female = \"female\",\n}\n\n/** The PlaySource model. */\nexport interface PlaySource {\n  /** @deprecated Not in use, instead use playsourcecacheid for similar functionality*/\n  playsourcacheid?: string;\n}\n\n/** The FileSource model. */\nexport interface FileSource extends PlaySource {\n  url: string;\n  readonly kind: \"fileSource\";\n}\n\n/** The TextSource model. */\nexport interface TextSource extends PlaySource {\n  text: string;\n  sourceLocale?: string;\n  voiceKind?: VoiceKind;\n  voiceName?: string;\n  customVoiceEndpointId?: string;\n  readonly kind: \"textSource\";\n}\n\n/** The SsmlSource model. */\nexport interface SsmlSource extends PlaySource {\n  ssmlText: string;\n  customVoiceEndpointId?: string;\n  readonly kind: \"ssmlSource\";\n}\n\n/** A Dtmf Tone. */\nexport enum DtmfTone {\n  /** Zero */\n  Zero = \"zero\",\n  /** One */\n  One = \"one\",\n  /** Two */\n  Two = \"two\",\n  /** Three */\n  Three = \"three\",\n  /** Four */\n  Four = \"four\",\n  /** Five */\n  Five = \"five\",\n  /** Six */\n  Six = \"six\",\n  /** Seven */\n  Seven = \"seven\",\n  /** Eight */\n  Eight = \"eight\",\n  /** Nine */\n  Nine = \"nine\",\n  /** A */\n  A = \"a\",\n  /** B */\n  B = \"b\",\n  /** C */\n  C = \"c\",\n  /** D */\n  D = \"d\",\n  /** Pound */\n  Pound = \"pound\",\n  /** Asterisk */\n  Asterisk = \"asterisk\",\n}\n\n/** A Recognition Choice */\nexport interface RecognitionChoice {\n  /** Identifier for a given choice */\n  label: string;\n  /** List of phrases to recognize */\n  phrases: string[];\n  tone?: DtmfTone;\n}\n\n/** The type of the recognition that the service accepts. */\nexport enum RecognizeInputType {\n  /** Dtmf */\n  Dtmf = \"dtmf\",\n}\n\n/** Call invitee details. */\nexport interface CallInvite {\n  /** The Target's PhoneNumberIdentifier, CommunicationUserIdentifier, MicrosoftTeamsUserIdentifier or MicrosoftTeamsAppIdentifier. */\n  readonly targetParticipant:\n    | PhoneNumberIdentifier\n    | CommunicationUserIdentifier\n    | MicrosoftTeamsUserIdentifier\n    | MicrosoftTeamsAppIdentifier;\n  /** Caller's phone number identifier. */\n  readonly sourceCallIdNumber?: PhoneNumberIdentifier;\n  sourceDisplayName?: string;\n  /** Used by customer to send custom context to targets. */\n  customCallingContext?: CustomCallingContext;\n}\n\n/** The locator type of a call. */\nexport type CallLocatorType = \"serverCallLocator\" | \"groupCallLocator\" | \"roomCallLocator\";\n\n/** The content type of a call recording. */\nexport type RecordingContent = \"audio\" | \"audioVideo\";\n\n/** The channel type of a call recording. */\nexport type RecordingChannel = \"mixed\" | \"unmixed\";\n\n/** The format type of a call recording. */\nexport type RecordingFormat = \"mp3\" | \"mp4\" | \"wav\";\n\n/** The format type of a call recording. */\nexport type RecordingKind = \"azureCommunicationServices\" | \"teams\" | \"teamsCompliance\";\n\n/** The storage type of a call recording. */\nexport type RecordingStorageKind = \"azureCommunicationServices\" | \"azureBlobStorage\";\n\n/** Channel affinity for a participant */\nexport interface ChannelAffinity {\n  /** Channel number to which bitstream from a particular participant will be written. */\n  channel?: number;\n  /**\n   * The identifier for the participant whose bitstream will be written to the channel\n   * represented by the channel number.\n   */\n  targetParticipant: CommunicationIdentifier;\n}\n\n/** The recording storage */\nexport interface RecordingStorage {\n  /** Defines the kind of recording storage */\n  recordingStorageKind: RecordingStorageKind;\n  /** Uri of a container or a location within a container */\n  recordingDestinationContainerUrl?: string;\n}\n\ninterface CustomCallingContextHeader {\n  key: string;\n  value: string;\n}\n\n/** VOIP header. */\nexport interface VoipHeader extends CustomCallingContextHeader {\n  kind: \"voip\";\n}\n\n/** SIP User To User header. */\nexport interface SipUserToUserHeader extends CustomCallingContextHeader {\n  kind: \"sipuui\";\n}\n\n/** SIP Custom header. */\nexport interface SipCustomHeader extends CustomCallingContextHeader {\n  kind: \"sipx\";\n}\n\n/** Custom Calling Context */\nexport type CustomCallingContext = (VoipHeader | SipUserToUserHeader | SipCustomHeader)[];\n\n/** AI options for the call. */\nexport interface CallIntelligenceOptions {\n  /** The identifier of the Cognitive Service resource assigned to this call. */\n  cognitiveServicesEndpoint?: string;\n}\n"]}

package/dist/browser/models/options.d.ts

@@ -0,0 +1,315 @@
+import { PhoneNumberIdentifier, CommunicationIdentifier } from "@azure/communication-common";
+import { OperationOptions } from "@azure/core-client";
+import { CallRejectReason, FileSource, TextSource, SsmlSource, DtmfTone, RecognitionChoice, RecordingContent, RecordingChannel, RecordingFormat, RecordingStorage, CallLocator, ChannelAffinity, CallIntelligenceOptions, CustomCallingContext } from "./models.js";
+/** Options to configure the recognize operation. */
+export interface CallMediaRecognizeOptions extends OperationOptions {
+    /** The source of the audio to be played for recognition. */
+    playPrompt?: FileSource | TextSource | SsmlSource;
+    /** The list source of the audio to be played for recognition. */
+    playPrompts?: (FileSource | TextSource | SsmlSource)[];
+    /** If set recognize can barge into other existing queued-up/currently-processing requests. */
+    interruptCallMediaOperation?: boolean;
+    /** @deprecated Not in use, instead use interruptCallMediaOperation for similar functionality*/
+    stopCurrentOperations?: boolean;
+    /** The value to identify context of the operation. */
+    operationContext?: string;
+    /** Determines if we interrupt the prompt and start recognizing. */
+    interruptPrompt?: boolean;
+    /** Time to wait for first input after prompt. */
+    initialSilenceTimeoutInSeconds?: number;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+}
+/** The recognize configuration specific to Dtmf. */
+export interface CallMediaRecognizeDtmfOptions extends CallMediaRecognizeOptions {
+    /** Time to wait between DTMF inputs to stop recognizing. */
+    interToneTimeoutInSeconds?: number;
+    /** List of tones that will stop recognizing. */
+    stopDtmfTones?: DtmfTone[];
+    /** Maximum number of DTMF tones to be collected. */
+    maxTonesToCollect?: number;
+    readonly kind: "callMediaRecognizeDtmfOptions";
+}
+/** The recognize configuration specific to Choices. */
+export interface CallMediaRecognizeChoiceOptions extends CallMediaRecognizeOptions {
+    /** The IvR choices for recognize. */
+    choices: RecognitionChoice[];
+    /** Speech language to be recognized, If not set default is en-US */
+    speechLanguage?: string;
+    /** Endpoint where the custom model was deployed. */
+    speechRecognitionModelEndpointId?: string;
+    readonly kind: "callMediaRecognizeChoiceOptions";
+}
+/** The recognize configuration specific to Speech. */
+export interface CallMediaRecognizeSpeechOptions extends CallMediaRecognizeOptions {
+    /** The length of end silence when user stops speaking and cogservice send response. */
+    endSilenceTimeoutInSeconds?: number;
+    /** Speech language to be recognized, If not set default is en-US */
+    speechLanguage?: string;
+    /** Endpoint where the custom model was deployed. */
+    speechRecognitionModelEndpointId?: string;
+    readonly kind: "callMediaRecognizeSpeechOptions";
+}
+/** The recognize configuration for Speech or Dtmf  */
+export interface CallMediaRecognizeSpeechOrDtmfOptions extends CallMediaRecognizeOptions {
+    /** The length of end silence when user stops speaking and cogservice send response. */
+    endSilenceTimeoutInSeconds?: number;
+    /** Time to wait between DTMF inputs to stop recognizing. */
+    interToneTimeoutInSeconds?: number;
+    /** List of tones that will stop recognizing. */
+    stopDtmfTones?: DtmfTone[];
+    /** Maximum number of DTMF tones to be collected. */
+    maxTonesToCollect?: number;
+    /** Speech language to be recognized, If not set default is en-US */
+    speechLanguage?: string;
+    /** Endpoint where the custom model was deployed. */
+    speechRecognitionModelEndpointId?: string;
+    readonly kind: "callMediaRecognizeSpeechOrDtmfOptions";
+}
+/**
+ * Options to create a call.
+ */
+export interface CreateCallOptions extends OperationOptions {
+    /**
+     * The source caller Id, a phone number, that's shown to the PSTN participant being invited.
+     * Required only when calling a PSTN callee.
+     */
+    sourceCallIdNumber?: PhoneNumberIdentifier;
+    /** Display name of the call if dialing out to a pstn number */
+    sourceDisplayName?: string;
+    /** The operation context. */
+    operationContext?: string;
+    /** AI options for the call. */
+    callIntelligenceOptions?: CallIntelligenceOptions;
+}
+/**
+ * Options to answer a call.
+ */
+export interface AnswerCallOptions extends OperationOptions {
+    /** AI options for the call. */
+    callIntelligenceOptions?: CallIntelligenceOptions;
+    /** The operation context. */
+    operationContext?: string;
+}
+/**
+ * Options to redirect call.
+ */
+export type RedirectCallOptions = OperationOptions;
+/**
+ * Options to reject call.
+ */
+export interface RejectCallOptions extends OperationOptions {
+    /** The rejection reason. */
+    callRejectReason?: CallRejectReason;
+}
+/**
+ * Options to transfer participants.
+ */
+export interface TransferCallToParticipantOptions extends OperationOptions {
+    /** Used by customers when calling mid-call actions to correlate the request to the response event. */
+    operationContext?: string;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+    /** Transferee is the participant who is transferred away. */
+    transferee?: CommunicationIdentifier;
+    /** Used by customer to send custom context to targets. */
+    customCallingContext?: CustomCallingContext;
+    /** The source caller Id, a phone number, that's will be used as the transferor's(Contoso) caller id when transfering a call a pstn target. */
+    sourceCallIdNumber?: PhoneNumberIdentifier;
+}
+/** Options to add participants. */
+export interface AddParticipantOptions extends OperationOptions {
+    /**
+     * Gets or sets the timeout to wait for the invited participant to pickup.
+     * The maximum value of this is 180 seconds
+     */
+    invitationTimeoutInSeconds?: number;
+    /** Used by customers when calling mid-call actions to correlate the request to the response event. */
+    operationContext?: string;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+}
+/**
+ * Options to remove participants.
+ */
+export interface RemoveParticipantsOption extends OperationOptions {
+    /** Used by customers when calling mid-call actions to correlate the request to the response event. */
+    operationContext?: string;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+}
+/**
+ * Options to mute participant.
+ */
+export interface MuteParticipantOption extends OperationOptions {
+    /** Used by customers when calling mid-call actions to correlate the request to the response event. */
+    operationContext?: string;
+}
+/**
+ * Options to play audio.
+ */
+export interface PlayOptions extends OperationOptions {
+    /** Determine if it is looping */
+    loop?: boolean;
+    /** The value to identify context of the operation. */
+    operationContext?: string;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+}
+/**
+ * Options to playToAll audio.
+ */
+export interface PlayToAllOptions extends PlayOptions {
+    /** If set play can barge into other existing queued-up/currently-processing requests. */
+    interruptCallMediaOperation?: boolean;
+}
+/**
+ * Options to get call connection properties.
+ */
+export type GetCallConnectionPropertiesOptions = OperationOptions;
+/**
+ * Options to hang up the call
+ */
+export type HangUpOptions = OperationOptions;
+/**
+ * Options to get a participant.
+ */
+export type GetParticipantOptions = OperationOptions;
+/**
+ * Options to get a start a recording.
+ */
+export interface StartRecordingOptions extends OperationOptions {
+    /** The call locator. */
+    callLocator: CallLocator;
+    /** The url to send notifications to. */
+    recordingStateCallbackEndpointUrl?: string;
+    /** The content type of call recording. */
+    recordingContent?: RecordingContent;
+    /** The channel type of call recording. */
+    recordingChannel?: RecordingChannel;
+    /** The format type of call recording. */
+    recordingFormat?: RecordingFormat;
+    /** Recording storage option. */
+    recordingStorage?: RecordingStorage;
+    /** Pause on start call recording option. */
+    pauseOnStart?: boolean;
+    /**
+     * The sequential order in which audio channels are assigned to participants in the unmixed recording.
+     * When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering` is not specified,
+     * the audio channel to participant mapping will be automatically assigned based on the order in which participant
+     * first audio was detected.  Channel to participant mapping details can be found in the metadata of the recording.
+     */
+    audioChannelParticipantOrdering?: CommunicationIdentifier[];
+    /**
+     * The channel affinity of call recording
+     * When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned.
+     * Channel-Participant mapping details can be found in the metadata of the recording.
+     */
+    channelAffinity?: ChannelAffinity[];
+}
+/**
+ * Options to get a stop a recording.
+ */
+export type StopRecordingOptions = OperationOptions;
+/**
+ * Options to get a pause a recording.
+ */
+export type PauseRecordingOptions = OperationOptions;
+/**
+ * Options to get recording properties.
+ */
+export type GetRecordingPropertiesOptions = OperationOptions;
+/**
+ * Options to resume recording.
+ */
+export type ResumeRecordingOptions = OperationOptions;
+/**
+ * Options to delete recording.
+ */
+export type DeleteRecordingOptions = OperationOptions;
+/**
+ * Options to download recording.
+ */
+export interface DownloadRecordingOptions extends OperationOptions {
+    /** Offset byte to start download from. */
+    offset?: number;
+    /** Max content length in bytes. */
+    length?: number;
+}
+/**
+ * Options to continuous Dtmf recognition.
+ */
+export interface ContinuousDtmfRecognitionOptions extends OperationOptions {
+    /** The value to identify context of the operation. */
+    operationContext?: string;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+}
+/**
+ * Options to send Dtmf tones.
+ */
+export interface SendDtmfTonesOptions extends OperationOptions {
+    /** The value to identify context of the operation. */
+    operationContext?: string;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+}
+/** Options for cancelling add participant request. */
+export interface CancelAddParticipantOperationOptions extends OperationOptions {
+    /** The value to identify context of the operation. */
+    operationContext?: string;
+    /**
+     * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.
+     * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
+     */
+    operationCallbackUrl?: string;
+}
+/**
+ * Options to Connect request.
+ */
+export interface ConnectCallOptions extends OperationOptions {
+    /** Used by customers to correlate the request to the response event. */
+    operationContext?: string;
+    /** AI options for the call. */
+    callIntelligenceOptions?: CallIntelligenceOptions;
+}
+/**
+ * Options to hold participant.
+ */
+export interface HoldOptions extends OperationOptions {
+    /** A PlaySource representing the source to play. */
+    playSource?: FileSource | TextSource | SsmlSource;
+    /** Operation Context. */
+    operationContext?: string;
+    /** Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation. */
+    operationCallbackUrl?: string;
+}
+/**
+ * Options to Unhold participant.
+ */
+export interface UnholdOptions extends OperationOptions {
+    /** Operation Context. */
+    operationContext?: string;
+}
+//# sourceMappingURL=options.d.ts.map

package/dist/browser/models/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/models/options.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,aAAa,CAAC;AAErB,oDAAoD;AACpD,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE,4DAA4D;IAC5D,UAAU,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAClD,iEAAiE;IACjE,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC,EAAE,CAAC;IACvD,8FAA8F;IAC9F,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,+FAA+F;IAC/F,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mEAAmE;IACnE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iDAAiD;IACjD,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oDAAoD;AACpD,MAAM,WAAW,6BAA8B,SAAQ,yBAAyB;IAC9E,4DAA4D;IAC5D,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,gDAAgD;IAChD,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC3B,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,+BAA+B,CAAC;CAChD;AAED,uDAAuD;AACvD,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IAChF,qCAAqC;IACrC,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B,oEAAoE;IACpE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,iCAAiC,CAAC;CAClD;AAED,sDAAsD;AACtD,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IAChF,uFAAuF;IACvF,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,oEAAoE;IACpE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,iCAAiC,CAAC;CAClD;AAED,sDAAsD;AACtD,MAAM,WAAW,qCAAsC,SAAQ,yBAAyB;IACtF,uFAAuF;IACvF,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,4DAA4D;IAC5D,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,gDAAgD;IAChD,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC3B,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oEAAoE;IACpE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,uCAAuC,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6BAA6B;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+BAA+B;IAC/B,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,+BAA+B;IAC/B,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAClD,6BAA6B;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,CAAC;AACnD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,4BAA4B;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,gBAAgB;IACxE,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,6DAA6D;IAC7D,UAAU,CAAC,EAAE,uBAAuB,CAAC;IACrC,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,8IAA8I;IAC9I,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;CAC5C;AAED,mCAAmC;AACnC,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;;OAGG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACnD,iCAAiC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,yFAAyF;IACzF,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,gBAAgB,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,wBAAwB;IACxB,WAAW,EAAE,WAAW,CAAC;IACzB,wCAAwC;IACxC,iCAAiC,CAAC,EAAE,MAAM,CAAC;IAC3C,0CAA0C;IAC1C,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,0CAA0C;IAC1C,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,yCAAyC;IACzC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,gCAAgC;IAChC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,4CAA4C;IAC5C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC5D;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,gBAAgB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,gBAAgB;IACxE,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,sDAAsD;AACtD,MAAM,WAAW,oCAAqC,SAAQ,gBAAgB;IAC5E,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+BAA+B;IAC/B,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACnD,oDAAoD;IACpD,UAAU,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAClD,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kHAAkH;IAClH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B"}

package/dist/browser/models/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/models/options.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { PhoneNumberIdentifier, CommunicationIdentifier } from \"@azure/communication-common\";\nimport { OperationOptions } from \"@azure/core-client\";\nimport {\n  CallRejectReason,\n  FileSource,\n  TextSource,\n  SsmlSource,\n  DtmfTone,\n  RecognitionChoice,\n  RecordingContent,\n  RecordingChannel,\n  RecordingFormat,\n  RecordingStorage,\n  CallLocator,\n  ChannelAffinity,\n  CallIntelligenceOptions,\n  CustomCallingContext,\n} from \"./models.js\";\n\n/** Options to configure the recognize operation. */\nexport interface CallMediaRecognizeOptions extends OperationOptions {\n  /** The source of the audio to be played for recognition. */\n  playPrompt?: FileSource | TextSource | SsmlSource;\n  /** The list source of the audio to be played for recognition. */\n  playPrompts?: (FileSource | TextSource | SsmlSource)[];\n  /** If set recognize can barge into other existing queued-up/currently-processing requests. */\n  interruptCallMediaOperation?: boolean;\n  /** @deprecated Not in use, instead use interruptCallMediaOperation for similar functionality*/\n  stopCurrentOperations?: boolean;\n  /** The value to identify context of the operation. */\n  operationContext?: string;\n  /** Determines if we interrupt the prompt and start recognizing. */\n  interruptPrompt?: boolean;\n  /** Time to wait for first input after prompt. */\n  initialSilenceTimeoutInSeconds?: number;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n}\n\n/** The recognize configuration specific to Dtmf. */\nexport interface CallMediaRecognizeDtmfOptions extends CallMediaRecognizeOptions {\n  /** Time to wait between DTMF inputs to stop recognizing. */\n  interToneTimeoutInSeconds?: number;\n  /** List of tones that will stop recognizing. */\n  stopDtmfTones?: DtmfTone[];\n  /** Maximum number of DTMF tones to be collected. */\n  maxTonesToCollect?: number;\n  readonly kind: \"callMediaRecognizeDtmfOptions\";\n}\n\n/** The recognize configuration specific to Choices. */\nexport interface CallMediaRecognizeChoiceOptions extends CallMediaRecognizeOptions {\n  /** The IvR choices for recognize. */\n  choices: RecognitionChoice[];\n  /** Speech language to be recognized, If not set default is en-US */\n  speechLanguage?: string;\n  /** Endpoint where the custom model was deployed. */\n  speechRecognitionModelEndpointId?: string;\n  readonly kind: \"callMediaRecognizeChoiceOptions\";\n}\n\n/** The recognize configuration specific to Speech. */\nexport interface CallMediaRecognizeSpeechOptions extends CallMediaRecognizeOptions {\n  /** The length of end silence when user stops speaking and cogservice send response. */\n  endSilenceTimeoutInSeconds?: number;\n  /** Speech language to be recognized, If not set default is en-US */\n  speechLanguage?: string;\n  /** Endpoint where the custom model was deployed. */\n  speechRecognitionModelEndpointId?: string;\n  readonly kind: \"callMediaRecognizeSpeechOptions\";\n}\n\n/** The recognize configuration for Speech or Dtmf  */\nexport interface CallMediaRecognizeSpeechOrDtmfOptions extends CallMediaRecognizeOptions {\n  /** The length of end silence when user stops speaking and cogservice send response. */\n  endSilenceTimeoutInSeconds?: number;\n  /** Time to wait between DTMF inputs to stop recognizing. */\n  interToneTimeoutInSeconds?: number;\n  /** List of tones that will stop recognizing. */\n  stopDtmfTones?: DtmfTone[];\n  /** Maximum number of DTMF tones to be collected. */\n  maxTonesToCollect?: number;\n  /** Speech language to be recognized, If not set default is en-US */\n  speechLanguage?: string;\n  /** Endpoint where the custom model was deployed. */\n  speechRecognitionModelEndpointId?: string;\n  readonly kind: \"callMediaRecognizeSpeechOrDtmfOptions\";\n}\n\n/**\n * Options to create a call.\n */\nexport interface CreateCallOptions extends OperationOptions {\n  /**\n   * The source caller Id, a phone number, that's shown to the PSTN participant being invited.\n   * Required only when calling a PSTN callee.\n   */\n  sourceCallIdNumber?: PhoneNumberIdentifier;\n  /** Display name of the call if dialing out to a pstn number */\n  sourceDisplayName?: string;\n  /** The operation context. */\n  operationContext?: string;\n  /** AI options for the call. */\n  callIntelligenceOptions?: CallIntelligenceOptions;\n}\n\n/**\n * Options to answer a call.\n */\nexport interface AnswerCallOptions extends OperationOptions {\n  /** AI options for the call. */\n  callIntelligenceOptions?: CallIntelligenceOptions;\n  /** The operation context. */\n  operationContext?: string;\n}\n\n/**\n * Options to redirect call.\n */\nexport type RedirectCallOptions = OperationOptions;\n/**\n * Options to reject call.\n */\nexport interface RejectCallOptions extends OperationOptions {\n  /** The rejection reason. */\n  callRejectReason?: CallRejectReason;\n}\n\n/**\n * Options to transfer participants.\n */\nexport interface TransferCallToParticipantOptions extends OperationOptions {\n  /** Used by customers when calling mid-call actions to correlate the request to the response event. */\n  operationContext?: string;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n  /** Transferee is the participant who is transferred away. */\n  transferee?: CommunicationIdentifier;\n  /** Used by customer to send custom context to targets. */\n  customCallingContext?: CustomCallingContext;\n  /** The source caller Id, a phone number, that's will be used as the transferor's(Contoso) caller id when transfering a call a pstn target. */\n  sourceCallIdNumber?: PhoneNumberIdentifier;\n}\n\n/** Options to add participants. */\nexport interface AddParticipantOptions extends OperationOptions {\n  /**\n   * Gets or sets the timeout to wait for the invited participant to pickup.\n   * The maximum value of this is 180 seconds\n   */\n  invitationTimeoutInSeconds?: number;\n  /** Used by customers when calling mid-call actions to correlate the request to the response event. */\n  operationContext?: string;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n}\n\n/**\n * Options to remove participants.\n */\nexport interface RemoveParticipantsOption extends OperationOptions {\n  /** Used by customers when calling mid-call actions to correlate the request to the response event. */\n  operationContext?: string;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n}\n\n/**\n * Options to mute participant.\n */\nexport interface MuteParticipantOption extends OperationOptions {\n  /** Used by customers when calling mid-call actions to correlate the request to the response event. */\n  operationContext?: string;\n}\n\n/**\n * Options to play audio.\n */\nexport interface PlayOptions extends OperationOptions {\n  /** Determine if it is looping */\n  loop?: boolean;\n  /** The value to identify context of the operation. */\n  operationContext?: string;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n}\n\n/**\n * Options to playToAll audio.\n */\nexport interface PlayToAllOptions extends PlayOptions {\n  /** If set play can barge into other existing queued-up/currently-processing requests. */\n  interruptCallMediaOperation?: boolean;\n}\n\n/**\n * Options to get call connection properties.\n */\nexport type GetCallConnectionPropertiesOptions = OperationOptions;\n\n/**\n * Options to hang up the call\n */\nexport type HangUpOptions = OperationOptions;\n\n/**\n * Options to get a participant.\n */\nexport type GetParticipantOptions = OperationOptions;\n\n/**\n * Options to get a start a recording.\n */\nexport interface StartRecordingOptions extends OperationOptions {\n  /** The call locator. */\n  callLocator: CallLocator;\n  /** The url to send notifications to. */\n  recordingStateCallbackEndpointUrl?: string;\n  /** The content type of call recording. */\n  recordingContent?: RecordingContent;\n  /** The channel type of call recording. */\n  recordingChannel?: RecordingChannel;\n  /** The format type of call recording. */\n  recordingFormat?: RecordingFormat;\n  /** Recording storage option. */\n  recordingStorage?: RecordingStorage;\n  /** Pause on start call recording option. */\n  pauseOnStart?: boolean;\n  /**\n   * The sequential order in which audio channels are assigned to participants in the unmixed recording.\n   * When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering` is not specified,\n   * the audio channel to participant mapping will be automatically assigned based on the order in which participant\n   * first audio was detected.  Channel to participant mapping details can be found in the metadata of the recording.\n   */\n  audioChannelParticipantOrdering?: CommunicationIdentifier[];\n  /**\n   * The channel affinity of call recording\n   * When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned.\n   * Channel-Participant mapping details can be found in the metadata of the recording.\n   */\n  channelAffinity?: ChannelAffinity[];\n}\n\n/**\n * Options to get a stop a recording.\n */\nexport type StopRecordingOptions = OperationOptions;\n\n/**\n * Options to get a pause a recording.\n */\nexport type PauseRecordingOptions = OperationOptions;\n\n/**\n * Options to get recording properties.\n */\nexport type GetRecordingPropertiesOptions = OperationOptions;\n\n/**\n * Options to resume recording.\n */\nexport type ResumeRecordingOptions = OperationOptions;\n\n/**\n * Options to delete recording.\n */\nexport type DeleteRecordingOptions = OperationOptions;\n\n/**\n * Options to download recording.\n */\nexport interface DownloadRecordingOptions extends OperationOptions {\n  /** Offset byte to start download from. */\n  offset?: number;\n  /** Max content length in bytes. */\n  length?: number;\n}\n\n/**\n * Options to continuous Dtmf recognition.\n */\nexport interface ContinuousDtmfRecognitionOptions extends OperationOptions {\n  /** The value to identify context of the operation. */\n  operationContext?: string;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n}\n\n/**\n * Options to send Dtmf tones.\n */\nexport interface SendDtmfTonesOptions extends OperationOptions {\n  /** The value to identify context of the operation. */\n  operationContext?: string;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n}\n\n/** Options for cancelling add participant request. */\nexport interface CancelAddParticipantOperationOptions extends OperationOptions {\n  /** The value to identify context of the operation. */\n  operationContext?: string;\n  /**\n   * Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation.\n   * This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.\n   */\n  operationCallbackUrl?: string;\n}\n\n/**\n * Options to Connect request.\n */\nexport interface ConnectCallOptions extends OperationOptions {\n  /** Used by customers to correlate the request to the response event. */\n  operationContext?: string;\n  /** AI options for the call. */\n  callIntelligenceOptions?: CallIntelligenceOptions;\n}\n\n/**\n * Options to hold participant.\n */\nexport interface HoldOptions extends OperationOptions {\n  /** A PlaySource representing the source to play. */\n  playSource?: FileSource | TextSource | SsmlSource;\n  /** Operation Context. */\n  operationContext?: string;\n  /** Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation. */\n  operationCallbackUrl?: string;\n}\n\n/**\n * Options to Unhold participant.\n */\nexport interface UnholdOptions extends OperationOptions {\n  /** Operation Context. */\n  operationContext?: string;\n}\n"]}

package/dist/browser/models/responses.d.ts

@@ -0,0 +1,73 @@
+import { CallConnection } from "../callConnection.js";
+import { CallConnectionProperties, CallParticipant } from "./models.js";
+import { RecordingState, RecordingKind } from "../generated/src/index.js";
+/**
+ * The interface used as parent of [action]CallResult
+ */
+interface CallResult {
+    callConnectionProperties: CallConnectionProperties;
+    callConnection: CallConnection;
+}
+/**
+ * CreateCall result
+ */
+export type CreateCallResult = CallResult;
+/**
+ * AnswerCall result
+ */
+export type AnswerCallResult = CallResult;
+/** The response payload for getting participants of the call. */
+export interface ListParticipantsResult {
+    /** List of the current participants in the call. */
+    values?: CallParticipant[];
+    /** Continue of the list of participants */
+    nextLink?: string;
+}
+/** The response payload for adding participants to the call. */
+export interface AddParticipantResult {
+    /** invitation ID used to add the participant. */
+    invitationId?: string;
+    /** List of current participants in the call. */
+    participant?: CallParticipant;
+    /** The operation context provided by client. */
+    operationContext?: string;
+}
+/** The response payload for transferring the call. */
+export interface TransferCallResult {
+    /** The operation context provided by client. */
+    operationContext?: string;
+}
+/** The response payload for removing participants from the call. */
+export interface RemoveParticipantResult {
+    /** The operation context provided by client. */
+    operationContext?: string;
+}
+/** The response payload for muting participant from the call. */
+export interface MuteParticipantResult {
+    /** The operation context provided by client. */
+    operationContext?: string;
+}
+/** The response payload for starting a call recording or getting call recording state. */
+export interface RecordingStateResult {
+    recordingId: string;
+    recordingKind: RecordingKind;
+    recordingState: RecordingState;
+}
+/** The response payload for sending DTMF tones. */
+export interface SendDtmfTonesResult {
+    /** The operation context provided by client. */
+    operationContext?: string;
+}
+/** The response payload for cancelling add participant request. */
+export interface CancelAddParticipantOperationResult {
+    /** the invitation ID used to cancel the add participant request. */
+    invitationId?: string;
+    /** The operation context provided by client. */
+    operationContext?: string;
+}
+/**
+ * Connect call result
+ */
+export type ConnectCallResult = CallResult;
+export {};
+//# sourceMappingURL=responses.d.ts.map