google-apps-chat-v1 0.a → 0.1.0

data/proto_docs/google/chat/v1/action_status.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module V1
+        # Represents the status for a request to either invoke or submit a
+        # [dialog](https://developers.google.com/workspace/chat/dialogs).
+        # @!attribute [rw] status_code
+        #   @return [::Google::Rpc::Code]
+        #     The status code.
+        # @!attribute [rw] user_facing_message
+        #   @return [::String]
+        #     The message to send users about the status of their request.
+        #     If unset, a generic message based on the `status_code` is sent.
+        class ActionStatus
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/chat/v1/annotation.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module 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/workspace/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"
+        #    }
+        # }]
+        # ```
+        # @!attribute [rw] type
+        #   @return [::Google::Apps::Chat::V1::AnnotationType]
+        #     The type of this annotation.
+        # @!attribute [rw] start_index
+        #   @return [::Integer]
+        #     Start index (0-based, inclusive) in the plain-text message body this
+        #     annotation corresponds to.
+        # @!attribute [rw] length
+        #   @return [::Integer]
+        #     Length of the substring in the plain-text message body this annotation
+        #     corresponds to.
+        # @!attribute [rw] user_mention
+        #   @return [::Google::Apps::Chat::V1::UserMentionMetadata]
+        #     The metadata of user mention.
+        # @!attribute [rw] slash_command
+        #   @return [::Google::Apps::Chat::V1::SlashCommandMetadata]
+        #     The metadata for a slash command.
+        # @!attribute [rw] rich_link_metadata
+        #   @return [::Google::Apps::Chat::V1::RichLinkMetadata]
+        #     The metadata for a rich link.
+        class Annotation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Annotation metadata for user mentions (@).
+        # @!attribute [rw] user
+        #   @return [::Google::Apps::Chat::V1::User]
+        #     The user mentioned.
+        # @!attribute [rw] type
+        #   @return [::Google::Apps::Chat::V1::UserMentionMetadata::Type]
+        #     The type of user mention.
+        class UserMentionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module Type
+            # Default value for the enum. Don't use.
+            TYPE_UNSPECIFIED = 0
+
+            # Add user to space.
+            ADD = 1
+
+            # Mention user in space.
+            MENTION = 2
+          end
+        end
+
+        # Annotation metadata for slash commands (/).
+        # @!attribute [rw] bot
+        #   @return [::Google::Apps::Chat::V1::User]
+        #     The Chat app whose command was invoked.
+        # @!attribute [rw] type
+        #   @return [::Google::Apps::Chat::V1::SlashCommandMetadata::Type]
+        #     The type of slash command.
+        # @!attribute [rw] command_name
+        #   @return [::String]
+        #     The name of the invoked slash command.
+        # @!attribute [rw] command_id
+        #   @return [::Integer]
+        #     The command ID of the invoked slash command.
+        # @!attribute [rw] triggers_dialog
+        #   @return [::Boolean]
+        #     Indicates whether the slash command is for a dialog.
+        class SlashCommandMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module 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
+          end
+        end
+
+        # A rich link to a resource.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     The URI of this link.
+        # @!attribute [rw] rich_link_type
+        #   @return [::Google::Apps::Chat::V1::RichLinkMetadata::RichLinkType]
+        #     The rich link type.
+        # @!attribute [rw] drive_link_data
+        #   @return [::Google::Apps::Chat::V1::DriveLinkData]
+        #     Data for a drive link.
+        class RichLinkMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The rich link type. More types might be added in the future.
+          module RichLinkType
+            # Default value for the enum. Don't use.
+            RICH_LINK_TYPE_UNSPECIFIED = 0
+
+            # A Google Drive rich link type.
+            DRIVE_FILE = 1
+          end
+        end
+
+        # Data for Google Drive links.
+        # @!attribute [rw] drive_data_ref
+        #   @return [::Google::Apps::Chat::V1::DriveDataRef]
+        #     A
+        #     [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref)
+        #     which references a Google Drive file.
+        # @!attribute [rw] mime_type
+        #   @return [::String]
+        #     The mime type of the linked Google Drive resource.
+        class DriveLinkData
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Type of the annotation.
+        module 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
+
+          # A rich link annotation.
+          RICH_LINK = 3
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/chat/v1/attachment.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module V1
+        # An attachment in Google Chat.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Resource name of the attachment, in the form
+        #     `spaces/*/messages/*/attachments/*`.
+        # @!attribute [r] content_name
+        #   @return [::String]
+        #     Output only. The original file name for the content, not the full path.
+        # @!attribute [r] content_type
+        #   @return [::String]
+        #     Output only. The content type (MIME type) of the file.
+        # @!attribute [rw] attachment_data_ref
+        #   @return [::Google::Apps::Chat::V1::AttachmentDataRef]
+        #     A reference to the attachment data. This field is used with the media API
+        #     to download the attachment data.
+        # @!attribute [r] drive_data_ref
+        #   @return [::Google::Apps::Chat::V1::DriveDataRef]
+        #     Output only. A reference to the Google Drive attachment. This field is
+        #     used with the Google Drive API.
+        # @!attribute [r] thumbnail_uri
+        #   @return [::String]
+        #     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.
+        # @!attribute [r] download_uri
+        #   @return [::String]
+        #     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.
+        # @!attribute [r] source
+        #   @return [::Google::Apps::Chat::V1::Attachment::Source]
+        #     Output only. The source of the attachment.
+        class Attachment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The source of the attachment.
+          module Source
+            # Reserved.
+            SOURCE_UNSPECIFIED = 0
+
+            # The file is a Google Drive file.
+            DRIVE_FILE = 1
+
+            # The file is uploaded to Chat.
+            UPLOADED_CONTENT = 2
+          end
+        end
+
+        # A reference to the data of a drive attachment.
+        # @!attribute [rw] drive_file_id
+        #   @return [::String]
+        #     The ID for the drive file. Use with the Drive API.
+        class DriveDataRef
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A reference to the attachment data.
+        # @!attribute [rw] resource_name
+        #   @return [::String]
+        #     The resource name of the attachment data. This field is used with the media
+        #     API to download the attachment data.
+        # @!attribute [rw] attachment_upload_token
+        #   @return [::String]
+        #     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.
+        class AttachmentDataRef
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to get an attachment.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource name of the attachment, in the form
+        #     `spaces/*/messages/*/attachments/*`.
+        class GetAttachmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to upload an attachment.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource name of the Chat space in which the attachment is
+        #     uploaded. Format "spaces/\\{space}".
+        # @!attribute [rw] filename
+        #   @return [::String]
+        #     Required. The filename of the attachment, including the file extension.
+        class UploadAttachmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of uploading an attachment.
+        # @!attribute [rw] attachment_data_ref
+        #   @return [::Google::Apps::Chat::V1::AttachmentDataRef]
+        #     Reference to the uploaded attachment.
+        class UploadAttachmentResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/chat/v1/contextual_addon.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module V1
+        # The markup for developers to specify the contents of a contextual AddOn.
+        class ContextualAddOnMarkup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A card is a UI element that can contain UI widgets such as text and
+          # images.
+          # @!attribute [rw] header
+          #   @return [::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader]
+          #     The header of the card. A header usually contains a title and an image.
+          # @!attribute [rw] sections
+          #   @return [::Array<::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::Section>]
+          #     Sections are separated by a line divider.
+          # @!attribute [rw] card_actions
+          #   @return [::Array<::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardAction>]
+          #     The actions of this card.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Name of the card.
+          class Card
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] title
+            #   @return [::String]
+            #     The title must be specified. The header has a fixed height: if both a
+            #     title and subtitle is specified, each takes up one line. If only the
+            #     title is specified, it takes up both lines.
+            # @!attribute [rw] subtitle
+            #   @return [::String]
+            #     The subtitle of the card header.
+            # @!attribute [rw] image_style
+            #   @return [::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader::ImageStyle]
+            #     The image's type (for example, square border or circular border).
+            # @!attribute [rw] image_url
+            #   @return [::String]
+            #     The URL of the image in the card header.
+            class CardHeader
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              module ImageStyle
+                IMAGE_STYLE_UNSPECIFIED = 0
+
+                # Square border.
+                IMAGE = 1
+
+                # Circular border.
+                AVATAR = 2
+              end
+            end
+
+            # A section contains a collection of widgets that are rendered
+            # (vertically) in the order that they are specified. Across all platforms,
+            # cards have a narrow fixed width, so
+            # there's currently no need for layout properties (for example, float).
+            # @!attribute [rw] header
+            #   @return [::String]
+            #     The header of the section. Formatted text is
+            #     supported. For more information
+            #     about formatting text, see
+            #     [Formatting text in Google Chat
+            #     apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
+            #     and
+            #     [Formatting
+            #     text in Google Workspace
+            #     Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
+            # @!attribute [rw] widgets
+            #   @return [::Array<::Google::Apps::Chat::V1::WidgetMarkup>]
+            #     A section must contain at least one widget.
+            class Section
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # A card action is
+            # the action associated with the card. For an invoice card, a
+            # typical action would be: delete invoice, email invoice or open the
+            # invoice in browser.
+            #
+            # Not supported by Google Chat apps.
+            # @!attribute [rw] action_label
+            #   @return [::String]
+            #     The label used to be displayed in the action menu item.
+            # @!attribute [rw] on_click
+            #   @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick]
+            #     The onclick action for this action item.
+            class CardAction
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/chat/v1/deletion_metadata.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module V1
+        # Information about a deleted message. A message is deleted when `delete_time`
+        # is set.
+        # @!attribute [rw] deletion_type
+        #   @return [::Google::Apps::Chat::V1::DeletionMetadata::DeletionType]
+        #     Indicates who deleted the message.
+        class DeletionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Who deleted the message and how it was deleted.
+          module DeletionType
+            # This value is unused.
+            DELETION_TYPE_UNSPECIFIED = 0
+
+            # User deleted their own message.
+            CREATOR = 1
+
+            # The space owner deleted the message.
+            SPACE_OWNER = 2
+
+            # A Google Workspace admin deleted the message.
+            ADMIN = 3
+
+            # A Chat app deleted its own message when it expired.
+            APP_MESSAGE_EXPIRY = 4
+
+            # A Chat app deleted the message on behalf of the user.
+            CREATOR_VIA_APP = 5
+
+            # A Chat app deleted the message on behalf of the space owner.
+            SPACE_OWNER_VIA_APP = 6
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/chat/v1/group.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module V1
+        # A Google Group in Google Chat.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Resource name for a Google Group.
+        #
+        #     Represents a
+        #     [group](https://cloud.google.com/identity/docs/reference/rest/v1/groups) in
+        #     Cloud Identity Groups API.
+        #
+        #     Format: groups/\\{group}
+        class Group
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/chat/v1/history_state.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module V1
+        # The history state for messages and spaces. Specifies how long messages and
+        # conversation threads are kept after creation.
+        module HistoryState
+          # Default value. Do not use.
+          HISTORY_STATE_UNSPECIFIED = 0
+
+          # History off. [Messages and threads are kept for 24
+          # hours](https://support.google.com/chat/answer/7664687).
+          HISTORY_OFF = 1
+
+          # History on. The organization's [Vault retention
+          # rules](https://support.google.com/vault/answer/7657597) specify for
+          # how long messages and threads are kept.
+          HISTORY_ON = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/chat/v1/matched_url.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Apps
+    module Chat
+      module V1
+        # A matched URL in a Chat message. Chat apps can preview matched URLs. For more
+        # information, see [Preview
+        # links](https://developers.google.com/chat/how-tos/preview-links).
+        # @!attribute [r] url
+        #   @return [::String]
+        #     Output only. The URL that was matched.
+        class MatchedUrl
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end