@maxim_mazurok/gapi.client.admin-directory_v1 0.0.20221109 → 0.0.20221122

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://admin.googleapis.com/$discovery/rest?version=directory_v1
-// Revision: 20221109
+// Revision: 20221122
 
 /// <reference types="gapi.client" />
 
@@ -1220,7 +1220,7 @@ declare namespace gapi.client {
              * excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
              */
             includeInGlobalAddressList?: boolean;
-            /** If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). */
+            /** If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration. */
             ipWhitelisted?: boolean;
             /**
              * Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an
@@ -3675,7 +3675,7 @@ declare namespace gapi.client {
              * excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
              */
             includeInGlobalAddressList?: boolean;
-            /** If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). */
+            /** If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration. */
             ipWhitelisted?: boolean;
             /**
              * Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an
@@ -4687,7 +4687,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Name of domain alias to be retrieved. */
                 domainAliasName: string;
@@ -4772,7 +4776,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -4832,7 +4840,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Name of domain to be retrieved */
                 domainName: string;
@@ -4917,7 +4929,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -5167,9 +5183,9 @@ declare namespace gapi.client {
                 /** JSONP */
                 callback?: string;
                 /**
-                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill in this field instead of `domain`. You can
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
                  * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
-                 * resource. Either the `customer` or the `domain` parameter must be provided.
+                 * resource. You must provide either the `customer` or the `domain` parameter.
                  */
                 customer?: string;
                 /** The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. */
@@ -5469,7 +5485,10 @@ declare namespace gapi.client {
                 uploadType?: string;
             },
             body: Member): Request<Member>;
-            /** Retrieves a paginated list of all members in a group. */
+            /**
+             * Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error
+             * codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
+             */
             list(request?: {
                 /** V1 error format. */
                 "$.xgafv"?: string;
@@ -5772,7 +5791,8 @@ declare namespace gapi.client {
             }): Request<MobileDevice>;
             /**
              * Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices
-             * API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead.
+             * API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error
+             * codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
              */
             list(request?: {
                 /** V1 error format. */
@@ -6121,7 +6141,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -7073,7 +7097,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -7158,7 +7186,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -7224,7 +7256,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -7309,7 +7345,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customer: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -7491,7 +7531,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customerId: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -7576,7 +7620,11 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** Immutable ID of the Google Workspace account. */
+                /**
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
+                 */
                 customerId: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -8301,9 +8349,9 @@ declare namespace gapi.client {
                 /** JSONP */
                 callback?: string;
                 /**
-                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also
-                 * use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).
-                 * Either the `customer` or the `domain` parameter must be provided.
+                 * The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can
+                 * also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
+                 * resource. You must provide either the `customer` or the `domain` parameter.
                  */
                 customer?: string;
                 /** A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. */
@@ -8548,8 +8596,10 @@ declare namespace gapi.client {
             },
             body: UserUndelete): Request<void>;
             /**
-             * Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved,
-             * and fields set to `null` will be cleared.
+             * Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be
+             * preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the
+             * request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-users#update_user) for more
+             * information.
              */
             update(request: {
                 /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.admin-directory_v1",
-  "version": "0.0.20221109",
+  "version": "0.0.20221122",
   "description": "TypeScript typings for Admin SDK API directory_v1",
   "license": "MIT",
   "author": {

package/readme.md

@@ -308,7 +308,7 @@ Adds a user to the specified group.
 await gapi.client.directory.members.insert({ groupKey: "groupKey",  });
 
 /*
-Retrieves a paginated list of all members in a group.
+Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
 */
 await gapi.client.directory.members.list({ groupKey: "groupKey",  });
 
@@ -338,7 +338,7 @@ Retrieves a mobile device's properties.
 await gapi.client.directory.mobiledevices.get({ customerId: "customerId", resourceId: "resourceId",  });
 
 /*
-Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead.
+Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
 */
 await gapi.client.directory.mobiledevices.list({ customerId: "customerId",  });
 
@@ -518,7 +518,7 @@ Undeletes a deleted user.
 await gapi.client.directory.users.undelete({ userKey: "userKey",  });
 
 /*
-Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared.
+Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-users#update_user) for more information.
 */
 await gapi.client.directory.users.update({ userKey: "userKey",  });
 

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20221109
+// Revision: 20221122
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -864,7 +864,10 @@ gapi.load('client', async () => {
             status: "Test string",
             type: "Test string",
         });
-        /** Retrieves a paginated list of all members in a group. */
+        /**
+         * Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error
+         * codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
+         */
         await gapi.client.directory.members.list({
             groupKey: "Test string",
             includeDerivedMembership: true,
@@ -920,7 +923,8 @@ gapi.load('client', async () => {
         });
         /**
          * Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices
-         * API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead.
+         * API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error
+         * codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
          */
         await gapi.client.directory.mobiledevices.list({
             customerId: "Test string",
@@ -1622,8 +1626,9 @@ gapi.load('client', async () => {
             orgUnitPath: "Test string",
         });
         /**
-         * Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and
-         * fields set to `null` will be cleared.
+         * Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved,
+         * and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body
+         * with the desired values for all items. See the [user accounts guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-users#update_user) for more information.
          */
         await gapi.client.directory.users.update({
             userKey: "Test string",