@google-apps/chat 0.10.0 → 0.12.0

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

@@ -78,12 +78,10 @@ message Membership {
     ROLE_MANAGER = 2;
   }
 
-  // Resource name of the membership, assigned by the server.
+  // Identifier. Resource name of the membership, assigned by the server.
   //
   // Format: `spaces/{space}/members/{member}`
-  string name = 1 [
-    (google.api.resource_reference) = { type: "chat.googleapis.com/Membership" }
-  ];
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Output only. State of the membership.
   MembershipState state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -97,16 +95,19 @@ message Membership {
   // Member associated with this membership. Other member types might be
   // supported in the future.
   oneof memberType {
-    // 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`.
-    User member = 3;
+    User member = 3 [(google.api.field_behavior) = OPTIONAL];
 
-    // The Google Group the membership corresponds to.
-    Group group_member = 5;
+    // 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).
+    Group group_member = 5 [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Optional. Immutable. The creation time of the membership, such as when a
@@ -140,24 +141,45 @@ message CreateMembershipRequest {
   ];
 
   // 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`.
   Membership membership = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // 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
@@ -170,7 +192,7 @@ message CreateMembershipRequest {
   // Creating app memberships or creating memberships for users outside the
   // administrator's Google Workspace organization isn't supported using admin
   // access.
-  bool use_admin_access = 5;
+  bool use_admin_access = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request message for updating a membership.
@@ -188,7 +210,7 @@ message UpdateMembershipRequest {
   google.protobuf.FieldMask update_mask = 2
       [(google.api.field_behavior) = REQUIRED];
 
-  // 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
@@ -197,7 +219,7 @@ message UpdateMembershipRequest {
   //
   // Requires the `chat.admin.memberships` [OAuth 2.0
   // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
-  bool use_admin_access = 3;
+  bool use_admin_access = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request message for listing memberships.
@@ -290,7 +312,7 @@ message ListMembershipsRequest {
   // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   bool show_invited = 7 [(google.api.field_behavior) = OPTIONAL];
 
-  // 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
@@ -302,7 +324,7 @@ message ListMembershipsRequest {
   // 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.
-  bool use_admin_access = 8;
+  bool use_admin_access = 8 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response to list memberships of the space.
@@ -326,9 +348,7 @@ message GetMembershipRequest {
   //
   // 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.
   string name = 1 [
@@ -336,7 +356,7 @@ message GetMembershipRequest {
     (google.api.resource_reference) = { type: "chat.googleapis.com/Membership" }
   ];
 
-  // 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
@@ -348,7 +368,7 @@ message GetMembershipRequest {
   // 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.
-  bool use_admin_access = 3;
+  bool use_admin_access = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request to delete a membership in a space.
@@ -372,7 +392,7 @@ message DeleteMembershipRequest {
     (google.api.resource_reference) = { type: "chat.googleapis.com/Membership" }
   ];
 
-  // 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
@@ -383,5 +403,5 @@ message DeleteMembershipRequest {
   // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   //
   // Deleting app memberships in a space isn't supported using admin access.
-  bool use_admin_access = 2;
+  bool use_admin_access = 2 [(google.api.field_behavior) = OPTIONAL];
 }

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

@@ -48,7 +48,7 @@ message Message {
     pattern: "spaces/{space}/messages/{message}"
   };
 
-  // Resource name of the message.
+  // Identifier. Resource name of the message.
   //
   // Format: `spaces/{space}/messages/{message}`
   //
@@ -63,7 +63,7 @@ message Message {
   // `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name
   // a
   // message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
-  string name = 1;
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Output only. The user who created the message.
   // If your Chat app [authenticates as a
@@ -95,16 +95,16 @@ message Message {
   google.protobuf.Timestamp delete_time = 26
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // 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).
-  string text = 4;
+  string text = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Output only. Contains the message `text` with markups added to communicate
   // formatting. This field might not capture all formatting visible in the UI,
@@ -139,7 +139,7 @@ message Message {
   // `cards_v2` can have a maximum size of 32 KB.
   repeated ContextualAddOnMarkup.Card cards = 5 [deprecated = true];
 
-  // 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
@@ -150,7 +150,7 @@ message Message {
   // message](https://developers.google.com/workspace/chat/create-messages).
   //
   // [Card builder](https://addons.gsuite.google.com/uikit/builder)
-  repeated CardWithId cards_v2 = 22;
+  repeated CardWithId cards_v2 = 22 [(google.api.field_behavior) = OPTIONAL];
 
   // Output only. Annotations associated with the `text` in this message.
   repeated Annotation annotations = 10
@@ -161,16 +161,16 @@ message Message {
   // thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
   Thread thread = 11;
 
-  // 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`.
-  Space space = 12;
+  Space space = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // A plain-text description of the message's cards, used when the actual cards
-  // can't be displayed—for example, mobile notifications.
-  string fallback_text = 13;
+  // Optional. A plain-text description of the message's cards, used when the
+  // actual cards can't be displayed—for example, mobile notifications.
+  string fallback_text = 13 [(google.api.field_behavior) = OPTIONAL];
 
   // Input only. Parameters that a Chat app can use to configure how its
   // response is posted.
@@ -184,8 +184,8 @@ message Message {
   // Output only. Slash command information, if applicable.
   SlashCommand slash_command = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // User-uploaded attachment.
-  repeated Attachment attachment = 18;
+  // Optional. User-uploaded attachment.
+  repeated Attachment attachment = 18 [(google.api.field_behavior) = OPTIONAL];
 
   // Output only. A URL in `spaces.messages.text` that matches a link preview
   // pattern. For more information, see [Preview
@@ -206,16 +206,17 @@ message Message {
   // [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id)
   // field when you create the message. For details, see [Name a
   // message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
-  string client_assigned_message_id = 32;
+  string client_assigned_message_id = 32
+      [(google.api.field_behavior) = OPTIONAL];
 
   // Output only. The list of emoji reaction summaries on the message.
   repeated EmojiReactionSummary emoji_reaction_summaries = 33
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // 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:
   //
@@ -225,7 +226,10 @@ message Message {
   //
   // For details, see [Send a message
   // privately](https://developers.google.com/workspace/chat/create-messages#private).
-  User private_message_viewer = 36 [(google.api.field_behavior) = IMMUTABLE];
+  User private_message_viewer = 36 [
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = OPTIONAL
+  ];
 
   // Output only. Information about a deleted message. A message is deleted when
   // `delete_time` is set.
@@ -241,16 +245,17 @@ message Message {
   repeated AttachedGif attached_gifs = 42
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // 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).
-  repeated AccessoryWidget accessory_widgets = 44;
+  repeated AccessoryWidget accessory_widgets = 44
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A GIF image that's specified by a URL.
@@ -293,10 +298,10 @@ message Thread {
     pattern: "spaces/{space}/threads/{thread}"
   };
 
-  // Resource name of the thread.
+  // Identifier. Resource name of the thread.
   //
   // Example: `spaces/{space}/threads/{thread}`
-  string name = 1;
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Optional. Input for creating or updating a thread. Otherwise, output only.
   // ID for the thread. Supports up to 4000 characters.
@@ -345,8 +350,8 @@ message ActionResponse {
     repeated google.apps.card.v1.SelectionInput.SelectionItem items = 1;
   }
 
-  // The response of the updated widget.
-  // Used to provide autocomplete options for a widget.
+  // For `selectionInput` widgets, returns autocomplete suggestions for a
+  // multiselect menu.
   message UpdatedWidget {
     // The widget updated in response to a user action.
     oneof updated_widget {
@@ -417,14 +422,14 @@ message DeleteMessageRequest {
     (google.api.resource_reference) = { type: "chat.googleapis.com/Message" }
   ];
 
-  // 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).
-  bool force = 2;
+  bool force = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request to update a message.
@@ -449,7 +454,8 @@ message UpdateMessageRequest {
   //
   // - `accessory_widgets`  (Requires [app
   // authentication](/chat/api/guides/auth/service-accounts).)
-  google.protobuf.FieldMask update_mask = 2;
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
 
   // Optional. If `true` and the message isn't found, a new message is created
   // and `updateMask` is ignored. The specified message ID must be
@@ -512,6 +518,12 @@ message CreateMessageRequest {
 
   // 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.
   MessageReplyOption message_reply_option = 8
       [(google.api.field_behavior) = OPTIONAL];
 
@@ -545,8 +557,8 @@ message ListMessagesRequest {
     }
   ];
 
-  // 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.
   //
@@ -554,19 +566,17 @@ message ListMessagesRequest {
   // automatically changed to 1000.
   //
   // Negative values return an `INVALID_ARGUMENT` error.
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // 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.
-  string page_token = 3;
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 
-  // A query filter.
+  // Optional. A query filter.
   //
   // You can filter messages by date (`create_time`) and thread (`thread.name`).
   //
@@ -603,23 +613,22 @@ message ListMessagesRequest {
   //
   // Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
   // error.
-  string filter = 4;
+  string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 
-  // 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`.
-  string order_by = 5;
+  string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
 
-  // Whether to include deleted messages. Deleted messages include deleted time
-  // and metadata about their deletion, but message content is unavailable.
-  bool show_deleted = 6;
+  // Optional. Whether to include deleted messages. Deleted messages include
+  // deleted time and metadata about their deletion, but message content is
+  // unavailable.
+  bool show_deleted = 6 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for listing messages.

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

@@ -17,6 +17,7 @@ syntax = "proto3";
 package google.chat.v1;
 
 import "google/api/field_behavior.proto";
+import "google/api/field_info.proto";
 import "google/api/resource.proto";
 import "google/chat/v1/user.proto";
 
@@ -36,43 +37,46 @@ message Reaction {
     pattern: "spaces/{space}/messages/{message}/reactions/{reaction}"
   };
 
-  // The resource name of the reaction.
+  // Identifier. The resource name of the reaction.
   //
   // Format: `spaces/{space}/messages/{message}/reactions/{reaction}`
-  string name = 1;
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Output only. The user who created the reaction.
   User user = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // The emoji used in the reaction.
-  Emoji emoji = 3;
+  // Required. The emoji used in the reaction.
+  Emoji emoji = 3 [(google.api.field_behavior) = REQUIRED];
 }
 
 // An emoji that is used as a reaction to a message.
 message Emoji {
-  // The content of the emoji.
+  // Required. The content of the emoji.
   oneof content {
-    // A basic emoji represented by a unicode string.
-    string unicode = 1;
+    // Optional. A basic emoji represented by a unicode string.
+    string unicode = 1 [(google.api.field_behavior) = OPTIONAL];
 
-    // Output only. A custom emoji.
-    CustomEmoji custom_emoji = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+    // A custom emoji.
+    CustomEmoji custom_emoji = 2;
   }
 }
 
 // Represents a custom emoji.
 message CustomEmoji {
   // Output only. Unique key for the custom emoji resource.
-  string uid = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  string uid = 1 [
+    (google.api.field_info).format = UUID4,
+    (google.api.field_behavior) = OUTPUT_ONLY
+  ];
 }
 
 // The number of people who reacted to a message with a specific emoji.
 message EmojiReactionSummary {
-  // Emoji associated with the reactions.
-  Emoji emoji = 1;
+  // Output only. Emoji associated with the reactions.
+  Emoji emoji = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // The total number of reactions using the associated emoji.
-  optional int32 reaction_count = 2;
+  // Output only. The total number of reactions using the associated emoji.
+  optional int32 reaction_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Creates a reaction to a message.