@azure-rest/communication-messages 2.0.1-alpha.20250122.2 → 2.0.1-alpha.20250127.1

package/README.md

@@ -32,22 +32,22 @@ You can get a key and/or connection string from your Communication Services reso
 
 ### Using a connection string
 
-```typescript
-import MessageClient, { MessagesServiceClient } from "@azure-rest/communication-messages";
+```ts snippet:ReadmeSampleCreateClient_ConnectionString
+import MessageClient 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 = MessageClient(connectionString);
 ```
 
 ### Using `AzureKeyCredential`
 
-```typescript
+```ts snippet:ReadmeSampleCreateClient_KeyCredential
 import { AzureKeyCredential } from "@azure/core-auth";
-import MessageClient, { MessagesServiceClient } from "@azure-rest/communication-messages";
+import MessageClient from "@azure-rest/communication-messages";
 
 const endpoint = "https://<resource-name>.communication.azure.com";
 const credential = new AzureKeyCredential("<Base64-Encoded-Key>");
-const client: MessagesServiceClient = MessageClient(endpoint, credential);
+const client = MessageClient(endpoint, credential);
 ```
 
 ### Using Azure Active Directory managed identity
@@ -61,13 +61,13 @@ npm install @azure/identity
 The [`@azure/identity`][azure_identity] package provides a variety of credential types that your application can use to do this. The README for @azure/identity provides more details and samples to get you started.
 AZURE_CLIENT_SECRET, AZURE_CLIENT_ID and AZURE_TENANT_ID environment variables are needed to create a DefaultAzureCredential object.
 
-```typescript
+```ts snippet:ReadmeSampleCreateClient_DefaultAzureCredential
 import { DefaultAzureCredential } from "@azure/identity";
-import MessageClient, { MessagesServiceClient } from "@azure-rest/communication-messages";
+import MessageClient from "@azure-rest/communication-messages";
 
 const endpoint = "https://<resource-name>.communication.azure.com";
 const credential = new DefaultAzureCredential();
-const client: MessagesServiceClient = MessageClient(endpoint, credential);
+const client = MessageClient(endpoint, credential);
 ```
 
 ## Send a Template Message with WhatsApp Channel
@@ -86,26 +86,33 @@ To send an Template Message, you need add template to your WhatsApp Bussiness Ac
 
 ```
 
-```typescript
-const nameValue: MessageTemplateValue = {
+```ts snippet:ReadmeSampleSendTemplateMessage
+import { DefaultAzureCredential } from "@azure/identity";
+import MessageClient, { isUnexpected } from "@azure-rest/communication-messages";
+
+const endpoint = "https://<resource-name>.communication.azure.com";
+const credential = new DefaultAzureCredential();
+const client = MessageClient(endpoint, credential);
+
+const nameValue = {
   kind: "text",
   name: "name",
   text: "Arif",
 };
 
