@azure-rest/communication-messages 2.1.0-alpha.20250331.1 → 2.1.0-alpha.20250402.1

package/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Release History
+
+## 2.1.0-beta.2 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
+## 2.1.0-beta.1 (2025-02-11)
+
+### Features Added
+
+- Added Interactive Message.
+- Added Reaction Message.
+- Added Sticker Message.
+
+## 2.0.0 (2024-10-23)
+
+### Features Added
+
+- Added ImageNotificationContent to send image messgae.
+- Added DocumentNotificationContent to send document message.
+- Added VideoNotificationContent to send video message.
+- Added AudioNotificationContent to  send audio message.
+- Deprecated MediaNotificationContent.
+
+### Breaking Changes
+
+- MediaNotificationContent interface kind field is update with value "image_v0" from "image".
+
+## 1.0.1 (2024-03-07)
+
+Using MessagesServiceClient:
+
+- Send WhatsApp messages.
+- Get Template List.
+- Download media file from WhatsApp server for incoming media message.
+
+### Other Changes
+
+- Fixed CI pipeline to publish MS doc.
+
+## 1.0.0 (2024-02-29)
+
+### Features Added
+
+This is the initial release of the @azure-rest version of Azure Communication Messages Services.
+
+Using MessagesServiceClient:
+
+- Send WhatsApp messages.
+- Get Template List.
+- Download media file from WhatsApp server for incoming media message.

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure-rest/communication-messages",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "2.1.0-alpha.20250331.1",
+  "version": "2.1.0-alpha.20250402.1",
   "description": "Azure client library for Azure Communication Messages services",
   "keywords": [
     "node",
@@ -23,7 +23,9 @@
   "files": [
     "dist/",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "review/",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=18.0.0"

package/review/communication-messages.api.md

@@ -0,0 +1,595 @@
+## API Report File for "@azure-rest/communication-messages"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { Client } from '@azure-rest/core-client';
+import type { ClientOptions } from '@azure-rest/core-client';
+import type { ErrorResponse } from '@azure-rest/core-client';
+import type { HttpResponse } from '@azure-rest/core-client';
+import type { KeyCredential } from '@azure/core-auth';
+import type { PathUncheckedResponse } from '@azure-rest/core-client';
+import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
+import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
+import type { RequestParameters } from '@azure-rest/core-client';
+import type { StreamableMethod } from '@azure-rest/core-client';
+import type { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type ActionBindings = ActionBindingsParent | WhatsAppListActionBindings | WhatsAppButtonActionBindings | WhatsAppUrlActionBindings;
+
+// @public
+export interface ActionBindingsParent {
+    // (undocumented)
+    kind: MessageActionBindingKind;
+}
+
+// @public
+export interface ActionGroup {
+    items: Array<ActionGroupItem>;
+    title: string;
+}
+
+// @public
+export interface ActionGroupContent extends MessageContentParent {
+    groups: Array<ActionGroup>;
+    kind: "group";
+    title: string;
+}
+
+// @public
+export interface ActionGroupItem {
+    description: string;
+    id: string;
+    title: string;
+}
+
+// @public
+export interface AudioNotificationContent extends NotificationContentParent {
+    kind: "audio";
+    mediaUri: string;
+}
+
+// @public
+export interface ButtonContent {
+    id: string;
+    title: string;
+}
+
+// @public
+export interface ButtonSetContent extends MessageContentParent {
+    buttons: Array<ButtonContent>;
+    kind: "buttonSet";
+}
+
+// @public
+export type CommunicationMessageKind = string;
+
+// @public
+export type CommunicationMessagesChannelOutput = string;
+
+// @public
+function createClient(connectionString: string, options?: ClientOptions): MessagesServiceClient;
+
+// @public
+function createClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: ClientOptions): MessagesServiceClient;
+export default createClient;
+
+// @public
+export interface DocumentMessageContent extends MessageContentParent {
+    kind: "document";
+    mediaUri: string;
+}
+
+// @public
+export interface DocumentNotificationContent extends NotificationContentParent {
+    caption?: string;
+    fileName?: string;
+    kind: "document";
+    mediaUri: string;
+}
+
+// @public
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+
+// @public (undocumented)
+export interface GetMedia {
+    get(options?: GetMediaParameters): StreamableMethod<GetMedia200Response | GetMediaDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface GetMedia200Headers {
+    "content-type": "application/octet-stream";
+    "x-ms-client-request-id"?: string;
+}
+
+// @public
+export interface GetMedia200Response extends HttpResponse {
+    body: Uint8Array;
+    // (undocumented)
+    headers: RawHttpHeaders & GetMedia200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface GetMediaDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface GetMediaDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & GetMediaDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface GetMediaHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetMediaHeaders;
+}
+
+// @public (undocumented)
+export interface GetMediaHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type GetMediaParameters = GetMediaHeaderParam & RequestParameters;
+
+// @public
+export type GetPage<TPage> = (pageLink: string) => Promise<{
+    page: TPage;
+    nextPageLink?: string;
+}>;
+
+// @public
+export interface ImageMessageContent extends MessageContentParent {
+    kind: "image";
+    mediaUri: string;
+}
+
+// @public
+export interface ImageNotificationContent extends NotificationContentParent {
+    caption?: string;
+    kind: "image";
+    mediaUri: string;
+}
+
+// @public
+export interface InteractiveMessage {
+    action: ActionBindings;
+    body: TextMessageContent;
+    footer?: TextMessageContent;
+    header?: MessageContent;
+}
+
+// @public
+export interface InteractiveNotificationContent extends NotificationContentParent {
+    interactiveMessage: InteractiveMessage;
+    kind: "interactive";
+}
+
+// @public (undocumented)
+export function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response is GetMediaDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: Send202Response | SendDefaultResponse): response is SendDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response is ListTemplatesDefaultResponse;
+
+// @public
+export interface LinkContent extends MessageContentParent {
+    kind: "url";
+    title: string;
+    url: string;
+}
+
+// @public (undocumented)
+export interface ListTemplates {
+    get(options?: ListTemplatesParameters): StreamableMethod<ListTemplates200Response | ListTemplatesDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface ListTemplates200Headers {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public
+export interface ListTemplates200Response extends HttpResponse {
+    // (undocumented)
+    body: PagedMessageTemplateItemOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & ListTemplates200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface ListTemplatesDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface ListTemplatesDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & ListTemplatesDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface ListTemplatesHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & ListTemplatesHeaders;
+}
+
+// @public (undocumented)
+export interface ListTemplatesHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type ListTemplatesParameters = ListTemplatesQueryParam & ListTemplatesHeaderParam & RequestParameters;
+
+// @public (undocumented)
+export interface ListTemplatesQueryParam {
+    // (undocumented)
+    queryParameters?: ListTemplatesQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface ListTemplatesQueryParamProperties {
+    maxpagesize?: number;
+}
+
+// @public @deprecated (undocumented)
+export interface MediaNotificationContent extends NotificationContentParent {
+    content?: string;
+    kind: "image_v0";
+    mediaUri: string;
+}
+
+// @public
+export type MessageActionBindingKind = string;
+
+// @public
+export type MessageContent = MessageContentParent | TextMessageContent | DocumentMessageContent | ImageMessageContent | VideoMessageContent | ButtonSetContent | LinkContent | ActionGroupContent;
+
+// @public
+export type MessageContentKind = string;
+
+// @public
+export interface MessageContentParent {
+    // (undocumented)
+    kind: MessageContentKind;
+}
+
+// @public
+export interface MessageReceiptOutput {
+    messageId: string;
+    to: string;
+}
+
+// @public (undocumented)
+export type MessagesServiceClient = Client & {
+    path: Routes;
+};
+
+// @public
+export interface MessagesServiceClientOptions extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface MessageTemplate {
+    bindings?: MessageTemplateBindings;
+    language: string;
+    name: string;
+    values?: Array<MessageTemplateValue>;
+}
+
+// @public
+export type MessageTemplateBindings = MessageTemplateBindingsParent | WhatsAppMessageTemplateBindings;
+
+// @public
+export type MessageTemplateBindingsKind = string;
+
+// @public
+export interface MessageTemplateBindingsParent {
+    // (undocumented)
+    kind: MessageTemplateBindingsKind;
+}
+
+// @public
+export interface MessageTemplateDocument extends MessageTemplateValueParent {
+    caption?: string;
+    fileName?: string;
+    kind: "document";
+    url: string;
+}
+
+// @public
+export interface MessageTemplateImage extends MessageTemplateValueParent {
+    caption?: string;
+    fileName?: string;
+    kind: "image";
+    url: string;
+}
+
+// @public
+export type MessageTemplateItemOutput = MessageTemplateItemOutputParent | WhatsAppMessageTemplateItemOutput;
+
+// @public
+export interface MessageTemplateItemOutputParent {
+    // (undocumented)
+    kind: CommunicationMessagesChannelOutput;
+    language: string;
+    readonly name: string;
+    status: MessageTemplateStatusOutput;
+}
+
+// @public
+export interface MessageTemplateLocation extends MessageTemplateValueParent {
+    address?: string;
+    kind: "location";
+    latitude: number;
+    locationName?: string;
+    longitude: number;
+}
+
+// @public
+export interface MessageTemplateQuickAction extends MessageTemplateValueParent {
+    kind: "quickAction";
+    payload?: string;
+    text?: string;
+}
+
+// @public
+export type MessageTemplateStatusOutput = string;
+
+// @public
+export interface MessageTemplateText extends MessageTemplateValueParent {
+    kind: "text";
+    text: string;
+}
+
+// @public
+export type MessageTemplateValue = MessageTemplateValueParent | MessageTemplateText | MessageTemplateImage | MessageTemplateDocument | MessageTemplateVideo | MessageTemplateLocation | MessageTemplateQuickAction;
+
+// @public
+export type MessageTemplateValueKind = string;
+
+// @public
+export interface MessageTemplateValueParent {
+    // (undocumented)
+    kind: MessageTemplateValueKind;
+    name: string;
+}
+
+// @public
+export interface MessageTemplateVideo extends MessageTemplateValueParent {
+    caption?: string;
+    fileName?: string;
+    kind: "video";
+    url: string;
+}
+
+// @public
+export type NotificationContent = NotificationContentParent | TextNotificationContent | MediaNotificationContent | ImageNotificationContent | DocumentNotificationContent | VideoNotificationContent | AudioNotificationContent | ReactionNotificationContent | StickerNotificationContent | InteractiveNotificationContent | TemplateNotificationContent;
+
+// @public
+export interface NotificationContentParent {
+    channelRegistrationId: string;
+    // (undocumented)
+    kind: CommunicationMessageKind;
+    to: string[];
+}
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PagedMessageTemplateItemOutput {
+    nextLink?: string;
+    value: Array<MessageTemplateItemOutput>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+export function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
+
+// @public
+export type PaginateReturn<TResult> = TResult extends {
+    body: {
+        value?: infer TPage;
+    };
+} ? GetArrayType<TPage> : Array<unknown>;
+
+// @public
+export interface PagingOptions<TResponse> {
+    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+
+// @public
+export interface ReactionNotificationContent extends NotificationContentParent {
+    emoji: string;
+    kind: "reaction";
+    messageId: string;
+}
+
+// @public
+export type RepeatabilityResultOutput = "accepted" | "rejected";
+
+// @public (undocumented)
+export interface Routes {
+    (path: "/messages/streams/{id}", id: string): GetMedia;
+    (path: "/messages/notifications:send"): Send;
+    (path: "/messages/channels/{channelId}/templates", channelId: string): ListTemplates;
+}
+
+// @public (undocumented)
+export interface Send {
+    post(options: SendParameters): StreamableMethod<Send202Response | SendDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface Send202Headers {
+    "repeatability-result"?: RepeatabilityResultOutput;
+    "x-ms-client-request-id"?: string;
+}
+
+// @public
+export interface Send202Response extends HttpResponse {
+    // (undocumented)
+    body: SendMessageResultOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & Send202Headers;
+    // (undocumented)
+    status: "202";
+}
+
+// @public (undocumented)
+export interface SendBodyParam {
+    body: NotificationContent;
+}
+
+// @public (undocumented)
+export interface SendDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface SendDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & SendDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface SendHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & SendHeaders;
+}
+
+// @public (undocumented)
+export interface SendHeaders {
+    "Repeatability-First-Sent"?: string;
+    "Repeatability-Request-ID"?: string;
+    "x-ms-client-request-id"?: string;
+}
+
+// @public
+export interface SendMessageResultOutput {
+    receipts: Array<MessageReceiptOutput>;
+}
+
+// @public (undocumented)
+export type SendParameters = SendHeaderParam & SendBodyParam & RequestParameters;
+
+// @public
+export interface StickerNotificationContent extends NotificationContentParent {
+    kind: "sticker";
+    mediaUri: string;
+}
+
+// @public
+export interface TemplateNotificationContent extends NotificationContentParent {
+    kind: "template";
+    template: MessageTemplate;
+}
+
+// @public
+export interface TextMessageContent extends MessageContentParent {
+    kind: "text";
+    text: string;
+}
+
+// @public
+export interface TextNotificationContent extends NotificationContentParent {
+    content: string;
+    kind: "text";
+}
+
+// @public
+export interface VideoMessageContent extends MessageContentParent {
+    kind: "video";
+    mediaUri: string;
+}
+
+// @public
+export interface VideoNotificationContent extends NotificationContentParent {
+    caption?: string;
+    kind: "video";
+    mediaUri: string;
+}
+
+// @public
+export interface WhatsAppButtonActionBindings extends ActionBindingsParent {
+    content: ButtonSetContent;
+    kind: "whatsAppButtonAction";
+}
+
+// @public
+export interface WhatsAppListActionBindings extends ActionBindingsParent {
+    content: ActionGroupContent;
+    kind: "whatsAppListAction";
+}
+
+// @public
+export type WhatsAppMessageButtonSubType = string;
+
+// @public
+export interface WhatsAppMessageTemplateBindings extends MessageTemplateBindingsParent {
+    body?: Array<WhatsAppMessageTemplateBindingsComponent>;
+    buttons?: Array<WhatsAppMessageTemplateBindingsButton>;
+    footer?: Array<WhatsAppMessageTemplateBindingsComponent>;
+    header?: Array<WhatsAppMessageTemplateBindingsComponent>;
+    kind: "whatsApp";
+}
+
+// @public
+export interface WhatsAppMessageTemplateBindingsButton {
+    refValue: string;
+    subType: WhatsAppMessageButtonSubType;
+}
+
+// @public
+export interface WhatsAppMessageTemplateBindingsComponent {
+    refValue: string;
+}
+
+// @public
+export interface WhatsAppMessageTemplateItemOutput extends MessageTemplateItemOutputParent {
+    content?: any;
+    kind: "whatsApp";
+}
+
+// @public
+export interface WhatsAppUrlActionBindings extends ActionBindingsParent {
+    content: LinkContent;
+    kind: "whatsAppUrlAction";
+}
+
+// (No @packageDocumentation comment for this package)
+
+```