diff --git a/AppsChat/metadata/Chat/V1/Attachment.php b/AppsChat/metadata/Chat/V1/Attachment.php index 1609b6964466..05a0516d53af 100644 Binary files a/AppsChat/metadata/Chat/V1/Attachment.php and b/AppsChat/metadata/Chat/V1/Attachment.php differ diff --git a/AppsChat/metadata/Chat/V1/Membership.php b/AppsChat/metadata/Chat/V1/Membership.php index 1aede18ab024..a69cfd423079 100644 Binary files a/AppsChat/metadata/Chat/V1/Membership.php and b/AppsChat/metadata/Chat/V1/Membership.php differ diff --git a/AppsChat/metadata/Chat/V1/Message.php b/AppsChat/metadata/Chat/V1/Message.php index 1182a27601d5..9c6f17aad0c3 100644 Binary files a/AppsChat/metadata/Chat/V1/Message.php and b/AppsChat/metadata/Chat/V1/Message.php differ diff --git a/AppsChat/metadata/Chat/V1/Reaction.php b/AppsChat/metadata/Chat/V1/Reaction.php index 466d59d51b69..4da039de48f2 100644 Binary files a/AppsChat/metadata/Chat/V1/Reaction.php and b/AppsChat/metadata/Chat/V1/Reaction.php differ diff --git a/AppsChat/metadata/Chat/V1/Space.php b/AppsChat/metadata/Chat/V1/Space.php index 5504f5780ffd..7bba5faa940b 100644 Binary files a/AppsChat/metadata/Chat/V1/Space.php and b/AppsChat/metadata/Chat/V1/Space.php differ diff --git a/AppsChat/metadata/Chat/V1/SpaceEvent.php b/AppsChat/metadata/Chat/V1/SpaceEvent.php index 28b3baeaed4a..7c6438b20564 100644 Binary files a/AppsChat/metadata/Chat/V1/SpaceEvent.php and b/AppsChat/metadata/Chat/V1/SpaceEvent.php differ diff --git a/AppsChat/samples/V1/ChatServiceClient/complete_import_space.php b/AppsChat/samples/V1/ChatServiceClient/complete_import_space.php index 3a70907c0c48..a2959e8ffec2 100644 --- a/AppsChat/samples/V1/ChatServiceClient/complete_import_space.php +++ b/AppsChat/samples/V1/ChatServiceClient/complete_import_space.php @@ -32,8 +32,11 @@ * Completes the * [import process](https://developers.google.com/workspace/chat/import-data) * for the specified space and makes it visible to users. - * Requires app authentication and domain-wide delegation. For more - * information, see [Authorize Google Chat apps to import + * + * Requires [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * and domain-wide delegation. For more information, see [Authorize Google + * Chat apps to import * data](https://developers.google.com/workspace/chat/authorize-import). * * @param string $formattedName Resource name of the import mode space. diff --git a/AppsChat/samples/V1/ChatServiceClient/create_membership.php b/AppsChat/samples/V1/ChatServiceClient/create_membership.php index 00c98fef72c7..f301b5fefca2 100644 --- a/AppsChat/samples/V1/ChatServiceClient/create_membership.php +++ b/AppsChat/samples/V1/ChatServiceClient/create_membership.php @@ -35,8 +35,19 @@ * 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 - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * For example usage, see: * diff --git a/AppsChat/samples/V1/ChatServiceClient/create_message.php b/AppsChat/samples/V1/ChatServiceClient/create_message.php index d25de7b6334b..af06848d903b 100644 --- a/AppsChat/samples/V1/ChatServiceClient/create_message.php +++ b/AppsChat/samples/V1/ChatServiceClient/create_message.php @@ -32,8 +32,11 @@ * Creates a message in a Google Chat space. For an example, see [Send a * message](https://developers.google.com/workspace/chat/create-messages). * - * The `create()` method requires either user or app authentication. Chat - * attributes the message sender differently depending on the type of + * The `create()` method requires either [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * or [app + * authentication](https://developers.google.com/workspace/chat/authorize-import). + * Chat attributes the message sender differently depending on the type of * authentication that you use in your request. * * The following image shows how Chat attributes a message when you use app @@ -54,6 +57,12 @@ * * The maximum message size, including the message contents, is 32,000 bytes. * + * For + * [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) + * requests, the response doesn't contain the full message. The response only + * populates the `name` and `thread.name` fields in addition to the + * information that was in the request. + * * @param string $formattedParent The resource name of the space in which to create a message. * * Format: `spaces/{space}` diff --git a/AppsChat/samples/V1/ChatServiceClient/create_reaction.php b/AppsChat/samples/V1/ChatServiceClient/create_reaction.php index 708a409cecff..d846067fdb00 100644 --- a/AppsChat/samples/V1/ChatServiceClient/create_reaction.php +++ b/AppsChat/samples/V1/ChatServiceClient/create_reaction.php @@ -26,6 +26,7 @@ use Google\ApiCore\ApiException; use Google\Apps\Chat\V1\Client\ChatServiceClient; use Google\Apps\Chat\V1\CreateReactionRequest; +use Google\Apps\Chat\V1\Emoji; use Google\Apps\Chat\V1\Reaction; /** @@ -33,6 +34,7 @@ * supported. For an example, see * [Add a reaction to a * message](https://developers.google.com/workspace/chat/create-reactions). + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @@ -47,7 +49,9 @@ function create_reaction_sample(string $formattedParent): void $chatServiceClient = new ChatServiceClient(); // Prepare the request message. - $reaction = new Reaction(); + $reactionEmoji = new Emoji(); + $reaction = (new Reaction()) + ->setEmoji($reactionEmoji); $request = (new CreateReactionRequest()) ->setParent($formattedParent) ->setReaction($reaction); diff --git a/AppsChat/samples/V1/ChatServiceClient/create_space.php b/AppsChat/samples/V1/ChatServiceClient/create_space.php index c331bbca54b9..3a8a71ee6300 100644 --- a/AppsChat/samples/V1/ChatServiceClient/create_space.php +++ b/AppsChat/samples/V1/ChatServiceClient/create_space.php @@ -29,21 +29,27 @@ use Google\Apps\Chat\V1\Space; /** - * 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 + * Creates a space with no members. Can be used to create a named space, or a + * group chat in `Import mode`. 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`. + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * + * When authenticating as an app, the `space.customer` field must be set in + * the request. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: diff --git a/AppsChat/samples/V1/ChatServiceClient/delete_membership.php b/AppsChat/samples/V1/ChatServiceClient/delete_membership.php index cb6d26d75502..fc136a99faf4 100644 --- a/AppsChat/samples/V1/ChatServiceClient/delete_membership.php +++ b/AppsChat/samples/V1/ChatServiceClient/delete_membership.php @@ -33,8 +33,18 @@ * [Remove a user or a Google Chat app from a * space](https://developers.google.com/workspace/chat/delete-members). * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * @param string $formattedName Resource name of the membership to delete. Chat apps can delete * human users' or their own memberships. Chat apps can't delete other apps' diff --git a/AppsChat/samples/V1/ChatServiceClient/delete_message.php b/AppsChat/samples/V1/ChatServiceClient/delete_message.php index 4cba6f6cda36..61bb07028f8e 100644 --- a/AppsChat/samples/V1/ChatServiceClient/delete_message.php +++ b/AppsChat/samples/V1/ChatServiceClient/delete_message.php @@ -32,13 +32,15 @@ * For an example, see [Delete a * message](https://developers.google.com/workspace/chat/delete-messages). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * * When using app authentication, requests can only delete messages * created by the calling Chat app. * diff --git a/AppsChat/samples/V1/ChatServiceClient/delete_reaction.php b/AppsChat/samples/V1/ChatServiceClient/delete_reaction.php index ff8e837d34a5..1edc9d23c05a 100644 --- a/AppsChat/samples/V1/ChatServiceClient/delete_reaction.php +++ b/AppsChat/samples/V1/ChatServiceClient/delete_reaction.php @@ -32,6 +32,7 @@ * For an example, see * [Delete a * reaction](https://developers.google.com/workspace/chat/delete-reactions). + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * diff --git a/AppsChat/samples/V1/ChatServiceClient/delete_space.php b/AppsChat/samples/V1/ChatServiceClient/delete_space.php index d5cb8b8e282c..e1579e08ca3a 100644 --- a/AppsChat/samples/V1/ChatServiceClient/delete_space.php +++ b/AppsChat/samples/V1/ChatServiceClient/delete_space.php @@ -33,9 +33,19 @@ * memberships in the space—are also deleted. For an example, see * [Delete a * space](https://developers.google.com/workspace/chat/delete-spaces). - * Requires [user + * + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * from a user who has permission to delete the space. + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * @param string $formattedName Resource name of the space to delete. * diff --git a/AppsChat/samples/V1/ChatServiceClient/find_direct_message.php b/AppsChat/samples/V1/ChatServiceClient/find_direct_message.php index db4dd111f3d3..f6af95fdc420 100644 --- a/AppsChat/samples/V1/ChatServiceClient/find_direct_message.php +++ b/AppsChat/samples/V1/ChatServiceClient/find_direct_message.php @@ -34,20 +34,24 @@ * see * [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). * + * With [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), + * returns the direct message space between the specified user and the calling + * Chat app. + * * With [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * returns the direct message space between the specified user and the * authenticated user. * - * With [app - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), - * returns the direct message space between the specified user and the calling - * Chat app. + * // Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) * - * Requires [user + * - [User * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * or [app - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * * @param string $name Resource name of the user to find direct message with. * diff --git a/AppsChat/samples/V1/ChatServiceClient/get_membership.php b/AppsChat/samples/V1/ChatServiceClient/get_membership.php index 2264921471c0..fb4111e42f18 100644 --- a/AppsChat/samples/V1/ChatServiceClient/get_membership.php +++ b/AppsChat/samples/V1/ChatServiceClient/get_membership.php @@ -33,13 +33,16 @@ * [Get details about a user's or Google Chat app's * membership](https://developers.google.com/workspace/chat/get-members). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * @param string $formattedName Resource name of the membership to retrieve. * @@ -49,9 +52,7 @@ * * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` * - * When [authenticated as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * you can use the user's email as an alias for `{member}`. For example, + * 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. Please see * {@see ChatServiceClient::membershipName()} for help formatting this field. diff --git a/AppsChat/samples/V1/ChatServiceClient/get_message.php b/AppsChat/samples/V1/ChatServiceClient/get_message.php index b37e14eb6ae3..27c4d4b6a1cd 100644 --- a/AppsChat/samples/V1/ChatServiceClient/get_message.php +++ b/AppsChat/samples/V1/ChatServiceClient/get_message.php @@ -33,13 +33,14 @@ * For an example, see [Get details about a * message](https://developers.google.com/workspace/chat/get-messages). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) * * Note: Might return a message from a blocked member or space. * diff --git a/AppsChat/samples/V1/ChatServiceClient/get_space.php b/AppsChat/samples/V1/ChatServiceClient/get_space.php index 58a222f3b3c2..be79d0567a6e 100644 --- a/AppsChat/samples/V1/ChatServiceClient/get_space.php +++ b/AppsChat/samples/V1/ChatServiceClient/get_space.php @@ -33,13 +33,16 @@ * [Get details about a * space](https://developers.google.com/workspace/chat/get-spaces). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * @param string $formattedName Resource name of the space, in the form `spaces/{space}`. * diff --git a/AppsChat/samples/V1/ChatServiceClient/list_memberships.php b/AppsChat/samples/V1/ChatServiceClient/list_memberships.php index 2b1320f8efb4..283871247ee6 100644 --- a/AppsChat/samples/V1/ChatServiceClient/list_memberships.php +++ b/AppsChat/samples/V1/ChatServiceClient/list_memberships.php @@ -42,13 +42,16 @@ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) * lists memberships in spaces that the authenticated user has access to. * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * @param string $formattedParent The resource name of the space for which to fetch a membership * list. diff --git a/AppsChat/samples/V1/ChatServiceClient/list_messages.php b/AppsChat/samples/V1/ChatServiceClient/list_messages.php index 5755838d98d7..c62dcf779c80 100644 --- a/AppsChat/samples/V1/ChatServiceClient/list_messages.php +++ b/AppsChat/samples/V1/ChatServiceClient/list_messages.php @@ -37,6 +37,7 @@ * 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). * diff --git a/AppsChat/samples/V1/ChatServiceClient/list_reactions.php b/AppsChat/samples/V1/ChatServiceClient/list_reactions.php index 316b53751c4d..960f96a63697 100644 --- a/AppsChat/samples/V1/ChatServiceClient/list_reactions.php +++ b/AppsChat/samples/V1/ChatServiceClient/list_reactions.php @@ -33,6 +33,7 @@ * Lists reactions to a message. For an example, see * [List reactions for a * message](https://developers.google.com/workspace/chat/list-reactions). + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * diff --git a/AppsChat/samples/V1/ChatServiceClient/list_spaces.php b/AppsChat/samples/V1/ChatServiceClient/list_spaces.php index b4ccd291b017..4f2abd42602f 100644 --- a/AppsChat/samples/V1/ChatServiceClient/list_spaces.php +++ b/AppsChat/samples/V1/ChatServiceClient/list_spaces.php @@ -35,16 +35,14 @@ * [List * spaces](https://developers.google.com/workspace/chat/list-spaces). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * - * Lists spaces visible to the caller or authenticated user. Group chats - * and DMs aren't listed until the first message is sent. + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) * * To list all named spaces by Google Workspace organization, use the * [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) diff --git a/AppsChat/samples/V1/ChatServiceClient/search_spaces.php b/AppsChat/samples/V1/ChatServiceClient/search_spaces.php index fd7b8279f999..dd25c5f9d2e4 100644 --- a/AppsChat/samples/V1/ChatServiceClient/search_spaces.php +++ b/AppsChat/samples/V1/ChatServiceClient/search_spaces.php @@ -31,7 +31,9 @@ /** * Returns a list of spaces in a Google Workspace organization based on an - * administrator's search. Requires [user + * 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`. diff --git a/AppsChat/samples/V1/ChatServiceClient/update_membership.php b/AppsChat/samples/V1/ChatServiceClient/update_membership.php index 387555dc4ec3..fc77283944c9 100644 --- a/AppsChat/samples/V1/ChatServiceClient/update_membership.php +++ b/AppsChat/samples/V1/ChatServiceClient/update_membership.php @@ -33,8 +33,18 @@ * Updates a membership. For an example, see [Update a user's membership in * a space](https://developers.google.com/workspace/chat/update-members). * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: diff --git a/AppsChat/samples/V1/ChatServiceClient/update_message.php b/AppsChat/samples/V1/ChatServiceClient/update_message.php index 1f748c1d8a50..90c7aa87ff2a 100644 --- a/AppsChat/samples/V1/ChatServiceClient/update_message.php +++ b/AppsChat/samples/V1/ChatServiceClient/update_message.php @@ -27,6 +27,7 @@ use Google\Apps\Chat\V1\Client\ChatServiceClient; use Google\Apps\Chat\V1\Message; use Google\Apps\Chat\V1\UpdateMessageRequest; +use Google\Protobuf\FieldMask; /** * Updates a message. There's a difference between the `patch` and `update` @@ -36,13 +37,15 @@ * [Update a * message](https://developers.google.com/workspace/chat/update-messages). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * * When using app authentication, requests can only update messages * created by the calling Chat app. * @@ -59,8 +62,10 @@ function update_message_sample(): void // Prepare the request message. $message = new Message(); + $updateMask = new FieldMask(); $request = (new UpdateMessageRequest()) - ->setMessage($message); + ->setMessage($message) + ->setUpdateMask($updateMask); // Call the API and handle any network failures. try { diff --git a/AppsChat/samples/V1/ChatServiceClient/update_space.php b/AppsChat/samples/V1/ChatServiceClient/update_space.php index a50b3fcfbeff..189cc315cd97 100644 --- a/AppsChat/samples/V1/ChatServiceClient/update_space.php +++ b/AppsChat/samples/V1/ChatServiceClient/update_space.php @@ -27,6 +27,7 @@ use Google\Apps\Chat\V1\Client\ChatServiceClient; use Google\Apps\Chat\V1\Space; use Google\Apps\Chat\V1\UpdateSpaceRequest; +use Google\Protobuf\FieldMask; /** * Updates a space. For an example, see @@ -37,8 +38,18 @@ * `ALREADY_EXISTS`, try a different display name.. An existing space within * the Google Workspace organization might already use this display name. * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: @@ -53,8 +64,10 @@ function update_space_sample(): void // Prepare the request message. $space = new Space(); + $updateMask = new FieldMask(); $request = (new UpdateSpaceRequest()) - ->setSpace($space); + ->setSpace($space) + ->setUpdateMask($updateMask); // Call the API and handle any network failures. try { diff --git a/AppsChat/samples/V1/ChatServiceClient/upload_attachment.php b/AppsChat/samples/V1/ChatServiceClient/upload_attachment.php index 5312833b0722..88c286bb516e 100644 --- a/AppsChat/samples/V1/ChatServiceClient/upload_attachment.php +++ b/AppsChat/samples/V1/ChatServiceClient/upload_attachment.php @@ -32,6 +32,7 @@ * Uploads an attachment. For an example, see * [Upload media as a file * attachment](https://developers.google.com/workspace/chat/upload-media-attachments). + * * Requires user * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * diff --git a/AppsChat/src/Chat/V1/ActionResponse/UpdatedWidget.php b/AppsChat/src/Chat/V1/ActionResponse/UpdatedWidget.php index 0d8dd3bb27ef..dc38b00338d9 100644 --- a/AppsChat/src/Chat/V1/ActionResponse/UpdatedWidget.php +++ b/AppsChat/src/Chat/V1/ActionResponse/UpdatedWidget.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The response of the updated widget. - * Used to provide autocomplete options for a widget. + * For `selectionInput` widgets, returns autocomplete suggestions for a + * multiselect menu. * * Generated from protobuf message google.chat.v1.ActionResponse.UpdatedWidget */ diff --git a/AppsChat/src/Chat/V1/Attachment.php b/AppsChat/src/Chat/V1/Attachment.php index 585adb4fc599..4e6577d4bc1b 100644 --- a/AppsChat/src/Chat/V1/Attachment.php +++ b/AppsChat/src/Chat/V1/Attachment.php @@ -16,10 +16,10 @@ class Attachment extends \Google\Protobuf\Internal\Message { /** - * Resource name of the attachment, in the form + * Optional. Resource name of the attachment, in the form * `spaces/{space}/messages/{message}/attachments/{attachment}`. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $name = ''; /** @@ -65,15 +65,16 @@ class Attachment extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Resource name of the attachment, in the form + * Optional. Resource name of the attachment, in the form * `spaces/{space}/messages/{message}/attachments/{attachment}`. * @type string $content_name * Output only. The original file name for the content, not the full path. * @type string $content_type * Output only. The content type (MIME type) of the file. * @type \Google\Apps\Chat\V1\AttachmentDataRef $attachment_data_ref - * A reference to the attachment data. This field is used with the media API - * to download the attachment data. + * Optional. A reference to the attachment data. This field is used to + * create or update messages with attachments, or with the media API to + * download the attachment data. * @type \Google\Apps\Chat\V1\DriveDataRef $drive_data_ref * Output only. A reference to the Google Drive attachment. This field is * used with the Google Drive API. @@ -95,10 +96,10 @@ public function __construct($data = NULL) { } /** - * Resource name of the attachment, in the form + * Optional. Resource name of the attachment, in the form * `spaces/{space}/messages/{message}/attachments/{attachment}`. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getName() @@ -107,10 +108,10 @@ public function getName() } /** - * Resource name of the attachment, in the form + * Optional. Resource name of the attachment, in the form * `spaces/{space}/messages/{message}/attachments/{attachment}`. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -175,10 +176,11 @@ public function setContentType($var) } /** - * A reference to the attachment data. This field is used with the media API - * to download the attachment data. + * Optional. A reference to the attachment data. This field is used to + * create or update messages with attachments, or with the media API to + * download the attachment data. * - * Generated from protobuf field .google.chat.v1.AttachmentDataRef attachment_data_ref = 4; + * Generated from protobuf field .google.chat.v1.AttachmentDataRef attachment_data_ref = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\AttachmentDataRef|null */ public function getAttachmentDataRef() @@ -192,10 +194,11 @@ public function hasAttachmentDataRef() } /** - * A reference to the attachment data. This field is used with the media API - * to download the attachment data. + * Optional. A reference to the attachment data. This field is used to + * create or update messages with attachments, or with the media API to + * download the attachment data. * - * Generated from protobuf field .google.chat.v1.AttachmentDataRef attachment_data_ref = 4; + * Generated from protobuf field .google.chat.v1.AttachmentDataRef attachment_data_ref = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\AttachmentDataRef $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/AttachmentDataRef.php b/AppsChat/src/Chat/V1/AttachmentDataRef.php index 713e30068a9b..4298cd26957d 100644 --- a/AppsChat/src/Chat/V1/AttachmentDataRef.php +++ b/AppsChat/src/Chat/V1/AttachmentDataRef.php @@ -16,18 +16,18 @@ class AttachmentDataRef extends \Google\Protobuf\Internal\Message { /** - * The resource name of the attachment data. This field is used with the media - * API to download the attachment data. + * Optional. The resource name of the attachment data. This field is used with + * the media API to download the attachment data. * - * Generated from protobuf field string resource_name = 1; + * Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $resource_name = ''; /** - * Opaque token containing a reference to an uploaded attachment. Treated by - * clients as an opaque string and used to create or update Chat messages with - * attachments. + * Optional. Opaque token containing a reference to an uploaded attachment. + * Treated by clients as an opaque string and used to create or update Chat + * messages with attachments. * - * Generated from protobuf field string attachment_upload_token = 2; + * Generated from protobuf field string attachment_upload_token = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $attachment_upload_token = ''; @@ -38,12 +38,12 @@ class AttachmentDataRef extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $resource_name - * The resource name of the attachment data. This field is used with the media - * API to download the attachment data. + * Optional. The resource name of the attachment data. This field is used with + * the media API to download the attachment data. * @type string $attachment_upload_token - * Opaque token containing a reference to an uploaded attachment. Treated by - * clients as an opaque string and used to create or update Chat messages with - * attachments. + * Optional. Opaque token containing a reference to an uploaded attachment. + * Treated by clients as an opaque string and used to create or update Chat + * messages with attachments. * } */ public function __construct($data = NULL) { @@ -52,10 +52,10 @@ public function __construct($data = NULL) { } /** - * The resource name of the attachment data. This field is used with the media - * API to download the attachment data. + * Optional. The resource name of the attachment data. This field is used with + * the media API to download the attachment data. * - * Generated from protobuf field string resource_name = 1; + * Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getResourceName() @@ -64,10 +64,10 @@ public function getResourceName() } /** - * The resource name of the attachment data. This field is used with the media - * API to download the attachment data. + * Optional. The resource name of the attachment data. This field is used with + * the media API to download the attachment data. * - * Generated from protobuf field string resource_name = 1; + * Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -80,11 +80,11 @@ public function setResourceName($var) } /** - * Opaque token containing a reference to an uploaded attachment. Treated by - * clients as an opaque string and used to create or update Chat messages with - * attachments. + * Optional. Opaque token containing a reference to an uploaded attachment. + * Treated by clients as an opaque string and used to create or update Chat + * messages with attachments. * - * Generated from protobuf field string attachment_upload_token = 2; + * Generated from protobuf field string attachment_upload_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getAttachmentUploadToken() @@ -93,11 +93,11 @@ public function getAttachmentUploadToken() } /** - * Opaque token containing a reference to an uploaded attachment. Treated by - * clients as an opaque string and used to create or update Chat messages with - * attachments. + * Optional. Opaque token containing a reference to an uploaded attachment. + * Treated by clients as an opaque string and used to create or update Chat + * messages with attachments. * - * Generated from protobuf field string attachment_upload_token = 2; + * Generated from protobuf field string attachment_upload_token = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Client/ChatServiceClient.php b/AppsChat/src/Chat/V1/Client/ChatServiceClient.php index f5ce6214a1fd..46dd4ed33aa0 100644 --- a/AppsChat/src/Chat/V1/Client/ChatServiceClient.php +++ b/AppsChat/src/Chat/V1/Client/ChatServiceClient.php @@ -472,8 +472,11 @@ public function __call($method, $args) * Completes the * [import process](https://developers.google.com/workspace/chat/import-data) * for the specified space and makes it visible to users. - * Requires app authentication and domain-wide delegation. For more - * information, see [Authorize Google Chat apps to import + * + * Requires [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * and domain-wide delegation. For more information, see [Authorize Google + * Chat apps to import * data](https://developers.google.com/workspace/chat/authorize-import). * * The async variant is {@see ChatServiceClient::completeImportSpaceAsync()} . @@ -508,8 +511,19 @@ public function completeImportSpace( * 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 - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * For example usage, see: * @@ -549,8 +563,11 @@ public function createMembership(CreateMembershipRequest $request, array $callOp * Creates a message in a Google Chat space. For an example, see [Send a * message](https://developers.google.com/workspace/chat/create-messages). * - * The `create()` method requires either user or app authentication. Chat - * attributes the message sender differently depending on the type of + * The `create()` method requires either [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * or [app + * authentication](https://developers.google.com/workspace/chat/authorize-import). + * Chat attributes the message sender differently depending on the type of * authentication that you use in your request. * * The following image shows how Chat attributes a message when you use app @@ -571,6 +588,12 @@ public function createMembership(CreateMembershipRequest $request, array $callOp * * The maximum message size, including the message contents, is 32,000 bytes. * + * For + * [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) + * requests, the response doesn't contain the full message. The response only + * populates the `name` and `thread.name` fields in addition to the + * information that was in the request. + * * The async variant is {@see ChatServiceClient::createMessageAsync()} . * * @example samples/V1/ChatServiceClient/create_message.php @@ -599,6 +622,7 @@ public function createMessage(CreateMessageRequest $request, array $callOptions * supported. For an example, see * [Add a reaction to a * message](https://developers.google.com/workspace/chat/create-reactions). + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @@ -626,21 +650,27 @@ public function createReaction(CreateReactionRequest $request, array $callOption } /** - * 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 + * Creates a space with no members. Can be used to create a named space, or a + * group chat in `Import mode`. 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`. + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * + * When authenticating as an app, the `space.customer` field must be set in + * the request. * * The async variant is {@see ChatServiceClient::createSpaceAsync()} . * @@ -670,8 +700,18 @@ public function createSpace(CreateSpaceRequest $request, array $callOptions = [] * [Remove a user or a Google Chat app from a * space](https://developers.google.com/workspace/chat/delete-members). * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * The async variant is {@see ChatServiceClient::deleteMembershipAsync()} . * @@ -701,13 +741,15 @@ public function deleteMembership(DeleteMembershipRequest $request, array $callOp * For an example, see [Delete a * message](https://developers.google.com/workspace/chat/delete-messages). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * * When using app authentication, requests can only delete messages * created by the calling Chat app. * @@ -737,6 +779,7 @@ public function deleteMessage(DeleteMessageRequest $request, array $callOptions * For an example, see * [Delete a * reaction](https://developers.google.com/workspace/chat/delete-reactions). + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @@ -767,9 +810,19 @@ public function deleteReaction(DeleteReactionRequest $request, array $callOption * memberships in the space—are also deleted. For an example, see * [Delete a * space](https://developers.google.com/workspace/chat/delete-spaces). - * Requires [user + * + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * from a user who has permission to delete the space. + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * The async variant is {@see ChatServiceClient::deleteSpaceAsync()} . * @@ -798,20 +851,24 @@ public function deleteSpace(DeleteSpaceRequest $request, array $callOptions = [] * see * [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). * + * With [app + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), + * returns the direct message space between the specified user and the calling + * Chat app. + * * With [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * returns the direct message space between the specified user and the * authenticated user. * - * With [app - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), - * returns the direct message space between the specified user and the calling - * Chat app. + * // Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): * - * Requires [user + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * + * - [User * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - * or [app - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * * The async variant is {@see ChatServiceClient::findDirectMessageAsync()} . * @@ -874,13 +931,16 @@ public function getAttachment(GetAttachmentRequest $request, array $callOptions * [Get details about a user's or Google Chat app's * membership](https://developers.google.com/workspace/chat/get-members). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * The async variant is {@see ChatServiceClient::getMembershipAsync()} . * @@ -910,13 +970,14 @@ public function getMembership(GetMembershipRequest $request, array $callOptions * For an example, see [Get details about a * message](https://developers.google.com/workspace/chat/get-messages). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) * * Note: Might return a message from a blocked member or space. * @@ -948,13 +1009,16 @@ public function getMessage(GetMessageRequest $request, array $callOptions = []): * [Get details about a * space](https://developers.google.com/workspace/chat/get-spaces). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * The async variant is {@see ChatServiceClient::getSpaceAsync()} . * @@ -1098,13 +1162,16 @@ public function getThreadReadState(GetThreadReadStateRequest $request, array $ca * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) * lists memberships in spaces that the authenticated user has access to. * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * The async variant is {@see ChatServiceClient::listMembershipsAsync()} . * @@ -1137,6 +1204,7 @@ public function listMemberships(ListMembershipsRequest $request, array $callOpti * 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). * @@ -1167,6 +1235,7 @@ public function listMessages(ListMessagesRequest $request, array $callOptions = * Lists reactions to a message. For an example, see * [List reactions for a * message](https://developers.google.com/workspace/chat/list-reactions). + * * Requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @@ -1238,16 +1307,14 @@ public function listSpaceEvents(ListSpaceEventsRequest $request, array $callOpti * [List * spaces](https://developers.google.com/workspace/chat/list-spaces). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * - * Lists spaces visible to the caller or authenticated user. Group chats - * and DMs aren't listed until the first message is sent. + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) * * To list all named spaces by Google Workspace organization, use the * [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) @@ -1278,7 +1345,9 @@ public function listSpaces(ListSpacesRequest $request, array $callOptions = []): /** * Returns a list of spaces in a Google Workspace organization based on an - * administrator's search. Requires [user + * 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`. @@ -1387,8 +1456,18 @@ public function setUpSpace(SetUpSpaceRequest $request, array $callOptions = []): * Updates a membership. For an example, see [Update a user's membership in * a space](https://developers.google.com/workspace/chat/update-members). * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * The async variant is {@see ChatServiceClient::updateMembershipAsync()} . * @@ -1421,13 +1500,15 @@ public function updateMembership(UpdateMembershipRequest $request, array $callOp * [Update a * message](https://developers.google.com/workspace/chat/update-messages). * - * Requires - * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). - * Supports - * [app + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - * and [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * * When using app authentication, requests can only update messages * created by the calling Chat app. * @@ -1463,8 +1544,18 @@ public function updateMessage(UpdateMessageRequest $request, array $callOptions * `ALREADY_EXISTS`, try a different display name.. An existing space within * the Google Workspace organization might already use this display name. * - * Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): + * + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) + * + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * You can authenticate and authorize this method with administrator + * privileges by setting the `use_admin_access` field in the request. * * The async variant is {@see ChatServiceClient::updateSpaceAsync()} . * @@ -1524,6 +1615,7 @@ public function updateSpaceReadState(UpdateSpaceReadStateRequest $request, array * Uploads an attachment. For an example, see * [Upload media as a file * attachment](https://developers.google.com/workspace/chat/upload-media-attachments). + * * Requires user * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * diff --git a/AppsChat/src/Chat/V1/CreateMembershipRequest.php b/AppsChat/src/Chat/V1/CreateMembershipRequest.php index 8d36c8549b38..d632bc21416c 100644 --- a/AppsChat/src/Chat/V1/CreateMembershipRequest.php +++ b/AppsChat/src/Chat/V1/CreateMembershipRequest.php @@ -29,23 +29,37 @@ class CreateMembershipRequest extends \Google\Protobuf\Internal\Message * `user.type` fields populated. The server will assign a resource name * and overwrite anything specified. * When a Chat app creates a membership relation for a human user, it must use - * the `chat.memberships` scope, set `user.type` to `HUMAN`, and set - * `user.name` with format `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` of the - * [person](https://developers.google.com/people/api/rest/v1/people) 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`. 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`. + * certain authorization scopes and set specific values for certain fields: + * - When [authenticating as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), + * the `chat.memberships` authorization scope is required. + * - When [authenticating as an + * app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), + * the `chat.app.memberships` authorization scope is required. + * Authenticating as an app is available in [Developer + * Preview](https://developers.google.com/workspace/preview). + * - Set `user.type` to `HUMAN`, and set `user.name` with format + * `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` of + * the [person](https://developers.google.com/people/api/rest/v1/people) 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`. + * Inviting users external to the Workspace organization that owns the space + * requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * When a Chat app creates a membership relation for itself, it must + * [authenticate as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set + * `user.name` to `users/app`. * * Generated from protobuf field .google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $membership = null; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -56,7 +70,7 @@ class CreateMembershipRequest extends \Google\Protobuf\Internal\Message * administrator's Google Workspace organization isn't supported using admin * access. * - * Generated from protobuf field bool use_admin_access = 5; + * Generated from protobuf field bool use_admin_access = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -67,21 +81,42 @@ class CreateMembershipRequest extends \Google\Protobuf\Internal\Message * Format: spaces/{space} * Please see {@see ChatServiceClient::spaceName()} for help formatting this field. * @param \Google\Apps\Chat\V1\Membership $membership Required. The membership relation to create. + * * The `memberType` field must contain a user with the `user.name` and * `user.type` fields populated. The server will assign a resource name * and overwrite anything specified. + * * When a Chat app creates a membership relation for a human user, it must use - * the `chat.memberships` scope, set `user.type` to `HUMAN`, and set - * `user.name` with format `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` of the - * [person](https://developers.google.com/people/api/rest/v1/people) 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`. 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`. + * certain authorization scopes and set specific values for certain fields: + * + * - When [authenticating as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), + * the `chat.memberships` authorization scope is required. + * + * - When [authenticating as an + * app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), + * the `chat.app.memberships` authorization scope is required. + * Authenticating as an app is available in [Developer + * Preview](https://developers.google.com/workspace/preview). + * + * - Set `user.type` to `HUMAN`, and set `user.name` with format + * `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` of + * the [person](https://developers.google.com/people/api/rest/v1/people) 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`. + * + * Inviting users external to the Workspace organization that owns the space + * requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * + * When a Chat app creates a membership relation for itself, it must + * [authenticate as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set + * `user.name` to `users/app`. * * @return \Google\Apps\Chat\V1\CreateMembershipRequest * @@ -110,19 +145,33 @@ public static function build(string $parent, \Google\Apps\Chat\V1\Membership $me * `user.type` fields populated. The server will assign a resource name * and overwrite anything specified. * When a Chat app creates a membership relation for a human user, it must use - * the `chat.memberships` scope, set `user.type` to `HUMAN`, and set - * `user.name` with format `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` of the - * [person](https://developers.google.com/people/api/rest/v1/people) 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`. 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`. + * certain authorization scopes and set specific values for certain fields: + * - When [authenticating as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), + * the `chat.memberships` authorization scope is required. + * - When [authenticating as an + * app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), + * the `chat.app.memberships` authorization scope is required. + * Authenticating as an app is available in [Developer + * Preview](https://developers.google.com/workspace/preview). + * - Set `user.type` to `HUMAN`, and set `user.name` with format + * `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` of + * the [person](https://developers.google.com/people/api/rest/v1/people) 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`. + * Inviting users external to the Workspace organization that owns the space + * requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * When a Chat app creates a membership relation for itself, it must + * [authenticate as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set + * `user.name` to `users/app`. * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -175,17 +224,31 @@ public function setParent($var) * `user.type` fields populated. The server will assign a resource name * and overwrite anything specified. * When a Chat app creates a membership relation for a human user, it must use - * the `chat.memberships` scope, set `user.type` to `HUMAN`, and set - * `user.name` with format `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` of the - * [person](https://developers.google.com/people/api/rest/v1/people) 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`. 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`. + * certain authorization scopes and set specific values for certain fields: + * - When [authenticating as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), + * the `chat.memberships` authorization scope is required. + * - When [authenticating as an + * app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), + * the `chat.app.memberships` authorization scope is required. + * Authenticating as an app is available in [Developer + * Preview](https://developers.google.com/workspace/preview). + * - Set `user.type` to `HUMAN`, and set `user.name` with format + * `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` of + * the [person](https://developers.google.com/people/api/rest/v1/people) 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`. + * Inviting users external to the Workspace organization that owns the space + * requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * When a Chat app creates a membership relation for itself, it must + * [authenticate as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set + * `user.name` to `users/app`. * * Generated from protobuf field .google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Apps\Chat\V1\Membership|null @@ -211,17 +274,31 @@ public function clearMembership() * `user.type` fields populated. The server will assign a resource name * and overwrite anything specified. * When a Chat app creates a membership relation for a human user, it must use - * the `chat.memberships` scope, set `user.type` to `HUMAN`, and set - * `user.name` with format `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` of the - * [person](https://developers.google.com/people/api/rest/v1/people) 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`. 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`. + * certain authorization scopes and set specific values for certain fields: + * - When [authenticating as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), + * the `chat.memberships` authorization scope is required. + * - When [authenticating as an + * app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), + * the `chat.app.memberships` authorization scope is required. + * Authenticating as an app is available in [Developer + * Preview](https://developers.google.com/workspace/preview). + * - Set `user.type` to `HUMAN`, and set `user.name` with format + * `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` of + * the [person](https://developers.google.com/people/api/rest/v1/people) 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`. + * Inviting users external to the Workspace organization that owns the space + * requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * When a Chat app creates a membership relation for itself, it must + * [authenticate as a + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set + * `user.name` to `users/app`. * * Generated from protobuf field .google.chat.v1.Membership membership = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Apps\Chat\V1\Membership $var @@ -236,7 +313,7 @@ public function setMembership($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -247,7 +324,7 @@ public function setMembership($var) * administrator's Google Workspace organization isn't supported using admin * access. * - * Generated from protobuf field bool use_admin_access = 5; + * Generated from protobuf field bool use_admin_access = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -256,7 +333,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -267,7 +344,7 @@ public function getUseAdminAccess() * administrator's Google Workspace organization isn't supported using admin * access. * - * Generated from protobuf field bool use_admin_access = 5; + * Generated from protobuf field bool use_admin_access = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/CreateMessageRequest.php b/AppsChat/src/Chat/V1/CreateMessageRequest.php index e90a569bc416..4e33aa1a8285 100644 --- a/AppsChat/src/Chat/V1/CreateMessageRequest.php +++ b/AppsChat/src/Chat/V1/CreateMessageRequest.php @@ -52,6 +52,11 @@ class CreateMessageRequest extends \Google\Protobuf\Internal\Message /** * Optional. Specifies whether a message starts a thread or replies to one. * Only supported in named spaces. + * When [responding to user + * interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), + * this field is ignored. For interactions within a thread, the reply is + * created in the same thread. Otherwise, the reply is created as a new + * thread. * * Generated from protobuf field .google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -134,6 +139,11 @@ public static function build(string $parent, \Google\Apps\Chat\V1\Message $messa * @type int $message_reply_option * Optional. Specifies whether a message starts a thread or replies to one. * Only supported in named spaces. + * When [responding to user + * interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), + * this field is ignored. For interactions within a thread, the reply is + * created in the same thread. Otherwise, the reply is created as a new + * thread. * @type string $message_id * Optional. A custom ID for a message. Lets Chat apps get, update, or delete * a message without needing to store the system-assigned ID in the message's @@ -293,6 +303,11 @@ public function setRequestId($var) /** * Optional. Specifies whether a message starts a thread or replies to one. * Only supported in named spaces. + * When [responding to user + * interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), + * this field is ignored. For interactions within a thread, the reply is + * created in the same thread. Otherwise, the reply is created as a new + * thread. * * Generated from protobuf field .google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -305,6 +320,11 @@ public function getMessageReplyOption() /** * Optional. Specifies whether a message starts a thread or replies to one. * Only supported in named spaces. + * When [responding to user + * interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), + * this field is ignored. For interactions within a thread, the reply is + * created in the same thread. Otherwise, the reply is created as a new + * thread. * * Generated from protobuf field .google.chat.v1.CreateMessageRequest.MessageReplyOption message_reply_option = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var diff --git a/AppsChat/src/Chat/V1/CreateSpaceRequest.php b/AppsChat/src/Chat/V1/CreateSpaceRequest.php index 0f89cf2aafdf..89f040b1239f 100644 --- a/AppsChat/src/Chat/V1/CreateSpaceRequest.php +++ b/AppsChat/src/Chat/V1/CreateSpaceRequest.php @@ -17,13 +17,11 @@ class CreateSpaceRequest extends \Google\Protobuf\Internal\Message { /** * Required. The `displayName` and `spaceType` fields must be populated. Only - * `SpaceType.SPACE` is supported. + * `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported. + * `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true. * 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. * @@ -44,15 +42,13 @@ class CreateSpaceRequest extends \Google\Protobuf\Internal\Message /** * @param \Google\Apps\Chat\V1\Space $space Required. The `displayName` and `spaceType` fields must be populated. Only - * `SpaceType.SPACE` is supported. + * `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported. + * `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true. * * 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. @@ -75,13 +71,11 @@ public static function build(\Google\Apps\Chat\V1\Space $space): self * * @type \Google\Apps\Chat\V1\Space $space * Required. The `displayName` and `spaceType` fields must be populated. Only - * `SpaceType.SPACE` is supported. + * `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported. + * `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true. * 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. * @type string $request_id @@ -100,13 +94,11 @@ public function __construct($data = NULL) { /** * Required. The `displayName` and `spaceType` fields must be populated. Only - * `SpaceType.SPACE` is supported. + * `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported. + * `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true. * 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. * @@ -130,13 +122,11 @@ public function clearSpace() /** * Required. The `displayName` and `spaceType` fields must be populated. Only - * `SpaceType.SPACE` is supported. + * `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported. + * `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true. * 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. * diff --git a/AppsChat/src/Chat/V1/CustomEmoji.php b/AppsChat/src/Chat/V1/CustomEmoji.php index 726372738cb6..b3dd4f9077f8 100644 --- a/AppsChat/src/Chat/V1/CustomEmoji.php +++ b/AppsChat/src/Chat/V1/CustomEmoji.php @@ -18,7 +18,7 @@ class CustomEmoji extends \Google\Protobuf\Internal\Message /** * Output only. Unique key for the custom emoji resource. * - * Generated from protobuf field string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { */ protected $uid = ''; @@ -40,7 +40,7 @@ public function __construct($data = NULL) { /** * Output only. Unique key for the custom emoji resource. * - * Generated from protobuf field string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { * @return string */ public function getUid() @@ -51,7 +51,7 @@ public function getUid() /** * Output only. Unique key for the custom emoji resource. * - * Generated from protobuf field string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string uid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { * @param string $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/DeleteMembershipRequest.php b/AppsChat/src/Chat/V1/DeleteMembershipRequest.php index cbbedad4aa34..80acd260d4af 100644 --- a/AppsChat/src/Chat/V1/DeleteMembershipRequest.php +++ b/AppsChat/src/Chat/V1/DeleteMembershipRequest.php @@ -32,7 +32,7 @@ class DeleteMembershipRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -41,7 +41,7 @@ class DeleteMembershipRequest extends \Google\Protobuf\Internal\Message * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * Deleting app memberships in a space isn't supported using admin access. * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -91,7 +91,7 @@ public static function build(string $name): self * and `spaces/{space}/members/app` format. * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`. * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -153,7 +153,7 @@ public function setName($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -162,7 +162,7 @@ public function setName($var) * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * Deleting app memberships in a space isn't supported using admin access. * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -171,7 +171,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -180,7 +180,7 @@ public function getUseAdminAccess() * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * Deleting app memberships in a space isn't supported using admin access. * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/DeleteMessageRequest.php b/AppsChat/src/Chat/V1/DeleteMessageRequest.php index 37cb2a3434f7..836e632b3328 100644 --- a/AppsChat/src/Chat/V1/DeleteMessageRequest.php +++ b/AppsChat/src/Chat/V1/DeleteMessageRequest.php @@ -27,14 +27,14 @@ class DeleteMessageRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * When `true`, deleting a message also deletes its threaded replies. When - * `false`, if a message has threaded replies, deletion fails. + * Optional. When `true`, deleting a message also deletes its threaded + * replies. When `false`, if a message has threaded replies, deletion fails. * Only applies when [authenticating as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * Has no effect when [authenticating as a Chat app] * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * - * Generated from protobuf field bool force = 2; + * Generated from protobuf field bool force = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $force = false; @@ -73,8 +73,8 @@ public static function build(string $name): self * message] * (https://developers.google.com/workspace/chat/create-messages#name_a_created_message). * @type bool $force - * When `true`, deleting a message also deletes its threaded replies. When - * `false`, if a message has threaded replies, deletion fails. + * Optional. When `true`, deleting a message also deletes its threaded + * replies. When `false`, if a message has threaded replies, deletion fails. * Only applies when [authenticating as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * Has no effect when [authenticating as a Chat app] @@ -123,14 +123,14 @@ public function setName($var) } /** - * When `true`, deleting a message also deletes its threaded replies. When - * `false`, if a message has threaded replies, deletion fails. + * Optional. When `true`, deleting a message also deletes its threaded + * replies. When `false`, if a message has threaded replies, deletion fails. * Only applies when [authenticating as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * Has no effect when [authenticating as a Chat app] * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * - * Generated from protobuf field bool force = 2; + * Generated from protobuf field bool force = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getForce() @@ -139,14 +139,14 @@ public function getForce() } /** - * When `true`, deleting a message also deletes its threaded replies. When - * `false`, if a message has threaded replies, deletion fails. + * Optional. When `true`, deleting a message also deletes its threaded + * replies. When `false`, if a message has threaded replies, deletion fails. * Only applies when [authenticating as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * Has no effect when [authenticating as a Chat app] * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * - * Generated from protobuf field bool force = 2; + * Generated from protobuf field bool force = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/DeleteSpaceRequest.php b/AppsChat/src/Chat/V1/DeleteSpaceRequest.php index 0f9bea7f4729..b84700299942 100644 --- a/AppsChat/src/Chat/V1/DeleteSpaceRequest.php +++ b/AppsChat/src/Chat/V1/DeleteSpaceRequest.php @@ -23,7 +23,7 @@ class DeleteSpaceRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -31,7 +31,7 @@ class DeleteSpaceRequest extends \Google\Protobuf\Internal\Message * Requires the `chat.admin.delete` [OAuth 2.0 * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -61,7 +61,7 @@ public static function build(string $name): self * Required. Resource name of the space to delete. * Format: `spaces/{space}` * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -104,7 +104,7 @@ public function setName($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -112,7 +112,7 @@ public function setName($var) * Requires the `chat.admin.delete` [OAuth 2.0 * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -121,7 +121,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -129,7 +129,7 @@ public function getUseAdminAccess() * Requires the `chat.admin.delete` [OAuth 2.0 * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/DeletionMetadata/DeletionType.php b/AppsChat/src/Chat/V1/DeletionMetadata/DeletionType.php index ac33dde93590..740138d691c9 100644 --- a/AppsChat/src/Chat/V1/DeletionMetadata/DeletionType.php +++ b/AppsChat/src/Chat/V1/DeletionMetadata/DeletionType.php @@ -7,7 +7,8 @@ use UnexpectedValueException; /** - * Who deleted the message and how it was deleted. + * Who deleted the message and how it was deleted. More values may be added in + * the future. * * Protobuf type google.chat.v1.DeletionMetadata.DeletionType */ diff --git a/AppsChat/src/Chat/V1/Emoji.php b/AppsChat/src/Chat/V1/Emoji.php index c4efb005ee19..ad3cffcf9133 100644 --- a/AppsChat/src/Chat/V1/Emoji.php +++ b/AppsChat/src/Chat/V1/Emoji.php @@ -24,7 +24,7 @@ class Emoji extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $unicode - * A basic emoji represented by a unicode string. + * Optional. A basic emoji represented by a unicode string. * @type \Google\Apps\Chat\V1\CustomEmoji $custom_emoji * Output only. A custom emoji. * } @@ -35,9 +35,9 @@ public function __construct($data = NULL) { } /** - * A basic emoji represented by a unicode string. + * Optional. A basic emoji represented by a unicode string. * - * Generated from protobuf field string unicode = 1; + * Generated from protobuf field string unicode = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getUnicode() @@ -51,9 +51,9 @@ public function hasUnicode() } /** - * A basic emoji represented by a unicode string. + * Optional. A basic emoji represented by a unicode string. * - * Generated from protobuf field string unicode = 1; + * Generated from protobuf field string unicode = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/EmojiReactionSummary.php b/AppsChat/src/Chat/V1/EmojiReactionSummary.php index c607da712f81..15ad15144705 100644 --- a/AppsChat/src/Chat/V1/EmojiReactionSummary.php +++ b/AppsChat/src/Chat/V1/EmojiReactionSummary.php @@ -16,15 +16,15 @@ class EmojiReactionSummary extends \Google\Protobuf\Internal\Message { /** - * Emoji associated with the reactions. + * Output only. Emoji associated with the reactions. * - * Generated from protobuf field .google.chat.v1.Emoji emoji = 1; + * Generated from protobuf field .google.chat.v1.Emoji emoji = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $emoji = null; /** - * The total number of reactions using the associated emoji. + * Output only. The total number of reactions using the associated emoji. * - * Generated from protobuf field optional int32 reaction_count = 2; + * Generated from protobuf field optional int32 reaction_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $reaction_count = null; @@ -35,9 +35,9 @@ class EmojiReactionSummary extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Apps\Chat\V1\Emoji $emoji - * Emoji associated with the reactions. + * Output only. Emoji associated with the reactions. * @type int $reaction_count - * The total number of reactions using the associated emoji. + * Output only. The total number of reactions using the associated emoji. * } */ public function __construct($data = NULL) { @@ -46,9 +46,9 @@ public function __construct($data = NULL) { } /** - * Emoji associated with the reactions. + * Output only. Emoji associated with the reactions. * - * Generated from protobuf field .google.chat.v1.Emoji emoji = 1; + * Generated from protobuf field .google.chat.v1.Emoji emoji = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Apps\Chat\V1\Emoji|null */ public function getEmoji() @@ -67,9 +67,9 @@ public function clearEmoji() } /** - * Emoji associated with the reactions. + * Output only. Emoji associated with the reactions. * - * Generated from protobuf field .google.chat.v1.Emoji emoji = 1; + * Generated from protobuf field .google.chat.v1.Emoji emoji = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Apps\Chat\V1\Emoji $var * @return $this */ @@ -82,9 +82,9 @@ public function setEmoji($var) } /** - * The total number of reactions using the associated emoji. + * Output only. The total number of reactions using the associated emoji. * - * Generated from protobuf field optional int32 reaction_count = 2; + * Generated from protobuf field optional int32 reaction_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int */ public function getReactionCount() @@ -103,9 +103,9 @@ public function clearReactionCount() } /** - * The total number of reactions using the associated emoji. + * Output only. The total number of reactions using the associated emoji. * - * Generated from protobuf field optional int32 reaction_count = 2; + * Generated from protobuf field optional int32 reaction_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/GetMembershipRequest.php b/AppsChat/src/Chat/V1/GetMembershipRequest.php index 55823f0ea600..b0f62701e3a5 100644 --- a/AppsChat/src/Chat/V1/GetMembershipRequest.php +++ b/AppsChat/src/Chat/V1/GetMembershipRequest.php @@ -21,9 +21,7 @@ class GetMembershipRequest extends \Google\Protobuf\Internal\Message * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * you can optionally use `spaces/{space}/members/app`. * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` - * When [authenticated as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * you can use the user's email as an alias for `{member}`. For example, + * 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. * @@ -31,7 +29,7 @@ class GetMembershipRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -41,7 +39,7 @@ class GetMembershipRequest extends \Google\Protobuf\Internal\Message * 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. * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -54,9 +52,7 @@ class GetMembershipRequest extends \Google\Protobuf\Internal\Message * * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` * - * When [authenticated as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * you can use the user's email as an alias for `{member}`. For example, + * 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. Please see * {@see ChatServiceClient::membershipName()} for help formatting this field. @@ -83,13 +79,11 @@ public static function build(string $name): self * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * you can optionally use `spaces/{space}/members/app`. * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` - * When [authenticated as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * you can use the user's email as an alias for `{member}`. For example, + * 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. * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -111,9 +105,7 @@ public function __construct($data = NULL) { * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * you can optionally use `spaces/{space}/members/app`. * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` - * When [authenticated as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * you can use the user's email as an alias for `{member}`. For example, + * 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. * @@ -131,9 +123,7 @@ public function getName() * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * you can optionally use `spaces/{space}/members/app`. * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` - * When [authenticated as a - * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * you can use the user's email as an alias for `{member}`. For example, + * 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. * @@ -150,7 +140,7 @@ public function setName($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -160,7 +150,7 @@ public function setName($var) * 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. * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -169,7 +159,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -179,7 +169,7 @@ public function getUseAdminAccess() * 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. * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/GetSpaceRequest.php b/AppsChat/src/Chat/V1/GetSpaceRequest.php index 6b3ee5dbaefd..c2df5218e73c 100644 --- a/AppsChat/src/Chat/V1/GetSpaceRequest.php +++ b/AppsChat/src/Chat/V1/GetSpaceRequest.php @@ -23,7 +23,7 @@ class GetSpaceRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -31,7 +31,7 @@ class GetSpaceRequest extends \Google\Protobuf\Internal\Message * 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). * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -61,7 +61,7 @@ public static function build(string $name): self * Required. Resource name of the space, in the form `spaces/{space}`. * Format: `spaces/{space}` * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -104,7 +104,7 @@ public function setName($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -112,7 +112,7 @@ public function setName($var) * 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). * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -121,7 +121,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -129,7 +129,7 @@ public function getUseAdminAccess() * 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). * - * Generated from protobuf field bool use_admin_access = 2; + * Generated from protobuf field bool use_admin_access = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/ListMembershipsRequest.php b/AppsChat/src/Chat/V1/ListMembershipsRequest.php index 6cdec7cabeab..de63ea85525a 100644 --- a/AppsChat/src/Chat/V1/ListMembershipsRequest.php +++ b/AppsChat/src/Chat/V1/ListMembershipsRequest.php @@ -100,7 +100,7 @@ class ListMembershipsRequest extends \Google\Protobuf\Internal\Message */ protected $show_invited = false; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -110,7 +110,7 @@ class ListMembershipsRequest extends \Google\Protobuf\Internal\Message * 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. * - * Generated from protobuf field bool use_admin_access = 8; + * Generated from protobuf field bool use_admin_access = 8 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -198,7 +198,7 @@ public static function build(string $parent): self * Currently requires [user * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -467,7 +467,7 @@ public function setShowInvited($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -477,7 +477,7 @@ public function setShowInvited($var) * 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. * - * Generated from protobuf field bool use_admin_access = 8; + * Generated from protobuf field bool use_admin_access = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -486,7 +486,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -496,7 +496,7 @@ public function getUseAdminAccess() * 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. * - * Generated from protobuf field bool use_admin_access = 8; + * Generated from protobuf field bool use_admin_access = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/ListMessagesRequest.php b/AppsChat/src/Chat/V1/ListMessagesRequest.php index ab83af2f4080..db9dfd00306e 100644 --- a/AppsChat/src/Chat/V1/ListMessagesRequest.php +++ b/AppsChat/src/Chat/V1/ListMessagesRequest.php @@ -23,29 +23,28 @@ class ListMessagesRequest extends \Google\Protobuf\Internal\Message */ protected $parent = ''; /** - * The maximum number of messages returned. The service might return fewer - * messages than this value. + * Optional. The maximum number of messages returned. The service might return + * fewer messages than this value. * If unspecified, at most 25 are returned. * The maximum value is 1000. If you use a value more than 1000, it's * automatically changed to 1000. * Negative values return an `INVALID_ARGUMENT` error. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_size = 0; /** - * Optional, if resuming from a previous query. - * A page token received from a previous list messages call. Provide this - * parameter to retrieve the subsequent page. + * Optional. A page token received from a previous list 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. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * A query filter. + * Optional. A query filter. * You can filter messages by date (`create_time`) and thread (`thread.name`). * To filter messages by the date they were created, specify the `create_time` * with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) @@ -72,25 +71,25 @@ class ListMessagesRequest extends \Google\Protobuf\Internal\Message * Invalid queries are rejected by the server with an `INVALID_ARGUMENT` * error. * - * Generated from protobuf field string filter = 4; + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $filter = ''; /** - * Optional, if resuming from a previous query. - * How the list of messages is ordered. Specify a value to order by an - * ordering operation. Valid ordering operation values are as follows: + * Optional. How the list of messages is ordered. Specify a value to order by + * an ordering operation. Valid ordering operation values are as follows: * - `ASC` for ascending. * - `DESC` for descending. * The default ordering is `create_time ASC`. * - * Generated from protobuf field string order_by = 5; + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $order_by = ''; /** - * Whether to include deleted messages. Deleted messages include deleted time - * and metadata about their deletion, but message content is unavailable. + * Optional. Whether to include deleted messages. Deleted messages include + * deleted time and metadata about their deletion, but message content is + * unavailable. * - * Generated from protobuf field bool show_deleted = 6; + * Generated from protobuf field bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $show_deleted = false; @@ -120,21 +119,20 @@ public static function build(string $parent): self * Required. The resource name of the space to list messages from. * Format: `spaces/{space}` * @type int $page_size - * The maximum number of messages returned. The service might return fewer - * messages than this value. + * Optional. The maximum number of messages returned. The service might return + * fewer messages than this value. * If unspecified, at most 25 are returned. * The maximum value is 1000. If you use a value more than 1000, it's * automatically changed to 1000. * Negative values return an `INVALID_ARGUMENT` error. * @type string $page_token - * Optional, if resuming from a previous query. - * A page token received from a previous list messages call. Provide this - * parameter to retrieve the subsequent page. + * Optional. A page token received from a previous list 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. * @type string $filter - * A query filter. + * Optional. A query filter. * You can filter messages by date (`create_time`) and thread (`thread.name`). * To filter messages by the date they were created, specify the `create_time` * with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) @@ -161,15 +159,15 @@ public static function build(string $parent): self * Invalid queries are rejected by the server with an `INVALID_ARGUMENT` * error. * @type string $order_by - * Optional, if resuming from a previous query. - * How the list of messages is ordered. Specify a value to order by an - * ordering operation. Valid ordering operation values are as follows: + * Optional. How the list of messages is ordered. Specify a value to order by + * an ordering operation. Valid ordering operation values are as follows: * - `ASC` for ascending. * - `DESC` for descending. * The default ordering is `create_time ASC`. * @type bool $show_deleted - * Whether to include deleted messages. Deleted messages include deleted time - * and metadata about their deletion, but message content is unavailable. + * Optional. Whether to include deleted messages. Deleted messages include + * deleted time and metadata about their deletion, but message content is + * unavailable. * } */ public function __construct($data = NULL) { @@ -206,14 +204,14 @@ public function setParent($var) } /** - * The maximum number of messages returned. The service might return fewer - * messages than this value. + * Optional. The maximum number of messages returned. The service might return + * fewer messages than this value. * If unspecified, at most 25 are returned. * The maximum value is 1000. If you use a value more than 1000, it's * automatically changed to 1000. * Negative values return an `INVALID_ARGUMENT` error. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() @@ -222,14 +220,14 @@ public function getPageSize() } /** - * The maximum number of messages returned. The service might return fewer - * messages than this value. + * Optional. The maximum number of messages returned. The service might return + * fewer messages than this value. * If unspecified, at most 25 are returned. * The maximum value is 1000. If you use a value more than 1000, it's * automatically changed to 1000. * Negative values return an `INVALID_ARGUMENT` error. * - * Generated from protobuf field int32 page_size = 2; + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -242,14 +240,13 @@ public function setPageSize($var) } /** - * Optional, if resuming from a previous query. - * A page token received from a previous list messages call. Provide this - * parameter to retrieve the subsequent page. + * Optional. A page token received from a previous list 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. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() @@ -258,14 +255,13 @@ public function getPageToken() } /** - * Optional, if resuming from a previous query. - * A page token received from a previous list messages call. Provide this - * parameter to retrieve the subsequent page. + * Optional. A page token received from a previous list 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. * - * Generated from protobuf field string page_token = 3; + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -278,7 +274,7 @@ public function setPageToken($var) } /** - * A query filter. + * Optional. A query filter. * You can filter messages by date (`create_time`) and thread (`thread.name`). * To filter messages by the date they were created, specify the `create_time` * with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) @@ -305,7 +301,7 @@ public function setPageToken($var) * Invalid queries are rejected by the server with an `INVALID_ARGUMENT` * error. * - * Generated from protobuf field string filter = 4; + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getFilter() @@ -314,7 +310,7 @@ public function getFilter() } /** - * A query filter. + * Optional. A query filter. * You can filter messages by date (`create_time`) and thread (`thread.name`). * To filter messages by the date they were created, specify the `create_time` * with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) @@ -341,7 +337,7 @@ public function getFilter() * Invalid queries are rejected by the server with an `INVALID_ARGUMENT` * error. * - * Generated from protobuf field string filter = 4; + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -354,14 +350,13 @@ public function setFilter($var) } /** - * Optional, if resuming from a previous query. - * How the list of messages is ordered. Specify a value to order by an - * ordering operation. Valid ordering operation values are as follows: + * Optional. How the list of messages is ordered. Specify a value to order by + * an ordering operation. Valid ordering operation values are as follows: * - `ASC` for ascending. * - `DESC` for descending. * The default ordering is `create_time ASC`. * - * Generated from protobuf field string order_by = 5; + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getOrderBy() @@ -370,14 +365,13 @@ public function getOrderBy() } /** - * Optional, if resuming from a previous query. - * How the list of messages is ordered. Specify a value to order by an - * ordering operation. Valid ordering operation values are as follows: + * Optional. How the list of messages is ordered. Specify a value to order by + * an ordering operation. Valid ordering operation values are as follows: * - `ASC` for ascending. * - `DESC` for descending. * The default ordering is `create_time ASC`. * - * Generated from protobuf field string order_by = 5; + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -390,10 +384,11 @@ public function setOrderBy($var) } /** - * Whether to include deleted messages. Deleted messages include deleted time - * and metadata about their deletion, but message content is unavailable. + * Optional. Whether to include deleted messages. Deleted messages include + * deleted time and metadata about their deletion, but message content is + * unavailable. * - * Generated from protobuf field bool show_deleted = 6; + * Generated from protobuf field bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getShowDeleted() @@ -402,10 +397,11 @@ public function getShowDeleted() } /** - * Whether to include deleted messages. Deleted messages include deleted time - * and metadata about their deletion, but message content is unavailable. + * Optional. Whether to include deleted messages. Deleted messages include + * deleted time and metadata about their deletion, but message content is + * unavailable. * - * Generated from protobuf field bool show_deleted = 6; + * Generated from protobuf field bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/ListSpaceEventsRequest.php b/AppsChat/src/Chat/V1/ListSpaceEventsRequest.php index d4cf55391b8b..170d88883f3c 100644 --- a/AppsChat/src/Chat/V1/ListSpaceEventsRequest.php +++ b/AppsChat/src/Chat/V1/ListSpaceEventsRequest.php @@ -29,17 +29,17 @@ class ListSpaceEventsRequest extends \Google\Protobuf\Internal\Message * return fewer than this value. * Negative values return an `INVALID_ARGUMENT` error. * - * Generated from protobuf field int32 page_size = 5; + * Generated from protobuf field int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_size = 0; /** - * A page token, received from a previous list space events call. Provide this - * to retrieve the subsequent page. + * Optional. A page token, received from a previous list space events call. + * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to list space events must * match the call that provided the page token. Passing different values to * the other parameters might lead to unexpected results. * - * Generated from protobuf field string page_token = 6; + * Generated from protobuf field string page_token = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** @@ -178,8 +178,8 @@ public static function build(string $parent, string $filter): self * return fewer than this value. * Negative values return an `INVALID_ARGUMENT` error. * @type string $page_token - * A page token, received from a previous list space events call. Provide this - * to retrieve the subsequent page. + * Optional. A page token, received from a previous list space events call. + * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to list space events must * match the call that provided the page token. Passing different values to * the other parameters might lead to unexpected results. @@ -271,7 +271,7 @@ public function setParent($var) * return fewer than this value. * Negative values return an `INVALID_ARGUMENT` error. * - * Generated from protobuf field int32 page_size = 5; + * Generated from protobuf field int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() @@ -284,7 +284,7 @@ public function getPageSize() * return fewer than this value. * Negative values return an `INVALID_ARGUMENT` error. * - * Generated from protobuf field int32 page_size = 5; + * Generated from protobuf field int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -297,13 +297,13 @@ public function setPageSize($var) } /** - * A page token, received from a previous list space events call. Provide this - * to retrieve the subsequent page. + * Optional. A page token, received from a previous list space events call. + * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to list space events must * match the call that provided the page token. Passing different values to * the other parameters might lead to unexpected results. * - * Generated from protobuf field string page_token = 6; + * Generated from protobuf field string page_token = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() @@ -312,13 +312,13 @@ public function getPageToken() } /** - * A page token, received from a previous list space events call. Provide this - * to retrieve the subsequent page. + * Optional. A page token, received from a previous list space events call. + * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to list space events must * match the call that provided the page token. Passing different values to * the other parameters might lead to unexpected results. * - * Generated from protobuf field string page_token = 6; + * Generated from protobuf field string page_token = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Membership.php b/AppsChat/src/Chat/V1/Membership.php index f62c182830dc..2948f947fb43 100644 --- a/AppsChat/src/Chat/V1/Membership.php +++ b/AppsChat/src/Chat/V1/Membership.php @@ -17,10 +17,10 @@ class Membership extends \Google\Protobuf\Internal\Message { /** - * Resource name of the membership, assigned by the server. + * Identifier. Resource name of the membership, assigned by the server. * Format: `spaces/{space}/members/{member}` * - * Generated from protobuf field string name = 1 [(.google.api.resource_reference) = { + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -62,7 +62,7 @@ class Membership extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Resource name of the membership, assigned by the server. + * Identifier. Resource name of the membership, assigned by the server. * Format: `spaces/{space}/members/{member}` * @type int $state * Output only. State of the membership. @@ -71,14 +71,16 @@ class Membership extends \Google\Protobuf\Internal\Message * actions in the space. * This field can only be used as input in `UpdateMembership`. * @type \Google\Apps\Chat\V1\User $member - * The Google Chat user or app the membership corresponds to. + * Optional. The Google Chat user or app the membership corresponds to. * If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * the output populates the * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) * `name` and `type`. * @type \Google\Apps\Chat\V1\Group $group_member - * The Google Group the membership corresponds to. + * Optional. The Google Group the membership corresponds to. + * Reading or mutating memberships for Google Groups requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @type \Google\Protobuf\Timestamp $create_time * Optional. Immutable. The creation time of the membership, such as when a * member joined or was invited to join a space. This field is output only, @@ -95,10 +97,10 @@ public function __construct($data = NULL) { } /** - * Resource name of the membership, assigned by the server. + * Identifier. Resource name of the membership, assigned by the server. * Format: `spaces/{space}/members/{member}` * - * Generated from protobuf field string name = 1 [(.google.api.resource_reference) = { + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -107,10 +109,10 @@ public function getName() } /** - * Resource name of the membership, assigned by the server. + * Identifier. Resource name of the membership, assigned by the server. * Format: `spaces/{space}/members/{member}` * - * Generated from protobuf field string name = 1 [(.google.api.resource_reference) = { + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ @@ -179,14 +181,14 @@ public function setRole($var) } /** - * The Google Chat user or app the membership corresponds to. + * Optional. The Google Chat user or app the membership corresponds to. * If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * the output populates the * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) * `name` and `type`. * - * Generated from protobuf field .google.chat.v1.User member = 3; + * Generated from protobuf field .google.chat.v1.User member = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\User|null */ public function getMember() @@ -200,14 +202,14 @@ public function hasMember() } /** - * The Google Chat user or app the membership corresponds to. + * Optional. The Google Chat user or app the membership corresponds to. * If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), * the output populates the * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) * `name` and `type`. * - * Generated from protobuf field .google.chat.v1.User member = 3; + * Generated from protobuf field .google.chat.v1.User member = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\User $var * @return $this */ @@ -220,9 +222,11 @@ public function setMember($var) } /** - * The Google Group the membership corresponds to. + * Optional. The Google Group the membership corresponds to. + * Reading or mutating memberships for Google Groups requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * - * Generated from protobuf field .google.chat.v1.Group group_member = 5; + * Generated from protobuf field .google.chat.v1.Group group_member = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Group|null */ public function getGroupMember() @@ -236,9 +240,11 @@ public function hasGroupMember() } /** - * The Google Group the membership corresponds to. + * Optional. The Google Group the membership corresponds to. + * Reading or mutating memberships for Google Groups requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * - * Generated from protobuf field .google.chat.v1.Group group_member = 5; + * Generated from protobuf field .google.chat.v1.Group group_member = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Group $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Message.php b/AppsChat/src/Chat/V1/Message.php index 4a893b5e16de..b2fbd059ccdf 100644 --- a/AppsChat/src/Chat/V1/Message.php +++ b/AppsChat/src/Chat/V1/Message.php @@ -16,7 +16,7 @@ class Message extends \Google\Protobuf\Internal\Message { /** - * Resource name of the message. + * Identifier. Resource name of the message. * Format: `spaces/{space}/messages/{message}` * Where `{space}` is the ID of the space where the message is posted and * `{message}` is a system-assigned ID for the message. For example, @@ -28,7 +28,7 @@ class Message extends \Google\Protobuf\Internal\Message * a * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -68,16 +68,16 @@ class Message extends \Google\Protobuf\Internal\Message */ protected $delete_time = null; /** - * Plain-text body of the message. The first link to an image, video, or web - * page generates a - * [preview chip](https://developers.google.com/workspace/chat/preview-links). - * You can also [@mention a Google Chat + * Optional. Plain-text body of the message. The first link to an image, + * video, or web page generates a [preview + * chip](https://developers.google.com/workspace/chat/preview-links). You can + * also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. * To learn about creating text messages, see [Send a * message](https://developers.google.com/workspace/chat/create-messages). * - * Generated from protobuf field string text = 4; + * Generated from protobuf field string text = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $text = ''; /** @@ -115,7 +115,7 @@ class Message extends \Google\Protobuf\Internal\Message */ private $cards; /** - * An array of + * Optional. An array of * [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), @@ -124,7 +124,7 @@ class Message extends \Google\Protobuf\Internal\Message * message](https://developers.google.com/workspace/chat/create-messages). * [Card builder](https://addons.gsuite.google.com/uikit/builder) * - * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22; + * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL]; */ private $cards_v2; /** @@ -142,20 +142,20 @@ class Message extends \Google\Protobuf\Internal\Message */ protected $thread = null; /** - * If your Chat app [authenticates as a + * Output only. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * the output populates the + * the output only populates the * [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) * `name`. * - * Generated from protobuf field .google.chat.v1.Space space = 12; + * Generated from protobuf field .google.chat.v1.Space space = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $space = null; /** - * A plain-text description of the message's cards, used when the actual cards - * can't be displayed—for example, mobile notifications. + * Optional. A plain-text description of the message's cards, used when the + * actual cards can't be displayed—for example, mobile notifications. * - * Generated from protobuf field string fallback_text = 13; + * Generated from protobuf field string fallback_text = 13 [(.google.api.field_behavior) = OPTIONAL]; */ protected $fallback_text = ''; /** @@ -179,9 +179,9 @@ class Message extends \Google\Protobuf\Internal\Message */ protected $slash_command = null; /** - * User-uploaded attachment. + * Optional. User-uploaded attachment. * - * Generated from protobuf field repeated .google.chat.v1.Attachment attachment = 18; + * Generated from protobuf field repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL]; */ private $attachment; /** @@ -210,7 +210,7 @@ class Message extends \Google\Protobuf\Internal\Message * field when you create the message. For details, see [Name a * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). * - * Generated from protobuf field string client_assigned_message_id = 32; + * Generated from protobuf field string client_assigned_message_id = 32 [(.google.api.field_behavior) = OPTIONAL]; */ protected $client_assigned_message_id = ''; /** @@ -220,10 +220,10 @@ class Message extends \Google\Protobuf\Internal\Message */ private $emoji_reaction_summaries; /** - * Immutable. Input for creating a message, otherwise output only. The user - * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. To include this field in - * your request, you must call the Chat API using [app + * Optional. Immutable. Input for creating a message, otherwise output only. + * The user that can view the message. When set, the message is private and + * only visible to the specified user and the Chat app. To include this field + * in your request, you must call the Chat API using [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) * and omit the following: * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) @@ -232,7 +232,7 @@ class Message extends \Google\Protobuf\Internal\Message * For details, see [Send a message * privately](https://developers.google.com/workspace/chat/create-messages#private). * - * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE]; + * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; */ protected $private_message_viewer = null; /** @@ -256,16 +256,16 @@ class Message extends \Google\Protobuf\Internal\Message */ private $attached_gifs; /** - * One or more interactive widgets that appear at the bottom of a message. - * You can add accessory widgets to messages that contain text, cards, or both - * text and cards. Not supported for messages that contain dialogs. For - * details, see [Add interactive widgets at the bottom of a + * Optional. One or more interactive widgets that appear at the bottom of a + * message. You can add accessory widgets to messages that contain text, + * cards, or both text and cards. Not supported for messages that contain + * dialogs. For details, see [Add interactive widgets at the bottom of a * message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). * Creating a message with accessory widgets requires [app * authentication] * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * - * Generated from protobuf field repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44; + * Generated from protobuf field repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL]; */ private $accessory_widgets; @@ -276,7 +276,7 @@ class Message extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Resource name of the message. + * Identifier. Resource name of the message. * Format: `spaces/{space}/messages/{message}` * Where `{space}` is the ID of the space where the message is posted and * `{message}` is a system-assigned ID for the message. For example, @@ -308,10 +308,10 @@ class Message extends \Google\Protobuf\Internal\Message * Output only. The time at which the message was deleted in * Google Chat. If the message is never deleted, this field is empty. * @type string $text - * Plain-text body of the message. The first link to an image, video, or web - * page generates a - * [preview chip](https://developers.google.com/workspace/chat/preview-links). - * You can also [@mention a Google Chat + * Optional. Plain-text body of the message. The first link to an image, + * video, or web page generates a [preview + * chip](https://developers.google.com/workspace/chat/preview-links). You can + * also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. * To learn about creating text messages, see [Send a @@ -342,7 +342,7 @@ class Message extends \Google\Protobuf\Internal\Message * normally displayed below the plain-text body of the message. `cards` and * `cards_v2` can have a maximum size of 32 KB. * @type array<\Google\Apps\Chat\V1\CardWithId>|\Google\Protobuf\Internal\RepeatedField $cards_v2 - * An array of + * Optional. An array of * [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), @@ -357,14 +357,14 @@ class Message extends \Google\Protobuf\Internal\Message * [Start or reply to a message * thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). * @type \Google\Apps\Chat\V1\Space $space - * If your Chat app [authenticates as a + * Output only. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * the output populates the + * the output only populates the * [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) * `name`. * @type string $fallback_text - * A plain-text description of the message's cards, used when the actual cards - * can't be displayed—for example, mobile notifications. + * Optional. A plain-text description of the message's cards, used when the + * actual cards can't be displayed—for example, mobile notifications. * @type \Google\Apps\Chat\V1\ActionResponse $action_response * Input only. Parameters that a Chat app can use to configure how its * response is posted. @@ -374,7 +374,7 @@ class Message extends \Google\Protobuf\Internal\Message * @type \Google\Apps\Chat\V1\SlashCommand $slash_command * Output only. Slash command information, if applicable. * @type array<\Google\Apps\Chat\V1\Attachment>|\Google\Protobuf\Internal\RepeatedField $attachment - * User-uploaded attachment. + * Optional. User-uploaded attachment. * @type \Google\Apps\Chat\V1\MatchedUrl $matched_url * Output only. A URL in `spaces.messages.text` that matches a link preview * pattern. For more information, see [Preview @@ -395,10 +395,10 @@ class Message extends \Google\Protobuf\Internal\Message * @type array<\Google\Apps\Chat\V1\EmojiReactionSummary>|\Google\Protobuf\Internal\RepeatedField $emoji_reaction_summaries * Output only. The list of emoji reaction summaries on the message. * @type \Google\Apps\Chat\V1\User $private_message_viewer - * Immutable. Input for creating a message, otherwise output only. The user - * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. To include this field in - * your request, you must call the Chat API using [app + * Optional. Immutable. Input for creating a message, otherwise output only. + * The user that can view the message. When set, the message is private and + * only visible to the specified user and the Chat app. To include this field + * in your request, you must call the Chat API using [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) * and omit the following: * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) @@ -415,10 +415,10 @@ class Message extends \Google\Protobuf\Internal\Message * @type array<\Google\Apps\Chat\V1\AttachedGif>|\Google\Protobuf\Internal\RepeatedField $attached_gifs * Output only. GIF images that are attached to the message. * @type array<\Google\Apps\Chat\V1\AccessoryWidget>|\Google\Protobuf\Internal\RepeatedField $accessory_widgets - * One or more interactive widgets that appear at the bottom of a message. - * You can add accessory widgets to messages that contain text, cards, or both - * text and cards. Not supported for messages that contain dialogs. For - * details, see [Add interactive widgets at the bottom of a + * Optional. One or more interactive widgets that appear at the bottom of a + * message. You can add accessory widgets to messages that contain text, + * cards, or both text and cards. Not supported for messages that contain + * dialogs. For details, see [Add interactive widgets at the bottom of a * message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). * Creating a message with accessory widgets requires [app * authentication] @@ -431,7 +431,7 @@ public function __construct($data = NULL) { } /** - * Resource name of the message. + * Identifier. Resource name of the message. * Format: `spaces/{space}/messages/{message}` * Where `{space}` is the ID of the space where the message is posted and * `{message}` is a system-assigned ID for the message. For example, @@ -443,7 +443,7 @@ public function __construct($data = NULL) { * a * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -452,7 +452,7 @@ public function getName() } /** - * Resource name of the message. + * Identifier. Resource name of the message. * Format: `spaces/{space}/messages/{message}` * Where `{space}` is the ID of the space where the message is posted and * `{message}` is a system-assigned ID for the message. For example, @@ -464,7 +464,7 @@ public function getName() * a * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ @@ -645,16 +645,16 @@ public function setDeleteTime($var) } /** - * Plain-text body of the message. The first link to an image, video, or web - * page generates a - * [preview chip](https://developers.google.com/workspace/chat/preview-links). - * You can also [@mention a Google Chat + * Optional. Plain-text body of the message. The first link to an image, + * video, or web page generates a [preview + * chip](https://developers.google.com/workspace/chat/preview-links). You can + * also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. * To learn about creating text messages, see [Send a * message](https://developers.google.com/workspace/chat/create-messages). * - * Generated from protobuf field string text = 4; + * Generated from protobuf field string text = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getText() @@ -663,16 +663,16 @@ public function getText() } /** - * Plain-text body of the message. The first link to an image, video, or web - * page generates a - * [preview chip](https://developers.google.com/workspace/chat/preview-links). - * You can also [@mention a Google Chat + * Optional. Plain-text body of the message. The first link to an image, + * video, or web page generates a [preview + * chip](https://developers.google.com/workspace/chat/preview-links). You can + * also [@mention a Google Chat * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), * or everyone in the space. * To learn about creating text messages, see [Send a * message](https://developers.google.com/workspace/chat/create-messages). * - * Generated from protobuf field string text = 4; + * Generated from protobuf field string text = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -783,7 +783,7 @@ public function setCards($var) } /** - * An array of + * Optional. An array of * [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), @@ -792,7 +792,7 @@ public function setCards($var) * message](https://developers.google.com/workspace/chat/create-messages). * [Card builder](https://addons.gsuite.google.com/uikit/builder) * - * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22; + * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getCardsV2() @@ -801,7 +801,7 @@ public function getCardsV2() } /** - * An array of + * Optional. An array of * [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). * Only Chat apps can create cards. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), @@ -810,7 +810,7 @@ public function getCardsV2() * message](https://developers.google.com/workspace/chat/create-messages). * [Card builder](https://addons.gsuite.google.com/uikit/builder) * - * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22; + * Generated from protobuf field repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Apps\Chat\V1\CardWithId>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -889,13 +889,13 @@ public function setThread($var) } /** - * If your Chat app [authenticates as a + * Output only. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * the output populates the + * the output only populates the * [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) * `name`. * - * Generated from protobuf field .google.chat.v1.Space space = 12; + * Generated from protobuf field .google.chat.v1.Space space = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Apps\Chat\V1\Space|null */ public function getSpace() @@ -914,13 +914,13 @@ public function clearSpace() } /** - * If your Chat app [authenticates as a + * Output only. If your Chat app [authenticates as a * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), - * the output populates the + * the output only populates the * [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) * `name`. * - * Generated from protobuf field .google.chat.v1.Space space = 12; + * Generated from protobuf field .google.chat.v1.Space space = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Apps\Chat\V1\Space $var * @return $this */ @@ -933,10 +933,10 @@ public function setSpace($var) } /** - * A plain-text description of the message's cards, used when the actual cards - * can't be displayed—for example, mobile notifications. + * Optional. A plain-text description of the message's cards, used when the + * actual cards can't be displayed—for example, mobile notifications. * - * Generated from protobuf field string fallback_text = 13; + * Generated from protobuf field string fallback_text = 13 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getFallbackText() @@ -945,10 +945,10 @@ public function getFallbackText() } /** - * A plain-text description of the message's cards, used when the actual cards - * can't be displayed—for example, mobile notifications. + * Optional. A plain-text description of the message's cards, used when the + * actual cards can't be displayed—for example, mobile notifications. * - * Generated from protobuf field string fallback_text = 13; + * Generated from protobuf field string fallback_text = 13 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -1063,9 +1063,9 @@ public function setSlashCommand($var) } /** - * User-uploaded attachment. + * Optional. User-uploaded attachment. * - * Generated from protobuf field repeated .google.chat.v1.Attachment attachment = 18; + * Generated from protobuf field repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAttachment() @@ -1074,9 +1074,9 @@ public function getAttachment() } /** - * User-uploaded attachment. + * Optional. User-uploaded attachment. * - * Generated from protobuf field repeated .google.chat.v1.Attachment attachment = 18; + * Generated from protobuf field repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Apps\Chat\V1\Attachment>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -1170,7 +1170,7 @@ public function setThreadReply($var) * field when you create the message. For details, see [Name a * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). * - * Generated from protobuf field string client_assigned_message_id = 32; + * Generated from protobuf field string client_assigned_message_id = 32 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getClientAssignedMessageId() @@ -1186,7 +1186,7 @@ public function getClientAssignedMessageId() * field when you create the message. For details, see [Name a * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). * - * Generated from protobuf field string client_assigned_message_id = 32; + * Generated from protobuf field string client_assigned_message_id = 32 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -1225,10 +1225,10 @@ public function setEmojiReactionSummaries($var) } /** - * Immutable. Input for creating a message, otherwise output only. The user - * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. To include this field in - * your request, you must call the Chat API using [app + * Optional. Immutable. Input for creating a message, otherwise output only. + * The user that can view the message. When set, the message is private and + * only visible to the specified user and the Chat app. To include this field + * in your request, you must call the Chat API using [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) * and omit the following: * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) @@ -1237,7 +1237,7 @@ public function setEmojiReactionSummaries($var) * For details, see [Send a message * privately](https://developers.google.com/workspace/chat/create-messages#private). * - * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE]; + * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\User|null */ public function getPrivateMessageViewer() @@ -1256,10 +1256,10 @@ public function clearPrivateMessageViewer() } /** - * Immutable. Input for creating a message, otherwise output only. The user - * that can view the message. When set, the message is private and only - * visible to the specified user and the Chat app. To include this field in - * your request, you must call the Chat API using [app + * Optional. Immutable. Input for creating a message, otherwise output only. + * The user that can view the message. When set, the message is private and + * only visible to the specified user and the Chat app. To include this field + * in your request, you must call the Chat API using [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) * and omit the following: * * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) @@ -1268,7 +1268,7 @@ public function clearPrivateMessageViewer() * For details, see [Send a message * privately](https://developers.google.com/workspace/chat/create-messages#private). * - * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE]; + * Generated from protobuf field .google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\User $var * @return $this */ @@ -1383,16 +1383,16 @@ public function setAttachedGifs($var) } /** - * One or more interactive widgets that appear at the bottom of a message. - * You can add accessory widgets to messages that contain text, cards, or both - * text and cards. Not supported for messages that contain dialogs. For - * details, see [Add interactive widgets at the bottom of a + * Optional. One or more interactive widgets that appear at the bottom of a + * message. You can add accessory widgets to messages that contain text, + * cards, or both text and cards. Not supported for messages that contain + * dialogs. For details, see [Add interactive widgets at the bottom of a * message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). * Creating a message with accessory widgets requires [app * authentication] * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * - * Generated from protobuf field repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44; + * Generated from protobuf field repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getAccessoryWidgets() @@ -1401,16 +1401,16 @@ public function getAccessoryWidgets() } /** - * One or more interactive widgets that appear at the bottom of a message. - * You can add accessory widgets to messages that contain text, cards, or both - * text and cards. Not supported for messages that contain dialogs. For - * details, see [Add interactive widgets at the bottom of a + * Optional. One or more interactive widgets that appear at the bottom of a + * message. You can add accessory widgets to messages that contain text, + * cards, or both text and cards. Not supported for messages that contain + * dialogs. For details, see [Add interactive widgets at the bottom of a * message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). * Creating a message with accessory widgets requires [app * authentication] * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). * - * Generated from protobuf field repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44; + * Generated from protobuf field repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Apps\Chat\V1\AccessoryWidget>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Reaction.php b/AppsChat/src/Chat/V1/Reaction.php index 373aec899eaf..ab3c3d2aefcf 100644 --- a/AppsChat/src/Chat/V1/Reaction.php +++ b/AppsChat/src/Chat/V1/Reaction.php @@ -16,10 +16,10 @@ class Reaction extends \Google\Protobuf\Internal\Message { /** - * The resource name of the reaction. + * Identifier. The resource name of the reaction. * Format: `spaces/{space}/messages/{message}/reactions/{reaction}` * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -29,9 +29,9 @@ class Reaction extends \Google\Protobuf\Internal\Message */ protected $user = null; /** - * The emoji used in the reaction. + * Required. The emoji used in the reaction. * - * Generated from protobuf field .google.chat.v1.Emoji emoji = 3; + * Generated from protobuf field .google.chat.v1.Emoji emoji = 3 [(.google.api.field_behavior) = REQUIRED]; */ protected $emoji = null; @@ -42,12 +42,12 @@ class Reaction extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * The resource name of the reaction. + * Identifier. The resource name of the reaction. * Format: `spaces/{space}/messages/{message}/reactions/{reaction}` * @type \Google\Apps\Chat\V1\User $user * Output only. The user who created the reaction. * @type \Google\Apps\Chat\V1\Emoji $emoji - * The emoji used in the reaction. + * Required. The emoji used in the reaction. * } */ public function __construct($data = NULL) { @@ -56,10 +56,10 @@ public function __construct($data = NULL) { } /** - * The resource name of the reaction. + * Identifier. The resource name of the reaction. * Format: `spaces/{space}/messages/{message}/reactions/{reaction}` * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -68,10 +68,10 @@ public function getName() } /** - * The resource name of the reaction. + * Identifier. The resource name of the reaction. * Format: `spaces/{space}/messages/{message}/reactions/{reaction}` * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ @@ -120,9 +120,9 @@ public function setUser($var) } /** - * The emoji used in the reaction. + * Required. The emoji used in the reaction. * - * Generated from protobuf field .google.chat.v1.Emoji emoji = 3; + * Generated from protobuf field .google.chat.v1.Emoji emoji = 3 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Apps\Chat\V1\Emoji|null */ public function getEmoji() @@ -141,9 +141,9 @@ public function clearEmoji() } /** - * The emoji used in the reaction. + * Required. The emoji used in the reaction. * - * Generated from protobuf field .google.chat.v1.Emoji emoji = 3; + * Generated from protobuf field .google.chat.v1.Emoji emoji = 3 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Apps\Chat\V1\Emoji $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Space.php b/AppsChat/src/Chat/V1/Space.php index 9fe556109f1e..c403687bd9dc 100644 --- a/AppsChat/src/Chat/V1/Space.php +++ b/AppsChat/src/Chat/V1/Space.php @@ -17,7 +17,7 @@ class Space extends \Google\Protobuf\Internal\Message { /** - * Resource name of the space. + * Identifier. Resource name of the space. * Format: `spaces/{space}` * Where `{space}` represents the system-assigned ID for the space. You can * obtain the space ID by calling the @@ -26,7 +26,7 @@ class Space extends \Google\Protobuf\Internal\Message * is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID * is `AAAAAAAAA`. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -38,10 +38,10 @@ class Space extends \Google\Protobuf\Internal\Message */ protected $type = 0; /** - * The type of space. Required when creating a space or updating the space - * type of a space. Output only for other usage. + * Optional. The type of space. Required when creating a space or updating the + * space type of a space. Output only for other usage. * - * Generated from protobuf field .google.chat.v1.Space.SpaceType space_type = 10; + * Generated from protobuf field .google.chat.v1.Space.SpaceType space_type = 10 [(.google.api.field_behavior) = OPTIONAL]; */ protected $space_type = 0; /** @@ -60,7 +60,7 @@ class Space extends \Google\Protobuf\Internal\Message */ protected $threaded = false; /** - * The space's display name. Required when [creating a + * Optional. The space's display name. Required when [creating a * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) * with a `spaceType` of `SPACE`. If you receive the error message * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a @@ -69,19 +69,19 @@ class Space extends \Google\Protobuf\Internal\Message * For direct messages, this field might be empty. * Supports up to 128 characters. * - * Generated from protobuf field string display_name = 3; + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $display_name = ''; /** - * Immutable. Whether this space permits any Google Chat user as a member. - * Input when creating a space in a Google Workspace organization. Omit this - * field when creating spaces in the following conditions: + * Optional. Immutable. Whether this space permits any Google Chat user as a + * member. Input when creating a space in a Google Workspace organization. + * Omit this field when creating spaces in the following conditions: * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. * For existing spaces, this field is output only. * - * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE]; + * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; */ protected $external_user_allowed = false; /** @@ -91,21 +91,23 @@ class Space extends \Google\Protobuf\Internal\Message */ protected $space_threading_state = 0; /** - * Details about the space including description and rules. + * Optional. Details about the space including description and rules. * - * Generated from protobuf field .google.chat.v1.Space.SpaceDetails space_details = 11; + * Generated from protobuf field .google.chat.v1.Space.SpaceDetails space_details = 11 [(.google.api.field_behavior) = OPTIONAL]; */ protected $space_details = null; /** - * The message history state for messages and threads in this space. + * Optional. The message history state for messages and threads in this space. * - * Generated from protobuf field .google.chat.v1.HistoryState space_history_state = 13; + * Generated from protobuf field .google.chat.v1.HistoryState space_history_state = 13 [(.google.api.field_behavior) = OPTIONAL]; */ protected $space_history_state = 0; /** * Optional. Whether this space is created in `Import Mode` as part of a data * migration into Google Workspace. While spaces are being imported, they * aren't visible to users until the import is complete. + * Creating a space in `Import Mode`requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Generated from protobuf field bool import_mode = 16 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -178,7 +180,7 @@ class Space extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Resource name of the space. + * Identifier. Resource name of the space. * Format: `spaces/{space}` * Where `{space}` represents the system-assigned ID for the space. You can * obtain the space ID by calling the @@ -190,8 +192,8 @@ class Space extends \Google\Protobuf\Internal\Message * Output only. Deprecated: Use `space_type` instead. * The type of a space. * @type int $space_type - * The type of space. Required when creating a space or updating the space - * type of a space. Output only for other usage. + * Optional. The type of space. Required when creating a space or updating the + * space type of a space. Output only for other usage. * @type bool $single_user_bot_dm * Optional. Whether the space is a DM between a Chat app and a single * human. @@ -199,7 +201,7 @@ class Space extends \Google\Protobuf\Internal\Message * Output only. Deprecated: Use `spaceThreadingState` instead. * Whether messages are threaded in this space. * @type string $display_name - * The space's display name. Required when [creating a + * Optional. The space's display name. Required when [creating a * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) * with a `spaceType` of `SPACE`. If you receive the error message * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a @@ -208,9 +210,9 @@ class Space extends \Google\Protobuf\Internal\Message * For direct messages, this field might be empty. * Supports up to 128 characters. * @type bool $external_user_allowed - * Immutable. Whether this space permits any Google Chat user as a member. - * Input when creating a space in a Google Workspace organization. Omit this - * field when creating spaces in the following conditions: + * Optional. Immutable. Whether this space permits any Google Chat user as a + * member. Input when creating a space in a Google Workspace organization. + * Omit this field when creating spaces in the following conditions: * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. @@ -218,13 +220,15 @@ class Space extends \Google\Protobuf\Internal\Message * @type int $space_threading_state * Output only. The threading state in the Chat space. * @type \Google\Apps\Chat\V1\Space\SpaceDetails $space_details - * Details about the space including description and rules. + * Optional. Details about the space including description and rules. * @type int $space_history_state - * The message history state for messages and threads in this space. + * Optional. The message history state for messages and threads in this space. * @type bool $import_mode * Optional. Whether this space is created in `Import Mode` as part of a data * migration into Google Workspace. While spaces are being imported, they * aren't visible to users until the import is complete. + * Creating a space in `Import Mode`requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * @type \Google\Protobuf\Timestamp $create_time * Optional. Immutable. For spaces created in Chat, the time the space was * created. This field is output only, except when used in import mode spaces. @@ -273,7 +277,7 @@ public function __construct($data = NULL) { } /** - * Resource name of the space. + * Identifier. Resource name of the space. * Format: `spaces/{space}` * Where `{space}` represents the system-assigned ID for the space. You can * obtain the space ID by calling the @@ -282,7 +286,7 @@ public function __construct($data = NULL) { * is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID * is `AAAAAAAAA`. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -291,7 +295,7 @@ public function getName() } /** - * Resource name of the space. + * Identifier. Resource name of the space. * Format: `spaces/{space}` * Where `{space}` represents the system-assigned ID for the space. You can * obtain the space ID by calling the @@ -300,7 +304,7 @@ public function getName() * is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID * is `AAAAAAAAA`. * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ @@ -345,10 +349,10 @@ public function setType($var) } /** - * The type of space. Required when creating a space or updating the space - * type of a space. Output only for other usage. + * Optional. The type of space. Required when creating a space or updating the + * space type of a space. Output only for other usage. * - * Generated from protobuf field .google.chat.v1.Space.SpaceType space_type = 10; + * Generated from protobuf field .google.chat.v1.Space.SpaceType space_type = 10 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getSpaceType() @@ -357,10 +361,10 @@ public function getSpaceType() } /** - * The type of space. Required when creating a space or updating the space - * type of a space. Output only for other usage. + * Optional. The type of space. Required when creating a space or updating the + * space type of a space. Output only for other usage. * - * Generated from protobuf field .google.chat.v1.Space.SpaceType space_type = 10; + * Generated from protobuf field .google.chat.v1.Space.SpaceType space_type = 10 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -433,7 +437,7 @@ public function setThreaded($var) } /** - * The space's display name. Required when [creating a + * Optional. The space's display name. Required when [creating a * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) * with a `spaceType` of `SPACE`. If you receive the error message * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a @@ -442,7 +446,7 @@ public function setThreaded($var) * For direct messages, this field might be empty. * Supports up to 128 characters. * - * Generated from protobuf field string display_name = 3; + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getDisplayName() @@ -451,7 +455,7 @@ public function getDisplayName() } /** - * The space's display name. Required when [creating a + * Optional. The space's display name. Required when [creating a * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) * with a `spaceType` of `SPACE`. If you receive the error message * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a @@ -460,7 +464,7 @@ public function getDisplayName() * For direct messages, this field might be empty. * Supports up to 128 characters. * - * Generated from protobuf field string display_name = 3; + * Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -473,15 +477,15 @@ public function setDisplayName($var) } /** - * Immutable. Whether this space permits any Google Chat user as a member. - * Input when creating a space in a Google Workspace organization. Omit this - * field when creating spaces in the following conditions: + * Optional. Immutable. Whether this space permits any Google Chat user as a + * member. Input when creating a space in a Google Workspace organization. + * Omit this field when creating spaces in the following conditions: * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. * For existing spaces, this field is output only. * - * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE]; + * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getExternalUserAllowed() @@ -490,15 +494,15 @@ public function getExternalUserAllowed() } /** - * Immutable. Whether this space permits any Google Chat user as a member. - * Input when creating a space in a Google Workspace organization. Omit this - * field when creating spaces in the following conditions: + * Optional. Immutable. Whether this space permits any Google Chat user as a + * member. Input when creating a space in a Google Workspace organization. + * Omit this field when creating spaces in the following conditions: * * The authenticated user uses a consumer account (unmanaged user * account). By default, a space created by a consumer account permits any * Google Chat user. * For existing spaces, this field is output only. * - * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE]; + * Generated from protobuf field bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -537,9 +541,9 @@ public function setSpaceThreadingState($var) } /** - * Details about the space including description and rules. + * Optional. Details about the space including description and rules. * - * Generated from protobuf field .google.chat.v1.Space.SpaceDetails space_details = 11; + * Generated from protobuf field .google.chat.v1.Space.SpaceDetails space_details = 11 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\SpaceDetails|null */ public function getSpaceDetails() @@ -558,9 +562,9 @@ public function clearSpaceDetails() } /** - * Details about the space including description and rules. + * Optional. Details about the space including description and rules. * - * Generated from protobuf field .google.chat.v1.Space.SpaceDetails space_details = 11; + * Generated from protobuf field .google.chat.v1.Space.SpaceDetails space_details = 11 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\SpaceDetails $var * @return $this */ @@ -573,9 +577,9 @@ public function setSpaceDetails($var) } /** - * The message history state for messages and threads in this space. + * Optional. The message history state for messages and threads in this space. * - * Generated from protobuf field .google.chat.v1.HistoryState space_history_state = 13; + * Generated from protobuf field .google.chat.v1.HistoryState space_history_state = 13 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getSpaceHistoryState() @@ -584,9 +588,9 @@ public function getSpaceHistoryState() } /** - * The message history state for messages and threads in this space. + * Optional. The message history state for messages and threads in this space. * - * Generated from protobuf field .google.chat.v1.HistoryState space_history_state = 13; + * Generated from protobuf field .google.chat.v1.HistoryState space_history_state = 13 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ @@ -602,6 +606,8 @@ public function setSpaceHistoryState($var) * Optional. Whether this space is created in `Import Mode` as part of a data * migration into Google Workspace. While spaces are being imported, they * aren't visible to users until the import is complete. + * Creating a space in `Import Mode`requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Generated from protobuf field bool import_mode = 16 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -615,6 +621,8 @@ public function getImportMode() * Optional. Whether this space is created in `Import Mode` as part of a data * migration into Google Workspace. While spaces are being imported, they * aren't visible to users until the import is complete. + * Creating a space in `Import Mode`requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Generated from protobuf field bool import_mode = 16 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/AppsChat/src/Chat/V1/Space/AccessSettings.php b/AppsChat/src/Chat/V1/Space/AccessSettings.php index 4c89622cbf46..0e90920c64aa 100644 --- a/AppsChat/src/Chat/V1/Space/AccessSettings.php +++ b/AppsChat/src/Chat/V1/Space/AccessSettings.php @@ -33,8 +33,19 @@ class AccessSettings extends \Google\Protobuf\Internal\Message * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * Reading the target audience supports: + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator + * approval](https://support.google.com/a?p=chat-app-auth) + * with the `chat.app.spaces` scope in [Developer + * Preview](https://developers.google.com/workspace/preview). * This field is not populated when using the `chat.bot` scope with [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * Setting the target audience requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Generated from protobuf field string audience = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -59,8 +70,19 @@ class AccessSettings extends \Google\Protobuf\Internal\Message * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * Reading the target audience supports: + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator + * approval](https://support.google.com/a?p=chat-app-auth) + * with the `chat.app.spaces` scope in [Developer + * Preview](https://developers.google.com/workspace/preview). * This field is not populated when using the `chat.bot` scope with [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * Setting the target audience requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * } */ public function __construct($data = NULL) { @@ -105,8 +127,19 @@ public function setAccessState($var) * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * Reading the target audience supports: + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator + * approval](https://support.google.com/a?p=chat-app-auth) + * with the `chat.app.spaces` scope in [Developer + * Preview](https://developers.google.com/workspace/preview). * This field is not populated when using the `chat.bot` scope with [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * Setting the target audience requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Generated from protobuf field string audience = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -127,8 +160,19 @@ public function getAudience() * Format: `audiences/{audience}` * To use the default target audience for the Google Workspace organization, * set to `audiences/default`. + * Reading the target audience supports: + * - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator + * approval](https://support.google.com/a?p=chat-app-auth) + * with the `chat.app.spaces` scope in [Developer + * Preview](https://developers.google.com/workspace/preview). * This field is not populated when using the `chat.bot` scope with [app * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * Setting the target audience requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Generated from protobuf field string audience = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php b/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php index 280f8e0b4ad5..e6c6b6093c73 100644 --- a/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php +++ b/AppsChat/src/Chat/V1/Space/AccessSettings/AccessState.php @@ -33,6 +33,8 @@ class AccessState * invited to the space can also discover and access the space. To learn * more, see [Make a space discoverable to specific * users](https://developers.google.com/workspace/chat/space-target-audience). + * Creating discoverable spaces requires [user + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Generated from protobuf enum DISCOVERABLE = 2; */ diff --git a/AppsChat/src/Chat/V1/Space/MembershipCount.php b/AppsChat/src/Chat/V1/Space/MembershipCount.php index 5953d6b63402..ff2ab21ac0d9 100644 --- a/AppsChat/src/Chat/V1/Space/MembershipCount.php +++ b/AppsChat/src/Chat/V1/Space/MembershipCount.php @@ -16,16 +16,16 @@ class MembershipCount extends \Google\Protobuf\Internal\Message { /** - * Count of human users that have directly joined the space, not counting - * users joined by having membership in a joined group. + * Output only. Count of human users that have directly joined the space, + * not counting users joined by having membership in a joined group. * - * Generated from protobuf field int32 joined_direct_human_user_count = 4; + * Generated from protobuf field int32 joined_direct_human_user_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $joined_direct_human_user_count = 0; /** - * Count of all groups that have directly joined the space. + * Output only. Count of all groups that have directly joined the space. * - * Generated from protobuf field int32 joined_group_count = 5; + * Generated from protobuf field int32 joined_group_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $joined_group_count = 0; @@ -36,10 +36,10 @@ class MembershipCount extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $joined_direct_human_user_count - * Count of human users that have directly joined the space, not counting - * users joined by having membership in a joined group. + * Output only. Count of human users that have directly joined the space, + * not counting users joined by having membership in a joined group. * @type int $joined_group_count - * Count of all groups that have directly joined the space. + * Output only. Count of all groups that have directly joined the space. * } */ public function __construct($data = NULL) { @@ -48,10 +48,10 @@ public function __construct($data = NULL) { } /** - * Count of human users that have directly joined the space, not counting - * users joined by having membership in a joined group. + * Output only. Count of human users that have directly joined the space, + * not counting users joined by having membership in a joined group. * - * Generated from protobuf field int32 joined_direct_human_user_count = 4; + * Generated from protobuf field int32 joined_direct_human_user_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int */ public function getJoinedDirectHumanUserCount() @@ -60,10 +60,10 @@ public function getJoinedDirectHumanUserCount() } /** - * Count of human users that have directly joined the space, not counting - * users joined by having membership in a joined group. + * Output only. Count of human users that have directly joined the space, + * not counting users joined by having membership in a joined group. * - * Generated from protobuf field int32 joined_direct_human_user_count = 4; + * Generated from protobuf field int32 joined_direct_human_user_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var * @return $this */ @@ -76,9 +76,9 @@ public function setJoinedDirectHumanUserCount($var) } /** - * Count of all groups that have directly joined the space. + * Output only. Count of all groups that have directly joined the space. * - * Generated from protobuf field int32 joined_group_count = 5; + * Generated from protobuf field int32 joined_group_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int */ public function getJoinedGroupCount() @@ -87,9 +87,9 @@ public function getJoinedGroupCount() } /** - * Count of all groups that have directly joined the space. + * Output only. Count of all groups that have directly joined the space. * - * Generated from protobuf field int32 joined_group_count = 5; + * Generated from protobuf field int32 joined_group_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Space/PermissionSetting.php b/AppsChat/src/Chat/V1/Space/PermissionSetting.php index 8132b74f377a..8cad72f829b4 100644 --- a/AppsChat/src/Chat/V1/Space/PermissionSetting.php +++ b/AppsChat/src/Chat/V1/Space/PermissionSetting.php @@ -16,15 +16,15 @@ class PermissionSetting extends \Google\Protobuf\Internal\Message { /** - * Whether spaces managers have this permission. + * Optional. Whether spaces managers have this permission. * - * Generated from protobuf field bool managers_allowed = 1; + * Generated from protobuf field bool managers_allowed = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $managers_allowed = false; /** - * Whether non-manager members have this permission. + * Optional. Whether non-manager members have this permission. * - * Generated from protobuf field bool members_allowed = 2; + * Generated from protobuf field bool members_allowed = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $members_allowed = false; @@ -35,9 +35,9 @@ class PermissionSetting extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $managers_allowed - * Whether spaces managers have this permission. + * Optional. Whether spaces managers have this permission. * @type bool $members_allowed - * Whether non-manager members have this permission. + * Optional. Whether non-manager members have this permission. * } */ public function __construct($data = NULL) { @@ -46,9 +46,9 @@ public function __construct($data = NULL) { } /** - * Whether spaces managers have this permission. + * Optional. Whether spaces managers have this permission. * - * Generated from protobuf field bool managers_allowed = 1; + * Generated from protobuf field bool managers_allowed = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getManagersAllowed() @@ -57,9 +57,9 @@ public function getManagersAllowed() } /** - * Whether spaces managers have this permission. + * Optional. Whether spaces managers have this permission. * - * Generated from protobuf field bool managers_allowed = 1; + * Generated from protobuf field bool managers_allowed = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ @@ -72,9 +72,9 @@ public function setManagersAllowed($var) } /** - * Whether non-manager members have this permission. + * Optional. Whether non-manager members have this permission. * - * Generated from protobuf field bool members_allowed = 2; + * Generated from protobuf field bool members_allowed = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getMembersAllowed() @@ -83,9 +83,9 @@ public function getMembersAllowed() } /** - * Whether non-manager members have this permission. + * Optional. Whether non-manager members have this permission. * - * Generated from protobuf field bool members_allowed = 2; + * Generated from protobuf field bool members_allowed = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Space/PermissionSettings.php b/AppsChat/src/Chat/V1/Space/PermissionSettings.php index a582b37b674b..8a89344e98e9 100644 --- a/AppsChat/src/Chat/V1/Space/PermissionSettings.php +++ b/AppsChat/src/Chat/V1/Space/PermissionSettings.php @@ -19,39 +19,40 @@ class PermissionSettings extends \Google\Protobuf\Internal\Message { /** - * Setting for managing members and groups in a space. + * Optional. Setting for managing members and groups in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $manage_members_and_groups = null; /** - * Setting for updating space name, avatar, description and guidelines. + * Optional. Setting for updating space name, avatar, description and + * guidelines. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $modify_space_details = null; /** - * Setting for toggling space history on and off. + * Optional. Setting for toggling space history on and off. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $toggle_history = null; /** - * Setting for using @all in a space. + * Optional. Setting for using @all in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_at_mention_all = null; /** - * Setting for managing apps in a space. + * Optional. Setting for managing apps in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $manage_apps = null; /** - * Setting for managing webhooks in a space. + * Optional. Setting for managing webhooks in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $manage_webhooks = null; /** @@ -61,9 +62,9 @@ class PermissionSettings extends \Google\Protobuf\Internal\Message */ protected $post_messages = null; /** - * Setting for replying to messages in a space. + * Optional. Setting for replying to messages in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8 [(.google.api.field_behavior) = OPTIONAL]; */ protected $reply_messages = null; @@ -74,21 +75,22 @@ class PermissionSettings extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Apps\Chat\V1\Space\PermissionSetting $manage_members_and_groups - * Setting for managing members and groups in a space. + * Optional. Setting for managing members and groups in a space. * @type \Google\Apps\Chat\V1\Space\PermissionSetting $modify_space_details - * Setting for updating space name, avatar, description and guidelines. + * Optional. Setting for updating space name, avatar, description and + * guidelines. * @type \Google\Apps\Chat\V1\Space\PermissionSetting $toggle_history - * Setting for toggling space history on and off. + * Optional. Setting for toggling space history on and off. * @type \Google\Apps\Chat\V1\Space\PermissionSetting $use_at_mention_all - * Setting for using @all in a space. + * Optional. Setting for using @all in a space. * @type \Google\Apps\Chat\V1\Space\PermissionSetting $manage_apps - * Setting for managing apps in a space. + * Optional. Setting for managing apps in a space. * @type \Google\Apps\Chat\V1\Space\PermissionSetting $manage_webhooks - * Setting for managing webhooks in a space. + * Optional. Setting for managing webhooks in a space. * @type \Google\Apps\Chat\V1\Space\PermissionSetting $post_messages * Output only. Setting for posting messages in a space. * @type \Google\Apps\Chat\V1\Space\PermissionSetting $reply_messages - * Setting for replying to messages in a space. + * Optional. Setting for replying to messages in a space. * } */ public function __construct($data = NULL) { @@ -97,9 +99,9 @@ public function __construct($data = NULL) { } /** - * Setting for managing members and groups in a space. + * Optional. Setting for managing members and groups in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null */ public function getManageMembersAndGroups() @@ -118,9 +120,9 @@ public function clearManageMembersAndGroups() } /** - * Setting for managing members and groups in a space. + * Optional. Setting for managing members and groups in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_members_and_groups = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var * @return $this */ @@ -133,9 +135,10 @@ public function setManageMembersAndGroups($var) } /** - * Setting for updating space name, avatar, description and guidelines. + * Optional. Setting for updating space name, avatar, description and + * guidelines. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null */ public function getModifySpaceDetails() @@ -154,9 +157,10 @@ public function clearModifySpaceDetails() } /** - * Setting for updating space name, avatar, description and guidelines. + * Optional. Setting for updating space name, avatar, description and + * guidelines. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting modify_space_details = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var * @return $this */ @@ -169,9 +173,9 @@ public function setModifySpaceDetails($var) } /** - * Setting for toggling space history on and off. + * Optional. Setting for toggling space history on and off. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null */ public function getToggleHistory() @@ -190,9 +194,9 @@ public function clearToggleHistory() } /** - * Setting for toggling space history on and off. + * Optional. Setting for toggling space history on and off. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting toggle_history = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var * @return $this */ @@ -205,9 +209,9 @@ public function setToggleHistory($var) } /** - * Setting for using @all in a space. + * Optional. Setting for using @all in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null */ public function getUseAtMentionAll() @@ -226,9 +230,9 @@ public function clearUseAtMentionAll() } /** - * Setting for using @all in a space. + * Optional. Setting for using @all in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting use_at_mention_all = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var * @return $this */ @@ -241,9 +245,9 @@ public function setUseAtMentionAll($var) } /** - * Setting for managing apps in a space. + * Optional. Setting for managing apps in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null */ public function getManageApps() @@ -262,9 +266,9 @@ public function clearManageApps() } /** - * Setting for managing apps in a space. + * Optional. Setting for managing apps in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_apps = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var * @return $this */ @@ -277,9 +281,9 @@ public function setManageApps($var) } /** - * Setting for managing webhooks in a space. + * Optional. Setting for managing webhooks in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null */ public function getManageWebhooks() @@ -298,9 +302,9 @@ public function clearManageWebhooks() } /** - * Setting for managing webhooks in a space. + * Optional. Setting for managing webhooks in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting manage_webhooks = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var * @return $this */ @@ -349,9 +353,9 @@ public function setPostMessages($var) } /** - * Setting for replying to messages in a space. + * Optional. Setting for replying to messages in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Apps\Chat\V1\Space\PermissionSetting|null */ public function getReplyMessages() @@ -370,9 +374,9 @@ public function clearReplyMessages() } /** - * Setting for replying to messages in a space. + * Optional. Setting for replying to messages in a space. * - * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8; + * Generated from protobuf field optional .google.chat.v1.Space.PermissionSetting reply_messages = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Apps\Chat\V1\Space\PermissionSetting $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Space/SpaceDetails.php b/AppsChat/src/Chat/V1/Space/SpaceDetails.php index 92ae7537b62c..64e4e5c83c41 100644 --- a/AppsChat/src/Chat/V1/Space/SpaceDetails.php +++ b/AppsChat/src/Chat/V1/Space/SpaceDetails.php @@ -20,14 +20,14 @@ class SpaceDetails extends \Google\Protobuf\Internal\Message * discussion topic, functional purpose, or participants. * Supports up to 150 characters. * - * Generated from protobuf field string description = 1; + * Generated from protobuf field string description = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $description = ''; /** * Optional. The space's rules, expectations, and etiquette. * Supports up to 5,000 characters. * - * Generated from protobuf field string guidelines = 2; + * Generated from protobuf field string guidelines = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $guidelines = ''; @@ -56,7 +56,7 @@ public function __construct($data = NULL) { * discussion topic, functional purpose, or participants. * Supports up to 150 characters. * - * Generated from protobuf field string description = 1; + * Generated from protobuf field string description = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getDescription() @@ -69,7 +69,7 @@ public function getDescription() * discussion topic, functional purpose, or participants. * Supports up to 150 characters. * - * Generated from protobuf field string description = 1; + * Generated from protobuf field string description = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -85,7 +85,7 @@ public function setDescription($var) * Optional. The space's rules, expectations, and etiquette. * Supports up to 5,000 characters. * - * Generated from protobuf field string guidelines = 2; + * Generated from protobuf field string guidelines = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getGuidelines() @@ -97,7 +97,7 @@ public function getGuidelines() * Optional. The space's rules, expectations, and etiquette. * Supports up to 5,000 characters. * - * Generated from protobuf field string guidelines = 2; + * Generated from protobuf field string guidelines = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/Thread.php b/AppsChat/src/Chat/V1/Thread.php index cef404ea9070..62c6b8b1cec7 100644 --- a/AppsChat/src/Chat/V1/Thread.php +++ b/AppsChat/src/Chat/V1/Thread.php @@ -21,10 +21,10 @@ class Thread extends \Google\Protobuf\Internal\Message { /** - * Resource name of the thread. + * Identifier. Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -47,7 +47,7 @@ class Thread extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Resource name of the thread. + * Identifier. Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * @type string $thread_key * Optional. Input for creating or updating a thread. Otherwise, output only. @@ -65,10 +65,10 @@ public function __construct($data = NULL) { } /** - * Resource name of the thread. + * Identifier. Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -77,10 +77,10 @@ public function getName() } /** - * Resource name of the thread. + * Identifier. Resource name of the thread. * Example: `spaces/{space}/threads/{thread}` * - * Generated from protobuf field string name = 1; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/UpdateMembershipRequest.php b/AppsChat/src/Chat/V1/UpdateMembershipRequest.php index cf3107d0a5e3..47236818c13d 100644 --- a/AppsChat/src/Chat/V1/UpdateMembershipRequest.php +++ b/AppsChat/src/Chat/V1/UpdateMembershipRequest.php @@ -32,7 +32,7 @@ class UpdateMembershipRequest extends \Google\Protobuf\Internal\Message */ protected $update_mask = null; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -40,7 +40,7 @@ class UpdateMembershipRequest extends \Google\Protobuf\Internal\Message * Requires the `chat.admin.memberships` [OAuth 2.0 * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -80,7 +80,7 @@ public static function build(\Google\Apps\Chat\V1\Membership $membership, \Googl * Currently supported field paths: * - `role` * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -175,7 +175,7 @@ public function setUpdateMask($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -183,7 +183,7 @@ public function setUpdateMask($var) * Requires the `chat.admin.memberships` [OAuth 2.0 * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -192,7 +192,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -200,7 +200,7 @@ public function getUseAdminAccess() * Requires the `chat.admin.memberships` [OAuth 2.0 * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/UpdateMessageRequest.php b/AppsChat/src/Chat/V1/UpdateMessageRequest.php index 338ec6bf863c..009c4836a1b1 100644 --- a/AppsChat/src/Chat/V1/UpdateMessageRequest.php +++ b/AppsChat/src/Chat/V1/UpdateMessageRequest.php @@ -34,7 +34,7 @@ class UpdateMessageRequest extends \Google\Protobuf\Internal\Message * - `accessory_widgets` (Requires [app * authentication](/chat/api/guides/auth/service-accounts).) * - * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** @@ -159,7 +159,7 @@ public function setMessage($var) * - `accessory_widgets` (Requires [app * authentication](/chat/api/guides/auth/service-accounts).) * - * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null */ public function getUpdateMask() @@ -190,7 +190,7 @@ public function clearUpdateMask() * - `accessory_widgets` (Requires [app * authentication](/chat/api/guides/auth/service-accounts).) * - * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/UpdateSpaceRequest.php b/AppsChat/src/Chat/V1/UpdateSpaceRequest.php index ef832bfb3be3..6683d3b67982 100644 --- a/AppsChat/src/Chat/V1/UpdateSpaceRequest.php +++ b/AppsChat/src/Chat/V1/UpdateSpaceRequest.php @@ -78,11 +78,11 @@ class UpdateSpaceRequest extends \Google\Protobuf\Internal\Message * - `permission_settings.manageWebhooks` * - `permission_settings.replyMessages` * - * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $update_mask = null; /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -92,7 +92,7 @@ class UpdateSpaceRequest extends \Google\Protobuf\Internal\Message * Some `FieldMask` values are not supported using admin access. For details, * see the description of `update_mask`. * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $use_admin_access = false; @@ -238,7 +238,7 @@ public static function build(\Google\Apps\Chat\V1\Space $space, \Google\Protobuf * - `permission_settings.manageWebhooks` * - `permission_settings.replyMessages` * @type bool $use_admin_access - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -349,7 +349,7 @@ public function setSpace($var) * - `permission_settings.manageWebhooks` * - `permission_settings.replyMessages` * - * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Protobuf\FieldMask|null */ public function getUpdateMask() @@ -422,7 +422,7 @@ public function clearUpdateMask() * - `permission_settings.manageWebhooks` * - `permission_settings.replyMessages` * - * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Protobuf\FieldMask $var * @return $this */ @@ -435,7 +435,7 @@ public function setUpdateMask($var) } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -445,7 +445,7 @@ public function setUpdateMask($var) * Some `FieldMask` values are not supported using admin access. For details, * see the description of `update_mask`. * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool */ public function getUseAdminAccess() @@ -454,7 +454,7 @@ public function getUseAdminAccess() } /** - * When `true`, the method runs using the user's Google Workspace + * Optional. 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 @@ -464,7 +464,7 @@ public function getUseAdminAccess() * Some `FieldMask` values are not supported using admin access. For details, * see the description of `update_mask`. * - * Generated from protobuf field bool use_admin_access = 3; + * Generated from protobuf field bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this */ diff --git a/AppsChat/src/Chat/V1/resources/chat_service_rest_client_config.php b/AppsChat/src/Chat/V1/resources/chat_service_rest_client_config.php index 70a4a1080af3..3bd36c3671ad 100644 --- a/AppsChat/src/Chat/V1/resources/chat_service_rest_client_config.php +++ b/AppsChat/src/Chat/V1/resources/chat_service_rest_client_config.php @@ -286,6 +286,9 @@ 'method' => 'patch', 'uriTemplate' => '/v1/{message.name=spaces/*/messages/*}', 'body' => 'message', + 'queryParams' => [ + 'update_mask', + ], ], ], 'placeholders' => [ @@ -296,6 +299,9 @@ ], ], ], + 'queryParams' => [ + 'update_mask', + ], ], 'UpdateSpace' => [ 'method' => 'patch', @@ -309,6 +315,9 @@ ], ], ], + 'queryParams' => [ + 'update_mask', + ], ], 'UpdateSpaceReadState' => [ 'method' => 'patch', diff --git a/AppsChat/tests/Unit/V1/Client/ChatServiceClientTest.php b/AppsChat/tests/Unit/V1/Client/ChatServiceClientTest.php index 122ed627dc9d..5ae53805ae90 100644 --- a/AppsChat/tests/Unit/V1/Client/ChatServiceClientTest.php +++ b/AppsChat/tests/Unit/V1/Client/ChatServiceClientTest.php @@ -38,6 +38,7 @@ use Google\Apps\Chat\V1\DeleteMessageRequest; use Google\Apps\Chat\V1\DeleteReactionRequest; use Google\Apps\Chat\V1\DeleteSpaceRequest; +use Google\Apps\Chat\V1\Emoji; use Google\Apps\Chat\V1\FindDirectMessageRequest; use Google\Apps\Chat\V1\GetAttachmentRequest; use Google\Apps\Chat\V1\GetMembershipRequest; @@ -336,6 +337,8 @@ public function createReactionTest() // Mock request $formattedParent = $gapicClient->messageName('[SPACE]', '[MESSAGE]'); $reaction = new Reaction(); + $reactionEmoji = new Emoji(); + $reaction->setEmoji($reactionEmoji); $request = (new CreateReactionRequest())->setParent($formattedParent)->setReaction($reaction); $response = $gapicClient->createReaction($request); $this->assertEquals($expectedResponse, $response); @@ -375,6 +378,8 @@ public function createReactionExceptionTest() // Mock request $formattedParent = $gapicClient->messageName('[SPACE]', '[MESSAGE]'); $reaction = new Reaction(); + $reactionEmoji = new Emoji(); + $reaction->setEmoji($reactionEmoji); $request = (new CreateReactionRequest())->setParent($formattedParent)->setReaction($reaction); try { $gapicClient->createReaction($request); @@ -1890,7 +1895,8 @@ public function updateMessageTest() $transport->addResponse($expectedResponse); // Mock request $message = new Message(); - $request = (new UpdateMessageRequest())->setMessage($message); + $updateMask = new FieldMask(); + $request = (new UpdateMessageRequest())->setMessage($message)->setUpdateMask($updateMask); $response = $gapicClient->updateMessage($request); $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); @@ -1900,6 +1906,8 @@ public function updateMessageTest() $this->assertSame('/google.chat.v1.ChatService/UpdateMessage', $actualFuncCall); $actualValue = $actualRequestObject->getMessage(); $this->assertProtobufEquals($message, $actualValue); + $actualValue = $actualRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); $this->assertTrue($transport->isExhausted()); } @@ -1926,7 +1934,8 @@ public function updateMessageExceptionTest() $transport->addResponse(null, $status); // Mock request $message = new Message(); - $request = (new UpdateMessageRequest())->setMessage($message); + $updateMask = new FieldMask(); + $request = (new UpdateMessageRequest())->setMessage($message)->setUpdateMask($updateMask); try { $gapicClient->updateMessage($request); // If the $gapicClient method call did not throw, fail the test @@ -1969,7 +1978,8 @@ public function updateSpaceTest() $transport->addResponse($expectedResponse); // Mock request $space = new Space(); - $request = (new UpdateSpaceRequest())->setSpace($space); + $updateMask = new FieldMask(); + $request = (new UpdateSpaceRequest())->setSpace($space)->setUpdateMask($updateMask); $response = $gapicClient->updateSpace($request); $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); @@ -1979,6 +1989,8 @@ public function updateSpaceTest() $this->assertSame('/google.chat.v1.ChatService/UpdateSpace', $actualFuncCall); $actualValue = $actualRequestObject->getSpace(); $this->assertProtobufEquals($space, $actualValue); + $actualValue = $actualRequestObject->getUpdateMask(); + $this->assertProtobufEquals($updateMask, $actualValue); $this->assertTrue($transport->isExhausted()); } @@ -2005,7 +2017,8 @@ public function updateSpaceExceptionTest() $transport->addResponse(null, $status); // Mock request $space = new Space(); - $request = (new UpdateSpaceRequest())->setSpace($space); + $updateMask = new FieldMask(); + $request = (new UpdateSpaceRequest())->setSpace($space)->setUpdateMask($updateMask); try { $gapicClient->updateSpace($request); // If the $gapicClient method call did not throw, fail the test