@azure-tools/communication-recipient-verification 1.0.0-alpha.20250122.2 → 1.0.0-alpha.20250130.1

package/README.md

@@ -35,10 +35,9 @@ Once you have a key, you can authenticate the `RecipientVerificationClient` with
 
 ### Using a connection string
 
-```javascript
-const {
-  RecipientVerificationClient,
-} = require("@azure-tools/communication-recipient-verification");
+```ts snippet:ReadmeSampleCreateClient_ConnectionString
+import { RecipientVerificationClient } from "@azure-tools/communication-recipient-verification";
+
 const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
 const client = new RecipientVerificationClient(connectionString);
 ```
@@ -47,11 +46,10 @@ const client = new RecipientVerificationClient(connectionString);
 
 If you use a key to initialize the client you will also need to provide the appropriate endpoint. You can get this endpoint from your Communication Services resource in [Azure Portal][azure_portal]. Once you have a key and endpoint, you can authenticate with the following code:
 
-```javascript
-const { AzureKeyCredential } = require("@azure/core-auth");
-const {
-  RecipientVerificationClient,
-} = require("@azure-tools/communication-recipient-verification");
+```ts snippet:ReadmeSampleCreateClient_KeyCredential
+import { AzureKeyCredential } from "@azure/core-auth";
+import { RecipientVerificationClient } from "@azure-tools/communication-recipient-verification";
+
 const credential = new AzureKeyCredential("<key-from-resource>");
 const client = new RecipientVerificationClient("<endpoint-from-resource>", credential);
 ```
@@ -66,11 +64,9 @@ 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`][azure_identity_readme] provides more details and samples to get you started.
 
-```javascript
-const { DefaultAzureCredential } = require("@azure/identity");
-const {
-  RecipientVerificationClient,
-} = require("@azure-tools/communication-recipient-verification");
+```ts snippet:ReadmeSampleCreateClient_DefaultAzureCredential
+import { DefaultAzureCredential } from "@azure/identity";
+import { RecipientVerificationClient } from "@azure-tools/communication-recipient-verification";
 
 const credential = new DefaultAzureCredential();
 const client = new RecipientVerificationClient("<endpoint-from-resource>", credential);
@@ -87,90 +83,94 @@ The following sections provide code snippets that cover some of the common tasks
 
 ### Request phone number verification code
 
-```typescript
+```ts snippet:ReadmeSampleRequestVerification
+import { DefaultAzureCredential } from "@azure/identity";
 import { RecipientVerificationClient } from "@azure-tools/communication-recipient-verification";
-const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
-const client = new RecipientVerificationClient(connectionString);
 
-async function main() {
-  // body of the request
-  const VerificationRequest = {
-    identity: "+11234567890",
-    channel: "sms",
-  };
+const credential = new DefaultAzureCredential();
+const client = new RecipientVerificationClient("<endpoint-from-resource>", credential);
 
-  // get the verification status
-  const status = await client.requestVerification(VerificationRequest);
-  console.log(status);
-}
+// body of the request
+const VerificationRequest = {
+  identity: "+11234567890",
+  channel: "sms",
+};
 
-main();
+// get the verification status
+const status = await client.requestVerification(VerificationRequest);
+console.log(status);
 ```
 
 ### Verify phone number
 
-```typescript
+```ts snippet:ReadmeSampleVerifyIdentity
+import { DefaultAzureCredential } from "@azure/identity";
 import { RecipientVerificationClient } from "@azure-tools/communication-recipient-verification";
-const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
-const client = new RecipientVerificationClient(connectionString);
 
-async function main() {
-  // id that is used to reference users phone number
-  const verificationId = "7e5dd7e1-5203-41ab-960e-65c1eb804fc6";
+const credential = new DefaultAzureCredential();
+const client = new RecipientVerificationClient("<endpoint-from-resource>", credential);
 
-  // body of the request
-  const VerificationRequest = {
-    verificationCode: "1234567",
-  };
+// id that is used to reference users phone number
+const verificationId = "7e5dd7e1-5203-41ab-960e-65c1eb804fc6";
 
-  // verifying your phone number
-  const status = await client.verifyIdentity(verificationId, VerificationRequest);
-  console.log(status);
-}
+// body of the request
+const VerificationRequest = {
+  verificationCode: "1234567",
+};
 
