@google-apps/chat 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.11.0](https://github.com/googleapis/google-cloud-node/compare/chat-v0.10.0...chat-v0.11.0) (2024-12-18)
+
+
+### Features
+
+* [chat] Add missing field annotations in space.proto, message.proto, reaction.proto, space_event.proto, membership.proto, attachment.proto ([#5870](https://github.com/googleapis/google-cloud-node/issues/5870)) ([0730fb1](https://github.com/googleapis/google-cloud-node/commit/0730fb1e6bce2ddb6e0cd0c38424ca03cf740cb5))
+* [chat] Chat Apps can now retrieve the import mode expire time information to know when to complete the import mode properly ([#5860](https://github.com/googleapis/google-cloud-node/issues/5860)) ([02b43ef](https://github.com/googleapis/google-cloud-node/commit/02b43ef30f6e45488dfea3bf7b4c15a5641b0755))
+
 ## [0.10.0](https://github.com/googleapis/google-cloud-node/compare/chat-v0.9.0...chat-v0.10.0) (2024-10-10)
 
 

package/build/protos/google/chat/v1/attachment.proto

@@ -47,9 +47,9 @@ message Attachment {
     UPLOADED_CONTENT = 2;
   }
 
-  // Resource name of the attachment, in the form
+  // Optional. Resource name of the attachment, in the form
   // `spaces/{space}/messages/{message}/attachments/{attachment}`.
-  string name = 1;
+  string name = 1 [(google.api.field_behavior) = OPTIONAL];
 
   // Output only. The original file name for the content, not the full path.
   string content_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -59,9 +59,11 @@ message Attachment {
 
   // The data reference to the attachment.
   oneof data_ref {
-    // A reference to the attachment data. This field is used with the media API
-    // to download the attachment data.
-    AttachmentDataRef attachment_data_ref = 4;
+    // 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.
+    AttachmentDataRef attachment_data_ref = 4
+        [(google.api.field_behavior) = OPTIONAL];
 
     // Output only. A reference to the Google Drive attachment. This field is
     // used with the Google Drive API.
@@ -90,14 +92,14 @@ message DriveDataRef {
 
 // A reference to the attachment data.
 message AttachmentDataRef {
-  // The resource name of the attachment data. This field is used with the media
-  // API to download the attachment data.
-  string resource_name = 1;
-
-  // 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.
-  string attachment_upload_token = 2;
+  // Optional. The resource name of the attachment data. This field is used with
+  // the media API to download the attachment data.
+  string resource_name = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // 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.
+  string attachment_upload_token = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request to get an attachment.

package/build/protos/google/chat/v1/chat_service.proto

@@ -69,8 +69,11 @@ service ChatService {
   // 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
@@ -90,6 +93,12 @@ service ChatService {
   // authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg)
   //
   // 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.
   rpc CreateMessage(CreateMessageRequest) returns (Message) {
     option (google.api.http) = {
       post: "/v1/{parent=spaces/*}/messages"
@@ -105,6 +114,7 @@ service ChatService {
   // 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).
   rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) {
@@ -126,13 +136,16 @@ service ChatService {
   // 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.
   rpc ListMemberships(ListMembershipsRequest)
       returns (ListMembershipsResponse) {
     option (google.api.http) = {
@@ -145,13 +158,16 @@ service ChatService {
   // [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.
   rpc GetMembership(GetMembershipRequest) returns (Membership) {
     option (google.api.http) = {
       get: "/v1/{name=spaces/*/members/*}"
@@ -163,13 +179,14 @@ service ChatService {
   // 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.
   rpc GetMessage(GetMessageRequest) returns (Message) {
@@ -186,13 +203,15 @@ service ChatService {
   // [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.
   rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
@@ -211,13 +230,15 @@ service ChatService {
   // 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.
   rpc DeleteMessage(DeleteMessageRequest) returns (google.protobuf.Empty) {
@@ -245,6 +266,7 @@ service ChatService {
   // 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).
   //
@@ -264,16 +286,14 @@ service ChatService {
   // [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)
@@ -286,7 +306,9 @@ service ChatService {
   }
 
   // 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`.
@@ -301,13 +323,16 @@ service ChatService {
   // [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.
   rpc GetSpace(GetSpaceRequest) returns (Space) {
     option (google.api.http) = {
       get: "/v1/{name=spaces/*}"
@@ -315,21 +340,27 @@ service ChatService {
     option (google.api.method_signature) = "name";
   }
 
-  // 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.
   rpc CreateSpace(CreateSpaceRequest) returns (Space) {
     option (google.api.http) = {
       post: "/v1/spaces"
@@ -405,8 +436,18 @@ service ChatService {
   // `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.
   rpc UpdateSpace(UpdateSpaceRequest) returns (Space) {
     option (google.api.http) = {
       patch: "/v1/{space.name=spaces/*}"
@@ -420,9 +461,19 @@ service ChatService {
   // 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.
   rpc DeleteSpace(DeleteSpaceRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v1/{name=spaces/*}"
@@ -433,8 +484,11 @@ service ChatService {
   // 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).
   rpc CompleteImportSpace(CompleteImportSpaceRequest)
       returns (CompleteImportSpaceResponse) {
@@ -449,20 +503,24 @@ service ChatService {
   // 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).
   rpc FindDirectMessage(FindDirectMessageRequest) returns (Space) {
     option (google.api.http) = {
       get: "/v1/spaces:findDirectMessage"
@@ -475,8 +533,19 @@ service ChatService {
   // 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:
   //
@@ -499,8 +568,18 @@ service ChatService {
   // 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.
   rpc UpdateMembership(UpdateMembershipRequest) returns (Membership) {
     option (google.api.http) = {
       patch: "/v1/{membership.name=spaces/*/members/*}"
@@ -513,8 +592,18 @@ service ChatService {
   // [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.
   rpc DeleteMembership(DeleteMembershipRequest) returns (Membership) {
     option (google.api.http) = {
       delete: "/v1/{name=spaces/*/members/*}"
@@ -526,6 +615,7 @@ service ChatService {
   // 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).
   rpc CreateReaction(CreateReactionRequest) returns (Reaction) {
@@ -539,6 +629,7 @@ service ChatService {
   // 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).
   rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse) {
@@ -552,6 +643,7 @@ service ChatService {
   // 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).
   rpc DeleteReaction(DeleteReactionRequest) returns (google.protobuf.Empty) {

package/build/protos/google/chat/v1/deletion_metadata.proto

@@ -28,7 +28,8 @@ option ruby_package = "Google::Apps::Chat::V1";
 // Information about a deleted message. A message is deleted when `delete_time`
 // is set.
 message DeletionMetadata {
-  // 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.
   enum DeletionType {
     // This value is unused.
     DELETION_TYPE_UNSPECIFIED = 0;