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

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

@@ -0,0 +1,104 @@
+# 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 user's read state within a space, used to identify read and unread
+        # messages.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Resource name of the space read state.
+        #
+        #     Format: `users/{user}/spaces/{space}/spaceReadState`
+        # @!attribute [rw] last_read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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.
+        class SpaceReadState
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetSpaceReadState API.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     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
+        class GetSpaceReadStateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for UpdateSpaceReadState API.
+        # @!attribute [rw] space_read_state
+        #   @return [::Google::Apps::Chat::V1::SpaceReadState]
+        #     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
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     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.
+        class UpdateSpaceReadStateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# 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
+        # Request to create a space and add specified users to it.
+        # @!attribute [rw] space
+        #   @return [::Google::Apps::Chat::V1::Space]
+        #     Required. The `Space.spaceType` field is required.
+        #
+        #     To create a space, set `Space.spaceType` to `SPACE` and set
+        #     `Space.displayName`. If you receive the error message `ALREADY_EXISTS` when
+        #     setting up a space, try a different `displayName`. An existing space
+        #     within the Google Workspace organization might already use this display
+        #     name.
+        #
+        #     To create a group chat, set `Space.spaceType` to
+        #     `GROUP_CHAT`. Don't set `Space.displayName`.
+        #
+        #     To create a 1:1 conversation between humans,
+        #     set `Space.spaceType` to `DIRECT_MESSAGE` and set
+        #     `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or
+        #     `Space.spaceDetails`.
+        #
+        #     To create an 1:1 conversation between a human and the calling Chat app, set
+        #     `Space.spaceType` to `DIRECT_MESSAGE` and
+        #     `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or
+        #     `Space.spaceDetails`.
+        #
+        #     If a `DIRECT_MESSAGE` space already exists, that space is returned instead
+        #     of creating a new space.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A unique identifier for this request.
+        #     A random UUID is recommended.
+        #     Specifying an existing request ID returns the space created with that ID
+        #     instead of creating a new space.
+        #     Specifying an existing request ID from the same Chat app with a different
+        #     authenticated user returns an error.
+        # @!attribute [rw] memberships
+        #   @return [::Array<::Google::Apps::Chat::V1::Membership>]
+        #     Optional. The Google Chat users to invite to join the space. Omit the
+        #     calling user, as they are added automatically.
+        #
+        #     The set currently allows up to 20 memberships (in addition to the caller).
+        #
+        #     The `Membership.member` field must contain a `user` with `name` populated
+        #     (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You can only
+        #     add human users when setting up a space (adding Chat apps is only supported
+        #     for direct message setup with the calling app). You can also add members
+        #     using the user's email as an alias for \\{user}. For example, the `user.name`
+        #     can be `users/example@gmail.com`." To invite Gmail users or users from
+        #     external Google Workspace domains, user's email must be used for
+        #     `{user}`.
+        #
+        #     Optional when setting `Space.spaceType` to `SPACE`.
+        #
+        #     Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at
+        #     least two memberships.
+        #
+        #     Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human
+        #     user, along with exactly one membership.
+        #
+        #     Must be empty when creating a 1:1 conversation between a human and the
+        #     calling Chat app (when setting `Space.spaceType` to
+        #     `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).
+        class SetUpSpaceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 user's read state within a thread, used to identify read and unread
+        # messages.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Resource name of the thread read state.
+        #
+        #     Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`
+        # @!attribute [rw] last_read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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.
+        class ThreadReadState
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetThreadReadStateRequest API.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     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
+        class GetThreadReadStateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# 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 user in Google Chat.
+        # When returned as an output from a request, if your Chat app [authenticates as
+        # 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`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Resource name for a Google Chat {::Google::Apps::Chat::V1::User user}.
+        #
+        #     Format: `users/{user}`. `users/app` can be used as an alias for the calling
+        #     app {::Google::Apps::Chat::V1::User::Type::BOT bot} user.
+        #
+        #     For {::Google::Apps::Chat::V1::User::Type::HUMAN human users}, `{user}` is the same
+        #     user identifier as:
+        #
+        #     - the `id` for the
+        #     [Person](https://developers.google.com/people/api/rest/v1/people) in the
+        #     People API. For example, `users/123456789` in Chat API represents the same
+        #     person as the `123456789` Person profile ID in People API.
+        #
+        #     - the `id` for a
+        #     [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users)
+        #     in the Admin SDK Directory API.
+        #
+        #     - the user's email address can be used as an alias for `{user}` in API
+        #     requests. For example, if the People API Person profile ID for
+        #     `user@example.com` is `123456789`, you can use `users/user@example.com` as
+        #     an alias to reference `users/123456789`. Only the canonical resource name
+        #     (for example `users/123456789`) will be returned from the API.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. The user's display name.
+        # @!attribute [rw] domain_id
+        #   @return [::String]
+        #     Unique identifier of the user's Google Workspace domain.
+        # @!attribute [rw] type
+        #   @return [::Google::Apps::Chat::V1::User::Type]
+        #     User type.
+        # @!attribute [r] is_anonymous
+        #   @return [::Boolean]
+        #     Output only. When `true`, the user is deleted or their profile is not
+        #     visible.
+        class User
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module Type
+            # Default value for the enum. DO NOT USE.
+            TYPE_UNSPECIFIED = 0
+
+            # Human user.
+            HUMAN = 1
+
+            # Chat app user.
+            BOT = 2
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,293 @@
+# 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 widget is a UI element that presents text and images.
+        # @!attribute [rw] text_paragraph
+        #   @return [::Google::Apps::Chat::V1::WidgetMarkup::TextParagraph]
+        #     Display a text paragraph in this widget.
+        # @!attribute [rw] image
+        #   @return [::Google::Apps::Chat::V1::WidgetMarkup::Image]
+        #     Display an image in this widget.
+        # @!attribute [rw] key_value
+        #   @return [::Google::Apps::Chat::V1::WidgetMarkup::KeyValue]
+        #     Display a key value item in this widget.
+        # @!attribute [rw] buttons
+        #   @return [::Array<::Google::Apps::Chat::V1::WidgetMarkup::Button>]
+        #     A list of buttons. Buttons is also `oneof data` and only one of these
+        #     fields should be set.
+        class WidgetMarkup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A paragraph of text. Formatted text 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] text
+          #   @return [::String]
+          class TextParagraph
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A button. Can be a text button or an image button.
+          # @!attribute [rw] text_button
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::TextButton]
+          #     A button with text and `onclick` action.
+          # @!attribute [rw] image_button
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::ImageButton]
+          #     A button with image and `onclick` action.
+          class Button
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A button with text and `onclick` action.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     The text of the button.
+          # @!attribute [rw] on_click
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick]
+          #     The `onclick` action of the button.
+          class TextButton
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A UI element contains a key (label) and a value (content). This
+          # element can also contain some actions such as `onclick` button.
+          # @!attribute [rw] icon
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::Icon]
+          #     An enum value that's replaced by the Chat API with the
+          #     corresponding icon image.
+          # @!attribute [rw] icon_url
+          #   @return [::String]
+          #     The icon specified by a URL.
+          # @!attribute [rw] top_label
+          #   @return [::String]
+          #     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/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] content
+          #   @return [::String]
+          #     The text of the content. Formatted text supported and always required.
+          #     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] content_multiline
+          #   @return [::Boolean]
+          #     If the content should be multiline.
+          # @!attribute [rw] bottom_label
+          #   @return [::String]
+          #     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/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] on_click
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick]
+          #     The `onclick` action. Only the top label, bottom label, and content
+          #     region are clickable.
+          # @!attribute [rw] button
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::Button]
+          #     A button that can be clicked to trigger an action.
+          class KeyValue
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # An image that's specified by a URL and can have an `onclick` action.
+          # @!attribute [rw] image_url
+          #   @return [::String]
+          #     The URL of the image.
+          # @!attribute [rw] on_click
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick]
+          #     The `onclick` action.
+          # @!attribute [rw] aspect_ratio
+          #   @return [::Float]
+          #     The aspect ratio of this image (width and height). This field lets you
+          #     reserve the right height for the image while waiting for it to load.
+          #     It's not meant to override the built-in aspect ratio of the image.
+          #     If unset, the server fills it by prefetching the image.
+          class Image
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # An image button with an `onclick` action.
+          # @!attribute [rw] icon
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::Icon]
+          #     The icon specified by an `enum` that indices to an icon provided by
+          #     Chat API.
+          # @!attribute [rw] icon_url
+          #   @return [::String]
+          #     The icon specified by a URL.
+          # @!attribute [rw] on_click
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick]
+          #     The `onclick` action.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of this `image_button` that's used for accessibility.
+          #     Default value is provided if this name isn't specified.
+          class ImageButton
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # An `onclick` action (for example, open a link).
+          # @!attribute [rw] action
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::FormAction]
+          #     A form action is triggered by this `onclick` action if specified.
+          # @!attribute [rw] open_link
+          #   @return [::Google::Apps::Chat::V1::WidgetMarkup::OpenLink]
+          #     This `onclick` action triggers an open link action if specified.
+          class OnClick
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A link that opens a new window.
+          # @!attribute [rw] url
+          #   @return [::String]
+          #     The URL to open.
+          class OpenLink
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A form action describes the behavior when the form is submitted.
+          # For example, you can invoke Apps Script to handle the form.
+          # @!attribute [rw] action_method_name
+          #   @return [::String]
+          #     The method name is used to identify which part of the form triggered the
+          #     form submission. This information is echoed back to the Chat app as part
+          #     of the card click event. You can use the same method name for several
+          #     elements that trigger a common behavior.
+          # @!attribute [rw] parameters
+          #   @return [::Array<::Google::Apps::Chat::V1::WidgetMarkup::FormAction::ActionParameter>]
+          #     List of action parameters.
+          class FormAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # List of string parameters to supply when the action method is invoked.
+            # For example, consider three snooze buttons: snooze now, snooze one day,
+            # snooze next week. You might use `action method = snooze()`, passing the
+            # snooze type and snooze time in the list of string parameters.
+            # @!attribute [rw] key
+            #   @return [::String]
+            #     The name of the parameter for the action script.
+            # @!attribute [rw] value
+            #   @return [::String]
+            #     The value of the parameter.
+            class ActionParameter
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The set of supported icons.
+          module Icon
+            ICON_UNSPECIFIED = 0
+
+            AIRPLANE = 1
+
+            BOOKMARK = 26
+
+            BUS = 25
+
+            CAR = 9
+
+            CLOCK = 2
+
+            CONFIRMATION_NUMBER_ICON = 12
+
+            DOLLAR = 14
+
+            DESCRIPTION = 27
+
+            EMAIL = 10
+
+            EVENT_PERFORMER = 20
+
+            EVENT_SEAT = 21
+
+            FLIGHT_ARRIVAL = 16
+
+            FLIGHT_DEPARTURE = 15
+
+            HOTEL = 6
+
+            HOTEL_ROOM_TYPE = 17
+
+            INVITE = 19
+
+            MAP_PIN = 3
+
+            MEMBERSHIP = 24
+
+            MULTIPLE_PEOPLE = 18
+
+            OFFER = 30
+
+            PERSON = 11
+
+            PHONE = 13
+
+            RESTAURANT_ICON = 7
+
+            SHOPPING_CART = 8
+
+            STAR = 5
+
+            STORE = 22
+
+            TICKET = 4
+
+            TRAIN = 23
+
+            VIDEO_CAMERA = 28
+
+            VIDEO_PLAY = 29
+          end
+        end
+      end
+    end
+  end
+end