From 45c607ba830205d4c564daf09a99a6488cc44b13 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 22 Dec 2022 01:40:06 +0000 Subject: [PATCH] feat(admin): update the API #### admin:datatransfer_v1 The following keys were changed: - resources.transfers.methods.insert.description - schemas.Application.description - schemas.Application.properties.id.description - schemas.Application.properties.transferParams.description - schemas.ApplicationDataTransfer.properties.applicationTransferParams.description - schemas.ApplicationDataTransfer.properties.applicationTransferStatus.description - schemas.ApplicationTransferParam.properties.key.description - schemas.ApplicationTransferParam.properties.value.description - schemas.ApplicationsListResponse.properties.applications.description - schemas.ApplicationsListResponse.properties.nextPageToken.description - schemas.DataTransfer.properties.applicationDataTransfers.description - schemas.DataTransfer.properties.id.description - schemas.DataTransfer.properties.overallTransferStatusCode.description - schemas.DataTransfer.properties.requestTime.description - schemas.DataTransfersListResponse.properties.nextPageToken.description #### admin:directory_v1 The following keys were added: - schemas.UserName.properties.displayName.description - schemas.UserName.properties.displayName.type The following keys were changed: - resources.domainAliases.methods.get.parameters.customer.description - resources.domainAliases.methods.list.parameters.customer.description - resources.domains.methods.get.parameters.customer.description - resources.domains.methods.list.parameters.customer.description - resources.groups.methods.list.parameters.customer.description - resources.members.methods.list.description - resources.mobiledevices.methods.list.description - resources.privileges.methods.list.parameters.customer.description - resources.roleAssignments.methods.get.parameters.customer.description - resources.roleAssignments.methods.list.parameters.customer.description - resources.roles.methods.get.parameters.customer.description - resources.roles.methods.list.parameters.customer.description - resources.schemas.methods.get.parameters.customerId.description - resources.schemas.methods.list.parameters.customerId.description - resources.users.methods.list.parameters.customer.description - resources.users.methods.update.description - schemas.User.properties.addresses.description - schemas.User.properties.emails.description - schemas.User.properties.externalIds.description - schemas.User.properties.gender.description - schemas.User.properties.ims.description - schemas.User.properties.ipWhitelisted.description - schemas.User.properties.keywords.description - schemas.User.properties.languages.description - schemas.User.properties.locations.description - schemas.User.properties.name.description - schemas.User.properties.organizations.description - schemas.User.properties.phones.description - schemas.User.properties.relations.description - schemas.User.properties.websites.description #### admin:reports_v1 The following keys were changed: - resources.customerUsageReports.methods.get.parameters.date.description - resources.userUsageReport.methods.get.parameters.date.description --- discovery/admin-datatransfer_v1.json | 32 +++++----- discovery/admin-directory_v1.json | 66 ++++++++++---------- discovery/admin-reports_v1.json | 6 +- src/apis/admin/datatransfer_v1.ts | 30 +++++----- src/apis/admin/directory_v1.ts | 90 +++++++++++++++------------- src/apis/admin/reports_v1.ts | 8 +-- 6 files changed, 120 insertions(+), 112 deletions(-) diff --git a/discovery/admin-datatransfer_v1.json b/discovery/admin-datatransfer_v1.json index 7ba8979b12..6b87391860 100644 --- a/discovery/admin-datatransfer_v1.json +++ b/discovery/admin-datatransfer_v1.json @@ -202,7 +202,7 @@ ] }, "insert": { - "description": "Inserts a data transfer request.", + "description": "Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.", "flatPath": "admin/datatransfer/v1/transfers", "httpMethod": "POST", "id": "datatransfer.transfers.insert", @@ -272,11 +272,11 @@ } } }, - "revision": "20210720", + "revision": "20221205", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { - "description": "Applications resources represent applications installed on the domain that support transferring ownership of user data.", + "description": "Application resources represent applications installed on the domain that support transferring ownership of user data.", "id": "Application", "properties": { "etag": { @@ -284,7 +284,7 @@ "type": "string" }, "id": { - "description": "The application's ID.", + "description": "The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.", "format": "int64", "type": "string" }, @@ -298,7 +298,7 @@ "type": "string" }, "transferParams": { - "description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred.", + "description": "The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer.", "items": { "$ref": "ApplicationTransferParam" }, @@ -317,14 +317,14 @@ "type": "string" }, "applicationTransferParams": { - "description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.", + "description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.", "items": { "$ref": "ApplicationTransferParam" }, "type": "array" }, "applicationTransferStatus": { - "description": "Current status of transfer for this application. (Read-only)", + "description": "Read-only. Current status of transfer for this application.", "type": "string" } }, @@ -335,11 +335,11 @@ "id": "ApplicationTransferParam", "properties": { "key": { - "description": "The type of the transfer parameter. eg: 'PRIVACY_LEVEL'", + "description": "The type of the transfer parameter, such as `PRIVACY_LEVEL`.", "type": "string" }, "value": { - "description": "The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'", + "description": "The value of the transfer parameter, such as `PRIVATE` or `SHARED`.", "items": { "type": "string" }, @@ -353,7 +353,7 @@ "id": "ApplicationsListResponse", "properties": { "applications": { - "description": "List of applications that support data transfer and are also installed for the customer.", + "description": "The list of applications that support data transfer and are also installed for the customer.", "items": { "$ref": "Application" }, @@ -369,7 +369,7 @@ "type": "string" }, "nextPageToken": { - "description": "Continuation token which will be used to specify next page in list API.", + "description": "Token to specify the next page in the list.", "type": "string" } }, @@ -380,7 +380,7 @@ "id": "DataTransfer", "properties": { "applicationDataTransfers": { - "description": "List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.", + "description": "The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.", "items": { "$ref": "ApplicationDataTransfer" }, @@ -391,7 +391,7 @@ "type": "string" }, "id": { - "description": "The transfer's ID (Read-only).", + "description": "Read-only. The transfer's ID.", "type": "string" }, "kind": { @@ -408,11 +408,11 @@ "type": "string" }, "overallTransferStatusCode": { - "description": "Overall transfer status (Read-only).", + "description": "Read-only. Overall transfer status.", "type": "string" }, "requestTime": { - "description": "The time at which the data transfer was requested (Read-only).", + "description": "Read-only. The time at which the data transfer was requested.", "format": "date-time", "type": "string" } @@ -440,7 +440,7 @@ "type": "string" }, "nextPageToken": { - "description": "Continuation token which will be used to specify next page in list API.", + "description": "Token to specify the next page in the list.", "type": "string" } }, diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index b16e2efaa9..eb0d2ef67a 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -1327,7 +1327,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -1385,7 +1385,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -1448,7 +1448,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -1506,7 +1506,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -1597,7 +1597,7 @@ "parameterOrder": [], "parameters": { "customer": { - "description": "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 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.", + "description": "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.", "location": "query", "type": "string" }, @@ -1933,7 +1933,7 @@ ] }, "list": { - "description": "Retrieves a paginated list of all members in a group.", + "description": "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).", "flatPath": "admin/directory/v1/groups/{groupKey}/members", "httpMethod": "GET", "id": "directory.members.list", @@ -2163,7 +2163,7 @@ ] }, "list": { - "description": "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.", + "description": "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).", "flatPath": "admin/directory/v1/customer/{customerId}/devices/mobile", "httpMethod": "GET", "id": "directory.mobiledevices.list", @@ -2479,7 +2479,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -3221,7 +3221,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -3279,7 +3279,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -3360,7 +3360,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -3418,7 +3418,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -3557,7 +3557,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -3615,7 +3615,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the Google Workspace account.", + "description": "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.", "location": "path", "required": true, "type": "string" @@ -3926,7 +3926,7 @@ "type": "string" }, "customer": { - "description": "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.", + "description": "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.", "location": "query", "type": "string" }, @@ -4144,7 +4144,7 @@ ] }, "update": { - "description": "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.", + "description": "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.", "flatPath": "admin/directory/v1/users/{userKey}", "httpMethod": "PUT", "id": "directory.users.update", @@ -4630,7 +4630,7 @@ } } }, - "revision": "20221020", + "revision": "20221205", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -7434,7 +7434,7 @@ "id": "User", "properties": { "addresses": { - "description": "The list of the user's addresses. The maximum allowed data size for this field is 10Kb.", + "description": "The list of the user's addresses. The maximum allowed data size for this field is 10KB.", "type": "any" }, "agreedToTerms": { @@ -7482,7 +7482,7 @@ "type": "string" }, "emails": { - "description": "The list of the user's email addresses. The maximum allowed data size for this field is 10Kb.", + "description": "The list of the user's email addresses. The maximum allowed data size for this field is 10KB.", "type": "any" }, "etag": { @@ -7491,11 +7491,11 @@ "type": "string" }, "externalIds": { - "description": "The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb.", + "description": "The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.", "type": "any" }, "gender": { - "description": "The user's gender. The maximum allowed data size for this field is 1Kb.", + "description": "The user's gender. The maximum allowed data size for this field is 1KB.", "type": "any" }, "hashFunction": { @@ -7507,7 +7507,7 @@ "type": "string" }, "ims": { - "description": "The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb.", + "description": "The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.", "type": "any" }, "includeInGlobalAddressList": { @@ -7515,7 +7515,7 @@ "type": "boolean" }, "ipWhitelisted": { - "description": "If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).", + "description": "If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.", "type": "boolean" }, "isAdmin": { @@ -7544,7 +7544,7 @@ "type": "boolean" }, "keywords": { - "description": "The list of the user's keywords. The maximum allowed data size for this field is 1Kb.", + "description": "The list of the user's keywords. The maximum allowed data size for this field is 1KB.", "type": "any" }, "kind": { @@ -7554,7 +7554,7 @@ "type": "string" }, "languages": { - "description": "The user's languages. The maximum allowed data size for this field is 1Kb.", + "description": "The user's languages. The maximum allowed data size for this field is 1KB.", "type": "any" }, "lastLoginTime": { @@ -7564,7 +7564,7 @@ "type": "string" }, "locations": { - "description": "The user's locations. The maximum allowed data size for this field is 10Kb.", + "description": "The user's locations. The maximum allowed data size for this field is 10KB.", "type": "any" }, "name": { @@ -7574,7 +7574,7 @@ "directory.users.insert" ] }, - "description": "Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb." + "description": "Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1KB." }, "nonEditableAliases": { "description": "Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.", @@ -7593,7 +7593,7 @@ "type": "string" }, "organizations": { - "description": "The list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb.", + "description": "The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.", "type": "any" }, "password": { @@ -7606,7 +7606,7 @@ "type": "string" }, "phones": { - "description": "The list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.", + "description": "The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.", "type": "any" }, "posixAccounts": { @@ -7631,7 +7631,7 @@ "type": "string" }, "relations": { - "description": "The list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.", + "description": "The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.", "type": "any" }, "sshPublicKeys": { @@ -7658,7 +7658,7 @@ "type": "string" }, "websites": { - "description": "The user's websites. The maximum allowed data size for this field is 2Kb.", + "description": "The user's websites. The maximum allowed data size for this field is 2KB.", "type": "any" } }, @@ -7955,6 +7955,10 @@ "UserName": { "id": "UserName", "properties": { + "displayName": { + "description": "The user's display name. Limit: 256 characters.", + "type": "string" + }, "familyName": { "annotations": { "required": [ diff --git a/discovery/admin-reports_v1.json b/discovery/admin-reports_v1.json index c3a6ab4b20..8ff29456c8 100644 --- a/discovery/admin-reports_v1.json +++ b/discovery/admin-reports_v1.json @@ -431,7 +431,7 @@ "type": "string" }, "date": { - "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.", + "description": "Represents the date the usage occurred, based on PST time zone. The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.", "location": "path", "pattern": "(\\d){4}-(\\d){2}-(\\d){2}", "required": true, @@ -560,7 +560,7 @@ "type": "string" }, "date": { - "description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.", + "description": "Represents the date the usage occurred, based on GMT-7:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.", "location": "path", "pattern": "(\\d){4}-(\\d){2}-(\\d){2}", "required": true, @@ -623,7 +623,7 @@ } } }, - "revision": "20221020", + "revision": "20221205", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/src/apis/admin/datatransfer_v1.ts b/src/apis/admin/datatransfer_v1.ts index 155eee805d..62b3db2622 100644 --- a/src/apis/admin/datatransfer_v1.ts +++ b/src/apis/admin/datatransfer_v1.ts @@ -127,7 +127,7 @@ export namespace admin_datatransfer_v1 { } /** - * Applications resources represent applications installed on the domain that support transferring ownership of user data. + * Application resources represent applications installed on the domain that support transferring ownership of user data. */ export interface Schema$Application { /** @@ -135,7 +135,7 @@ export namespace admin_datatransfer_v1 { */ etag?: string | null; /** - * The application's ID. + * The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method. */ id?: string | null; /** @@ -147,7 +147,7 @@ export namespace admin_datatransfer_v1 { */ name?: string | null; /** - * The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred. + * The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer. */ transferParams?: Schema$ApplicationTransferParam[]; } @@ -160,11 +160,11 @@ export namespace admin_datatransfer_v1 { */ applicationId?: string | null; /** - * The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. + * The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference. */ applicationTransferParams?: Schema$ApplicationTransferParam[]; /** - * Current status of transfer for this application. (Read-only) + * Read-only. Current status of transfer for this application. */ applicationTransferStatus?: string | null; } @@ -173,7 +173,7 @@ export namespace admin_datatransfer_v1 { */ export interface Schema$ApplicationsListResponse { /** - * List of applications that support data transfer and are also installed for the customer. + * The list of applications that support data transfer and are also installed for the customer. */ applications?: Schema$Application[]; /** @@ -185,7 +185,7 @@ export namespace admin_datatransfer_v1 { */ kind?: string | null; /** - * Continuation token which will be used to specify next page in list API. + * Token to specify the next page in the list. */ nextPageToken?: string | null; } @@ -194,11 +194,11 @@ export namespace admin_datatransfer_v1 { */ export interface Schema$ApplicationTransferParam { /** - * The type of the transfer parameter. eg: 'PRIVACY_LEVEL' + * The type of the transfer parameter, such as `PRIVACY_LEVEL`. */ key?: string | null; /** - * The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' + * The value of the transfer parameter, such as `PRIVATE` or `SHARED`. */ value?: string[] | null; } @@ -207,7 +207,7 @@ export namespace admin_datatransfer_v1 { */ export interface Schema$DataTransfer { /** - * List of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation. + * The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation. */ applicationDataTransfers?: Schema$ApplicationDataTransfer[]; /** @@ -215,7 +215,7 @@ export namespace admin_datatransfer_v1 { */ etag?: string | null; /** - * The transfer's ID (Read-only). + * Read-only. The transfer's ID. */ id?: string | null; /** @@ -231,11 +231,11 @@ export namespace admin_datatransfer_v1 { */ oldOwnerUserId?: string | null; /** - * Overall transfer status (Read-only). + * Read-only. Overall transfer status. */ overallTransferStatusCode?: string | null; /** - * The time at which the data transfer was requested (Read-only). + * Read-only. The time at which the data transfer was requested. */ requestTime?: string | null; } @@ -256,7 +256,7 @@ export namespace admin_datatransfer_v1 { */ kind?: string | null; /** - * Continuation token which will be used to specify next page in list API. + * Token to specify the next page in the list. */ nextPageToken?: string | null; } @@ -712,7 +712,7 @@ export namespace admin_datatransfer_v1 { } /** - * Inserts a data transfer request. + * Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. * @example * ```js * // Before running the sample: diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 0f78f47d8a..547a955647 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -2020,7 +2020,7 @@ export namespace admin_directory_v1 { */ export interface Schema$User { /** - * The list of the user's addresses. The maximum allowed data size for this field is 10Kb. + * The list of the user's addresses. The maximum allowed data size for this field is 10KB. */ addresses?: any | null; /** @@ -2053,7 +2053,7 @@ export namespace admin_directory_v1 { customSchemas?: {[key: string]: Schema$UserCustomProperties} | null; deletionTime?: string | null; /** - * The list of the user's email addresses. The maximum allowed data size for this field is 10Kb. + * The list of the user's email addresses. The maximum allowed data size for this field is 10KB. */ emails?: any | null; /** @@ -2061,11 +2061,11 @@ export namespace admin_directory_v1 { */ etag?: string | null; /** - * The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. + * The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB. */ externalIds?: any | null; /** - * The user's gender. The maximum allowed data size for this field is 1Kb. + * The user's gender. The maximum allowed data size for this field is 1KB. */ gender?: any | null; /** @@ -2077,7 +2077,7 @@ export namespace admin_directory_v1 { */ id?: string | null; /** - * The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. + * The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB. */ ims?: any | null; /** @@ -2085,7 +2085,7 @@ export namespace admin_directory_v1 { */ includeInGlobalAddressList?: boolean | null; /** - * 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 | null; /** @@ -2109,7 +2109,7 @@ export namespace admin_directory_v1 { */ isMailboxSetup?: boolean | null; /** - * The list of the user's keywords. The maximum allowed data size for this field is 1Kb. + * The list of the user's keywords. The maximum allowed data size for this field is 1KB. */ keywords?: any | null; /** @@ -2117,7 +2117,7 @@ export namespace admin_directory_v1 { */ kind?: string | null; /** - * The user's languages. The maximum allowed data size for this field is 1Kb. + * The user's languages. The maximum allowed data size for this field is 1KB. */ languages?: any | null; /** @@ -2125,11 +2125,11 @@ export namespace admin_directory_v1 { */ lastLoginTime?: string | null; /** - * The user's locations. The maximum allowed data size for this field is 10Kb. + * The user's locations. The maximum allowed data size for this field is 10KB. */ locations?: any | null; /** - * Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. + * Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1KB. */ name?: Schema$UserName; /** @@ -2141,7 +2141,7 @@ export namespace admin_directory_v1 { */ notes?: any | null; /** - * The list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. + * The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB. */ organizations?: any | null; /** @@ -2153,7 +2153,7 @@ export namespace admin_directory_v1 { */ password?: string | null; /** - * The list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. + * The list of the user's phone numbers. The maximum allowed data size for this field is 1KB. */ phones?: any | null; /** @@ -2173,7 +2173,7 @@ export namespace admin_directory_v1 { */ recoveryPhone?: string | null; /** - * The list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. + * The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB. */ relations?: any | null; /** @@ -2197,7 +2197,7 @@ export namespace admin_directory_v1 { */ thumbnailPhotoUrl?: string | null; /** - * The user's websites. The maximum allowed data size for this field is 2Kb. + * The user's websites. The maximum allowed data size for this field is 2KB. */ websites?: any | null; } @@ -2455,6 +2455,10 @@ export namespace admin_directory_v1 { status?: boolean | null; } export interface Schema$UserName { + /** + * The user's display name. Limit: 256 characters. + */ + displayName?: string | null; /** * The user's last name. Required when creating a user account. */ @@ -7910,7 +7914,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.domainAliases.get({ - * // 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: 'placeholder-value', * // Name of domain alias to be retrieved. * domainAliasName: 'placeholder-value', @@ -8195,7 +8199,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.domainAliases.list({ - * // 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: 'placeholder-value', * // Name of the parent domain for which domain aliases are to be fetched. * parentDomainName: 'placeholder-value', @@ -8315,7 +8319,7 @@ export namespace admin_directory_v1 { export interface Params$Resource$Domainaliases$Get extends StandardParameters { /** - * 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; /** @@ -8338,7 +8342,7 @@ export namespace admin_directory_v1 { export interface Params$Resource$Domainaliases$List extends StandardParameters { /** - * 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; /** @@ -8506,7 +8510,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.domains.get({ - * // 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: 'placeholder-value', * // Name of domain to be retrieved * domainName: 'placeholder-value', @@ -8792,7 +8796,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.domains.list({ - * // 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: 'placeholder-value', * }); * console.log(res.data); @@ -8907,7 +8911,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Domains$Get extends StandardParameters { /** - * 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; /** @@ -8928,7 +8932,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Domains$List extends StandardParameters { /** - * 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; } @@ -9383,7 +9387,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.groups.list({ - * // 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 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. + * // 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: 'placeholder-value', * // 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. * domain: 'placeholder-value', @@ -9830,7 +9834,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Groups$List extends StandardParameters { /** - * 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 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. + * 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; /** @@ -10886,7 +10890,7 @@ export namespace admin_directory_v1 { } /** - * 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). * @example * ```js * // Before running the sample: @@ -11876,7 +11880,7 @@ export namespace admin_directory_v1 { } /** - * 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). * @example * ```js * // Before running the sample: @@ -13076,7 +13080,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.privileges.list({ - * // 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: 'placeholder-value', * }); * console.log(res.data); @@ -13182,7 +13186,7 @@ export namespace admin_directory_v1 { export interface Params$Resource$Privileges$List extends StandardParameters { /** - * 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; } @@ -16431,7 +16435,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.roleAssignments.get({ - * // 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: 'placeholder-value', * // Immutable ID of the role assignment. * roleAssignmentId: 'placeholder-value', @@ -16720,7 +16724,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.roleAssignments.list({ - * // 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: 'placeholder-value', * // Maximum number of results to return. * maxResults: 'placeholder-value', @@ -16848,7 +16852,7 @@ export namespace admin_directory_v1 { export interface Params$Resource$Roleassignments$Get extends StandardParameters { /** - * 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; /** @@ -16871,7 +16875,7 @@ export namespace admin_directory_v1 { export interface Params$Resource$Roleassignments$List extends StandardParameters { /** - * 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; /** @@ -17050,7 +17054,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.roles.get({ - * // 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: 'placeholder-value', * // Immutable ID of the role. * roleId: 'placeholder-value', @@ -17338,7 +17342,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.roles.list({ - * // 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: 'placeholder-value', * // Maximum number of results to return. * maxResults: 'placeholder-value', @@ -17760,7 +17764,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Roles$Get extends StandardParameters { /** - * 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; /** @@ -17781,7 +17785,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Roles$List extends StandardParameters { /** - * 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; /** @@ -17983,7 +17987,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.schemas.get({ - * // 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: 'placeholder-value', * // Name or immutable ID of the schema. * schemaKey: 'placeholder-value', @@ -18266,7 +18270,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.schemas.list({ - * // 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: 'placeholder-value', * }); * console.log(res.data); @@ -18677,7 +18681,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Schemas$Get extends StandardParameters { /** - * 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; /** @@ -18698,7 +18702,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Schemas$List extends StandardParameters { /** - * 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; } @@ -19858,7 +19862,7 @@ export namespace admin_directory_v1 { * * // Do the magic * const res = await directory.users.list({ - * // 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: 'placeholder-value', * // A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. * customFieldMask: 'placeholder-value', @@ -20588,7 +20592,7 @@ export namespace admin_directory_v1 { } /** - * 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. * @example * ```js * // Before running the sample: @@ -21026,7 +21030,7 @@ export namespace admin_directory_v1 { } export interface Params$Resource$Users$List extends StandardParameters { /** - * 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; /** diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index ac3a2443d8..ee63df3261 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -986,7 +986,7 @@ export namespace admin_reports_v1 { * const res = await reports.customerUsageReports.get({ * // The unique ID of the customer to retrieve data for. * customerId: 'C.+|my_customer', - * // Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. + * // Represents the date the usage occurred, based on PST time zone. The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`. * date: '(d){4}-(d){2}-(d){2}', * // Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the `nextPageToken` value in the `pageToken` query string. * pageToken: 'placeholder-value', @@ -1105,7 +1105,7 @@ export namespace admin_reports_v1 { */ customerId?: string; /** - * Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. + * Represents the date the usage occurred, based on PST time zone. The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`. */ date?: string; /** @@ -1344,7 +1344,7 @@ export namespace admin_reports_v1 { * const res = await reports.userUsageReport.get({ * // The unique ID of the customer to retrieve data for. * customerId: 'C.+|my_customer', - * // Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. + * // Represents the date the usage occurred, based on GMT-7:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`. * date: '(d){4}-(d){2}-(d){2}', * // The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<\>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<\>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `\>` - 'greater than'. It is URL-encoded (%3E). - `\>=` - 'greater than or equal to'. It is URL-encoded (%3E=). * filters: @@ -1473,7 +1473,7 @@ export namespace admin_reports_v1 { */ customerId?: string; /** - * Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. + * Represents the date the usage occurred, based on GMT-7:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`. */ date?: string; /**