-const yesAction: MessageTemplateValue = {
+const yesAction = {
   kind: "quickAction",
   name: "Yes",
   payload: "Yes",
 };
 
-const noAction: MessageTemplateValue = {
+const noAction = {
   kind: "quickAction",
   name: "No",
   payload: "No",
 };
 
-const templateBindings: MessageTemplateBindings = {
+const templateBindings = {
   kind: "whatsApp",
   body: [
     {
@@ -124,7 +131,7 @@ const templateBindings: MessageTemplateBindings = {
   ],
 };
 
-const template: MessageTemplate = {
+const template = {
   name: "sample_issue_resolution",
   language: "en_US",
   bindings: templateBindings,
@@ -140,13 +147,11 @@ const result = await client.path("/messages/notifications:send").post({
     template: template,
   },
 });
-if (result.status === "202") {
-  const response: Send202Response = result as Send202Response;
-  response.body.receipts.forEach((receipt) => {
+
+if (!isUnexpected(result)) {
+  result.body.receipts.forEach((receipt) => {
     console.log("Message sent to:" + receipt.to + " with message id:" + receipt.messageId);
   });
-} else {
-  throw new Error("Failed to send message");
 }
 ```
 
@@ -154,7 +159,14 @@ if (result.status === "202") {
 
 `Note: Business can't start a conversation with a text message. It needs to be user initiated.`
 
-```typescript
+```ts snippet:ReadmeSampleSendTextMessage
+import { DefaultAzureCredential } from "@azure/identity";
+import MessageClient, { isUnexpected } from "@azure-rest/communication-messages";
+
+const endpoint = "https://<resource-name>.communication.azure.com";
+const credential = new DefaultAzureCredential();
+const client = MessageClient(endpoint, credential);
+
 const result = await client.path("/messages/notifications:send").post({
   contentType: "application/json",
   body: {
@@ -165,13 +177,10 @@ const result = await client.path("/messages/notifications:send").post({
   },
 });
 
-if (result.status === "202") {
-  const response: Send202Response = result as Send202Response;
-  response.body.receipts.forEach((receipt) => {
+if (!isUnexpected(result)) {
+  result.body.receipts.forEach((receipt) => {
     console.log("Message sent to:" + receipt.to + " with message id:" + receipt.messageId);
   });
-} else {
-  throw new Error("Failed to send message");
 }
 ```
 
@@ -179,7 +188,14 @@ if (result.status === "202") {
 
 `Note: Business can't start a conversation with a media message. It needs to be user initiated.`
 
-```typescript
+```ts snippet:ReadmeSampleSendMediaMessage
+import { DefaultAzureCredential } from "@azure/identity";
+import MessageClient, { isUnexpected } from "@azure-rest/communication-messages";
+
+const endpoint = "https://<resource-name>.communication.azure.com";
+const credential = new DefaultAzureCredential();
+const client = MessageClient(endpoint, credential);
+
 const result = await client.path("/messages/notifications:send").post({
   contentType: "application/json",
   body: {
@@ -190,13 +206,10 @@ const result = await client.path("/messages/notifications:send").post({
   },
 });
 
-if (result.status === "202") {
-  const response: Send202Response = result as Send202Response;
-  response.body.receipts.forEach((receipt) => {
+if (!isUnexpected(result)) {
+  result.body.receipts.forEach((receipt) => {
     console.log("Message sent to:" + receipt.to + " with message id:" + receipt.messageId);
   });
-} else {
-  throw new Error("Failed to send message");
 }
 ```
 
@@ -206,8 +219,8 @@ if (result.status === "202") {
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure-rest/communication-messages",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "2.0.1-alpha.20250122.2",
+  "version": "2.0.1-alpha.20250127.1",
   "description": "Azure client library for Azure Communication Messages services",
   "keywords": [
     "node",
@@ -38,7 +38,7 @@
     "check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\"  \"test/**/*.ts\"",
     "clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
     "execute:samples": "echo skipped",
-    "extract-api": "dev-tool run vendored rimraf review && dev-tool run vendored mkdirp ./review && dev-tool run extract-api",
+    "extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
     "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\"  \"test/**/*.ts\"",
     "generate:client": "echo skipped",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
@@ -53,19 +53,19 @@
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser",
     "unit-test:node": "dev-tool run test:vitest",
-    "update-snippets": "echo skipped"
+    "update-snippets": "dev-tool run update-snippets"
   },
   "sideEffects": false,
   "autoPublish": false,
   "dependencies": {
-    "@azure-rest/core-client": "^2.3.1",
+    "@azure-rest/core-client": "^2.3.2",
     "@azure/communication-common": "^2.3.1",
-    "@azure/core-auth": "^1.6.0",
-    "@azure/core-paging": "^1.5.0",
-    "@azure/core-rest-pipeline": "^1.12.0",
-    "@azure/core-util": "^1.7.0",
-    "@azure/logger": "^1.0.0",
-    "tslib": "^2.2.0"
+    "@azure/core-auth": "^1.9.0",
+    "@azure/core-paging": "^1.6.2",
+    "@azure/core-rest-pipeline": "^1.18.2",
+    "@azure/core-util": "^1.11.0",
+    "@azure/logger": "^1.1.4",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@azure-tools/test-credential": "^2.0.0",
@@ -73,17 +73,17 @@
     "@azure-tools/test-utils-vitest": ">=1.0.0-alpha <1.0.0-alphb",
     "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
     "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
-    "@azure/identity": "^4.2.1",
+    "@azure/identity": "^4.5.0",
     "@types/node": "^18.0.0",
-    "@vitest/browser": "^2.1.5",
-    "@vitest/coverage-istanbul": "^2.1.5",
+    "@vitest/browser": "^3.0.3",
+    "@vitest/coverage-istanbul": "^3.0.3",
     "autorest": "latest",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
     "karma-source-map-support": "~1.4.0",
     "playwright": "^1.48.2",
     "typescript": "~5.7.2",
-    "vitest": "^2.1.5"
+    "vitest": "^3.0.3"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-messages-rest-rest/README.md",
   "//metadata": {