microsoft-graph 2.23.0 → 2.25.0

package/docs/api/stringCaseConversion.md

@@ -0,0 +1,27 @@
+[Microsoft Graph SDK](README.md) / stringCaseConversion
+
+# stringCaseConversion
+
+Utilities for converting string case styles (e.g., kebab-case to camelCase).
+
+## Functions
+
+### kebabToCamelCase()
+
+> **kebabToCamelCase**(`str`): `string`
+
+Defined in: [src/services/stringCaseConversion.ts:12](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/stringCaseConversion.ts#L12)
+
+Converts a kebab-case string to camelCase.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `str` | `string` | The kebab-case string. |
+
+#### Returns
+
+`string`
+
+The camelCase string.

package/docs/api/tasks/setColumnHidden.md

@@ -0,0 +1,24 @@
+[Microsoft Graph SDK](../README.md) / tasks/setColumnHidden
+
+# tasks/setColumnHidden
+
+## Functions
+
+### setColumnHidden()
+
+> **setColumnHidden**(`rangeRef`, `hidden`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Defined in: [src/tasks/setColumnHidden.ts:10](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/setColumnHidden.ts#L10)
+
+Set one or more columns visibility.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) | Reference to the workbook range representing the columns to hide or show. |
+| `hidden` | `boolean` | Boolean indicating whether to hide (`true`) or show (`false`) the columns. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

package/docs/api/tasks/setRowHidden.md

@@ -0,0 +1,26 @@
+[Microsoft Graph SDK](../README.md) / tasks/setRowHidden
+
+# tasks/setRowHidden
+
+## Functions
+
+### setRowHidden()
+
+> **setRowHidden**(`rangeRef`, `hidden`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Defined in: [src/tasks/setRowHidden.ts:11](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/setRowHidden.ts#L11)
+
+Set one or more rows visibility.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) | Reference to the workbook range representing the rows to hide or show. |
+| `hidden` | `boolean` | Boolean indicating whether to hide (`true`) or show (`false`) the rows. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+The updated workbook range.

package/docs/api/tasks/setWorkbookRangeValues.md

@@ -0,0 +1,3 @@
+[Microsoft Graph SDK](../README.md) / tasks/setWorkbookRangeValues
+
+# tasks/setWorkbookRangeValues

package/docs/api/templatedPaths.md

@@ -0,0 +1,32 @@
+[Microsoft Graph SDK](README.md) / templatedPaths
+
+# templatedPaths
+
+Utilities for generating and parsing templated HTTP paths.
+
+## Functions
+
+### generatePath()
+
+> **generatePath**(`template`, `args`): [`HttpPath`](Http-1.md#httppath)
+
+Defined in: [src/services/templatedPaths.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/templatedPaths.ts#L20)
+
+Generates a HTTP path based on a template and arguments. Arguments are automatically escaped.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `template` | `string` | The path template, which must start with a slash. |
+| `args` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `unknown`\> | Record of arguments to replace placeholders in the template. |
+
+#### Returns
+
+[`HttpPath`](Http-1.md#httppath)
+
+The generated Graph API path.
+
+#### Throws
+
+BadTemplateError if the template is invalid or required arguments are missing.

package/docs/api/temporaryFiles.md

@@ -0,0 +1,27 @@
+[Microsoft Graph SDK](README.md) / temporaryFiles
+
+# temporaryFiles
+
+Utilities for generating temporary file names for use with Drive Items.
+
+## Functions
+
+### generateTempFileName()
+
+> **generateTempFileName**(`extension`): [`DriveItemPath`](DriveItem-1.md#driveitempath)
+
+Defined in: [src/services/temporaryFiles.ts:15](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/temporaryFiles.ts#L15)
+
+Generates a temporary file name with the specified extension.
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `extension` | `null` \| `string` | `"tmp"` | The file extension. Defaults to "tmp". |
+
+#### Returns
+
+[`DriveItemPath`](DriveItem-1.md#driveitempath)
+
+A temporary file name.

package/docs/api/tryCloseWorkbookSession.md

@@ -0,0 +1,31 @@
+[Microsoft Graph SDK](README.md) / tryCloseWorkbookSession
+
+# tryCloseWorkbookSession
+
+Try and close a workbook session.
+
+## Functions
+
+### tryCloseWorkbookSession()
+
+> **tryCloseWorkbookSession**(`workbookRef`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>
+
+Defined in: [src/tasks/tryCloseWorkbookSession.ts:15](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/tryCloseWorkbookSession.ts#L15)
+
+Try and close a workbook session.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | Reference to the workbook. The session ID is required. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>
+
+If the session was closed, false if it was not possible to close the session.
+
+#### Remarks
+
+Does not error if the session is already closed or expired.

package/docs/api/tryDeleteDriveItem.md

@@ -0,0 +1,31 @@
+[Microsoft Graph SDK](README.md) / tryDeleteDriveItem
+
+# tryDeleteDriveItem
+
+Attempts to delete a drive item, returning success status.
+
+## Functions
+
+### tryDeleteDriveItem()
+
+> **tryDeleteDriveItem**(`driveItemRef`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>
+
+Defined in: [src/tasks/tryDeleteDriveItem.ts:15](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/tryDeleteDriveItem.ts#L15)
+
+Attempts to delete a drive item, returning success status.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `driveItemRef` | [`DriveItemRef`](DriveItem-1.md#driveitemref) | A reference to the DriveItem to delete. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`boolean`\>
+
+Boolean indicating whether the DriveItem was successfully deleted.
+
+#### Remarks
+
+No error is thrown.

package/docs/api/unmergeWorkbookRange.md

@@ -0,0 +1,29 @@
+[Microsoft Graph SDK](README.md) / unmergeWorkbookRange
+
+# unmergeWorkbookRange
+
+Unmerge a merged range of cells in a worksheet.
+
+## Functions
+
+### unmergeWorkbookRange()
+
+> **unmergeWorkbookRange**(`rangeRef`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+Defined in: [src/operations/workbookRange/unmergeWorkbookRange.ts:18](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookRange/unmergeWorkbookRange.ts#L18)
+
+Unmerge a merged range of cells in a worksheet.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the worksheet range. * |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/range-unmerge

package/docs/api/updateWorkbookNamedRange.md

@@ -0,0 +1,34 @@
+[Microsoft Graph SDK](README.md) / updateWorkbookNamedRange
+
+# updateWorkbookNamedRange
+
+Update a named range.
+
+## Functions
+
+### updateWorkbookNamedRange()
+
+> **updateWorkbookNamedRange**(`rangeRef`, `value`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+Defined in: [src/operations/workbookRange/updateWorkbookNamedRange.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookRange/updateWorkbookNamedRange.ts#L20)
+
+Update a named range.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookNamedRangeRef`](WorkbookNamedRange.md#workbooknamedrangeref) | Reference to the named range to be updated. |
+| `value` | `WorkbookRange` | The updated properties for the named range. * |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+#### Remarks
+
+Properties that aren't included in the request maintain their previous values or are recalculated based on changes to other property values.
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/range-update

package/docs/api/updateWorkbookRange.md

@@ -0,0 +1,36 @@
+[Microsoft Graph SDK](README.md) / updateWorkbookRange
+
+# updateWorkbookRange
+
+Update a range, including values and formatting.
+
+## Functions
+
+### updateWorkbookRange()
+
+> **updateWorkbookRange**(`rangeRef`, `update`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`WorkbookRange` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object` & `object`\>
+
+Defined in: [src/operations/workbookRange/updateWorkbookRange.ts:23](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookRange/updateWorkbookRange.ts#L23)
+
+Update a range.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the range to be updated. |
+| `update` | `WorkbookRange` | The updated properties for the range. |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`WorkbookRange` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object` & `object`\>
+
+The updated range.
+
+#### Remarks
+
+Properties that aren't included in the request maintain their previous values or are recalculated based on changes to other property values.
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/range-update

package/docs/api/updateWorkbookWorksheet.md

@@ -0,0 +1,35 @@
+[Microsoft Graph SDK](README.md) / updateWorkbookWorksheet
+
+# updateWorkbookWorksheet
+
+Update the name, position, and/or visibility of a worksheet.
+
+## Functions
+
+### updateWorkbookWorksheet()
+
+> **updateWorkbookWorksheet**(`worksheetRef`, `updates`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
+
+Defined in: [src/operations/workbookWorksheet/updateWorkbookWorksheet.ts:23](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookWorksheet/updateWorkbookWorksheet.ts#L23)
+
+Update the name, position, and/or visibility of a worksheet.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `worksheetRef` | [`WorkbookWorksheetRef`](WorkbookWorksheet-1.md#workbookworksheetref) | Reference to the worksheet to be updated. |
+| `updates` | \{ `name?`: `string`; `position?`: `number`; `visibility?`: `"Visible"` \| `"Hidden"` \| `"VeryHidden"`; \} | An object containing the properties to update: - `name` (optional): The new name for the worksheet. - `position` (optional): The new position of the worksheet in the workbook. - `visibility` (optional): The visibility state of the worksheet - "Visible", "Hidden", or "VeryHidden". |
+| `updates.name?` | `string` | - |
+| `updates.position?` | `number` | - |
+| `updates.visibility?` | `"Visible"` \| `"Hidden"` \| `"VeryHidden"` | - |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
+
+The updated worksheet, including its reference information.
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/worksheet-update

package/docs/api/userSendMail.md

@@ -0,0 +1,35 @@
+[Microsoft Graph SDK](README.md) / userSendMail
+
+# userSendMail
+
+Send an email.
+
+## Functions
+
+### userSendMail()
+
+> **userSendMail**(`context`, `sender`, `message`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+Defined in: [src/operations/user/userSendMail.ts:27](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/user/userSendMail.ts#L27)
+
+Send an email.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | [`Context`](Context-1.md#context) | Reference to the context. |
+| `sender` | `null` \| `string` | The email address of the sender or NULL for the current user. Must match a valid email address in this tenant. |
+| `message` | `Message` | The email message to be sent. * |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+#### Throws
+
+InvalidArgumentError if the sender email address does not match the required pattern.
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/user-sendmail

package/docs/api/workbookRange.md

@@ -0,0 +1,28 @@
+[Microsoft Graph SDK](README.md) / workbookRange
+
+# workbookRange
+
+Utilities for working with workbook ranges and references.
+
+## Functions
+
+### createWorkbookRangeRef()
+
+> **createWorkbookRangeRef**(`worksheetRef`, `address`): [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref)
+
+Defined in: [src/services/workbookRange.ts:19](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/workbookRange.ts#L19)
+
+Creates a reference to a workbook range.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `worksheetRef` | [`WorkbookWorksheetRef`](WorkbookWorksheet-1.md#workbookworksheetref) | The reference to the worksheet containing the range. |
+| `address` | `undefined` \| [`Address`](Address.md#address) | The address of the range. |
+
+#### Returns
+
+[`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref)
+
+A reference to the workbook range.

package/docs/api/workbookTable.md

@@ -0,0 +1,32 @@
+[Microsoft Graph SDK](README.md) / workbookTable
+
+# workbookTable
+
+Utilities for creating and working with workbook table references.
+
+## Functions
+
+### createWorkbookTableRef()
+
+> **createWorkbookTableRef**(`worksheetRef`, `tableId`): [`WorkbookTableRef`](WorkbookTable-1.md#workbooktableref)
+
+Defined in: [src/services/workbookTable.ts:17](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/workbookTable.ts#L17)
+
+Creates a reference to a workbook table.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `worksheetRef` | [`WorkbookWorksheetRef`](WorkbookWorksheet-1.md#workbookworksheetref) | The reference to the worksheet containing the table. |
+| `tableId` | `undefined` \| [`WorkbookTableId`](WorkbookTable-1.md#workbooktableid) | The ID of the table. |
+
+#### Returns
+
+[`WorkbookTableRef`](WorkbookTable-1.md#workbooktableref)
+
+A reference to the workbook table.
+
+#### Throws
+
+Error if the table ID is missing.

package/docs/api/workbookTableColumn.md

@@ -0,0 +1,32 @@
+[Microsoft Graph SDK](README.md) / workbookTableColumn
+
+# workbookTableColumn
+
+Utilities for creating and working with workbook table column references.
+
+## Functions
+
+### createWorkbookTableColumnRef()
+
+> **createWorkbookTableColumnRef**(`tableRef`, `column`): [`WorkbookTableColumnRef`](WorkbookTable-1.md#workbooktablecolumnref)
+
+Defined in: [src/services/workbookTableColumn.ts:17](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/workbookTableColumn.ts#L17)
+
+Creates a reference to a workbook table column.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tableRef` | [`WorkbookTableRef`](WorkbookTable-1.md#workbooktableref) | The reference to the worksheet containing the table. |
+| `column` | `undefined` \| `string` \| [`ColumnName`](Column.md#columnname) | Name of the table column |
+
+#### Returns
+
+[`WorkbookTableColumnRef`](WorkbookTable-1.md#workbooktablecolumnref)
+
+A reference to the workbook table.
+
+#### Throws
+
+Error if the table ID is missing.

package/docs/api/workbookWorksheet.md

@@ -0,0 +1,74 @@
+[Microsoft Graph SDK](README.md) / workbookWorksheet
+
+# workbookWorksheet
+
+Utilities for creating and working with workbook worksheet references.
+
+## Variables
+
+### defaultWorkbookWorksheetId
+
+> `const` **defaultWorkbookWorksheetId**: [`WorkbookWorksheetId`](WorkbookWorksheet-1.md#workbookworksheetid)
+
+Defined in: [src/services/workbookWorksheet.ts:11](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/workbookWorksheet.ts#L11)
+
+ID of the initial worksheet that is included in a new workbook.
+
+***
+
+### defaultWorkbookWorksheetName
+
+> `const` **defaultWorkbookWorksheetName**: [`WorkbookWorksheetName`](WorkbookWorksheet-1.md#workbookworksheetname)
+
+Defined in: [src/services/workbookWorksheet.ts:14](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/workbookWorksheet.ts#L14)
+
+Name of the initial worksheet that is included in a new workbook.
+
+## Functions
+
+### createDefaultWorkbookWorksheetRef()
+
+> **createDefaultWorkbookWorksheetRef**(`workbookRef`): [`WorkbookWorksheetRef`](WorkbookWorksheet-1.md#workbookworksheetref)
+
+Defined in: [src/services/workbookWorksheet.ts:43](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/workbookWorksheet.ts#L43)
+
+Creates a reference to the default workbook worksheet that is initially included in all new workbooks.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | The reference to the workbook. |
+
+#### Returns
+
+[`WorkbookWorksheetRef`](WorkbookWorksheet-1.md#workbookworksheetref)
+
+A reference to the default workbook worksheet.
+
+***
+
+### createWorkbookWorksheetRef()
+
+> **createWorkbookWorksheetRef**(`workbookRef`, `worksheetId`): [`WorkbookWorksheetRef`](WorkbookWorksheet-1.md#workbookworksheetref)
+
+Defined in: [src/services/workbookWorksheet.ts:23](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/workbookWorksheet.ts#L23)
+
+Creates a reference to a workbook worksheet.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | The reference to the workbook. |
+| `worksheetId` | `undefined` \| [`WorkbookWorksheetId`](WorkbookWorksheet-1.md#workbookworksheetid) | The ID of the worksheet. |
+
+#### Returns
+
+[`WorkbookWorksheetRef`](WorkbookWorksheet-1.md#workbookworksheetref)
+
+A reference to the workbook worksheet.
+
+#### Throws
+
+Error if the worksheet ID is missing.

package/docs/api/writeWorkbookRows.md

@@ -0,0 +1,40 @@
+[Microsoft Graph SDK](README.md) / writeWorkbookRows
+
+# writeWorkbookRows
+
+Write rows to a workbook range.
+
+## Functions
+
+### writeWorkbookRows()
+
+> **writeWorkbookRows**(`originRef`, `rows`, `overwriteMaxRowsPerChunk`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`number`\>
+
+Defined in: [src/tasks/writeWorkbookRows.ts:30](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/writeWorkbookRows.ts#L30)
+
+Write rows to a workbook range.
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `originRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | `undefined` | The reference to the workbook range where rows will be written. Only the upper-left is used as an origin point. |
+| `rows` | [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[], `any`, `any`\> \| `AsyncIterable`\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[], `any`, `any`\> | `undefined` | An iterable or async iterable of rows to write. Each row is an array of cells. |
+| `overwriteMaxRowsPerChunk` | `null` \| `number` | `null` | Overwrite the number of rows per underlying request. DO NOT SET EXCEPT FOR ADVANCED TUNING. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`number`\>
+
+Number of rows written.
+
+#### Example
+
+```ts
+const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B3");
+await writeWorkbookRows(rangeRef, [
+  [{ value: 1 }, { value: 2 }],
+  [{ value: 3 }, { value: 4 }],
+  [{ value: 5 }, { value: 6 }],
+]);
+```

package/docs/topics/README.md

@@ -0,0 +1,14 @@
+# Microsoft Graph SDK: Topics Index
+
+This section provides in-depth guides and explanations for key concepts, workarounds, and advanced usage of the Microsoft Graph SDK in this project.
+
+## Topics
+
+- [Approach](./approach.md): Rationale for building this SDK and not using the default Microsoft Graph SDKs.
+- [Key Concepts](./concepts.md): Overview of operations, tasks, and how to use them effectively.
+- [How to Find Your SharePoint Site and Drive ID](./findingSiteDriveId.md): Step-by-step instructions for locating essential SharePoint identifiers.
+- [Workbook Calculation Consistency](./calculateWorkbook.md): Why and how to use `calculateWorkbook()` to ensure data consistency.
+- [Handling Locked Workbooks](./lockedWorkbook.md): Strategies for dealing with "resource is locked" errors.
+- [Performance](./performance.md): Tips for optimizing performance, including batching and session management.
+- [Pivot Tables](./pivotTables.md): Current limitations and workarounds for pivot table support.
+- [Request Retrying](./retrying.md): How the SDK handles Graph API throttling and automatic retries.

package/docs/topics/performance.md

@@ -0,0 +1,59 @@
+# Performance
+
+For enhanced performance with the Graph API, use the following techniques:
+
+## Workbook Sessions
+When performing more than a single operations on a workbook, there are significant performance benefits to use workbook sessions. To do this first open a session with `createWorkbookSession` and close it with `closeWorkbookSession` when done. This keeps the workbook open, reducing overhead from repeatedly opening and closing the document. Be sure to close sessions otherwise they linger for a number of minutes preventing worksheets from being deleted or moved.
+
+**Recommended pattern:**
+
+```typescript
+const workbook = await createWorkbookSession(driveItemRef);
+try {
+    // Perform multiple operations
+    const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B3");
+    await writeWorkbookRows(rangeRef, [
+        [{ value: 1 }, { value: 2 }],
+        [{ value: 3 }, { value: 4 }],
+        [{ value: 5 }, { value: 6 }],
+    ]);
+    // ...more operations
+} finally {
+    await closeWorkbookSession(workbook);
+}
+```
+
+## Batching Requests
+Batching allows up to 20 operations in a single network request. Use batching for performance, but be aware:
+- Debugging failures is harder (which operation failed?).
+- Concurrency issues may arise if multiple operations modify the same resource.
+
+### Parallel Batch
+Use `await parallel(operation1(), operation2(), ...)` for independent operations that can run at the same time.
+
+**Example:**
+```typescript
+await parallel(
+    updateWorkbookRange(rangeRef1, { values: values1 }),
+    updateWorkbookRange(rangeRef2, { values: values2 }),
+    clearWorkbookRange(rangeRef3)
+);
+```
+
+### Sequential Batch
+If order matters, use `await sequential(operation1(), operation2(), ...)`. Each operation waits for the previous one to finish.
+
+**Example:**
+```typescript
+const [updated, cleared, calculated, result] = await sequential(
+    updateWorkbookRange(rangeRef, { values }),
+    clearWorkbookRange(rangeRef),
+    calculateWorkbook(workbookRef),
+    getWorkbookRange(rangeRef)
+);
+```
+
+**Summary:**
+- Use sessions for multiple workbook operations.
+- Use batching for up to 20 operations per request.
+- Use `parallel` for independent operations, `sequential` for ordered ones.