@google-apps/chat 0.27.0 → 0.29.0

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

@@ -3010,6 +3010,586 @@ export declare class ChatServiceClient {
      * region_tag:chat_v1_generated_ChatService_ListMemberships_async
      */
     listMembershipsAsync(request?: protos.google.chat.v1.IListMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IMembership>;
+    /**
+     * Searches for messages in Google Chat that the calling user has access to.
+     * Returns a list of messages matching the search criteria.
+     *
+     * To search across all spaces the user has access to, set `parent` to
+     * `spaces/-`. Using any other value for `parent` results in an
+     * `INVALID_ARGUMENT` error. The returned messages have their `name` field
+     * populated with the full resource name, which includes the specific `space`
+     * in which the message resides.
+     *
+     * This API doesn't return all message types. The types of messages listed
+     * below aren't included in the response. Use
+     * {@link protos.google.chat.v1.ChatService.ListMessages|ListMessages} to list all
+     * messages.
+     *
+     * - Private Messages that are visible to the authenticated user.
+     * - Messages posted by Chat apps in spaces or group chats.
+     * - Messages in a Chat app DM.
+     * - Messages from blocked users.
+     * - Messages in spaces that the caller has muted.
+     *
+     * Requires [user
+     * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+     * with one of the following [authorization
+     * scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.messages.readonly`
+     *   - `https://www.googleapis.com/auth/chat.messages`
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the space to search within.
+     *
+     *   To search across all spaces the user has access to, set this field to
+     *   `spaces/-`. Using any other value for `parent` results in an
+     *   `INVALID_ARGUMENT` error.
+     *
+     *   To limit the search to one or more spaces, use `space.name` or
+     *   `space.display_name` in the `filter`.
+     * @param {string} request.filter
+     *   Required. A search query.
+     *
+     *   The query can specify one or more search keywords, which are used to filter
+     *   the results,
+     *
+     *   You can also filter the results using the following message fields:
+     *
+     *   - `create_time`: Accepts a timestamp in
+     *     [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the
+     *     supported comparison operators are: `<` and `>=`.
+     *   - `sender.name`: The resource name of the sender (`users/{user}`). Only
+     *     supports `=`. You can use the e-mail as an alias for `{user}`. For
+     *     example, `users/example@gmail.com`, where `example@gmail.com` is the
+     *     e-mail of the Google Chat user.
+     *   - `space.name`: The resource name of the space where the message is posted.
+     *     (`spaces/{space}`). Only supports `=`. If this filter is not set, the
+     *     search is performed across all direct messages and spaces the user has
+     *     access to as a space member.
+     *   - `space.display_name`: Supports the operator `:` (has) and filters spaces
+     *     based on a partial match of their display name. Results are limited to
+     *     the top five space matches. For example, `space.display_name:Project`
+     *     searches for messages in the top five spaces that contain the word
+     *     "Project" in their display names.
+     *   - `attachment`: Supports the operator `:*` (has any) to check for the
+     *     presence of attachments. If `attachment:*` is specified, only messages
+     *     that have at least one attachment are returned.
+     *   - `annotations.user_mentions.user.name`: The resource name of the mentioned
+     *     user (`users/{user}`). Only supports `:` (has). For example:
+     *     `annotations.user_mentions.user.name:"users/1234567890"` returns only
+     *     messages that contain a mention to the specified user. Alternatively, the
+     *     alias `me` can be used to filter for messages that mention the caller
+     *     user, for example: `annotations.user_mentions.user.name:users/me`. You
+     *     can also use the e-mail as an alias for `{user}`, for example,
+     *     `users/example@gmail.com`.
+     *
+     *   For advanced filtering, the following functions are also available:
+     *
+     *   - `has_link()`: Returns only messages that have at least one hyperlink in
+     *     the message text.
+     *   - `is_unread()`: Filters out messages that have been read by the calling
+     *     user.
+     *
+     *   Using the `space.display_name` filter requires that the calling credentials
+     *   include one of the following [authorization
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.spaces.readonly`
+     *   - `https://www.googleapis.com/auth/chat.spaces`
+     *
+     *   Using the `is_unread()` filter requires that the calling credentials
+     *   include one of the following [authorization
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
+     *   - `https://www.googleapis.com/auth/chat.users.readstate`
+     *
+     *
+     *   Across different fields, only `AND` operators are supported. A valid
+     *   example is `sender.name = "users/1234567890" AND is_unread()`. The word
+     *   `AND` is optional and is implied if omitted. For example, `sender.name =
+     *   "users/1234567890" is_unread()` is valid and is equivalent to the previous
+     *   example. An invalid example is `sender.name = "users/1234567890" OR
+     *   is_unread()` because `OR` is not supported between different fields.
+     *
+     *   Among the same field:
+     *
+     *   - `create_time` supports only `AND`, and can only be used to represent
+     *      an interval, such as `create_time >= "2022-01-01T00:00:00+00:00" AND
+     *      create_time < "2023-01-01T00:00:00+00:00"`.
+     *   - `sender.name` supports only the `OR` operator, for example:
+     *     `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`.
+     *   - `space.name` supports only the `OR` operator, for example:
+     *     `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`.
+     *   - `space.display_name` supports the operators `AND` and `OR`, but not a
+     *     mix of both. For example:
+     *     `space.display_name:Project AND space.display_name:Tasks` returns
+     *     messages that are in spaces with display names containing both `Project`
+     *     and `Tasks`, whereas
+     *     `space.display_name:Project OR space.display_name:Tasks` returns messages
+     *     that are in spaces with display names containing either `Project` or
+     *     `Tasks` or both.
+     *   - `annotations.user_mentions.user.name` supports the operators `AND` and
+     *     `OR`, but not a mix of both. For example:
+     *     `annotations.user_mentions.user.name:"users/1234567890" AND
+     *     annotations.user_mentions.user.name:"users/0987654321"` returns only
+     *     messages that mentions both users, whereas
+     *     `annotations.user_mentions.user.name:"users/1234567890" OR
+     *     annotations.user_mentions.user.name:"users/0987654321"` returns messages
+     *     that mention either user or both.
+     *
+     *   Parentheses are required to disambiguate operator precedence when combining
+     *   `AND` and `OR` operators in the same query. For example:
+     *   `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`.
+     *   Otherwise, parentheses are optional.
+     *
+     *   The following example queries are valid:
+     *
+     *   ```
+     *   "Pending reports" AND create_time >= "2023-01-01T00:00:00Z"
+     *
+     *   sender.name = "users/example@gmail.com"
+     *
+     *   annotations.user_mentions.user.name:"users/0987654321"
+     *
+     *   attachment:* AND space.name = "spaces/ABCDEFGH"
+     *
+     *   tasks AND is_unread() AND sender.name = "users/1234567890"
+     *
+     *   "things to do" "urgent"
+     *
+     *   (sender.name = "users/1234567890")
+     *   AND (create_time < "2023-05-01T00:00:00Z")
+     *
+     *   tasks AND space.name = "spaces/ABCDEFGH" AND has_link()
+     *
+     *   "project one" is_unread()
+     *
+     *   space.display_name:Project tasks
+     *   ```
+     *
+     *   The maximum query length is 1,000 characters.
+     *
+     *   Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
+     *   error.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of results to return. The service may return
+     *   fewer than this value.
+     *
+     *   If unspecified, at most 25 are returned.
+     *
+     *   The maximum value is 100. If you use a value more than 100, it's
+     *   automatically changed to 100.
+     * @param {string} [request.pageToken]
+     *   Optional. A token, received from the previous search messages 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.orderBy]
+     *   Optional. How the results list is ordered.
+     *
+     *   Supported attributes to order by are:
+     *
+     *   - `create_time`: Sorts the results by the time of the message creation.
+     *     Default value.
+     *   - `relevance`: Sorts the results by relevance.
+     *     [Developer Preview](https://developers.google.com/workspace/preview).
+     *
+     *   The default ordering is `create_time desc`. Only a single order per query
+     *   (`create_time` or `relevance`) is supported. Only descending order (`desc`)
+     *   is supported, and it must be specified after the order attribute.
+     * @param {google.chat.v1.SearchMessagesRequest.SearchMessagesView} [request.view]
+     *   Optional. Specifies what kind of search results view to return. The default
+     *   is `SEARCH_MESSAGES_VIEW_BASIC`.
+     * @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.SearchMessageResult|SearchMessageResult}.
+     *   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 `searchMessagesAsync()`
+     *   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.
+     */
+    searchMessages(request?: protos.google.chat.v1.ISearchMessagesRequest, options?: CallOptions): Promise<[
+        protos.google.chat.v1.ISearchMessageResult[],
+        protos.google.chat.v1.ISearchMessagesRequest | null,
+        protos.google.chat.v1.ISearchMessagesResponse
+    ]>;
+    searchMessages(request: protos.google.chat.v1.ISearchMessagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.chat.v1.ISearchMessagesRequest, protos.google.chat.v1.ISearchMessagesResponse | null | undefined, protos.google.chat.v1.ISearchMessageResult>): void;
+    searchMessages(request: protos.google.chat.v1.ISearchMessagesRequest, callback: PaginationCallback<protos.google.chat.v1.ISearchMessagesRequest, protos.google.chat.v1.ISearchMessagesResponse | null | undefined, protos.google.chat.v1.ISearchMessageResult>): void;
+    /**
+     * Equivalent to `searchMessages`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the space to search within.
+     *
+     *   To search across all spaces the user has access to, set this field to
+     *   `spaces/-`. Using any other value for `parent` results in an
+     *   `INVALID_ARGUMENT` error.
+     *
+     *   To limit the search to one or more spaces, use `space.name` or
+     *   `space.display_name` in the `filter`.
+     * @param {string} request.filter
+     *   Required. A search query.
+     *
+     *   The query can specify one or more search keywords, which are used to filter
+     *   the results,
+     *
+     *   You can also filter the results using the following message fields:
+     *
+     *   - `create_time`: Accepts a timestamp in
+     *     [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the
+     *     supported comparison operators are: `<` and `>=`.
+     *   - `sender.name`: The resource name of the sender (`users/{user}`). Only
+     *     supports `=`. You can use the e-mail as an alias for `{user}`. For
+     *     example, `users/example@gmail.com`, where `example@gmail.com` is the
+     *     e-mail of the Google Chat user.
+     *   - `space.name`: The resource name of the space where the message is posted.
+     *     (`spaces/{space}`). Only supports `=`. If this filter is not set, the
+     *     search is performed across all direct messages and spaces the user has
+     *     access to as a space member.
+     *   - `space.display_name`: Supports the operator `:` (has) and filters spaces
+     *     based on a partial match of their display name. Results are limited to
+     *     the top five space matches. For example, `space.display_name:Project`
+     *     searches for messages in the top five spaces that contain the word
+     *     "Project" in their display names.
+     *   - `attachment`: Supports the operator `:*` (has any) to check for the
+     *     presence of attachments. If `attachment:*` is specified, only messages
+     *     that have at least one attachment are returned.
+     *   - `annotations.user_mentions.user.name`: The resource name of the mentioned
+     *     user (`users/{user}`). Only supports `:` (has). For example:
+     *     `annotations.user_mentions.user.name:"users/1234567890"` returns only
+     *     messages that contain a mention to the specified user. Alternatively, the
+     *     alias `me` can be used to filter for messages that mention the caller
+     *     user, for example: `annotations.user_mentions.user.name:users/me`. You
+     *     can also use the e-mail as an alias for `{user}`, for example,
+     *     `users/example@gmail.com`.
+     *
+     *   For advanced filtering, the following functions are also available:
+     *
+     *   - `has_link()`: Returns only messages that have at least one hyperlink in
+     *     the message text.
+     *   - `is_unread()`: Filters out messages that have been read by the calling
+     *     user.
+     *
+     *   Using the `space.display_name` filter requires that the calling credentials
+     *   include one of the following [authorization
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.spaces.readonly`
+     *   - `https://www.googleapis.com/auth/chat.spaces`
+     *
+     *   Using the `is_unread()` filter requires that the calling credentials
+     *   include one of the following [authorization
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
+     *   - `https://www.googleapis.com/auth/chat.users.readstate`
+     *
+     *
+     *   Across different fields, only `AND` operators are supported. A valid
+     *   example is `sender.name = "users/1234567890" AND is_unread()`. The word
+     *   `AND` is optional and is implied if omitted. For example, `sender.name =
+     *   "users/1234567890" is_unread()` is valid and is equivalent to the previous
+     *   example. An invalid example is `sender.name = "users/1234567890" OR
+     *   is_unread()` because `OR` is not supported between different fields.
+     *
+     *   Among the same field:
+     *
+     *   - `create_time` supports only `AND`, and can only be used to represent
+     *      an interval, such as `create_time >= "2022-01-01T00:00:00+00:00" AND
+     *      create_time < "2023-01-01T00:00:00+00:00"`.
+     *   - `sender.name` supports only the `OR` operator, for example:
+     *     `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`.
+     *   - `space.name` supports only the `OR` operator, for example:
+     *     `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`.
+     *   - `space.display_name` supports the operators `AND` and `OR`, but not a
+     *     mix of both. For example:
+     *     `space.display_name:Project AND space.display_name:Tasks` returns
+     *     messages that are in spaces with display names containing both `Project`
+     *     and `Tasks`, whereas
+     *     `space.display_name:Project OR space.display_name:Tasks` returns messages
+     *     that are in spaces with display names containing either `Project` or
+     *     `Tasks` or both.
+     *   - `annotations.user_mentions.user.name` supports the operators `AND` and
+     *     `OR`, but not a mix of both. For example:
+     *     `annotations.user_mentions.user.name:"users/1234567890" AND
+     *     annotations.user_mentions.user.name:"users/0987654321"` returns only
+     *     messages that mentions both users, whereas
+     *     `annotations.user_mentions.user.name:"users/1234567890" OR
+     *     annotations.user_mentions.user.name:"users/0987654321"` returns messages
+     *     that mention either user or both.
+     *
+     *   Parentheses are required to disambiguate operator precedence when combining
+     *   `AND` and `OR` operators in the same query. For example:
+     *   `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`.
+     *   Otherwise, parentheses are optional.
+     *
+     *   The following example queries are valid:
+     *
+     *   ```
+     *   "Pending reports" AND create_time >= "2023-01-01T00:00:00Z"
+     *
+     *   sender.name = "users/example@gmail.com"
+     *
+     *   annotations.user_mentions.user.name:"users/0987654321"
+     *
+     *   attachment:* AND space.name = "spaces/ABCDEFGH"
+     *
+     *   tasks AND is_unread() AND sender.name = "users/1234567890"
+     *
+     *   "things to do" "urgent"
+     *
+     *   (sender.name = "users/1234567890")
+     *   AND (create_time < "2023-05-01T00:00:00Z")
+     *
+     *   tasks AND space.name = "spaces/ABCDEFGH" AND has_link()
+     *
+     *   "project one" is_unread()
+     *
+     *   space.display_name:Project tasks
+     *   ```
+     *
+     *   The maximum query length is 1,000 characters.
+     *
+     *   Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
+     *   error.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of results to return. The service may return
+     *   fewer than this value.
+     *
+     *   If unspecified, at most 25 are returned.
+     *
+     *   The maximum value is 100. If you use a value more than 100, it's
+     *   automatically changed to 100.
+     * @param {string} [request.pageToken]
+     *   Optional. A token, received from the previous search messages 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.orderBy]
+     *   Optional. How the results list is ordered.
+     *
+     *   Supported attributes to order by are:
+     *
+     *   - `create_time`: Sorts the results by the time of the message creation.
+     *     Default value.
+     *   - `relevance`: Sorts the results by relevance.
+     *     [Developer Preview](https://developers.google.com/workspace/preview).
+     *
+     *   The default ordering is `create_time desc`. Only a single order per query
+     *   (`create_time` or `relevance`) is supported. Only descending order (`desc`)
+     *   is supported, and it must be specified after the order attribute.
+     * @param {google.chat.v1.SearchMessagesRequest.SearchMessagesView} [request.view]
+     *   Optional. Specifies what kind of search results view to return. The default
+     *   is `SEARCH_MESSAGES_VIEW_BASIC`.
+     * @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.SearchMessageResult|SearchMessageResult} 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 `searchMessagesAsync()`
+     *   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.
+     */
+    searchMessagesStream(request?: protos.google.chat.v1.ISearchMessagesRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `searchMessages`, 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 {string} request.parent
+     *   Required. The resource name of the space to search within.
+     *
+     *   To search across all spaces the user has access to, set this field to
+     *   `spaces/-`. Using any other value for `parent` results in an
+     *   `INVALID_ARGUMENT` error.
+     *
+     *   To limit the search to one or more spaces, use `space.name` or
+     *   `space.display_name` in the `filter`.
+     * @param {string} request.filter
+     *   Required. A search query.
+     *
+     *   The query can specify one or more search keywords, which are used to filter
+     *   the results,
+     *
+     *   You can also filter the results using the following message fields:
+     *
+     *   - `create_time`: Accepts a timestamp in
+     *     [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the
+     *     supported comparison operators are: `<` and `>=`.
+     *   - `sender.name`: The resource name of the sender (`users/{user}`). Only
+     *     supports `=`. You can use the e-mail as an alias for `{user}`. For
+     *     example, `users/example@gmail.com`, where `example@gmail.com` is the
+     *     e-mail of the Google Chat user.
+     *   - `space.name`: The resource name of the space where the message is posted.
+     *     (`spaces/{space}`). Only supports `=`. If this filter is not set, the
+     *     search is performed across all direct messages and spaces the user has
+     *     access to as a space member.
+     *   - `space.display_name`: Supports the operator `:` (has) and filters spaces
+     *     based on a partial match of their display name. Results are limited to
+     *     the top five space matches. For example, `space.display_name:Project`
+     *     searches for messages in the top five spaces that contain the word
+     *     "Project" in their display names.
+     *   - `attachment`: Supports the operator `:*` (has any) to check for the
+     *     presence of attachments. If `attachment:*` is specified, only messages
+     *     that have at least one attachment are returned.
+     *   - `annotations.user_mentions.user.name`: The resource name of the mentioned
+     *     user (`users/{user}`). Only supports `:` (has). For example:
+     *     `annotations.user_mentions.user.name:"users/1234567890"` returns only
+     *     messages that contain a mention to the specified user. Alternatively, the
+     *     alias `me` can be used to filter for messages that mention the caller
+     *     user, for example: `annotations.user_mentions.user.name:users/me`. You
+     *     can also use the e-mail as an alias for `{user}`, for example,
+     *     `users/example@gmail.com`.
+     *
+     *   For advanced filtering, the following functions are also available:
+     *
+     *   - `has_link()`: Returns only messages that have at least one hyperlink in
+     *     the message text.
+     *   - `is_unread()`: Filters out messages that have been read by the calling
+     *     user.
+     *
+     *   Using the `space.display_name` filter requires that the calling credentials
+     *   include one of the following [authorization
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.spaces.readonly`
+     *   - `https://www.googleapis.com/auth/chat.spaces`
+     *
+     *   Using the `is_unread()` filter requires that the calling credentials
+     *   include one of the following [authorization
+     *   scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.users.readstate.readonly`
+     *   - `https://www.googleapis.com/auth/chat.users.readstate`
+     *
+     *
+     *   Across different fields, only `AND` operators are supported. A valid
+     *   example is `sender.name = "users/1234567890" AND is_unread()`. The word
+     *   `AND` is optional and is implied if omitted. For example, `sender.name =
+     *   "users/1234567890" is_unread()` is valid and is equivalent to the previous
+     *   example. An invalid example is `sender.name = "users/1234567890" OR
+     *   is_unread()` because `OR` is not supported between different fields.
+     *
+     *   Among the same field:
+     *
+     *   - `create_time` supports only `AND`, and can only be used to represent
+     *      an interval, such as `create_time >= "2022-01-01T00:00:00+00:00" AND
+     *      create_time < "2023-01-01T00:00:00+00:00"`.
+     *   - `sender.name` supports only the `OR` operator, for example:
+     *     `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`.
+     *   - `space.name` supports only the `OR` operator, for example:
+     *     `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`.
+     *   - `space.display_name` supports the operators `AND` and `OR`, but not a
+     *     mix of both. For example:
+     *     `space.display_name:Project AND space.display_name:Tasks` returns
+     *     messages that are in spaces with display names containing both `Project`
+     *     and `Tasks`, whereas
+     *     `space.display_name:Project OR space.display_name:Tasks` returns messages
+     *     that are in spaces with display names containing either `Project` or
+     *     `Tasks` or both.
+     *   - `annotations.user_mentions.user.name` supports the operators `AND` and
+     *     `OR`, but not a mix of both. For example:
+     *     `annotations.user_mentions.user.name:"users/1234567890" AND
+     *     annotations.user_mentions.user.name:"users/0987654321"` returns only
+     *     messages that mentions both users, whereas
+     *     `annotations.user_mentions.user.name:"users/1234567890" OR
+     *     annotations.user_mentions.user.name:"users/0987654321"` returns messages
+     *     that mention either user or both.
+     *
+     *   Parentheses are required to disambiguate operator precedence when combining
+     *   `AND` and `OR` operators in the same query. For example:
+     *   `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`.
+     *   Otherwise, parentheses are optional.
+     *
+     *   The following example queries are valid:
+     *
+     *   ```
+     *   "Pending reports" AND create_time >= "2023-01-01T00:00:00Z"
+     *
+     *   sender.name = "users/example@gmail.com"
+     *
+     *   annotations.user_mentions.user.name:"users/0987654321"
+     *
+     *   attachment:* AND space.name = "spaces/ABCDEFGH"
+     *
+     *   tasks AND is_unread() AND sender.name = "users/1234567890"
+     *
+     *   "things to do" "urgent"
+     *
+     *   (sender.name = "users/1234567890")
+     *   AND (create_time < "2023-05-01T00:00:00Z")
+     *
+     *   tasks AND space.name = "spaces/ABCDEFGH" AND has_link()
+     *
+     *   "project one" is_unread()
+     *
+     *   space.display_name:Project tasks
+     *   ```
+     *
+     *   The maximum query length is 1,000 characters.
+     *
+     *   Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
+     *   error.
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of results to return. The service may return
+     *   fewer than this value.
+     *
+     *   If unspecified, at most 25 are returned.
+     *
+     *   The maximum value is 100. If you use a value more than 100, it's
+     *   automatically changed to 100.
+     * @param {string} [request.pageToken]
+     *   Optional. A token, received from the previous search messages 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.orderBy]
+     *   Optional. How the results list is ordered.
+     *
+     *   Supported attributes to order by are:
+     *
+     *   - `create_time`: Sorts the results by the time of the message creation.
+     *     Default value.
+     *   - `relevance`: Sorts the results by relevance.
+     *     [Developer Preview](https://developers.google.com/workspace/preview).
+     *
+     *   The default ordering is `create_time desc`. Only a single order per query
+     *   (`create_time` or `relevance`) is supported. Only descending order (`desc`)
+     *   is supported, and it must be specified after the order attribute.
+     * @param {google.chat.v1.SearchMessagesRequest.SearchMessagesView} [request.view]
+     *   Optional. Specifies what kind of search results view to return. The default
+     *   is `SEARCH_MESSAGES_VIEW_BASIC`.
+     * @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.SearchMessageResult|SearchMessageResult}. 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_messages.js</caption>
+     * region_tag:chat_v1_generated_ChatService_SearchMessages_async
+     */
+    searchMessagesAsync(request?: protos.google.chat.v1.ISearchMessagesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISearchMessageResult>;
     /**
      * Lists spaces the caller is a member of. Group chats and DMs aren't listed
      * until the first message is sent. For an example, see
@@ -3199,19 +3779,30 @@ export declare class ChatServiceClient {
      */
     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. In the request, set `use_admin_access` to `true`.
-     * For an example, see [Search for and manage
+     * Returns a list of spaces in a Google Workspace organization. For an
+     * example, see [Search for and manage
      * spaces](https://developers.google.com/workspace/chat/search-manage-admin).
      *
-     * Requires [user
+     * When `use_admin_access` is set to `false`, the results are limited to
+     * spaces where the calling user is a joined member. To search with
+     * administrator privileges, set `use_admin_access` to `true`.
+     *
+     * Supports the following types of
+     * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
+     *
+     * - [User
+     * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+     * with one of the following authorization scopes:
+     *     - `https://www.googleapis.com/auth/chat.spaces.readonly`
+     *     - `https://www.googleapis.com/auth/chat.spaces`
+     *
+     * - [User
      * authentication with administrator
      * privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges)
      * and one of the following [authorization
      * scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
-     *
-     *   - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
-     *   - `https://www.googleapis.com/auth/chat.admin.spaces`
+     *     - `https://www.googleapis.com/auth/chat.admin.spaces.readonly`
+     *     - `https://www.googleapis.com/auth/chat.admin.spaces`
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -3226,9 +3817,6 @@ export declare class ChatServiceClient {
      *   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.
@@ -3247,7 +3835,8 @@ export declare class ChatServiceClient {
      * @param {string} request.query
      *   Required. A search query.
      *
-     *   You can search by using the following parameters:
+     *   You can search by using the following parameters when `useAdminAccess`
+     *   is set to `true`:
      *
      *   - `create_time`
      *   - `customer`
@@ -3257,18 +3846,27 @@ export declare class ChatServiceClient {
      *   - `space_history_state`
      *   - `space_type`
      *
+     *   When `useAdminAccess` is set to `false`:
+     *
+     *   - `display_name`
+     *   - `external_user_allowed`
+     *   - `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.
+     *   `customer` is required when `useAdminAccess` is set to `true`, 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`.
+     *   evening was fun`, but not `notFun event` or `even`. When `useAdminAccess`
+     *   is set to `false`, `display_name` is required to retrieve meaningful
+     *   results. Otherwise, the default behavior is to return an empty response.
      *
      *   `external_user_allowed` accepts either `true` or `false`.
      *
@@ -3291,7 +3889,8 @@ export declare class ChatServiceClient {
      *   < "2022-01-01T00:00:00+00:00" AND last_active_time >
      *   "2023-01-01T00:00:00+00:00"`.
      *
-     *   The following example queries are valid:
+     *   The following example queries are valid when `useAdminAccess` is set to
+     *   `true`:
      *
      *   ```
      *   customer = "customers/my_customer" AND space_type = "SPACE"
@@ -3313,6 +3912,21 @@ export declare class ChatServiceClient {
      *   "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
      *   (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
      *   ```
+     *
+     *   The following example queries are valid when `useAdminAccess` is set to
+     *   `false`:
+     *
+     *   ```
+     *   display_name:"Hello World" AND space_type = "SPACE"
+     *
+     *   (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"
+     *
+     *   (external_user_allowed = "true" AND space_type = "SPACE") // Returns an
+     *   empty response.
+     *
+     *   (external_user_allowed = "true" AND display_name:"Hello" AND space_type =
+     *   "SPACE")
+     *   ```
      * @param {string} [request.orderBy]
      *   Optional. How the list of spaces is ordered.
      *
@@ -3324,13 +3938,17 @@ export declare class ChatServiceClient {
      *   any topic of this space.
      *   - `create_time` — Denotes the time of the space creation.
      *
+     *   When `useAdminAccess` is `false`, only `create_time` and `relevance` are
+     *   supported for ordering. Only `DESC` is supported for these fields in
+     *   non-admin searches.
+     *
      *   Valid ordering operation values are:
      *
      *   - `ASC` for ascending. Default value.
      *
      *   - `DESC` for descending.
      *
-     *   The supported syntax are:
+     *   The supported syntax are when `useAdminAccess` is set to `true`:
      *
      *   - `membership_count.joined_direct_human_user_count DESC`
      *   - `membership_count.joined_direct_human_user_count ASC`
@@ -3338,6 +3956,11 @@ export declare class ChatServiceClient {
      *   - `last_active_time ASC`
      *   - `create_time DESC`
      *   - `create_time ASC`
+     *
+     *   When `useAdminAccess` is set to `false`:
+     *
+     *   - `create_time DESC`
+     *   - `relevance DESC`
      * @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.
@@ -3372,9 +3995,6 @@ export declare class ChatServiceClient {
      *   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.
@@ -3393,7 +4013,8 @@ export declare class ChatServiceClient {
      * @param {string} request.query
      *   Required. A search query.
      *
-     *   You can search by using the following parameters:
+     *   You can search by using the following parameters when `useAdminAccess`
+     *   is set to `true`:
      *
      *   - `create_time`
      *   - `customer`
@@ -3403,18 +4024,27 @@ export declare class ChatServiceClient {
      *   - `space_history_state`
      *   - `space_type`
      *
+     *   When `useAdminAccess` is set to `false`:
+     *
+     *   - `display_name`
+     *   - `external_user_allowed`
+     *   - `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.
+     *   `customer` is required when `useAdminAccess` is set to `true`, 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`.
+     *   evening was fun`, but not `notFun event` or `even`. When `useAdminAccess`
+     *   is set to `false`, `display_name` is required to retrieve meaningful
+     *   results. Otherwise, the default behavior is to return an empty response.
      *
      *   `external_user_allowed` accepts either `true` or `false`.
      *
@@ -3437,7 +4067,8 @@ export declare class ChatServiceClient {
      *   < "2022-01-01T00:00:00+00:00" AND last_active_time >
      *   "2023-01-01T00:00:00+00:00"`.
      *
-     *   The following example queries are valid:
+     *   The following example queries are valid when `useAdminAccess` is set to
+     *   `true`:
      *
      *   ```
      *   customer = "customers/my_customer" AND space_type = "SPACE"
@@ -3459,6 +4090,21 @@ export declare class ChatServiceClient {
      *   "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
      *   (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
      *   ```
+     *
+     *   The following example queries are valid when `useAdminAccess` is set to
+     *   `false`:
+     *
+     *   ```
+     *   display_name:"Hello World" AND space_type = "SPACE"
+     *
+     *   (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"
+     *
+     *   (external_user_allowed = "true" AND space_type = "SPACE") // Returns an
+     *   empty response.
+     *
+     *   (external_user_allowed = "true" AND display_name:"Hello" AND space_type =
+     *   "SPACE")
+     *   ```
      * @param {string} [request.orderBy]
      *   Optional. How the list of spaces is ordered.
      *
@@ -3470,13 +4116,17 @@ export declare class ChatServiceClient {
      *   any topic of this space.
      *   - `create_time` — Denotes the time of the space creation.
      *
+     *   When `useAdminAccess` is `false`, only `create_time` and `relevance` are
+     *   supported for ordering. Only `DESC` is supported for these fields in
+     *   non-admin searches.
+     *
      *   Valid ordering operation values are:
      *
      *   - `ASC` for ascending. Default value.
      *
      *   - `DESC` for descending.
      *
-     *   The supported syntax are:
+     *   The supported syntax are when `useAdminAccess` is set to `true`:
      *
      *   - `membership_count.joined_direct_human_user_count DESC`
      *   - `membership_count.joined_direct_human_user_count ASC`
@@ -3484,6 +4134,11 @@ export declare class ChatServiceClient {
      *   - `last_active_time ASC`
      *   - `create_time DESC`
      *   - `create_time ASC`
+     *
+     *   When `useAdminAccess` is set to `false`:
+     *
+     *   - `create_time DESC`
+     *   - `relevance DESC`
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -3513,9 +4168,6 @@ export declare class ChatServiceClient {
      *   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.
@@ -3534,7 +4186,8 @@ export declare class ChatServiceClient {
      * @param {string} request.query
      *   Required. A search query.
      *
-     *   You can search by using the following parameters:
+     *   You can search by using the following parameters when `useAdminAccess`
+     *   is set to `true`:
      *
      *   - `create_time`
      *   - `customer`
@@ -3544,18 +4197,27 @@ export declare class ChatServiceClient {
      *   - `space_history_state`
      *   - `space_type`
      *
+     *   When `useAdminAccess` is set to `false`:
+     *
+     *   - `display_name`
+     *   - `external_user_allowed`
+     *   - `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.
+     *   `customer` is required when `useAdminAccess` is set to `true`, 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`.
+     *   evening was fun`, but not `notFun event` or `even`. When `useAdminAccess`
+     *   is set to `false`, `display_name` is required to retrieve meaningful
+     *   results. Otherwise, the default behavior is to return an empty response.
      *
      *   `external_user_allowed` accepts either `true` or `false`.
      *
@@ -3578,7 +4240,8 @@ export declare class ChatServiceClient {
      *   < "2022-01-01T00:00:00+00:00" AND last_active_time >
      *   "2023-01-01T00:00:00+00:00"`.
      *
-     *   The following example queries are valid:
+     *   The following example queries are valid when `useAdminAccess` is set to
+     *   `true`:
      *
      *   ```
      *   customer = "customers/my_customer" AND space_type = "SPACE"
@@ -3600,6 +4263,21 @@ export declare class ChatServiceClient {
      *   "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
      *   (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
      *   ```
+     *
+     *   The following example queries are valid when `useAdminAccess` is set to
+     *   `false`:
+     *
+     *   ```
+     *   display_name:"Hello World" AND space_type = "SPACE"
+     *
+     *   (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"
+     *
+     *   (external_user_allowed = "true" AND space_type = "SPACE") // Returns an
+     *   empty response.
+     *
+     *   (external_user_allowed = "true" AND display_name:"Hello" AND space_type =
+     *   "SPACE")
+     *   ```
      * @param {string} [request.orderBy]
      *   Optional. How the list of spaces is ordered.
      *
@@ -3611,13 +4289,17 @@ export declare class ChatServiceClient {
      *   any topic of this space.
      *   - `create_time` — Denotes the time of the space creation.
      *
+     *   When `useAdminAccess` is `false`, only `create_time` and `relevance` are
+     *   supported for ordering. Only `DESC` is supported for these fields in
+     *   non-admin searches.
+     *
      *   Valid ordering operation values are:
      *
      *   - `ASC` for ascending. Default value.
      *
      *   - `DESC` for descending.
      *
-     *   The supported syntax are:
+     *   The supported syntax are when `useAdminAccess` is set to `true`:
      *
      *   - `membership_count.joined_direct_human_user_count DESC`
      *   - `membership_count.joined_direct_human_user_count ASC`
@@ -3625,6 +4307,11 @@ export declare class ChatServiceClient {
      *   - `last_active_time ASC`
      *   - `create_time DESC`
      *   - `create_time ASC`
+     *
+     *   When `useAdminAccess` is set to `false`:
+     *
+     *   - `create_time DESC`
+     *   - `relevance DESC`
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}