@microsoft/msgraph-sdk-users 1.0.0-preview.54 → 1.0.0-preview.55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/users/index.d.ts CHANGED
@@ -37,30 +37,30 @@ export interface UsersRequestBuilder extends BaseRequestBuilder<UsersRequestBuil
37
37
  */
38
38
  byUserId(userId: string): UserItemRequestBuilder;
39
39
  /**
40
- * Retrieve a list of user objects.
40
+ * List properties and relationships of the user objects.
41
41
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
42
42
  * @returns {Promise<UserCollectionResponse>}
43
43
  * @throws {ODataError} error when the service returns a 4XX or 5XX status code
44
- * @see {@link https://learn.microsoft.com/graph/api/user-list?view=graph-rest-1.0|Find more info here}
44
+ * @see {@link https://learn.microsoft.com/graph/api/intune-mam-user-list?view=graph-rest-1.0|Find more info here}
45
45
  */
46
46
  get(requestConfiguration?: RequestConfiguration<UsersRequestBuilderGetQueryParameters> | undefined): Promise<UserCollectionResponse | undefined>;
47
47
  /**
48
- * Create a new user object.
48
+ * Create a new user.The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties.
49
49
  * @param body The request body
50
50
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
51
51
  * @returns {Promise<User>}
52
52
  * @throws {ODataError} error when the service returns a 4XX or 5XX status code
53
- * @see {@link https://learn.microsoft.com/graph/api/intune-mam-user-create?view=graph-rest-1.0|Find more info here}
53
+ * @see {@link https://learn.microsoft.com/graph/api/user-post-users?view=graph-rest-1.0|Find more info here}
54
54
  */
55
55
  post(body: User, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<User | undefined>;
56
56
  /**
57
- * Retrieve a list of user objects.
57
+ * List properties and relationships of the user objects.
58
58
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
59
59
  * @returns {RequestInformation}
60
60
  */
61
61
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<UsersRequestBuilderGetQueryParameters> | undefined): RequestInformation;
62
62
  /**
63
- * Create a new user object.
63
+ * Create a new user.The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties.
64
64
  * @param body The request body
65
65
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
66
66
  * @returns {RequestInformation}
@@ -68,7 +68,7 @@ export interface UsersRequestBuilder extends BaseRequestBuilder<UsersRequestBuil
68
68
  toPostRequestInformation(body: User, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
69
69
  }
70
70
  /**
71
- * Retrieve a list of user objects.
71
+ * List properties and relationships of the user objects.
72
72
  */
