@azure-rest/communication-messages 2.0.1-alpha.20241216.1 → 2.0.1-alpha.20241219.1

package/README.md

@@ -36,7 +36,7 @@ You can get a key and/or connection string from your Communication Services reso
 import MessageClient, { MessagesServiceClient } from "@azure-rest/communication-messages";
 
 const connectionString = `endpoint=https://<resource-name>.communication.azure.com/;accessKey=<Base64-Encoded-Key>`;
-const client:MessagesServiceClient = MessageClient(connectionString);
+const client: MessagesServiceClient = MessageClient(connectionString);
 ```
 
 ### Using `AzureKeyCredential`
@@ -47,7 +47,7 @@ import MessageClient, { MessagesServiceClient } from "@azure-rest/communication-
 
 const endpoint = "https://<resource-name>.communication.azure.com";
 const credential = new AzureKeyCredential("<Base64-Encoded-Key>");
-const client:MessagesServiceClient = MessageClient(endpoint, credential);
+const client: MessagesServiceClient = MessageClient(endpoint, credential);
 ```
 
 ### Using Azure Active Directory managed identity
@@ -67,87 +67,87 @@ import MessageClient, { MessagesServiceClient } from "@azure-rest/communication-
 
 const endpoint = "https://<resource-name>.communication.azure.com";
 const credential = new DefaultAzureCredential();
-const client:MessagesServiceClient = MessageClient(endpoint, credential);
+const client: MessagesServiceClient = MessageClient(endpoint, credential);
 ```
 
 ## Send a Template Message with WhatsApp Channel
 
 `Note: Business always starts the conversation with a template message.`
 
-To send an Template Message, you need add template to your WhatsApp Bussiness Account. For more detail on WhatsApp Template, refer [Create and Manage Templates][create-manage-whatsapp-template]. In below example, we are using 
+To send an Template Message, you need add template to your WhatsApp Bussiness Account. For more detail on WhatsApp Template, refer [Create and Manage Templates][create-manage-whatsapp-template]. In below example, we are using
 
 ```
  Template Name: sample_issue_resolution
  Template Language: en_US
 
  Template Body: "Hi {{1}}, were we able to solve the issue that you were facing?"
- 
+
  With Quick Action Button (Yes, No)
 
 ```
 
 ```typescript
-const nameValue:MessageTemplateValue = {
-        kind: "text",
-        name: "name",
-        text: "Arif"
-    };
-
-    const yesAction: MessageTemplateValue = {
-        kind: "quickAction",
-        name: "Yes",
-        payload: "Yes"
-    };
-
-    const noAction: MessageTemplateValue = {
-        kind: "quickAction",
-        name: "No",
-        payload: "No"
-    };
-
-    const templateBindings:MessageTemplateBindings = {
-        kind: "whatsApp",
-        body: [
-            {
-                refValue: "name"
-            }
-        ],
-        buttons: [
-            {
-                subType: "quickReply",
-                refValue: "Yes"
-            },
-            {
-                subType: "quickReply",
-                refValue: "No"
-            }
-        ]
-    };
-
-    const template:MessageTemplate = {
-        name: "sample_issue_resolution",
-        language: "en_US",
-        bindings: templateBindings,
-        values: [nameValue, yesAction, noAction]
-    };
-
-    const  result = await client.path("/messages/notifications:send").post({
-        contentType: "application/json",
-        body: {
-            channelRegistrationId: "<Channel_Registration_Id>",
-            to: ["<to-phone-number-1>"],
-            kind: "template",
-            template: template
-        }
-    });
-    if (result.status === "202") {
-        const response:Send202Response = result as Send202Response;
-        response.body.receipts.forEach((receipt) => {
-            console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
-        });
-    } else {
-        throw new Error("Failed to send message");
-    }
+const nameValue: MessageTemplateValue = {
+  kind: "text",
+  name: "name",
+  text: "Arif",
+};
+
+const yesAction: MessageTemplateValue = {
+  kind: "quickAction",
+  name: "Yes",
+  payload: "Yes",
+};
+
+const noAction: MessageTemplateValue = {
+  kind: "quickAction",
+  name: "No",
+  payload: "No",
+};
+
+const templateBindings: MessageTemplateBindings = {
+  kind: "whatsApp",
+  body: [
+    {
+      refValue: "name",
+    },
+  ],
+  buttons: [
+    {
+      subType: "quickReply",
+      refValue: "Yes",
+    },
+    {
+      subType: "quickReply",
+      refValue: "No",
+    },
+  ],
+};
+
+const template: MessageTemplate = {
+  name: "sample_issue_resolution",
+  language: "en_US",
+  bindings: templateBindings,
+  values: [nameValue, yesAction, noAction],
+};
+
+const result = await client.path("/messages/notifications:send").post({
+  contentType: "application/json",
+  body: {
+    channelRegistrationId: "<Channel_Registration_Id>",
+    to: ["<to-phone-number-1>"],
+    kind: "template",
+    template: template,
+  },
+});
+if (result.status === "202") {
+  const response: Send202Response = result as Send202Response;
+  response.body.receipts.forEach((receipt) => {
+    console.log("Message sent to:" + receipt.to + " with message id:" + receipt.messageId);
+  });
+} else {
+  throw new Error("Failed to send message");
+}
 ```
 
 ## Send a Text Message with WhatsApp Channel
@@ -155,24 +155,24 @@ const nameValue:MessageTemplateValue = {
 `Note: Business can't start a conversation with a text message. It needs to be user initiated.`
 
 ```typescript
-const  result = await client.path("/messages/notifications:send").post({
-        contentType: "application/json",
-        body: {
-            channelRegistrationId: "<Channel_Registration_Id>",
-            to: ["<to-phone-number-1>"],
-            kind: "text",
-            content: "Hello World!!"
-        }
-    });
-
- if (result.status === "202") {
-        const response:Send202Response = result as Send202Response;
-        response.body.receipts.forEach((receipt) => {
-            console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
-        });
-    } else {
-        throw new Error("Failed to send message");
-    }
+const result = await client.path("/messages/notifications:send").post({
+  contentType: "application/json",
+  body: {
+    channelRegistrationId: "<Channel_Registration_Id>",
+    to: ["<to-phone-number-1>"],
+    kind: "text",
+    content: "Hello World!!",
+  },
+});
+
+if (result.status === "202") {
+  const response: Send202Response = result as Send202Response;
+  response.body.receipts.forEach((receipt) => {
+    console.log("Message sent to:" + receipt.to + " with message id:" + receipt.messageId);
+  });
+} else {
+  throw new Error("Failed to send message");
+}
 ```
 
 ## Send a Media Message with WhatsApp Channel
