@google-apps/chat 0.2.0 → 0.4.0

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

@@ -40,6 +40,7 @@ message Space {
 
   // Deprecated: Use `SpaceType` instead.
   enum Type {
+    // Reserved.
     TYPE_UNSPECIFIED = 0;
 
     // Conversations between two or more humans.
@@ -124,7 +125,7 @@ message Space {
       [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY];
 
   // The space's display name. Required when [creating a
-  // space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create).
+  // space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create).
   // If you receive the error message `ALREADY_EXISTS` when creating a space or
   // updating the `displayName`, try a different `displayName`. An
   // existing space within the Google Workspace organization might already use
@@ -139,13 +140,18 @@ message Space {
   // 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 Google Account. By default,
-  //     the space permits any Google Chat user.
+  //   * The authenticated user uses a consumer account (unmanaged user
+  //     account). By default, a space created by a consumer account permits any
+  //     Google Chat user.
   //
   //   * The space is used to [import data to Google Chat]
-  //     (https://developers.google.com/chat/api/guides/import-data-overview).
-  //     Import mode spaces must only permit members from the same Google
-  //     Workspace organization.
+  //     (https://developers.google.com/chat/api/guides/import-data-overview)
+  //     because import mode spaces must only permit members from the same
+  //     Google Workspace organization. However, as part of the [Google
+  //     Workspace Developer Preview
+  //     Program](https://developers.google.com/workspace/preview), import mode
+  //     spaces can permit any Google Chat user so this field can then be set
+  //     for import mode spaces.
   //
   // For existing spaces, this field is output only.
   bool external_user_allowed = 8 [(google.api.field_behavior) = IMMUTABLE];
@@ -188,6 +194,7 @@ message Space {
   bool admin_installed = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
+// A request to create a named space.
 message CreateSpaceRequest {
   // Required. The `displayName` and `spaceType` fields must be populated.  Only
   // `SpaceType.SPACE` is supported.
@@ -216,8 +223,8 @@ message ListSpacesRequest {
   //
   // If unspecified, at most 100 spaces are returned.
   //
-  // The maximum value is 1,000. If you use a value more than 1,000, it's
-  // automatically changed to 1,000.
+  // 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.
   int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL];
@@ -232,7 +239,7 @@ message ListSpacesRequest {
   // Optional. A query filter.
   //
   // You can filter spaces by the space type
-  // ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
+  // ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
   //
   // To filter by space type, you must specify valid enum value, such as
   // `SPACE` or `GROUP_CHAT` (the `space_type` can't be
@@ -251,6 +258,7 @@ message ListSpacesRequest {
   string filter = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
+// The response for a list spaces request.
 message ListSpacesResponse {
   // List of spaces in the requested (or first) page.
   repeated Space spaces = 1;
@@ -282,8 +290,8 @@ message FindDirectMessageRequest {
   // in the Directory API. For example, if the People API profile ID is
   // `123456789`, you can find a direct message with that person by using
   // `users/123456789` as the `name`. When [authenticated as a
-  // user](https://developers.google.com/chat/api/guides/auth/users), you can
-  // use the email as an alias for `{user}`. For example,
+  // user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
+  // you can use the email as an alias for `{user}`. For example,
   // `users/example@gmail.com` where `example@gmail.com` is the email of the
   // Google Chat user.
   string name = 1 [(google.api.field_behavior) = REQUIRED];
@@ -310,12 +318,13 @@ message UpdateSpaceRequest {
   // Google Workspace organization might already use this display name.)
   //
   // - `space_type` (Only supports changing a `GROUP_CHAT` space type to
-  // `SPACE`. Include `display_name` together with `space_type` in the update
-  // mask and ensure that the specified space has a non-empty display name and
-  // the `SPACE` space type. Including the `space_type` mask and the `SPACE`
-  // type in the specified space when updating the display name is optional if
-  // the existing space already has the `SPACE` type. Trying to update the
-  // space type in other ways results in an invalid argument error).
+  // `SPACE`. Include `display_name` together
+  // with `space_type` in the update mask and ensure that the specified space
+  // has a non-empty display name and the `SPACE` space type. Including the
+  // `space_type` mask and the `SPACE` type in the specified space when updating
+  // the display name is optional if the existing space already has the `SPACE`
+  // type. Trying to update the space type in other ways results in an invalid
+  // argument error).
   //
   // - `space_details`
   //
@@ -324,6 +333,7 @@ message UpdateSpaceRequest {
   // allows users to change their history
   // setting](https://support.google.com/a/answer/7664184).
   // Warning: mutually exclusive with all other field paths.)
+  //
   // - Developer Preview: `access_settings.audience` (Supports changing the
   // [access setting](https://support.google.com/chat/answer/11971020) of a
   // space. If no audience is specified in the access setting, the space's
@@ -354,6 +364,7 @@ message CompleteImportSpaceRequest {
   ];
 }
 
+// Response message for completing the import process for a space.
 message CompleteImportSpaceResponse {
   // The import mode space.
   Space space = 1;

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

@@ -0,0 +1,112 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.chat.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Apps.Chat.V1";
+option go_package = "cloud.google.com/go/chat/apiv1/chatpb;chatpb";
+option java_multiple_files = true;
+option java_outer_classname = "SpaceReadStateProto";
+option java_package = "com.google.chat.v1";
+option php_namespace = "Google\\Apps\\Chat\\V1";
+option ruby_package = "Google::Apps::Chat::V1";
+
+// A user's read state within a space, used to identify read and unread
+// messages.
+message SpaceReadState {
+  option (google.api.resource) = {
+    type: "chat.googleapis.com/SpaceReadState"
+    pattern: "users/{user}/spaces/{space}/spaceReadState"
+    singular: "spaceReadState"
+  };
+
+  // Resource name of the space read state.
+  //
+  // Format: `users/{user}/spaces/{space}/spaceReadState`
+  string name = 1;
+
+  // Optional. The time when the user's space read state was updated. Usually
+  // this corresponds with either the timestamp of the last read message, or a
+  // timestamp specified by the user to mark the last read position in a space.
+  google.protobuf.Timestamp last_read_time = 2
+      [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request message for GetSpaceReadState API.
+message GetSpaceReadStateRequest {
+  // Required. Resource name of the space read state to retrieve.
+  //
+  // Only supports getting read state for the calling user.
+  //
+  // To refer to the calling user, set one of the following:
+  //
+  // - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`.
+  //
+  // - Their Workspace email address. For example,
+  // `users/user@example.com/spaces/{space}/spaceReadState`.
+  //
+  // - Their user id. For example,
+  // `users/123456789/spaces/{space}/spaceReadState`.
+  //
+  // Format: users/{user}/spaces/{space}/spaceReadState
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "chat.googleapis.com/SpaceReadState"
+    }
+  ];
+}
+
+// Request message for UpdateSpaceReadState API.
+message UpdateSpaceReadStateRequest {
+  // Required. The space read state and fields to update.
+  //
+  // Only supports updating read state for the calling user.
+  //
+  // To refer to the calling user, set one of the following:
+  //
+  // - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`.
+  //
+  // - Their Workspace email address. For example,
+  // `users/user@example.com/spaces/{space}/spaceReadState`.
+  //
+  // - Their user id. For example,
+  // `users/123456789/spaces/{space}/spaceReadState`.
+  //
+  // Format: users/{user}/spaces/{space}/spaceReadState
+  SpaceReadState space_read_state = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The field paths to update. Currently supported field paths:
+  //
+  // - `last_read_time`
+  //
+  // When the `last_read_time` is before the latest message create time, the
+  // space appears as unread in the UI.
+  //
+  // To mark the space as read, set `last_read_time` to any value later (larger)
+  // than the latest message create time. The `last_read_time` is coerced to
+  // match the latest message create time. Note that the space read state only
+  // affects the read state of messages that are visible in the space's
+  // top-level conversation. Replies in threads are unaffected by this
+  // timestamp, and instead rely on the thread read state.
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
+}

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

@@ -28,6 +28,7 @@ option java_package = "com.google.chat.v1";
 option php_namespace = "Google\\Apps\\Chat\\V1";
 option ruby_package = "Google::Apps::Chat::V1";
 
+// Request to create a space and add specified users to it.
 message SetUpSpaceRequest {
   // Required. The `Space.spaceType` field is required.
   //

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

@@ -0,0 +1,74 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.chat.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Apps.Chat.V1";
+option go_package = "cloud.google.com/go/chat/apiv1/chatpb;chatpb";
+option java_multiple_files = true;
+option java_outer_classname = "ThreadReadStateProto";
+option java_package = "com.google.chat.v1";
+option php_namespace = "Google\\Apps\\Chat\\V1";
+option ruby_package = "Google::Apps::Chat::V1";
+
+// A user's read state within a thread, used to identify read and unread
+// messages.
+message ThreadReadState {
+  option (google.api.resource) = {
+    type: "chat.googleapis.com/ThreadReadState"
+    pattern: "users/{user}/spaces/{space}/threads/{thread}/threadReadState"
+    singular: "threadReadState"
+  };
+
+  // Resource name of the thread read state.
+  //
+  // Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`
+  string name = 1;
+
+  // The time when the user's thread read state was updated. Usually this
+  // corresponds with the timestamp of the last read message in a thread.
+  google.protobuf.Timestamp last_read_time = 2;
+}
+
+// Request message for GetThreadReadStateRequest API.
+message GetThreadReadStateRequest {
+  // Required. Resource name of the thread read state to retrieve.
+  //
+  // Only supports getting read state for the calling user.
+  //
+  // To refer to the calling user, set one of the following:
+  //
+  // - The `me` alias. For example,
+  // `users/me/spaces/{space}/threads/{thread}/threadReadState`.
+  //
+  // - Their Workspace email address. For example,
+  // `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`.
+  //
+  // - Their user id. For example,
+  // `users/123456789/spaces/{space}/threads/{thread}/threadReadState`.
+  //
+  // Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "chat.googleapis.com/ThreadReadState"
+    }
+  ];
+}

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

@@ -29,8 +29,9 @@ option ruby_package = "Google::Apps::Chat::V1";
 
 // A user in Google Chat.
 // When returned as an output from a request, if your Chat app [authenticates as
-// a user](https://developers.google.com/chat/api/guides/auth/users), the output
-// for a `User` resource only populates the user's `name` and `type`.
+// a
+// user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
+// the output for a `User` resource only populates the user's `name` and `type`.
 message User {
   enum Type {
     // Default value for the enum. DO NOT USE.

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

@@ -29,7 +29,7 @@ message WidgetMarkup {
   // A paragraph of text. Formatted text supported. For more information
   // about formatting text, see
   // [Formatting text in Google Chat
-  // apps](https://developers.google.com/chat/format-messages#card-formatting)
+  // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   // and
   // [Formatting
   // text in Google Workspace
@@ -139,7 +139,7 @@ message WidgetMarkup {
     // The text of the top label. Formatted text supported. For more information
     // about formatting text, see
     // [Formatting text in Google Chat
-    // apps](https://developers.google.com/chat/format-messages#card-formatting)
+    // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
     // and
     // [Formatting
     // text in Google Workspace
@@ -150,7 +150,7 @@ message WidgetMarkup {
     // For more information
     // about formatting text, see
     // [Formatting text in Google Chat
-    // apps](https://developers.google.com/chat/format-messages#card-formatting)
+    // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
     // and
     // [Formatting
     // text in Google Workspace
@@ -162,7 +162,7 @@ message WidgetMarkup {
 
     // The text of the bottom label. Formatted text supported. For more
     // information about formatting text, see [Formatting text in Google Chat
-    // apps](https://developers.google.com/chat/format-messages#card-formatting)
+    // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
     // and
     // [Formatting
     // text in Google Workspace