@azure/eventgrid 5.3.0-alpha.20240403.1 → 5.4.0-alpha.20240410.3

package/types/eventgrid.d.ts

@@ -300,6 +300,142 @@ export declare interface AcsIncomingCallEventData {
     correlationId: string;
 }
 
+/**
+ * Defines values for AcsInteractiveReplyKind. \
+ * {@link KnownAcsInteractiveReplyKind} can be used interchangeably with AcsInteractiveReplyKind,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **buttonReply**: Messaged interactive reply type is ButtonReply \
+ * **listReply**: Messaged interactive reply type is ListReply \
+ * **unknown**: Messaged interactive reply type is Unknown
+ */
+export declare type AcsInteractiveReplyKind = string;
+
+/** Message Button Content */
+export declare interface AcsMessageButtonContent {
+    /** The Text of the button */
+    text: string;
+    /** The Payload of the button which was clicked by the user, setup by the business */
+    payload: string;
+}
+
+/** Message Channel Event Error */
+export declare interface AcsMessageChannelEventError {
+    /** The channel error code */
+    channelCode: string;
+    /** The channel error message */
+    channelMessage: string;
+}
+
+/**
+ * Defines values for AcsMessageChannelKind. \
+ * {@link KnownAcsMessageChannelKind} can be used interchangeably with AcsMessageChannelKind,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **whatsapp**: Updated message channel type is Whatsapp
+ */
+export declare type AcsMessageChannelKind = string;
+
+/** Message Context */
+export declare interface AcsMessageContext {
+    /** The WhatsApp ID for the customer who replied to an inbound message. */
+    from: string;
+    /** The message ID for the sent message for an inbound reply */
+    messageId: string;
+}
+
+/**
+ * Defines values for AcsMessageDeliveryStatus. \
+ * {@link KnownAcsMessageDeliveryStatus} can be used interchangeably with AcsMessageDeliveryStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **read** \
+ * **delivered** \
+ * **failed** \
+ * **sent** \
+ * **warning** \
+ * **unknown**
+ */
+export declare type AcsMessageDeliveryStatus = string;
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event. */
+export declare type AcsMessageDeliveryStatusUpdatedEventData = AcsMessageEventData & {
+    /** The message id */
+    messageId: string;
+    /** The updated message status */
+    status: AcsMessageDeliveryStatus;
+    /** The updated message channel type */
+    channelKind: AcsMessageChannelKind;
+};
+
+/** Schema of common properties of all chat thread events */
+export declare interface AcsMessageEventData {
+    /** The message sender */
+    from: string;
+    /** The message recipient */
+    to: string;
+    /** The time message was received */
+    receivedTimestamp: string;
+    /** The channel event error */
+    error: AcsMessageChannelEventError;
+}
+
+/** Message Interactive button reply content for a user to business message */
+export declare interface AcsMessageInteractiveButtonReplyContent {
+    /** The ID of the button */
+    buttonId: string;
+    /** The title of the button */
+    title: string;
+}
+
+/** Message Interactive Content */
+export declare interface AcsMessageInteractiveContent {
+    /** The Message interactive reply type */
+    replyKind: AcsInteractiveReplyKind;
+    /** The Message Sent when a customer clicks a button */
+    buttonReply: AcsMessageInteractiveButtonReplyContent;
+    /** The Message Sent when a customer selects an item from a list */
+    listReply: AcsMessageInteractiveListReplyContent;
+}
+
+/** Message Interactive list reply content for a user to business message */
+export declare interface AcsMessageInteractiveListReplyContent {
+    /** The ID of the selected list item */
+    listItemId: string;
+    /** The title of the selected list item */
+    title: string;
+    /** The sescription of the selected row */
+    description: string;
+}
+
+/** Message Media Content */
+export declare interface AcsMessageMediaContent {
+    /** The MIME type of the file this media represents */
+    mimeType: string;
+    /** The media identifier */
+    mediaId: string;
+    /** The filename of the underlying media file as specified when uploaded */
+    fileName: string;
+    /** The caption for the media object, if supported and provided */
+    caption: string;
+}
+
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event. */
+export declare type AcsMessageReceivedEventData = AcsMessageEventData & {
+    /** The received message content */
+    content: string;
+    /** The received message channel Kind */
+    channelKind: AcsMessageChannelKind;
+    /** The received message media content */
+    mediaContent: AcsMessageMediaContent;
+    /** The received message context */
+    context: AcsMessageContext;
+    /** The received message button content */
+    button: AcsMessageButtonContent;
+    /** The received message interactive content */
+    interactiveContent: AcsMessageInteractiveContent;
+};
+
 /** Schema for all properties of  Recording Chunk Information. */
 export declare interface AcsRecordingChunkInfo {
     /** The documentId of the recording chunk */
@@ -561,6 +697,20 @@ export declare interface AcsRouterQueueDetails {
     };
 }
 
