@google-apps/chat 0.8.0 → 0.10.0

package/build/src/v1/chat_service_client.d.ts

@@ -116,18 +116,30 @@ export declare class ChatServiceClient {
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
     /**
-     * Creates a message in a Google Chat space. The maximum message size,
-     * including text and cards, is 32,000 bytes. For an example, see [Send a
+     * Creates a message in a Google Chat space. For an example, see [Send a
      * message](https://developers.google.com/workspace/chat/create-messages).
      *
-     * Calling this method requires
-     * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
-     * and supports the following authentication types:
+     * The `create()` method requires either user or app authentication. Chat
+     * attributes the message sender differently depending on the type of
+     * authentication that you use in your request.
      *
-     * - For text messages, user authentication or app authentication are
-     * supported.
-     * - For card messages, only app authentication is supported. (Only Chat apps
-     * can create card messages.)
+     * The following image shows how Chat attributes a message when you use app
+     * authentication. Chat displays the Chat app as the message
+     * sender. The content of the message can contain text (`text`), cards
+     * (`cardsV2`), and accessory widgets (`accessoryWidgets`).
+     *
+     * ![Message sent with app
+     * authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg)
+     *
+     * The following image shows how Chat attributes a message when you use user
+     * authentication. Chat displays the user as the message sender and attributes
+     * the Chat app to the message by displaying its name. The content of message
+     * can only contain text (`text`).
+     *
+     * ![Message sent with user
+     * authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg)
+     *
+     * The maximum message size, including the message contents, is 32,000 bytes.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -213,6 +225,19 @@ export declare class ChatServiceClient {
      *   you can use the user's email as an alias for `{member}`. For example,
      *   `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
      *   email of the Google Chat user.
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly`
+     *   [OAuth 2.0
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   Getting app memberships in a space isn't supported when using admin access.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -466,6 +491,16 @@ export declare class ChatServiceClient {
      *   Required. Resource name of the space, in the form `spaces/{space}`.
      *
      *   Format: `spaces/{space}`
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -483,14 +518,19 @@ export declare class ChatServiceClient {
     getSpace(request: protos.google.chat.v1.IGetSpaceRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IGetSpaceRequest | null | undefined, {} | null | undefined>): void;
     getSpace(request: protos.google.chat.v1.IGetSpaceRequest, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IGetSpaceRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * Creates a named space. Spaces grouped by topics aren't supported. For an
-     * example, see [Create a
+     * Creates a space with no members. Can be used to create a named space.
+     * Spaces grouped by topics aren't supported. For an example, see
+     * [Create a
      * space](https://developers.google.com/workspace/chat/create-spaces).
      *
      *  If you receive the error message `ALREADY_EXISTS` when creating
      *  a space, try a different `displayName`. An existing space within
      *  the Google Workspace organization might already use this display name.
      *
+     * If you're a member of the [Developer Preview
+     * program](https://developers.google.com/workspace/preview), you can create a
+     * group chat in import mode using `spaceType.GROUP_CHAT`.
+     *
      * Requires [user
      * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
      *
@@ -500,10 +540,14 @@ export declare class ChatServiceClient {
      *   Required. The `displayName` and `spaceType` fields must be populated.  Only
      *   `SpaceType.SPACE` is supported.
      *
-     *   If you receive the error message `ALREADY_EXISTS` when creating a space,
+     *   If you receive the error message `ALREADY_EXISTS`,
      *   try a different `displayName`. An existing space within the Google
      *   Workspace organization might already use this display name.
      *
+     *   If you're a member of the [Developer Preview
+     *   program](https://developers.google.com/workspace/preview),
+     *   `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
+     *
      *   The space `name` is assigned on the server so anything specified in this
      *   field will be ignored.
      * @param {string} [request.requestId]
@@ -684,54 +728,77 @@ export declare class ChatServiceClient {
      *   Required. The updated field paths, comma separated if there are
      *   multiple.
      *
-     *   Currently supported field paths:
+     *   You can update the following fields for a space:
+     *
+     *   `space_details`: Updates the space's description. Supports up to 150
+     *   characters.
      *
-     *   - `display_name` (Only supports changing the display name of a space with
-     *   the `SPACE` type, or when also including the `space_type` mask to change a
-     *   `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a
-     *   `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument
-     *   error. If you receive the error message `ALREADY_EXISTS` when updating the
-     *   `displayName`, try a different `displayName`. An existing space within the
-     *   Google Workspace organization might already use this display name.)
+     *   `display_name`: Only supports updating the display name for spaces where
+     *   `spaceType` field is `SPACE`.
+     *    If you receive the error message `ALREADY_EXISTS`, try a different
+     *    value. An existing space within the
+     *   Google Workspace organization might already use this display name.
      *
-     *   - `space_type` (Only supports changing a `GROUP_CHAT` space type to
+     *   `space_type`: Only supports changing a `GROUP_CHAT` space type to
      *   `SPACE`. Include `display_name` together
      *   with `space_type` in the update mask and ensure that the specified space
      *   has a non-empty display name and the `SPACE` space type. Including the
      *   `space_type` mask and the `SPACE` type in the specified space when updating
      *   the display name is optional if the existing space already has the `SPACE`
      *   type. Trying to update the space type in other ways results in an invalid
-     *   argument error).
-     *   `space_type` is not supported with admin access.
-     *
-     *   - `space_details`
+     *   argument error.
+     *   `space_type` is not supported with `useAdminAccess`.
      *
-     *   - `space_history_state` (Supports [turning history on or off for the
-     *   space](https://support.google.com/chat/answer/7664687) if [the organization
-     *   allows users to change their history
-     *   setting](https://support.google.com/a/answer/7664184).
-     *   Warning: mutually exclusive with all other field paths.)
-     *   `space_history_state` is not supported with admin access.
+     *   `space_history_state`: Updates [space history
+     *   settings](https://support.google.com/chat/answer/7664687) by turning
+     *   history on or off for the space. Only supported if history settings are
+     *   enabled for the Google Workspace organization. To update the
+     *   space history state, you must omit all other field masks in your request.
+     *   `space_history_state` is not supported with `useAdminAccess`.
      *
-     *   - `access_settings.audience` (Supports changing the [access
+     *   `access_settings.audience`: Updates the [access
      *   setting](https://support.google.com/chat/answer/11971020) of who can
-     *   discover the space, join the space, and preview the messages in space. If
-     *   no audience is specified in the access setting, the space's access setting
-     *   is updated to private. Warning: mutually exclusive with all other field
-     *   paths.)
-     *   `access_settings.audience` is not supported with admin access.
-     *
-     *   - Developer Preview: Supports changing the [permission
-     *   settings](https://support.google.com/chat/answer/13340792) of a space,
-     *   supported field paths
-     *   include: `permission_settings.manage_members_and_groups`,
-     *   `permission_settings.modify_space_details`,
-     *   `permission_settings.toggle_history`,
-     *   `permission_settings.use_at_mention_all`,
-     *   `permission_settings.manage_apps`, `permission_settings.manage_webhooks`,
-     *   `permission_settings.reply_messages`
-     *    (Warning: mutually exclusive with all other non-permission settings field
-     *   paths). `permission_settings` is not supported with admin access.
+     *   discover the space, join the space, and preview the messages in named space
+     *   where `spaceType` field is `SPACE`. If the existing space has a
+     *   target audience, you can remove the audience and restrict space access by
+     *   omitting a value for this field mask. To update access settings for a
+     *   space, the authenticating user must be a space manager and omit all other
+     *   field masks in your request. You can't update this field if the space is in
+     *   [import
+     *   mode](https://developers.google.com/workspace/chat/import-data-overview).
+     *   To learn more, see [Make a space discoverable to specific
+     *   users](https://developers.google.com/workspace/chat/space-target-audience).
+     *   `access_settings.audience` is not supported with `useAdminAccess`.
+     *
+     *   `permission_settings`: Supports changing the
+     *   [permission settings](https://support.google.com/chat/answer/13340792)
+     *   of a space.
+     *   When updating permission settings, you can only specify
+     *   `permissionSettings` field masks; you cannot update other field masks
+     *   at the same time. `permissionSettings` is not supported with
+     *   `useAdminAccess`.
+     *   The supported field masks include:
+     *
+     *   - `permission_settings.manageMembersAndGroups`
+     *   - `permission_settings.modifySpaceDetails`
+     *   - `permission_settings.toggleHistory`
+     *   - `permission_settings.useAtMentionAll`
+     *   - `permission_settings.manageApps`
+     *   - `permission_settings.manageWebhooks`
+     *   - `permission_settings.replyMessages`
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires the `chat.admin.spaces` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   Some `FieldMask` values are not supported using admin access. For details,
+     *   see the description of `update_mask`.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -764,6 +831,16 @@ export declare class ChatServiceClient {
      *   Required. Resource name of the space to delete.
      *
      *   Format: `spaces/{space}`
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires the `chat.admin.delete` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -864,40 +941,25 @@ export declare class ChatServiceClient {
     findDirectMessage(request: protos.google.chat.v1.IFindDirectMessageRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IFindDirectMessageRequest | null | undefined, {} | null | undefined>): void;
     findDirectMessage(request: protos.google.chat.v1.IFindDirectMessageRequest, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IFindDirectMessageRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * Creates a human membership or app membership for the calling app. Creating
-     * memberships for other apps isn't supported. For an example, see
-     * [Invite or add a user or a Google Chat app to a
-     * space](https://developers.google.com/workspace/chat/create-members).
+     * Creates a membership for the calling Chat app, a user, or a Google Group.
+     * Creating memberships for other Chat apps isn't supported.
      * When creating a membership, if the specified member has their auto-accept
      * policy turned off, then they're invited, and must accept the space
      * invitation before joining. Otherwise, creating a membership adds the member
-     * directly to the specified space. Requires [user
+     * directly to the specified space.
+     * Requires [user
      * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
      *
-     * To specify the member to add, set the `membership.member.name` for the
-     * human or app member, or set the `membership.group_member.name` for the
-     * group member.
-     *
-     * - To add the calling app to a space or a direct message between two human
-     *   users, use `users/app`. Unable to add other
-     *   apps to the space.
-     *
-     * - To add a human user, use `users/{user}`, where `{user}` can be the email
-     * address for the user. For users in the same Workspace organization `{user}`
-     * can also be the `id` for the person from the People API, or the `id` for
-     * the user in the Directory API. For example, if the People API Person
-     * profile ID for `user@example.com` is `123456789`, you can add the user to
-     * the space by setting the `membership.member.name` to
-     * `users/user@example.com` or `users/123456789`.
-     *
-     * - To add or invite a Google group in a named space, use
-     * `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
-     * Identity Groups API. For example, you can use [Cloud Identity Groups lookup
-     * API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
-     * to retrieve the ID `123456789` for group email `group@example.com`, then
-     * you can add or invite the group to a named space by setting the
-     * `membership.group_member.name` to `groups/123456789`. Group email is not
-     * supported, and Google groups can only be added as members in named spaces.
+     * For example usage, see:
+     *
+     * - [Invite or add a user to a
+     * space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
+     *
+     * - [Invite or add a Google Group to a
+     * space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
+     *
+     * - [Add the Chat app to a
+     * space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -923,6 +985,20 @@ export declare class ChatServiceClient {
      *   `users/user@example.com` or `users/123456789`. When a Chat app creates a
      *   membership relation for itself, it must use the `chat.memberships.app`
      *   scope, set `user.type` to `BOT`, and set `user.name` to `users/app`.
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires the `chat.admin.memberships` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   Creating app memberships or creating memberships for users outside the
+     *   administrator's Google Workspace organization isn't supported using admin
+     *   access.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -958,6 +1034,16 @@ export declare class ChatServiceClient {
      *   Currently supported field paths:
      *
      *   - `role`
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires the `chat.admin.memberships` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -999,6 +1085,18 @@ export declare class ChatServiceClient {
      *   and `spaces/{space}/members/app` format.
      *
      *   Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires the `chat.admin.memberships` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   Deleting app memberships in a space isn't supported using admin access.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -1228,6 +1326,9 @@ export declare class ChatServiceClient {
      * updated, the server returns the updated `Message` resource in the event
      * payload.
      *
+     * Note: The `permissionSettings` field is not returned in the Space
+     * object of the Space event data for this request.
+     *
      * Requires [user
      * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
      * To get an event, the authenticated user must be a member of the space.
@@ -1260,8 +1361,12 @@ export declare class ChatServiceClient {
     getSpaceEvent(request: protos.google.chat.v1.IGetSpaceEventRequest, callback: Callback<protos.google.chat.v1.ISpaceEvent, protos.google.chat.v1.IGetSpaceEventRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Lists messages in a space that the caller is a member of, including
-     * messages from blocked members and spaces. For an example, see
-     * [List messages](/chat/api/guides/v1/messages/list).
+     * messages from blocked members and spaces. If you list messages from a
+     * space with no messages, the response is an empty object. When using a
+     * REST/HTTP interface, the response contains an empty JSON object, `{}`.
+     * For an example, see
+     * [List
+     * messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
      * Requires [user
      * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
      *
@@ -1601,8 +1706,8 @@ export declare class ChatServiceClient {
      *
      *   To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
      *
-     *   To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer
-     *   Preview: You can also filter for `member.type` using the `!=` operator.
+     *   To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also
+     *   filter for `member.type` using the `!=` operator.
      *
      *   To filter by both role and type, use the `AND` operator. To filter by
      *   either role or type, use the `OR` operator.
@@ -1646,6 +1751,19 @@ export declare class ChatServiceClient {
      *
      *   Currently requires [user
      *   authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires either the `chat.admin.memberships.readonly` or
+     *   `chat.admin.memberships` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   Listing app memberships in a space isn't supported when using admin access.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
@@ -1701,8 +1819,8 @@ export declare class ChatServiceClient {
      *
      *   To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
      *
-     *   To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer
-     *   Preview: You can also filter for `member.type` using the `!=` operator.
+     *   To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also
+     *   filter for `member.type` using the `!=` operator.
      *
      *   To filter by both role and type, use the `AND` operator. To filter by
      *   either role or type, use the `OR` operator.
@@ -1746,6 +1864,19 @@ export declare class ChatServiceClient {
      *
      *   Currently requires [user
      *   authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires either the `chat.admin.memberships.readonly` or
+     *   `chat.admin.memberships` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   Listing app memberships in a space isn't supported when using admin access.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -1796,8 +1927,8 @@ export declare class ChatServiceClient {
      *
      *   To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
      *
-     *   To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer
-     *   Preview: You can also filter for `member.type` using the `!=` operator.
+     *   To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also
+     *   filter for `member.type` using the `!=` operator.
      *
      *   To filter by both role and type, use the `AND` operator. To filter by
      *   either role or type, use the `OR` operator.
@@ -1841,6 +1972,19 @@ export declare class ChatServiceClient {
      *
      *   Currently requires [user
      *   authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires either the `chat.admin.memberships.readonly` or
+     *   `chat.admin.memberships` [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   Listing app memberships in a space isn't supported when using admin access.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -2039,6 +2183,438 @@ export declare class ChatServiceClient {
      * region_tag:chat_v1_generated_ChatService_ListSpaces_async
      */
     listSpacesAsync(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
+    /**
+     * Returns a list of spaces in a Google Workspace organization based on an
+     * administrator's search. Requires [user
+     * authentication with administrator
+     * privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
+     * In the request, set `use_admin_access` to `true`.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces`
+     *   [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   This method currently only supports admin access, thus only `true` is
+     *   accepted for this field.
+     * @param {number} request.pageSize
+     *   The maximum number of spaces to return. The service may return fewer than
+     *   this value.
+     *
+     *   If unspecified, at most 100 spaces are returned.
+     *
+     *   The maximum value is 1000. If you use a value more than 1000, it's
+     *   automatically changed to 1000.
+     * @param {string} request.pageToken
+     *   A token, received from the previous search spaces call. Provide this
+     *   parameter to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided should match the call that
+     *   provided the page token. Passing different values to the other parameters
+     *   might lead to unexpected results.
+     * @param {string} request.query
+     *   Required. A search query.
+     *
+     *   You can search by using the following parameters:
+     *
+     *   - `create_time`
+     *   - `customer`
+     *   - `display_name`
+     *   - `external_user_allowed`
+     *   - `last_active_time`
+     *   - `space_history_state`
+     *   - `space_type`
+     *
+     *   `create_time` and `last_active_time` accept a timestamp in
+     *   [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported
+     *   comparison operators are: `=`, `<`, `>`, `<=`, `>=`.
+     *
+     *   `customer` is required and is used to indicate which customer
+     *   to fetch spaces from. `customers/my_customer` is the only supported value.
+     *
+     *   `display_name` only accepts the `HAS` (`:`) operator. The text to
+     *   match is first tokenized into tokens and each token is prefix-matched
+     *   case-insensitively and independently as a substring anywhere in the space's
+     *   `display_name`. For example, `Fun Eve` matches `Fun event` or `The
+     *   evening was fun`, but not `notFun event` or `even`.
+     *
+     *   `external_user_allowed` accepts either `true` or `false`.
+     *
+     *   `space_history_state` only accepts values from the [`historyState`]
+     *   (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)
+     *   field of a `space` resource.
+     *
+     *   `space_type` is required and the only valid value is `SPACE`.
+     *
+     *   Across different fields, only `AND` operators are supported. A valid
+     *   example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid
+     *   example is `space_type = "SPACE" OR display_name:"Hello"`.
+     *
+     *   Among the same field,
+     *   `space_type` doesn't support `AND` or `OR` operators.
+     *   `display_name`, 'space_history_state', and 'external_user_allowed' only
+     *   support `OR` operators.
+     *   `last_active_time` and `create_time` support both `AND` and `OR` operators.
+     *   `AND` can only be used to represent an interval, such as `last_active_time
+     *   < "2022-01-01T00:00:00+00:00" AND last_active_time >
+     *   "2023-01-01T00:00:00+00:00"`.
+     *
+     *   The following example queries are valid:
+     *
+     *   ```
+     *   customer = "customers/my_customer" AND space_type = "SPACE"
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   display_name:"Hello World"
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
+     *   "2022-01-01T00:00:00+00:00")
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (display_name:"Hello World" OR display_name:"Fun event") AND
+     *   (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
+     *   "2022-01-01T00:00:00+00:00")
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (create_time > "2019-01-01T00:00:00+00:00" AND create_time <
+     *   "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
+     *   (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
+     *   ```
+     * @param {string} [request.orderBy]
+     *   Optional. How the list of spaces is ordered.
+     *
+     *   Supported attributes to order by are:
+     *
+     *   - `membership_count.joined_direct_human_user_count` — Denotes the count of
+     *   human users that have directly joined a space.
+     *   - `last_active_time` — Denotes the time when last eligible item is added to
+     *   any topic of this space.
+     *   - `create_time` — Denotes the time of the space creation.
+     *
+     *   Valid ordering operation values are:
+     *
+     *   - `ASC` for ascending. Default value.
+     *
+     *   - `DESC` for descending.
+     *
+     *   The supported syntax are:
+     *
+     *   - `membership_count.joined_direct_human_user_count DESC`
+     *   - `membership_count.joined_direct_human_user_count ASC`
+     *   - `last_active_time DESC`
+     *   - `last_active_time ASC`
+     *   - `create_time DESC`
+     *   - `create_time ASC`
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of {@link protos.google.chat.v1.Space|Space}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `searchSpacesAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    searchSpaces(request?: protos.google.chat.v1.ISearchSpacesRequest, options?: CallOptions): Promise<[
+        protos.google.chat.v1.ISpace[],
+        protos.google.chat.v1.ISearchSpacesRequest | null,
+        protos.google.chat.v1.ISearchSpacesResponse
+    ]>;
+    searchSpaces(request: protos.google.chat.v1.ISearchSpacesRequest, options: CallOptions, callback: PaginationCallback<protos.google.chat.v1.ISearchSpacesRequest, protos.google.chat.v1.ISearchSpacesResponse | null | undefined, protos.google.chat.v1.ISpace>): void;
+    searchSpaces(request: protos.google.chat.v1.ISearchSpacesRequest, callback: PaginationCallback<protos.google.chat.v1.ISearchSpacesRequest, protos.google.chat.v1.ISearchSpacesResponse | null | undefined, protos.google.chat.v1.ISpace>): void;
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces`
+     *   [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   This method currently only supports admin access, thus only `true` is
+     *   accepted for this field.
+     * @param {number} request.pageSize
+     *   The maximum number of spaces to return. The service may return fewer than
+     *   this value.
+     *
+     *   If unspecified, at most 100 spaces are returned.
+     *
+     *   The maximum value is 1000. If you use a value more than 1000, it's
+     *   automatically changed to 1000.
+     * @param {string} request.pageToken
+     *   A token, received from the previous search spaces call. Provide this
+     *   parameter to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided should match the call that
+     *   provided the page token. Passing different values to the other parameters
+     *   might lead to unexpected results.
+     * @param {string} request.query
+     *   Required. A search query.
+     *
+     *   You can search by using the following parameters:
+     *
+     *   - `create_time`
+     *   - `customer`
+     *   - `display_name`
+     *   - `external_user_allowed`
+     *   - `last_active_time`
+     *   - `space_history_state`
+     *   - `space_type`
+     *
+     *   `create_time` and `last_active_time` accept a timestamp in
+     *   [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported
+     *   comparison operators are: `=`, `<`, `>`, `<=`, `>=`.
+     *
+     *   `customer` is required and is used to indicate which customer
+     *   to fetch spaces from. `customers/my_customer` is the only supported value.
+     *
+     *   `display_name` only accepts the `HAS` (`:`) operator. The text to
+     *   match is first tokenized into tokens and each token is prefix-matched
+     *   case-insensitively and independently as a substring anywhere in the space's
+     *   `display_name`. For example, `Fun Eve` matches `Fun event` or `The
+     *   evening was fun`, but not `notFun event` or `even`.
+     *
+     *   `external_user_allowed` accepts either `true` or `false`.
+     *
+     *   `space_history_state` only accepts values from the [`historyState`]
+     *   (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)
+     *   field of a `space` resource.
+     *
+     *   `space_type` is required and the only valid value is `SPACE`.
+     *
+     *   Across different fields, only `AND` operators are supported. A valid
+     *   example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid
+     *   example is `space_type = "SPACE" OR display_name:"Hello"`.
+     *
+     *   Among the same field,
+     *   `space_type` doesn't support `AND` or `OR` operators.
+     *   `display_name`, 'space_history_state', and 'external_user_allowed' only
+     *   support `OR` operators.
+     *   `last_active_time` and `create_time` support both `AND` and `OR` operators.
+     *   `AND` can only be used to represent an interval, such as `last_active_time
+     *   < "2022-01-01T00:00:00+00:00" AND last_active_time >
+     *   "2023-01-01T00:00:00+00:00"`.
+     *
+     *   The following example queries are valid:
+     *
+     *   ```
+     *   customer = "customers/my_customer" AND space_type = "SPACE"
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   display_name:"Hello World"
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
+     *   "2022-01-01T00:00:00+00:00")
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (display_name:"Hello World" OR display_name:"Fun event") AND
+     *   (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
+     *   "2022-01-01T00:00:00+00:00")
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (create_time > "2019-01-01T00:00:00+00:00" AND create_time <
+     *   "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
+     *   (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
+     *   ```
+     * @param {string} [request.orderBy]
+     *   Optional. How the list of spaces is ordered.
+     *
+     *   Supported attributes to order by are:
+     *
+     *   - `membership_count.joined_direct_human_user_count` — Denotes the count of
+     *   human users that have directly joined a space.
+     *   - `last_active_time` — Denotes the time when last eligible item is added to
+     *   any topic of this space.
+     *   - `create_time` — Denotes the time of the space creation.
+     *
+     *   Valid ordering operation values are:
+     *
+     *   - `ASC` for ascending. Default value.
+     *
+     *   - `DESC` for descending.
+     *
+     *   The supported syntax are:
+     *
+     *   - `membership_count.joined_direct_human_user_count DESC`
+     *   - `membership_count.joined_direct_human_user_count ASC`
+     *   - `last_active_time DESC`
+     *   - `last_active_time ASC`
+     *   - `create_time DESC`
+     *   - `create_time ASC`
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.chat.v1.Space|Space} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `searchSpacesAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    searchSpacesStream(request?: protos.google.chat.v1.ISearchSpacesRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `searchSpaces`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {boolean} request.useAdminAccess
+     *   When `true`, the method runs using the user's Google Workspace
+     *   administrator privileges.
+     *
+     *   The calling user must be a Google Workspace administrator with the
+     *   [manage chat and spaces conversations
+     *   privilege](https://support.google.com/a/answer/13369245).
+     *
+     *   Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces`
+     *   [OAuth 2.0
+     *   scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
+     *
+     *   This method currently only supports admin access, thus only `true` is
+     *   accepted for this field.
+     * @param {number} request.pageSize
+     *   The maximum number of spaces to return. The service may return fewer than
+     *   this value.
+     *
+     *   If unspecified, at most 100 spaces are returned.
+     *
+     *   The maximum value is 1000. If you use a value more than 1000, it's
+     *   automatically changed to 1000.
+     * @param {string} request.pageToken
+     *   A token, received from the previous search spaces call. Provide this
+     *   parameter to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided should match the call that
+     *   provided the page token. Passing different values to the other parameters
+     *   might lead to unexpected results.
+     * @param {string} request.query
+     *   Required. A search query.
+     *
+     *   You can search by using the following parameters:
+     *
+     *   - `create_time`
+     *   - `customer`
+     *   - `display_name`
+     *   - `external_user_allowed`
+     *   - `last_active_time`
+     *   - `space_history_state`
+     *   - `space_type`
+     *
+     *   `create_time` and `last_active_time` accept a timestamp in
+     *   [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported
+     *   comparison operators are: `=`, `<`, `>`, `<=`, `>=`.
+     *
+     *   `customer` is required and is used to indicate which customer
+     *   to fetch spaces from. `customers/my_customer` is the only supported value.
+     *
+     *   `display_name` only accepts the `HAS` (`:`) operator. The text to
+     *   match is first tokenized into tokens and each token is prefix-matched
+     *   case-insensitively and independently as a substring anywhere in the space's
+     *   `display_name`. For example, `Fun Eve` matches `Fun event` or `The
+     *   evening was fun`, but not `notFun event` or `even`.
+     *
+     *   `external_user_allowed` accepts either `true` or `false`.
+     *
+     *   `space_history_state` only accepts values from the [`historyState`]
+     *   (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)
+     *   field of a `space` resource.
+     *
+     *   `space_type` is required and the only valid value is `SPACE`.
+     *
+     *   Across different fields, only `AND` operators are supported. A valid
+     *   example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid
+     *   example is `space_type = "SPACE" OR display_name:"Hello"`.
+     *
+     *   Among the same field,
+     *   `space_type` doesn't support `AND` or `OR` operators.
+     *   `display_name`, 'space_history_state', and 'external_user_allowed' only
+     *   support `OR` operators.
+     *   `last_active_time` and `create_time` support both `AND` and `OR` operators.
+     *   `AND` can only be used to represent an interval, such as `last_active_time
+     *   < "2022-01-01T00:00:00+00:00" AND last_active_time >
+     *   "2023-01-01T00:00:00+00:00"`.
+     *
+     *   The following example queries are valid:
+     *
+     *   ```
+     *   customer = "customers/my_customer" AND space_type = "SPACE"
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   display_name:"Hello World"
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
+     *   "2022-01-01T00:00:00+00:00")
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (display_name:"Hello World" OR display_name:"Fun event") AND
+     *   (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
+     *   "2022-01-01T00:00:00+00:00")
+     *
+     *   customer = "customers/my_customer" AND space_type = "SPACE" AND
+     *   (create_time > "2019-01-01T00:00:00+00:00" AND create_time <
+     *   "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
+     *   (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
+     *   ```
+     * @param {string} [request.orderBy]
+     *   Optional. How the list of spaces is ordered.
+     *
+     *   Supported attributes to order by are:
+     *
+     *   - `membership_count.joined_direct_human_user_count` — Denotes the count of
+     *   human users that have directly joined a space.
+     *   - `last_active_time` — Denotes the time when last eligible item is added to
+     *   any topic of this space.
+     *   - `create_time` — Denotes the time of the space creation.
+     *
+     *   Valid ordering operation values are:
+     *
+     *   - `ASC` for ascending. Default value.
+     *
+     *   - `DESC` for descending.
+     *
+     *   The supported syntax are:
+     *
+     *   - `membership_count.joined_direct_human_user_count DESC`
+     *   - `membership_count.joined_direct_human_user_count ASC`
+     *   - `last_active_time DESC`
+     *   - `last_active_time ASC`
+     *   - `create_time DESC`
+     *   - `create_time ASC`
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.chat.v1.Space|Space}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/chat_service.search_spaces.js</caption>
+     * region_tag:chat_v1_generated_ChatService_SearchSpaces_async
+     */
+    searchSpacesAsync(request?: protos.google.chat.v1.ISearchSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
     /**
      * Lists reactions to a message. For an example, see
      * [List reactions for a