microsoft-graph 3.6.0 → 3.7.0

package/dist/cjs/tasks/tryGetWorkbookWorksheetByName.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Attempts to retrieve a worksheet by its name, returning null if not found.
+ * @module tryGetWorkbookWorksheetByName
+ * @category Tasks
+ */
+import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
+import type { WorkbookRef } from "../models/Workbook.ts";
+import type { WorkbookWorksheetName, WorkbookWorksheetRef } from "../models/WorkbookWorksheet.ts";
+/**
+ * Attempts to retrieve a worksheet by its name.
+ * Returns null if the worksheet does not exist (NotFoundError).
+ * @param workbookRef Reference to the workbook containing the worksheet.
+ * @param name The name of the worksheet to retrieve.
+ * @returns The worksheet, or null if not found.
+ */
+export default function tryGetWorkbookWorksheetByName(workbookRef: WorkbookRef, name: WorkbookWorksheetName): Promise<(WorkbookWorksheet & WorkbookWorksheetRef) | null>;
+//# sourceMappingURL=tryGetWorkbookWorksheetByName.d.ts.map

package/dist/cjs/tasks/tryGetWorkbookWorksheetByName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tryGetWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../../src/tasks/tryGetWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAIlG;;;;;;GAMG;AACH,wBAA8B,6BAA6B,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAS7K"}

package/dist/cjs/tasks/tryGetWorkbookWorksheetByName.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = tryGetWorkbookWorksheetByName;
+const getWorkbookWorksheetByName_ts_1 = __importDefault(require("../operations/workbookWorksheet/getWorkbookWorksheetByName.js"));
+const error_ts_1 = require("../services/error.js");
+/**
+ * Attempts to retrieve a worksheet by its name.
+ * Returns null if the worksheet does not exist (NotFoundError).
+ * @param workbookRef Reference to the workbook containing the worksheet.
+ * @param name The name of the worksheet to retrieve.
+ * @returns The worksheet, or null if not found.
+ */
+async function tryGetWorkbookWorksheetByName(workbookRef, name) {
+    try {
+        return await (0, getWorkbookWorksheetByName_ts_1.default)(workbookRef, name);
+    }
+    catch (error) {
+        if ((0, error_ts_1.isErrorWithName)(error, "NotFoundError")) {
+            return null;
+        }
+        throw error;
+    }
+}

package/dist/esm/tasks/tryGetWorkbookWorksheetByName.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Attempts to retrieve a worksheet by its name, returning null if not found.
+ * @module tryGetWorkbookWorksheetByName
+ * @category Tasks
+ */
+import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
+import type { WorkbookRef } from "../models/Workbook.ts";
+import type { WorkbookWorksheetName, WorkbookWorksheetRef } from "../models/WorkbookWorksheet.ts";
+/**
+ * Attempts to retrieve a worksheet by its name.
+ * Returns null if the worksheet does not exist (NotFoundError).
+ * @param workbookRef Reference to the workbook containing the worksheet.
+ * @param name The name of the worksheet to retrieve.
+ * @returns The worksheet, or null if not found.
+ */
+export default function tryGetWorkbookWorksheetByName(workbookRef: WorkbookRef, name: WorkbookWorksheetName): Promise<(WorkbookWorksheet & WorkbookWorksheetRef) | null>;
+//# sourceMappingURL=tryGetWorkbookWorksheetByName.d.ts.map

package/dist/esm/tasks/tryGetWorkbookWorksheetByName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tryGetWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../../src/tasks/tryGetWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAIlG;;;;;;GAMG;AACH,wBAA8B,6BAA6B,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAS7K"}

package/dist/esm/tasks/tryGetWorkbookWorksheetByName.js