+/**
+ * Defines values for AcsRouterUpdatedWorkerProperty. \
+ * {@link KnownAcsRouterUpdatedWorkerProperty} can be used interchangeably with AcsRouterUpdatedWorkerProperty,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **AvailableForOffers** \
+ * **TotalCapacity** \
+ * **QueueAssignments** \
+ * **Labels** \
+ * **Tags** \
+ * **ChannelConfigurations**
+ */
+export declare type AcsRouterUpdatedWorkerProperty = string;
+
 /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event */
 export declare type AcsRouterWorkerDeletedEventData = AcsRouterWorkerEventData & {};
 
@@ -704,6 +854,28 @@ export declare interface AcsRouterWorkerSelector {
  */
 export declare type AcsRouterWorkerSelectorState = string;
 
+/** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event */
+export declare interface AcsRouterWorkerUpdatedEventData {
+    /** Router Worker Updated Worker Id */
+    workerId: string;
+    /** Router Worker Updated Queue Info */
+    queueAssignments: AcsRouterQueueDetails[];
+    /** Router Worker Updated Channel Configuration */
+    channelConfigurations: AcsRouterChannelConfiguration[];
+    /** Router Worker Updated Total Capacity */
+    totalCapacity: number;
+    /** Router Worker Updated Labels */
+    labels: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Updated Tags */
+    tags: {
+        [propertyName: string]: string;
+    };
+    /** Router Worker Properties Updated */
+    updatedWorkerProperties: AcsRouterUpdatedWorkerProperty[];
+}
+
 /** Schema for details of a delivery attempt */
 export declare interface AcsSmsDeliveryAttempt {
     /** TimeStamp when delivery was attempted */
@@ -1181,8 +1353,10 @@ export declare interface CloudEventSendOptions extends SendOptions {
  */
 export declare type CommunicationCloudEnvironmentModel = string;
 
-/** Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set. */
+/** Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. */
 export declare interface CommunicationIdentifierModel {
+    /** The identifier kind. Only required in responses. */
+    kind?: CommunicationIdentifierModelKind;
     /** Raw Id of the identifier. Optional in requests, required in responses. */
     rawId: string;
     /** The communication user. */
@@ -1191,8 +1365,23 @@ export declare interface CommunicationIdentifierModel {
     phoneNumber?: PhoneNumberIdentifierModel;
     /** The Microsoft Teams user. */
     microsoftTeamsUser?: MicrosoftTeamsUserIdentifierModel;
+    /** The Microsoft Teams application. */
+    microsoftTeamsApp?: MicrosoftTeamsAppIdentifierModel;
 }
 
+/**
+ * Defines values for CommunicationIdentifierModelKind. \
+ * {@link KnownCommunicationIdentifierModelKind} can be used interchangeably with CommunicationIdentifierModelKind,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **unknown** \
+ * **communicationUser** \
+ * **phoneNumber** \
+ * **microsoftTeamsUser** \
+ * **microsoftTeamsApp**
+ */
+export declare type CommunicationIdentifierModelKind = string;
+
 /** A user that got created with an Azure Communication Services resource. */
 export declare interface CommunicationUserIdentifierModel {
     /** The Id of the communication user. */
@@ -2265,6 +2454,32 @@ export declare const enum KnownAcsEmailDeliveryReportStatus {
     Suppressed = "Suppressed"
 }
 
+/** Known values of {@link AcsInteractiveReplyKind} that the service accepts. */
+export declare const enum KnownAcsInteractiveReplyKind {
+    /** Messaged interactive reply type is ButtonReply */
+    ButtonReply = "buttonReply",
+    /** Messaged interactive reply type is ListReply */
+    ListReply = "listReply",
+    /** Messaged interactive reply type is Unknown */
+    Unknown = "unknown"
+}
+
+/** Known values of {@link AcsMessageChannelKind} that the service accepts. */
+export declare const enum KnownAcsMessageChannelKind {
+    /** Updated message channel type is Whatsapp */
+    Whatsapp = "whatsapp"
+}
+
+/** Known values of {@link AcsMessageDeliveryStatus} that the service accepts. */
+export declare const enum KnownAcsMessageDeliveryStatus {
+    Read = "read",
+    Delivered = "delivered",
+    Failed = "failed",
+    Sent = "sent",
+    Warning = "warning",
+    Unknown = "unknown"
+}
+
 /** Known values of {@link AcsRouterJobStatus} that the service accepts. */
 export declare const enum KnownAcsRouterJobStatus {
     PendingClassification = "PendingClassification",
@@ -2297,6 +2512,16 @@ export declare const enum KnownAcsRouterLabelOperator {
     LessThanOrEqual = "LessThanOrEqual"
 }
 
+/** Known values of {@link AcsRouterUpdatedWorkerProperty} that the service accepts. */
+export declare const enum KnownAcsRouterUpdatedWorkerProperty {
+    AvailableForOffers = "AvailableForOffers",
+    TotalCapacity = "TotalCapacity",
+    QueueAssignments = "QueueAssignments",
+    Labels = "Labels",
+    Tags = "Tags",
+    ChannelConfigurations = "ChannelConfigurations"
+}
+
 /** Known values of {@link AcsRouterWorkerSelectorState} that the service accepts. */
 export declare const enum KnownAcsRouterWorkerSelectorState {
     /** Router Job Worker Selector is Active */
@@ -2350,6 +2575,15 @@ export declare const enum KnownCommunicationCloudEnvironmentModel {
     Gcch = "gcch"
 }
 
+/** Known values of {@link CommunicationIdentifierModelKind} that the service accepts. */
+export declare const enum KnownCommunicationIdentifierModelKind {
+    Unknown = "unknown",
+    CommunicationUser = "communicationUser",
+    PhoneNumber = "phoneNumber",
+    MicrosoftTeamsUser = "microsoftTeamsUser",
+    MicrosoftTeamsApp = "microsoftTeamsApp"
+}
+
 /** Known values of {@link DataBoxStageName} that the service accepts. */
 export declare const enum KnownDataBoxStageName {
     /** Copy has started */
@@ -3416,6 +3650,14 @@ export declare interface MediaLiveEventTrackDiscontinuityDetectedEventData {
     readonly discontinuityGap: string;
 }
 
+/** A Microsoft Teams application. */
+export declare interface MicrosoftTeamsAppIdentifierModel {
+    /** The Id of the Microsoft Teams application. */
+    appId: string;
+    /** The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. */
+    cloud?: CommunicationCloudEnvironmentModel;
+}
+
 /** A Microsoft Teams user. */
 export declare interface MicrosoftTeamsUserIdentifierModel {
     /** The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. */
@@ -4702,6 +4944,12 @@ export declare interface SystemEventNameToEventData {
     "Microsoft.ApiCenter.ApiDefinitionAdded": ApiCenterApiDefinitionAddedEventData;
     /** An interface for the event data of a "Microsoft.ApiCenter.ApiDefinitionUpdated" event. */
     "Microsoft.ApiCenter.ApiDefinitionUpdated": ApiCenterApiDefinitionUpdatedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated" event. */
+    "Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated": AcsMessageDeliveryStatusUpdatedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.AdvancedMessageReceived" event. */
+    "Microsoft.Communication.AdvancedMessageReceived": AcsMessageReceivedEventData;
+    /** An interface for the event data of a "Microsoft.Communication.RouterWorkerUpdated" event. */
+    "Microsoft.Communication.RouterWorkerUpdated": AcsRouterWorkerUpdatedEventData;
 }
 
 /** Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event. */