microsoft-graph 2.23.0 → 2.25.0

package/docs/api/operationId.md

@@ -0,0 +1,49 @@
+[Microsoft Graph SDK](README.md) / operationId
+
+# operationId
+
+Utilities for converting between operation IDs and indexes.
+
+## Functions
+
+### operationIdToIndex()
+
+> **operationIdToIndex**(`id`): `number`
+
+Defined in: [src/services/operationId.ts:21](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationId.ts#L21)
+
+Converts an operation ID to an operation index.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The operation ID as a string. |
+
+#### Returns
+
+`number`
+
+The operation index as a number.
+
+***
+
+### operationIndexToId()
+
+> **operationIndexToId**(`index`): `string`
+
+Defined in: [src/services/operationId.ts:12](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationId.ts#L12)
+
+Converts an operation index to an operation ID.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `index` | `number` | The operation index. |
+
+#### Returns
+
+`string`
+
+The operation ID as a string.

package/docs/api/operationInvoker.md

@@ -0,0 +1,91 @@
+[Microsoft Graph SDK](README.md) / operationInvoker
+
+# operationInvoker
+
+Invoke operations, potentially as parallel or sequential batches.
+
+## Functions
+
+### operation()
+
+> **operation**\<`T`\>(`definition`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`T`\>
+
+Defined in: [src/services/operationInvoker.ts:36](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L36)
+
+Define a operation.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `definition` | [`GraphOperationDefinition`](GraphOperation.md#graphoperationdefinition)\<`T`\> |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`T`\>
+
+#### Remarks
+
+Operations can be `await`d to execute independently, or passed with others as arguments to `parallel` or `sequential` to execute as part of a batch.
+
+***
+
+### parallel()
+
+> **parallel**\<`T`\>(...`operations`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
+
+Defined in: [src/services/operationInvoker.ts:50](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L50)
+
+Execute a batch of GraphAPI operations in parallel.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`GraphOperation`](GraphOperation.md#graphoperation)\<`unknown`\>[] |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`operations` | `T` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
+
+#### Remarks
+
+Provides the best performance for batch operations, however only useful if operations can logically be performed at the same time.
+
+***
+
+### sequential()
+
+> **sequential**\<`T`\>(...`operations`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
+
+Defined in: [src/services/operationInvoker.ts:59](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L59)
+
+Execute a batch of GraphAPI operations sequentially.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* [`GraphOperation`](GraphOperation.md#graphoperation)\<`unknown`\>[] |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`operations` | `T` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>

package/docs/api/random.md

@@ -0,0 +1,27 @@
+[Microsoft Graph SDK](README.md) / random
+
+# random
+
+Utilities for generating random values for spreadsheet and API operations.
+
+## Functions
+
+### generateRandomString()
+
+> **generateRandomString**(`length`): `string`
+
+Defined in: [src/services/random.ts:16](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/random.ts#L16)
+
+Generates a random alphanumeric string of the specified length.
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `length` | `number` | `16` | The length of the string to generate. Defaults to 16. |
+
+#### Returns
+
+`string`
+
+A random alphanumeric string.

package/docs/api/rangeManipulation.md

@@ -0,0 +1,108 @@
+[Microsoft Graph SDK](README.md) / rangeManipulation
+
+# rangeManipulation
+
+Utilities for inferring and manipulating spreadsheet ranges and objects.
+
+## Functions
+
+### inferObjectRange()
+
+> **inferObjectRange**(`objs`, `header`): [`CellValue`](Cell.md#cellvalue-1)[][]
+
+Defined in: [src/services/rangeManipulation.ts:120](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/rangeManipulation.ts#L120)
+
+Converts an array of objects into a 2D array of cell values.
+The first row of the 2D array contains the keys as headers.
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `objs` | `unknown`[] | `undefined` | Array of objects to convert. |
+| `header` | `null` \| `string`[] | `null` | Optional header row. If not provided, it will be inferred from the object keys. |
+
+#### Returns
+
+[`CellValue`](Cell.md#cellvalue-1)[][]
+
+A 2D array where the first row is the header and subsequent rows are the object values.
+
+***
+
+### inferRangeAddress()
+
+> **inferRangeAddress**(`values`, `rowOffset?`, `columnOffset?`): [`Address`](Address.md#address)
+
+Defined in: [src/services/rangeManipulation.ts:23](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/rangeManipulation.ts#L23)
+
+Converts a 2D array of cell values into range address in the upper left.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `values` | [`CellValue`](Cell.md#cellvalue-1)[][] | A 2D array representing cell values. |
+| `rowOffset?` | [`RowOffset`](Row.md#rowoffset) | The row offset to apply to the range address. |
+| `columnOffset?` | [`ColumnOffset`](Column.md#columnoffset) | The column offset to apply to the range address. |
+
+#### Returns
+
+[`Address`](Address.md#address)
+
+The default cell range address (e.g., "A1:C3").
+
+#### Throws
+
+If rows have inconsistent column counts.
+
+***
+
+### inferRangeObject()
+
+> **inferRangeObject**(`values`): `unknown`[]
+
+Defined in: [src/services/rangeManipulation.ts:90](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/rangeManipulation.ts#L90)
+
+Converts a 2D array of cell values into an array of objects.
+Assumes the first row is a header and uses it as keys for the objects.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `values` | [`CellValue`](Cell.md#cellvalue-1)[][] | A 2D array representing cell values. |
+
+#### Returns
+
+`unknown`[]
+
+Array of objects where each object represents a row.
+
+#### Throws
+
+If rows have inconsistent column counts or no header row is present.
+
+***
+
+### inferRowAddress()
+
+> **inferRowAddress**(`row`, `rowOffset?`, `columnOffset?`): [`Address`](Address.md#address)
+
+Defined in: [src/services/rangeManipulation.ts:63](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/rangeManipulation.ts#L63)
+
+Converts a 2D array of cell values into a row address in the upper left.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `row` | [`CellValue`](Cell.md#cellvalue-1)[] | A single row of cell values. |
+| `rowOffset?` | [`RowOffset`](Row.md#rowoffset) | The row offset to apply to the address. |
+| `columnOffset?` | [`ColumnOffset`](Column.md#columnoffset) | The column offset to apply to the address. |
+
+#### Returns
+
+[`Address`](Address.md#address)
+
+The default cell range address for the row (e.g., "A1").

package/docs/api/readWorkbookRows.md

@@ -0,0 +1,32 @@
+[Microsoft Graph SDK](README.md) / readWorkbookRows
+
+# readWorkbookRows
+
+Iterates over the rows in a given worksheet range.
+
+## Functions
+
+### readWorkbookRows()
+
+> **readWorkbookRows**(`rangeRef`, `overwriteMaxRowsPerChunk`): `AsyncIterable`\<[`Row`](Row.md#row)\>
+
+Defined in: [src/tasks/readWorkbookRows.ts:25](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/readWorkbookRows.ts#L25)
+
+Iterates over the rows in a given worksheet range.
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | `undefined` | Reference to the workbook range to iterate over. |
+| `overwriteMaxRowsPerChunk` | `null` \| `number` | `null` | Overwrite the number of rows per underlying request. DO NOT SET EXCEPT FOR ADVANCED TUNING. |
+
+#### Returns
+
+`AsyncIterable`\<[`Row`](Row.md#row)\>
+
+An async iterable that yields rows of range values.
+
+#### Throws
+
+[InvalidArgumentError](InvalidArgumentError.md) If `overwriteMaxRowsPerChunk` is set to a value less than 1.

package/docs/api/refreshWorkbookSession.md

@@ -0,0 +1,33 @@
+[Microsoft Graph SDK](README.md) / refreshWorkbookSession
+
+# refreshWorkbookSession
+
+Refresh a workbook session.
+
+## Functions
+
+### refreshWorkbookSession()
+
+> **refreshWorkbookSession**(`workbookRef`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+Defined in: [src/operations/workbookSession/refreshWorkbookSession.ts:19](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookSession/refreshWorkbookSession.ts#L19)
+
+Refresh a workbook session.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | Reference to the workbook. * |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+#### Throws
+
+[InvalidArgumentError](InvalidArgumentError.md) if the session ID is not provided.
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/workbook-refreshsession

package/docs/api/safeDeleteWorkbook.md

@@ -0,0 +1,31 @@
+[Microsoft Graph SDK](README.md) / safeDeleteWorkbook
+
+# safeDeleteWorkbook
+
+Safely delete a workbook by first closing any open sessions and then deleting it.
+
+## Functions
+
+### safeDeleteWorkbook()
+
+> **safeDeleteWorkbook**(`workbookRef`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Defined in: [src/tasks/safeDeleteWorkbook.ts:18](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/safeDeleteWorkbook.ts#L18)
+
+Safely delete a workbook by first closing any open sessions and then deleting it.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | Reference to the workbook to be deleted. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Void when the workbook is successfully deleted.
+
+#### See
+
+https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md

package/docs/api/searchSites.md

@@ -0,0 +1,32 @@
+[Microsoft Graph SDK](README.md) / searchSites
+
+# searchSites
+
+Find accessible sites that match the provided keywords.
+
+## Functions
+
+### searchSites()
+
+> **searchSites**(`contextRef`, `search`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`Site` & [`SiteRef`](Site-1.md#siteref)[]\>
+
+Defined in: [src/operations/site/searchSites.ts:22](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/site/searchSites.ts#L22)
+
+Find accessible sites that match the provided keywords.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `contextRef` | [`ContextRef`](Context-1.md#contextref) | Reference to the context. |
+| `search` | `string` | Search keywords to find matching sites. |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`Site` & [`SiteRef`](Site-1.md#siteref)[]\>
+
+Array of sites that match the search criteria, each including its metadata and reference information.
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/site-search

package/docs/api/setWorkbookRangeFill.md

@@ -0,0 +1,30 @@
+[Microsoft Graph SDK](README.md) / setWorkbookRangeFill
+
+# setWorkbookRangeFill
+
+Update the fill format of a workbook range.
+
+## Functions
+
+### setWorkbookRangeFill()
+
+> **setWorkbookRangeFill**(`rangeRef`, `format`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+Defined in: [src/operations/workbookRange/setWorkbookRangeFill.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookRange/setWorkbookRangeFill.ts#L20)
+
+Update the fill format of a workbook range.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the range to be formatted. |
+| `format` | `WorkbookRangeFill` | Fill format properties to apply to the range. |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/rangefill-update

package/docs/api/setWorkbookRangeFont.md

@@ -0,0 +1,30 @@
+[Microsoft Graph SDK](README.md) / setWorkbookRangeFont
+
+# setWorkbookRangeFont
+
+Update the font format of a workbook range.
+
+## Functions
+
+### setWorkbookRangeFont()
+
+> **setWorkbookRangeFont**(`rangeRef`, `format`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+Defined in: [src/operations/workbookRange/setWorkbookRangeFont.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookRange/setWorkbookRangeFont.ts#L20)
+
+Update the font format of a workbook range.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the range to be formatted. |
+| `format` | `WorkbookRangeFont` | Font format properties to apply to the range. |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/rangefont-update

package/docs/api/setWorkbookRangeFormat.md

@@ -0,0 +1,30 @@
+[Microsoft Graph SDK](README.md) / setWorkbookRangeFormat
+
+# setWorkbookRangeFormat
+
+Update the general format of a workbook range.
+
+## Functions
+
+### setWorkbookRangeFormat()
+
+> **setWorkbookRangeFormat**(`rangeRef`, `format`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+Defined in: [src/operations/workbookRange/setWorkbookRangeFormat.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookRange/setWorkbookRangeFormat.ts#L20)
+
+Update the general format of a workbook range.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the range to be formatted. |
+| `format` | `WorkbookRangeFormat` | General format properties to apply to the range. |
+
+#### Returns
+
+[`GraphOperation`](GraphOperation.md#graphoperation)\<`void`\>
+
+#### See
+
+https://learn.microsoft.com/en-us/graph/api/rangeformat-update

package/docs/api/setWorkbookTableBodyVisibleRows.md

@@ -0,0 +1,35 @@
+[Microsoft Graph SDK](README.md) / setWorkbookTableBodyVisibleRows
+
+# setWorkbookTableBodyVisibleRows
+
+Set visible rows of a workbook table with the provided 2D array of values, ignoring hidden rows and inserting new rows at the end if needed.
+
+## Functions
+
+### setWorkbookTableBodyVisibleRows()
+
+> **setWorkbookTableBodyVisibleRows**(`tableRef`, `values`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Defined in: [src/tasks/setWorkbookTableBodyVisibleRows.ts:25](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/setWorkbookTableBodyVisibleRows.ts#L25)
+
+Set visible rows of a workbook table with the provided 2D array of values, ignoring hidden rows and inserting new rows at the end if needed.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tableRef` | [`WorkbookTableRef`](WorkbookTable-1.md#workbooktableref) | Reference to the workbook table. |
+| `values` | `string`[][] | 2D array of strings representing the values to set in the visible rows of the table. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Throws
+
+[InvalidArgumentError](InvalidArgumentError.md) If the number of columns in any row of `values` does not match the table's column count.
+ *
+
+#### Remarks
+
+THIS FUNCTION IS SLOW, as it must check each row's visibility.

package/docs/api/sharepointUrl.md

@@ -0,0 +1,43 @@
+[Microsoft Graph SDK](README.md) / sharepointUrl
+
+# sharepointUrl
+
+Utilities for parsing and extracting information from SharePoint URLs.
+
+## Functions
+
+### parseSharepointUrl()
+
+> **parseSharepointUrl**(`url`): `object`
+
+Defined in: [src/services/sharepointUrl.ts:18](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sharepointUrl.ts#L18)
+
+Parses a SharePoint document URL to extract the site name, host name, and item ID.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `url` | [`URL`](https://developer.mozilla.org/docs/Web/API/URL) | The SharePoint document URL. |
+
+#### Returns
+
+`object`
+
+An object containing the host name, site name, and item ID.
+
+##### hostName
+
+> **hostName**: [`HostName`](HostName.md#hostname)
+
+##### itemId
+
+> **itemId**: [`DriveItemId`](DriveItem-1.md#driveitemid)
+
+##### siteName
+
+> **siteName**: [`SiteName`](Site-1.md#sitename)
+
+#### Throws
+
+InvalidArgumentError if the URL is invalid or required components are missing.

package/docs/api/site.md

@@ -0,0 +1,52 @@
+[Microsoft Graph SDK](README.md) / site
+
+# site
+
+Utilities for working with Microsoft Graph Site references and operations.
+
+## Functions
+
+### createSiteRef()
+
+> **createSiteRef**(`contextRef`, `siteId`): [`SiteRef`](Site-1.md#siteref)
+
+Defined in: [src/services/site.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/site.ts#L20)
+
+Creates a reference to a site.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `contextRef` | [`ContextRef`](Context-1.md#contextref) | The reference to the context. |
+| `siteId` | `undefined` \| [`SiteId`](Site-1.md#siteid) | The ID of the site. |
+
+#### Returns
+
+[`SiteRef`](Site-1.md#siteref)
+
+A reference to the site.
+
+#### Throws
+
+ProtocolError if the site ID is missing.
+
+***
+
+### getDefaultSiteRef()
+
+> **getDefaultSiteRef**(): [`SiteRef`](Site-1.md#siteref)
+
+Defined in: [src/services/site.ts:36](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/site.ts#L36)
+
+Retrieves the opinionated default site reference. NOT RECOMMENDED FOR PRODUCTION USE
+
+#### Returns
+
+[`SiteRef`](Site-1.md#siteref)
+
+A reference to the default site.
+
+#### Remarks
+
+This method is opinionated and not recommended for production use.

package/docs/api/sleep.md

@@ -0,0 +1,27 @@
+[Microsoft Graph SDK](README.md) / sleep
+
+# sleep
+
+Utility for pausing execution (sleep) in async workflows.
+
+## Functions
+
+### sleep()
+
+> **sleep**(`ms`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Defined in: [src/services/sleep.ts:12](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sleep.ts#L12)
+
+Pauses execution for the specified number of milliseconds.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `ms` | `number` | Number of milliseconds to sleep. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+A promise that resolves after the specified time.