@@ -180,27 +180,26 @@ const  result = await client.path("/messages/notifications:send").post({
 `Note: Business can't start a conversation with a media message. It needs to be user initiated.`
 
 ```typescript
-const  result = await client.path("/messages/notifications:send").post({
-        contentType: "application/json",
-        body: {
-            channelRegistrationId: "<Channel_Registration_Id>",
-            to: ["<to-phone-number-1>"],
-            kind: "image",
-            mediaUri: "https://<your-media-image-file>"
-        }
-    });
-
- if (result.status === "202") {
-        const response:Send202Response = result as Send202Response;
-        response.body.receipts.forEach((receipt) => {
-            console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
-        });
-    } else {
-        throw new Error("Failed to send message");
-    }
+const result = await client.path("/messages/notifications:send").post({
+  contentType: "application/json",
+  body: {
+    channelRegistrationId: "<Channel_Registration_Id>",
+    to: ["<to-phone-number-1>"],
+    kind: "image",
+    mediaUri: "https://<your-media-image-file>",
+  },
+});
+
+if (result.status === "202") {
+  const response: Send202Response = result as Send202Response;
+  response.body.receipts.forEach((receipt) => {
+    console.log("Message sent to:" + receipt.to + " with message id:" + receipt.messageId);
+  });
+} else {
+  throw new Error("Failed to send message");
+}
 ```
 
-
 ## Troubleshooting
 
 ### Logging
@@ -223,19 +222,18 @@ Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/bl
 
 If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
 
-
 ## Related projects
 
 - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
 
-[azure_cli]: https://docs.microsoft.com/cli/azure
+[azure_cli]: https://learn.microsoft.com/cli/azure
 [azure_sub]: https://azure.microsoft.com/free/
 [azure_portal]: https://portal.azure.com
-[azure_powershell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
+[azure_powershell]: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
 [defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
 [azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
 [azure_communication_messaging_qs]: https://learn.microsoft.com/azure/communication-services/concepts/advanced-messaging/whatsapp/whatsapp-overview
 [register_whatsapp_business_account]: https://learn.microsoft.com/azure/communication-services/quickstarts/advanced-messaging/whatsapp/connect-whatsapp-business-account
 [create-manage-whatsapp-template]: https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcommunication%2Fcommunication-sms%2FREADME.png)
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcommunication%2Fcommunication-sms%2FREADME.png)

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure-rest/communication-messages",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "2.0.1-alpha.20241216.1",
+  "version": "2.0.1-alpha.20241219.1",
   "description": "Azure client library for Azure Communication Messages services",
   "keywords": [
     "node",
@@ -82,7 +82,7 @@
     "eslint": "^9.9.0",
     "karma-source-map-support": "~1.4.0",
     "playwright": "^1.48.2",
-    "typescript": "~5.6.2",
+    "typescript": "~5.7.2",
     "vitest": "^2.1.5"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-messages-rest-rest/README.md",