@azure-rest/purview-sharing 1.0.0-alpha.20250220.1 → 1.0.0-alpha.20250224.2

package/README.md

@@ -44,14 +44,85 @@ can be used to authenticate the client.
 Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
 AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
 
+Use the returned token credential to authenticate the client:
+
+```ts snippet:ReadmeSampleCreateClient_Node
+import PurviewSharingClient from "@azure-rest/purview-sharing";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = PurviewSharingClient(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
+```
+
+## Examples
+
+The following sections provide several code snippets covering some of the most common Purview Sharing scenarios, including:
+
+- Get Recipient for a Given Sent Share
+
+```ts snippet:ReadmeSampleGetRecipientForAGivenSentShare
+import PurviewSharingClient, { isUnexpected, paginate } from "@azure-rest/purview-sharing";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = PurviewSharingClient(
+  "https://<my-account-name>.purview.azure.com",
+  new DefaultAzureCredential(),
+);
+
+const storageAccountResourceId = "<storage-account-resource-id>";
+const options = {
+  queryParameters: {
+    referenceName: storageAccountResourceId,
+  },
+};
+const initialResponse = await client.path("/sentShares").get(options);
+if (isUnexpected(initialResponse)) {
+  throw initialResponse.body.error;
+}
+
+const pageData = paginate(client, initialResponse);
+for await (const sharedInvitationOutput of pageData) {
+  const sharedInvitationId = sharedInvitationOutput.id;
+  if (sharedInvitationId) {
+    const sentShareResponse = await client
+      .path("/sentShares/{sentShareId}", sharedInvitationId)
+      .get();
+
+    if (isUnexpected(sentShareResponse)) {
+      throw sentShareResponse.body.error;
+    }
+
+    const sentShareId = sentShareResponse.body.id;
+    if (sentShareId) {
+      const sentShareRecipientResponse = await client
+        .path(
+          "/sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}",
+          sentShareId,
+          sharedInvitationId,
+        )
+        .get();
+
+      if (isUnexpected(sentShareRecipientResponse)) {
+        throw sentShareRecipientResponse.body.error;
+      }
+
+      const sentShareRecipientId = sentShareRecipientResponse.body.id;
+      console.log(`Sent Share Recipient Id: ${sentShareRecipientId}`);
+    }
+  }
+}
+```
+
 ## 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
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/dist/commonjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.50.0"
+      "packageVersion": "7.50.1"
     }
   ]
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure-rest/purview-sharing",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "1.0.0-alpha.20250220.1",
+  "version": "1.0.0-alpha.20250224.2",
   "description": "A generated SDK for PurviewSharing.",
   "keywords": [
     "node",
@@ -53,7 +53,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"
   },
   "sideEffects": false,
   "autoPublish": false,
@@ -62,7 +62,7 @@
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-auth": "^1.9.0",
     "@azure/core-lro": "^3.0.0",
-    "@azure/core-rest-pipeline": "^1.18.0",
+    "@azure/core-rest-pipeline": "^1.19.0",
     "@azure/logger": "^1.1.4",
     "tslib": "^2.8.1"
   },
@@ -72,16 +72,16 @@
     "@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.5.0",
+    "@azure/identity": "^4.7.0",
     "@types/node": "^18.0.0",
-    "@vitest/browser": "^3.0.3",
-    "@vitest/coverage-istanbul": "^3.0.3",
+    "@vitest/browser": "^3.0.6",
+    "@vitest/coverage-istanbul": "^3.0.6",
     "autorest": "latest",
     "dotenv": "^16.0.3",
     "eslint": "^9.9.0",
-    "playwright": "^1.49.0",
+    "playwright": "^1.50.1",
     "typescript": "~5.7.2",
-    "vitest": "^3.0.3"
+    "vitest": "^3.0.6"
   },
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-sharing-rest/README.md",
   "//metadata": {
@@ -106,6 +106,7 @@
   },
   "type": "module",
   "tshy": {
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts"
@@ -118,8 +119,7 @@
       "browser",
       "react-native"
     ],
-    "selfLink": false,
-    "project": "./tsconfig.src.json"
+    "selfLink": false
   },
   "exports": {
     "./package.json": "./package.json",
@@ -141,5 +141,6 @@
         "default": "./dist/commonjs/index.js"
       }
     }
-  }
+  },
+  "react-native": "./dist/react-native/index.js"
 }