@google-apps/chat 0.1.0

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

@@ -0,0 +1,38 @@
+// 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/rpc/code.proto";
+
+option csharp_namespace = "Google.Chat.V1";
+option go_package = "cloud.google.com/go/chat/apiv1/chatpb;chatpb";
+option java_multiple_files = true;
+option java_outer_classname = "ActionStatusProto";
+option java_package = "com.google.chat.v1";
+option php_namespace = "Google\\Chat\\V1";
+option ruby_package = "Google::Chat::V1";
+
+// Represents the status for a request to either invoke or submit a
+// [dialog](https://developers.google.com/chat/how-tos/dialogs).
+message ActionStatus {
+  // The status code.
+  google.rpc.Code status_code = 1;
+
+  // The message to send users about the status of their request.
+  // If unset, a generic message based on the `status_code` is sent.
+  string user_facing_message = 2;
+}

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

@@ -0,0 +1,137 @@
+// 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/chat/v1/user.proto";
+
+option csharp_namespace = "Google.Chat.V1";
+option go_package = "cloud.google.com/go/chat/apiv1/chatpb;chatpb";
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationProto";
+option java_package = "com.google.chat.v1";
+option php_namespace = "Google\\Chat\\V1";
+option ruby_package = "Google::Chat::V1";
+
+// Output only. Annotations associated with the plain-text body of the message.
+// To add basic formatting to a text message, see
+// [Format text
+// messages](https://developers.google.com/chat/format-messages).
+//
+// Example plain-text message body:
+// ```
+// Hello @FooBot how are you!"
+// ```
+//
+// The corresponding annotations metadata:
+// ```
+// "annotations":[{
+//   "type":"USER_MENTION",
+//   "startIndex":6,
+//   "length":7,
+//   "userMention": {
+//     "user": {
+//       "name":"users/{user}",
+//       "displayName":"FooBot",
+//       "avatarUrl":"https://goo.gl/aeDtrS",
+//       "type":"BOT"
+//     },
+//     "type":"MENTION"
+//    }
+// }]
+// ```
+message Annotation {
+  // The type of this annotation.
+  AnnotationType type = 1;
+
+  // Start index (0-based, inclusive) in the plain-text message body this
+  // annotation corresponds to.
+  optional int32 start_index = 2;
+
+  // Length of the substring in the plain-text message body this annotation
+  // corresponds to.
+  int32 length = 3;
+
+  // Additional metadata about the annotation.
+  oneof metadata {
+    // The metadata of user mention.
+    UserMentionMetadata user_mention = 4;
+
+    // The metadata for a slash command.
+    SlashCommandMetadata slash_command = 5;
+  }
+}
+
+// Annotation metadata for user mentions (@).
+message UserMentionMetadata {
+  enum Type {
+    // Default value for the enum. Don't use.
+    TYPE_UNSPECIFIED = 0;
+
+    // Add user to space.
+    ADD = 1;
+
+    // Mention user in space.
+    MENTION = 2;
+  }
+
+  // The user mentioned.
+  User user = 1;
+
+  // The type of user mention.
+  Type type = 2;
+}
+
+// Annotation metadata for slash commands (/).
+message SlashCommandMetadata {
+  enum Type {
+    // Default value for the enum. Don't use.
+    TYPE_UNSPECIFIED = 0;
+
+    // Add Chat app to space.
+    ADD = 1;
+
+    // Invoke slash command in space.
+    INVOKE = 2;
+  }
+
+  // The Chat app whose command was invoked.
+  User bot = 1;
+
+  // The type of slash command.
+  Type type = 2;
+
+  // The name of the invoked slash command.
+  string command_name = 3;
+
+  // The command ID of the invoked slash command.
+  int64 command_id = 4;
+
+  // Indicates whether the slash command is for a dialog.
+  bool triggers_dialog = 5;
+}
+
+// Type of the annotation.
+enum AnnotationType {
+  // Default value for the enum. Don't use.
+  ANNOTATION_TYPE_UNSPECIFIED = 0;
+
+  // A user is mentioned.
+  USER_MENTION = 1;
+
+  // A slash command is invoked.
+  SLASH_COMMAND = 2;
+}

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

@@ -0,0 +1,122 @@
+// 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";
+
+option csharp_namespace = "Google.Chat.V1";
+option go_package = "cloud.google.com/go/chat/apiv1/chatpb;chatpb";
+option java_multiple_files = true;
+option java_outer_classname = "AttachmentProto";
+option java_package = "com.google.chat.v1";
+option php_namespace = "Google\\Chat\\V1";
+option ruby_package = "Google::Chat::V1";
+
+// An attachment in Google Chat.
+message Attachment {
+  option (google.api.resource) = {
+    type: "chat.googleapis.com/Attachment"
+    pattern: "spaces/{space}/messages/{message}/attachments/{attachment}"
+  };
+
+  enum Source {
+    SOURCE_UNSPECIFIED = 0;
+
+    DRIVE_FILE = 1;
+
+    UPLOADED_CONTENT = 2;
+  }
+
+  // Resource name of the attachment, in the form
+  // `spaces/*/messages/*/attachments/*`.
+  string name = 1;
+
+  // Output only. The original file name for the content, not the full path.
+  string content_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The content type (MIME type) of the file.
+  string content_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  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;
+
+    // Output only. A reference to the Google Drive attachment. This field is
+    // used with the Google Drive API.
+    DriveDataRef drive_data_ref = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Output only. The thumbnail URL which should be used to preview the
+  // attachment to a human user. Chat apps shouldn't use this URL to download
+  // attachment content.
+  string thumbnail_uri = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The download URL which should be used to allow a human user to
+  // download the attachment. Chat apps shouldn't use this URL to download
+  // attachment content.
+  string download_uri = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The source of the attachment.
+  Source source = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// A reference to the data of a drive attachment.
+message DriveDataRef {
+  // The ID for the drive file. Use with the Drive API.
+  string drive_file_id = 2;
+}
+
+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;
+}
+
+message GetAttachmentRequest {
+  // Required. Resource name of the attachment, in the form
+  // `spaces/*/messages/*/attachments/*`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "chat.googleapis.com/Attachment" }
+  ];
+}
+
+message UploadAttachmentRequest {
+  // Required. Resource name of the Chat space in which the attachment is
+  // uploaded. Format "spaces/{space}".
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "chat.googleapis.com/Message"
+    }
+  ];
+
+  // Required. The filename of the attachment, including the file extension.
+  string filename = 4 [(google.api.field_behavior) = REQUIRED];
+}
+
+message UploadAttachmentResponse {
+  // Reference to the uploaded attachment.
+  AttachmentDataRef attachment_data_ref = 1;
+}