73
73
  export interface UsersRequestBuilderGetQueryParameters {
74
74
  /**
@@ -391,11 +391,11 @@ export interface UserItemRequestBuilder extends BaseRequestBuilder<UserItemReque
391
391
  */
392
392
  exportDeviceAndAppManagementDataWithSkipWithTop(skip: number | undefined, top: number | undefined): ExportDeviceAndAppManagementDataWithSkipWithTopRequestBuilder;
393
393
  /**
394
- * Read properties and relationships of the user object.
394
+ * Retrieve the properties and relationships of user object. This operation returns by default only a subset of the more commonly used properties for each user. These default properties are noted in the Properties section. To get properties that are not returned by default, do a GET operation for the user and specify the properties in a $select OData query option. Because the user resource supports extensions, you can also use the GET operation to get custom properties and extension data in a user instance. Customers through Microsoft Entra ID for customers can also use this API operation to retrieve their details.
395
395
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
396
396
  * @returns {Promise<User>}
397
397
  * @throws {ODataError} error when the service returns a 4XX or 5XX status code
398
- * @see {@link https://learn.microsoft.com/graph/api/intune-mam-user-get?view=graph-rest-1.0|Find more info here}
398
+ * @see {@link https://learn.microsoft.com/graph/api/user-get?view=graph-rest-1.0|Find more info here}
399
399
  */
400
400
  get(requestConfiguration?: RequestConfiguration<UserItemRequestBuilderGetQueryParameters> | undefined): Promise<User | undefined>;
401
401
  /**
@@ -404,7 +404,7 @@ export interface UserItemRequestBuilder extends BaseRequestBuilder<UserItemReque
404
404
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
405
405
  * @returns {Promise<User>}
406
406
  * @throws {ODataError} error when the service returns a 4XX or 5XX status code
407
- * @see {@link https://learn.microsoft.com/graph/api/intune-mam-user-update?view=graph-rest-1.0|Find more info here}
407
+ * @see {@link https://learn.microsoft.com/graph/api/user-update?view=graph-rest-1.0|Find more info here}
408
408
  */
409
409
  patch(body: User, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<User | undefined>;
410
410
  /**
@@ -421,7 +421,7 @@ export interface UserItemRequestBuilder extends BaseRequestBuilder<UserItemReque
421
421
  */
422
422
  toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
423
423
  /**
424
- * Read properties and relationships of the user object.
424
+ * Retrieve the properties and relationships of user object. This operation returns by default only a subset of the more commonly used properties for each user. These default properties are noted in the Properties section. To get properties that are not returned by default, do a GET operation for the user and specify the properties in a $select OData query option. Because the user resource supports extensions, you can also use the GET operation to get custom properties and extension data in a user instance. Customers through Microsoft Entra ID for customers can also use this API operation to retrieve their details.
425
425
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
426
426
  * @returns {RequestInformation}
427
427
  */
@@ -435,7 +435,7 @@ export interface UserItemRequestBuilder extends BaseRequestBuilder<UserItemReque
435
435
  toPatchRequestInformation(body: User, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
436
436
  }
437
437
  /**
438
- * Read properties and relationships of the user object.
438
+ * Retrieve the properties and relationships of user object. This operation returns by default only a subset of the more commonly used properties for each user. These default properties are noted in the Properties section. To get properties that are not returned by default, do a GET operation for the user and specify the properties in a $select OData query option. Because the user resource supports extensions, you can also use the GET operation to get custom properties and extension data in a user instance. Customers through Microsoft Entra ID for customers can also use this API operation to retrieve their details.
439
439
  */
440
440
  export interface UserItemRequestBuilderGetQueryParameters {
441
441
  /**
@@ -36,11 +36,11 @@ export interface PresenceRequestBuilder extends BaseRequestBuilder<PresenceReque
36
36
  */
37
37
  delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
38
38
  /**
39
- * Set a presence status message for a user. An optional expiration date and time can be supplied.
39
+ * Get a user's presence information.
40
40
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
41
41
  * @returns {Promise<Presence>}
42
42
  * @throws {ODataError} error when the service returns a 4XX or 5XX status code
43
- * @see {@link https://learn.microsoft.com/graph/api/presence-setstatusmessage?view=graph-rest-1.0|Find more info here}
43
+ * @see {@link https://learn.microsoft.com/graph/api/presence-get?view=graph-rest-1.0|Find more info here}
44
44
  */
45
45
  get(requestConfiguration?: RequestConfiguration<PresenceRequestBuilderGetQueryParameters> | undefined): Promise<Presence | undefined>;
46
46
  /**
@@ -58,7 +58,7 @@ export interface PresenceRequestBuilder extends BaseRequestBuilder<PresenceReque
58
58
  */
59
59
  toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
60
60
  /**
61
- * Set a presence status message for a user. An optional expiration date and time can be supplied.
61
+ * Get a user's presence information.
62
62
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
63
63
  * @returns {RequestInformation}
64
64
  */
@@ -72,7 +72,7 @@ export interface PresenceRequestBuilder extends BaseRequestBuilder<PresenceReque
72
72
  toPatchRequestInformation(body: Presence, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
73
73
  }
74
74
  /**
75
- * Set a presence status message for a user. An optional expiration date and time can be supplied.
75
+ * Get a user's presence information.
76
76
  */
77
77
  export interface PresenceRequestBuilderGetQueryParameters {
78
78
  /**