microsoft-graph 2.22.3 → 2.24.0

package/docs/api/Context-1.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / Context
+
+# Context
+
+Context of requests.
+
+## Type Aliases
+
+### Context
+
+> **Context** = `object`
+
+Defined in: [src/models/Context.ts:9](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Context.ts#L9)
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="generateaccesstoken"></a> `generateAccessToken` | [`AccessTokenGenerator`](AccessTokenGenerator.md#accesstokengenerator) | Method to generate an access token to use to authenticate the request. | [src/models/Context.ts:13](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Context.ts#L13) |

package/docs/api/ContextRef.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / ContextRef
+
+# ContextRef
+
+Reference to a context
+
+## Type Aliases
+
+### ContextRef
+
+> **ContextRef** = `object`
+
+Defined in: [src/models/ContextRef.ts:9](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/ContextRef.ts#L9)
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="context"></a> `context` | [`Context`](Context-1.md#context) | [src/models/ContextRef.ts:10](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/ContextRef.ts#L10) |

package/docs/api/DriveId.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / DriveId
+
+# DriveId
+
+Identifier for a drive.
+
+## Type Aliases
+
+### DriveId
+
+> **DriveId** = `string` & `object`
+
+Defined in: [src/models/DriveId.ts:7](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/DriveId.ts#L7)
+
+#### Type declaration
+
+##### \_\_brand
+
+> **\_\_brand**: `"DriveId"`

package/docs/api/DriveItemId.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / DriveItemId
+
+# DriveItemId
+
+Identifier for an item in a drive.
+
+## Type Aliases
+
+### DriveItemId
+
+> **DriveItemId** = `string` & `object`
+
+Defined in: [src/models/DriveItemId.ts:7](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/DriveItemId.ts#L7)
+
+#### Type declaration
+
+##### \_\_brand
+
+> **\_\_brand**: `"DriveItemId"`

package/docs/api/DriveItemPath.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / DriveItemPath
+
+# DriveItemPath
+
+Path of an item in a drive.
+
+## Type Aliases
+
+### DriveItemPath
+
+> **DriveItemPath** = `string` & `object`
+
+Defined in: [src/models/DriveItemPath.ts:7](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/DriveItemPath.ts#L7)
+
+#### Type declaration
+
+##### \_\_brand
+
+> **\_\_brand**: `"DriveItemPath"`

package/docs/api/DriveItemRef.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / DriveItemRef
+
+# DriveItemRef
+
+Reference to an item in a drive.
+
+## Type Aliases
+
+### DriveItemRef
+
+> **DriveItemRef** = [`DriveRef`](DriveRef.md#driveref) & `object`
+
+Defined in: [src/models/DriveItemRef.ts:11](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/DriveItemRef.ts#L11)
+
+#### Type declaration
+
+##### itemId
+
+> **itemId**: [`DriveItemId`](DriveItemId.md#driveitemid)

package/docs/api/DriveRef.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / DriveRef
+
+# DriveRef
+
+Reference to a drive.
+
+## Type Aliases
+
+### DriveRef
+
+> **DriveRef** = [`SiteRef`](SiteRef.md#siteref) & `object`
+
+Defined in: [src/models/DriveRef.ts:11](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/DriveRef.ts#L11)
+
+#### Type declaration
+
+##### driveId
+
+> **driveId**: [`DriveId`](DriveId.md#driveid)

package/docs/api/EnvironmentVariableMissingError.md

@@ -0,0 +1,191 @@
+[Microsoft Graph SDK](README.md) / EnvironmentVariableMissingError
+
+# EnvironmentVariableMissingError
+
+Error thrown when a required environment variable is not set, empty or whitespace.
+
+## Classes
+
+### EnvironmentVariableMissingError
+
+Defined in: [src/errors/EnvironmentVariableMissingError.ts:6](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/errors/EnvironmentVariableMissingError.ts#L6)
+
+#### Extends
+
+- [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
+
+#### Constructors
+
+##### Constructor
+
+> **new EnvironmentVariableMissingError**(`env`): [`EnvironmentVariableMissingError`](#environmentvariablemissingerror)
+
+Defined in: [src/errors/EnvironmentVariableMissingError.ts:7](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/errors/EnvironmentVariableMissingError.ts#L7)
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `env` | `string` |
+
+###### Returns
+
+[`EnvironmentVariableMissingError`](#environmentvariablemissingerror)
+
+###### Overrides
+
+`Error.constructor`
+
+#### Properties
+
+##### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+###### Inherited from
+
+`Error.cause`
+
+##### message
+
+> **message**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+###### Inherited from
+
+`Error.message`
+
+##### name
+
+> **name**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+###### Inherited from
+
+`Error.name`
+
+##### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+###### Inherited from
+
+`Error.stack`
+
+##### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/@types/node/globals.d.ts:161
+
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
+
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+###### Inherited from
+
+`Error.stackTraceLimit`
+
+#### Methods
+
+##### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/@types/node/globals.d.ts:145
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |
+
+###### Returns
+
+`void`
+
+###### Inherited from
+
+`Error.captureStackTrace`
+
+##### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: node\_modules/@types/node/globals.d.ts:149
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `err` | [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+| `stackTraces` | [`CallSite`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/4771e16937e188c0e0eca9749d208676f85fefb9/types/node/globals.d.ts#L170)[] |
+
+###### Returns
+
+`any`
+
+###### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+###### Inherited from
+
+`Error.prepareStackTrace`

package/docs/api/GraphOperation.md

@@ -0,0 +1,70 @@
+[Microsoft Graph SDK](README.md) / GraphOperation
+
+# GraphOperation
+
+An atomic operation to be performed against the Microsoft Graph API.
+
+## Type Aliases
+
+### GraphOperation\<T\>
+
+> **GraphOperation**\<`T`\> = [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`T`\> & `object`
+
+Defined in: [src/models/GraphOperation.ts:33](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L33)
+
+Instance of an operation to be performed against the Microsoft Graph API.
+
+#### Type declaration
+
+##### definition
+
+> **definition**: [`GraphOperationDefinition`](#graphoperationdefinition)\<`T`\>
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The type of the response from the operation. |
+
+***
+
+### GraphOperationDefinition\<T\>
+
+> **GraphOperationDefinition**\<`T`\> = `object`
+
+Defined in: [src/models/GraphOperation.ts:14](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L14)
+
+Definition of an operation to be performed against the Microsoft Graph API.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The type of the response from the operation. |
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="body"></a> `body` | `unknown` | JSON object or a base64 URL-encoded value, for example, when the body is an image. When a body is included with the request, the headers object must contain a value for Content-Type. | [src/models/GraphOperation.ts:24](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L24) |
+| <a id="context"></a> `context` | [`Context`](Context-1.md#context) | Context to match the operation to. Used for authentication etc. | [src/models/GraphOperation.ts:16](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L16) |
+| <a id="headers"></a> `headers` | [`HttpHeaders`](Http-1.md#httpheaders) | HTTP headers to be used. When the body is supplied, a Content-Type header must be included. | [src/models/GraphOperation.ts:22](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L22) |
+| <a id="method"></a> `method` | [`HttpMethod`](Http-1.md#httpmethod) | HTTP method to be used. | [src/models/GraphOperation.ts:18](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L18) |
+| <a id="path"></a> `path` | [`HttpPath`](Http-1.md#httppath) | Relative resource URL for the individual request. Ie, if the absolute URL is `https://graph.microsoft.com/v1.0/users`, this path is `/users`. | [src/models/GraphOperation.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L20) |
+| <a id="responsetransform"></a> `responseTransform` | (`response`) => `T` | Translate the server response into a usable model | [src/models/GraphOperation.ts:26](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L26) |
+
+***
+
+### OperationResponse\<T\>
+
+> **OperationResponse**\<`T`\> = `{ [K in keyof T]: T[K] extends GraphOperation<infer R> ? R : never }`
+
+Defined in: [src/models/GraphOperation.ts:41](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/GraphOperation.ts#L41)
+
+Response from a batch of Graph operations.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The type of the operations in the batch. |

package/docs/api/HostName.md

@@ -0,0 +1,19 @@
+[Microsoft Graph SDK](README.md) / HostName
+
+# HostName
+
+Name of a remote host, resolvable by DNS.
+
+## Type Aliases
+
+### HostName
+
+> **HostName** = `string` & `object`
+
+Defined in: [src/models/HostName.ts:6](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/HostName.ts#L6)
+
+#### Type declaration
+
+##### \_\_brand
+
+> **\_\_brand**: `"Hostname"`

package/docs/api/Http-1.md

@@ -0,0 +1,64 @@
+[Microsoft Graph SDK](README.md) / Http
+
+# Http
+
+HTTP models for handling HTTP requests and responses.
+
+## Type Aliases
+
+### HttpHeaders
+
+> **HttpHeaders** = `object`
+
+Defined in: [src/models/Http.ts:12](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Http.ts#L12)
+
+HTTP headers used in requests and responses.
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="content-type"></a> `content-type?` | `string` | [src/models/Http.ts:14](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Http.ts#L14) |
+| <a id="workbook-session-id"></a> `workbook-session-id?` | [`WorkbookSessionId`](WorkbookSessionId.md#workbooksessionid) | [src/models/Http.ts:13](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Http.ts#L13) |
+
+***
+
+### HttpMethod
+
+> **HttpMethod** = `"GET"` \| `"POST"` \| `"PUT"` \| `"PATCH"` \| `"DELETE"`
+
+Defined in: [src/models/Http.ts:18](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Http.ts#L18)
+
+HTTP methods used in requests.
+
+***
+
+### HttpPath
+
+> **HttpPath** = `string` & `object`
+
+Defined in: [src/models/Http.ts:21](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Http.ts#L21)
+
+HTTP path used in requests
+
+#### Type declaration
+
+##### \_\_brand
+
+> **\_\_brand**: `"Path"`
+
+***
+
+### HttpProxy
+
+> **HttpProxy** = `string` & `object`
+
+Defined in: [src/models/Http.ts:26](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Http.ts#L26)
+
+HTTP proxy used to route requests
+
+#### Type declaration
+
+##### \_\_brand
+
+> **\_\_brand**: `"HttpProxy"`

package/docs/api/InconsistentContextError.md

@@ -0,0 +1,191 @@
+[Microsoft Graph SDK](README.md) / InconsistentContextError
+
+# InconsistentContextError
+
+Error thrown when batched operations are performed with an inconsistent context (ie, different authentication).
+
+## Classes
+
+### InconsistentContextError
+
+Defined in: [src/errors/InconsistentContextError.ts:6](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/errors/InconsistentContextError.ts#L6)
+
+#### Extends
+
+- [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
+
+#### Constructors
+
+##### Constructor
+
+> **new InconsistentContextError**(`message`): [`InconsistentContextError`](#inconsistentcontexterror)
+
+Defined in: [src/errors/InconsistentContextError.ts:7](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/errors/InconsistentContextError.ts#L7)
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+
+###### Returns
+
+[`InconsistentContextError`](#inconsistentcontexterror)
+
+###### Overrides
+
+`Error.constructor`
+
+#### Properties
+
+##### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+###### Inherited from
+
+`Error.cause`
+
+##### message
+
+> **message**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+###### Inherited from
+
+`Error.message`
+
+##### name
+
+> **name**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+###### Inherited from
+
+`Error.name`
+
+##### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+###### Inherited from
+
+`Error.stack`
+
+##### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/@types/node/globals.d.ts:161
+
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
+
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+###### Inherited from
+
+`Error.stackTraceLimit`
+
+#### Methods
+
+##### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/@types/node/globals.d.ts:145
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |
+
+###### Returns
+
+`void`
+
+###### Inherited from
+
+`Error.captureStackTrace`
+
+##### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: node\_modules/@types/node/globals.d.ts:149
+
+###### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `err` | [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+| `stackTraces` | [`CallSite`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/4771e16937e188c0e0eca9749d208676f85fefb9/types/node/globals.d.ts#L170)[] |
+
+###### Returns
+
+`any`
+
+###### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+###### Inherited from
+
+`Error.prepareStackTrace`