-main();
+// verifying your phone number
+const status = await client.verifyIdentity(verificationId, VerificationRequest);
+console.log(status);
 ```
 
 ### Remove verified number
 
-```typescript
+```ts snippet:ReadmeSampleDeleteVerification
+import { DefaultAzureCredential } from "@azure/identity";
 import { RecipientVerificationClient } from "@azure-tools/communication-recipient-verification";
-const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
-const client = new RecipientVerificationClient(connectionString);
 
-async function main() {
-  // id that is used to reference users phone number
-  const verificationId = "4d313ff0-3aeb-477e-8c15-7c9a893e8999";
+const credential = new DefaultAzureCredential();
+const client = new RecipientVerificationClient("<endpoint-from-resource>", credential);
 
-  // delete verification for a resource
-  await client.deleteVerification(verificationId);
-}
+// id that is used to reference users phone number
+const verificationId = "4d313ff0-3aeb-477e-8c15-7c9a893e8999";
 
-main();
+// delete verification for a resource
+await client.deleteVerification(verificationId);
 ```
 
 ### Get verified numbers
 
-```typescript
+```ts snippet:ReadmeSampleGetVerifications
+import { DefaultAzureCredential } from "@azure/identity";
 import { RecipientVerificationClient } from "@azure-tools/communication-recipient-verification";
-const connectionString = "endpoint=<endpoint>;accessKey=<accessKey>";
-const client = new RecipientVerificationClient(connectionString);
 
-async function main() {
-  // get all verifications for a resource
-  const verifications = await client.getVerifications();
+const credential = new DefaultAzureCredential();
+const client = new RecipientVerificationClient("<endpoint-from-resource>", credential);
+
+// get all verifications for a resource
+const verifications = await client.getVerifications();
 
-  // print all verifications
-  for await (const verification of verifications) {
-    console.log(verification);
-  }
+// print all verifications
+for await (const verification of verifications) {
+  console.log(verification);
 }
-
-main();
 ```
 
 ## Troubleshooting
 
+### Logging
+
+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`:
+
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
+
 ## Next steps
 
 Please take a look at the samples directory for detailed examples on how to use this library.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/communication-recipient-verification",
-  "version": "1.0.0-alpha.20250122.2",
+  "version": "1.0.0-alpha.20250130.1",
   "description": "Test",
   "sdk-type": "client",
   "main": "./dist/commonjs/index.js",
@@ -32,7 +32,7 @@
     "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"
   },
   "files": [
     "dist/",
@@ -57,17 +57,17 @@
   "sideEffects": false,
   "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
   "dependencies": {
-    "@azure/abort-controller": "^2.0.0",
-    "@azure/communication-common": "^2.2.0",
-    "@azure/core-auth": "^1.3.0",
+    "@azure/abort-controller": "^2.1.2",
+    "@azure/communication-common": "^2.3.1",
+    "@azure/core-auth": "^1.9.0",
     "@azure/core-client": "^1.3.2",
-    "@azure/core-lro": "^2.2.0",
-    "@azure/core-paging": "^1.1.1",
-    "@azure/core-rest-pipeline": "^1.3.2",
-    "@azure/core-tracing": "^1.0.0",
-    "@azure/logger": "^1.0.0",
-    "events": "^3.0.0",
-    "tslib": "^2.2.0"
+    "@azure/core-lro": "^2.7.2",
+    "@azure/core-paging": "^1.6.2",
+    "@azure/core-rest-pipeline": "^1.18.2",
+    "@azure/core-tracing": "^1.2.0",
+    "@azure/logger": "^1.1.4",
+    "events": "^3.3.0",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@azure-tools/test-recorder": ">=4.1.0-alpha <4.1.0-alphb",
@@ -77,13 +77,13 @@
     "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
     "@azure/identity": "^4.0.1",
     "@types/node": "^18.0.0",
-    "@vitest/browser": "^2.1.4",
-    "@vitest/coverage-istanbul": "^2.1.4",
+    "@vitest/browser": "^3.0.3",
+    "@vitest/coverage-istanbul": "^3.0.3",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
     "playwright": "^1.48.2",
     "typescript": "~5.7.2",
-    "vitest": "^2.1.4"
+    "vitest": "^3.0.3"
   },
   "//metadata": {
     "constantPaths": [