@@ -0,0 +1,20 @@
+import getWorkbookWorksheetByName from "../operations/workbookWorksheet/getWorkbookWorksheetByName.js";
+import { isErrorWithName } from "../services/error.js";
+/**
+ * Attempts to retrieve a worksheet by its name.
+ * Returns null if the worksheet does not exist (NotFoundError).
+ * @param workbookRef Reference to the workbook containing the worksheet.
+ * @param name The name of the worksheet to retrieve.
+ * @returns The worksheet, or null if not found.
+ */
+export default async function tryGetWorkbookWorksheetByName(workbookRef, name) {
+    try {
+        return await getWorkbookWorksheetByName(workbookRef, name);
+    }
+    catch (error) {
+        if (isErrorWithName(error, "NotFoundError")) {
+            return null;
+        }
+        throw error;
+    }
+}

package/docs/api/README.md

@@ -205,6 +205,7 @@
 | [tryCloseWorkbookSession](tryCloseWorkbookSession.md) | Try and close a workbook session. |
 | [tryDeleteDriveItem](tryDeleteDriveItem.md) | Attempts to delete a drive item, returning success status. |
 | [tryGetDriveItemByPath](tryGetDriveItemByPath.md) | Attempts to retrieve the metadata for an item in a drive by file path, returning null if the item does not exist. |
+| [tryGetWorkbookWorksheetByName](tryGetWorkbookWorksheetByName.md) | Attempts to retrieve a worksheet by its name, returning null if not found. |
 | [updateWorkbookRangeFirstRow](updateWorkbookRangeFirstRow.md) | Update first row in a given workbook range. |
 | [updateWorkbookRangeRows](updateWorkbookRangeRows.md) | Update rows in a given workbook range. |
 | [writeWorkbookRows](writeWorkbookRows.md) | Write rows to a workbook range. |

package/docs/api/tryGetWorkbookWorksheetByName.md

@@ -0,0 +1,29 @@
+[Microsoft Graph SDK](README.md) / tryGetWorkbookWorksheetByName
+
+# tryGetWorkbookWorksheetByName
+
+Attempts to retrieve a worksheet by its name, returning null if not found.
+
+## Functions
+
+### tryGetWorkbookWorksheetByName()
+
+> **tryGetWorkbookWorksheetByName**(`workbookRef`, `name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`null` \| `WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
+
+Defined in: [src/tasks/tryGetWorkbookWorksheetByName.ts:19](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/tryGetWorkbookWorksheetByName.ts#L19)
+
+Attempts to retrieve a worksheet by its name.
+Returns null if the worksheet does not exist (NotFoundError).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | Reference to the workbook containing the worksheet. |
+| `name` | [`WorkbookWorksheetName`](WorkbookWorksheet-1.md#workbookworksheetname) | The name of the worksheet to retrieve. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`null` \| `WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
+
+The worksheet, or null if not found.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "microsoft-graph",
-	"version": "3.6.0",
+	"version": "3.7.0",
 	"description": "Microsoft GraphAPI SDK for NodeJS",
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
@@ -1892,6 +1892,16 @@
 			"require": "./dist/cjs/tasks/tryGetDriveItemByPath.js",
 			"types": "./dist/esm/tasks/tryGetDriveItemByPath.d.ts"
 		},
+		"./tryGetWorkbookWorksheetByName": {
+			"import": "./dist/esm/tasks/tryGetWorkbookWorksheetByName.js",
+			"require": "./dist/cjs/tasks/tryGetWorkbookWorksheetByName.js",
+			"types": "./dist/esm/tasks/tryGetWorkbookWorksheetByName.d.ts"
+		},
+		"./dist/cjs/tasks/tryGetWorkbookWorksheetByName": {
+			"import": "./dist/esm/tasks/tryGetWorkbookWorksheetByName.js",
+			"require": "./dist/cjs/tasks/tryGetWorkbookWorksheetByName.js",
+			"types": "./dist/esm/tasks/tryGetWorkbookWorksheetByName.d.ts"
+		},
 		"./tryGetWorkbookWorksheetUsedRangeRef": {
 			"import": "./dist/esm/tasks/tryGetWorkbookWorksheetUsedRangeRef.js",
 			"require": "./dist/cjs/tasks/tryGetWorkbookWorksheetUsedRangeRef.js",