google-apps-chat-v1 0.6.0 → 0.7.0

data/proto_docs/google/api/field_info.rb

@@ -0,0 +1,88 @@
+# 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 Api
+    # Rich semantic information of an API field beyond basic typing.
+    # @!attribute [rw] format
+    #   @return [::Google::Api::FieldInfo::Format]
+    #     The standard format of a field value. This does not explicitly configure
+    #     any API consumer, just documents the API's format for the field it is
+    #     applied to.
+    # @!attribute [rw] referenced_types
+    #   @return [::Array<::Google::Api::TypeReference>]
+    #     The type(s) that the annotated, generic field may represent.
+    #
+    #     Currently, this must only be used on fields of type `google.protobuf.Any`.
+    #     Supporting other generic types may be considered in the future.
+    class FieldInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # The standard format of a field value. The supported formats are all backed
+      # by either an RFC defined by the IETF or a Google-defined AIP.
+      module Format
+        # Default, unspecified value.
+        FORMAT_UNSPECIFIED = 0
+
+        # Universally Unique Identifier, version 4, value as defined by
+        # https://datatracker.ietf.org/doc/html/rfc4122. The value may be
+        # normalized to entirely lowercase letters. For example, the value
+        # `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to
+        # `f47ac10b-58cc-0372-8567-0e02b2c3d479`.
+        UUID4 = 1
+
+        # Internet Protocol v4 value as defined by [RFC
+        # 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be
+        # condensed, with leading zeros in each octet stripped. For example,
+        # `001.022.233.040` would be condensed to `1.22.233.40`.
+        IPV4 = 2
+
+        # Internet Protocol v6 value as defined by [RFC
+        # 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be
+        # normalized to entirely lowercase letters with zeros compressed, following
+        # [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,
+        # the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.
+        IPV6 = 3
+
+        # An IP address in either v4 or v6 format as described by the individual
+        # values defined herein. See the comments on the IPV4 and IPV6 types for
+        # allowed normalizations of each.
+        IPV4_OR_IPV6 = 4
+      end
+    end
+
+    # A reference to a message type, for use in {::Google::Api::FieldInfo FieldInfo}.
+    # @!attribute [rw] type_name
+    #   @return [::String]
+    #     The name of the type that the annotated, generic field may represent.
+    #     If the type is in the same protobuf package, the value can be the simple
+    #     message name e.g., `"MyMessage"`. Otherwise, the value must be the
+    #     fully-qualified message name e.g., `"google.library.v1.Book"`.
+    #
+    #     If the type(s) are unknown to the service (e.g. the field accepts generic
+    #     user input), use the wildcard `"*"` to denote this behavior.
+    #
+    #     See [AIP-202](https://google.aip.dev/202#type-references) for more details.
+    class TypeReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -24,7 +24,7 @@ module Google
         # An attachment in Google Chat.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Resource name of the attachment, in the form
+        #     Optional. Resource name of the attachment, in the form
         #     `spaces/{space}/messages/{message}/attachments/{attachment}`.
         # @!attribute [r] content_name
         #   @return [::String]
@@ -34,8 +34,9 @@ module Google
         #     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.
+        #     Optional. A reference to the attachment data. This field is used to
+        #     create or update messages with attachments, or 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
@@ -82,13 +83,13 @@ module Google
         # 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.
+        #     Optional. 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.
+        #     Optional. 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

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

@@ -30,7 +30,8 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Who deleted the message and how it was deleted.
+          # Who deleted the message and how it was deleted. More values may be added in
+          # the future.
           module DeletionType
             # This value is unused.
             DELETION_TYPE_UNSPECIFIED = 0

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

@@ -25,7 +25,7 @@ module Google
         # Chat app is invited to, part of, or absent from a space.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Resource name of the membership, assigned by the server.
+        #     Identifier. Resource name of the membership, assigned by the server.
         #
         #     Format: `spaces/{space}/members/{member}`
         # @!attribute [r] state
@@ -39,7 +39,7 @@ module Google
         #     This field can only be used as input in `UpdateMembership`.
         # @!attribute [rw] member
         #   @return [::Google::Apps::Chat::V1::User]
-        #     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
@@ -47,7 +47,10 @@ module Google
         #     `name` and `type`.
         # @!attribute [rw] group_member
         #   @return [::Google::Apps::Chat::V1::Group]
-        #     The Google Group the membership corresponds to.
+        #     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).
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Optional. Immutable. The creation time of the membership, such as when a
@@ -111,24 +114,45 @@ module Google
         # @!attribute [rw] membership
         #   @return [::Google::Apps::Chat::V1::Membership]
         #     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`.
         # @!attribute [rw] use_admin_access
         #   @return [::Boolean]
-        #     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
@@ -161,7 +185,7 @@ module Google
         #     - `role`
         # @!attribute [rw] use_admin_access
         #   @return [::Boolean]
-        #     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
@@ -261,7 +285,7 @@ module Google
         #     authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
         # @!attribute [rw] use_admin_access
         #   @return [::Boolean]
-        #     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,14 +326,12 @@ module Google
         #
         #     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.
         # @!attribute [rw] use_admin_access
         #   @return [::Boolean]
-        #     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
@@ -345,7 +367,7 @@ module Google
         #     Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
         # @!attribute [rw] use_admin_access
         #   @return [::Boolean]
-        #     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

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

@@ -24,7 +24,7 @@ module Google
         # A message in a Google Chat space.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Resource name of the message.
+        #     Identifier. Resource name of the message.
         #
         #     Format: `spaces/{space}/messages/{message}`
         #
@@ -66,10 +66,10 @@ module Google
         #     Google Chat. If the message is never deleted, this field is empty.
         # @!attribute [rw] text
         #   @return [::String]
-        #     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.
         #
@@ -111,7 +111,7 @@ module Google
         #     `cards_v2` can have a maximum size of 32 KB.
         # @!attribute [rw] cards_v2
         #   @return [::Array<::Google::Apps::Chat::V1::CardWithId>]
-        #     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
@@ -130,17 +130,17 @@ module Google
         #     The thread the message belongs to. For example usage, see
         #     [Start or reply to a message
         #     thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
-        # @!attribute [rw] space
+        # @!attribute [r] space
         #   @return [::Google::Apps::Chat::V1::Space]
-        #     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`.
         # @!attribute [rw] fallback_text
         #   @return [::String]
-        #     A plain-text description of the message's cards, used when the actual cards
-        #     can't be displayed—for example, mobile notifications.
+        #     Optional. A plain-text description of the message's cards, used when the
+        #     actual cards can't be displayed—for example, mobile notifications.
         # @!attribute [rw] action_response
         #   @return [::Google::Apps::Chat::V1::ActionResponse]
         #     Input only. Parameters that a Chat app can use to configure how its
@@ -154,7 +154,7 @@ module Google
         #     Output only. Slash command information, if applicable.
         # @!attribute [rw] attachment
         #   @return [::Array<::Google::Apps::Chat::V1::Attachment>]
-        #     User-uploaded attachment.
+        #     Optional. User-uploaded attachment.
         # @!attribute [r] matched_url
         #   @return [::Google::Apps::Chat::V1::MatchedUrl]
         #     Output only. A URL in `spaces.messages.text` that matches a link preview
@@ -181,10 +181,10 @@ module Google
         #     Output only. The list of emoji reaction summaries on the message.
         # @!attribute [rw] private_message_viewer
         #   @return [::Google::Apps::Chat::V1::User]
-        #     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:
         #
@@ -207,10 +207,10 @@ module Google
         #     Output only. GIF images that are attached to the message.
         # @!attribute [rw] accessory_widgets
         #   @return [::Array<::Google::Apps::Chat::V1::AccessoryWidget>]
-        #     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
@@ -254,7 +254,7 @@ module Google
         # field to determine what happens if no matching thread is found.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Resource name of the thread.
+        #     Identifier. Resource name of the thread.
         #
         #     Example: `spaces/{space}/threads/{thread}`
         # @!attribute [rw] thread_key
@@ -301,8 +301,8 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # The response of the updated widget.
-          # Used to provide autocomplete options for a widget.
+          # For `selectionInput` widgets, returns autocomplete suggestions for a
+          # multiselect menu.
           # @!attribute [rw] suggestions
           #   @return [::Google::Apps::Chat::V1::ActionResponse::SelectionItems]
           #     List of widget autocomplete results
@@ -384,8 +384,8 @@ module Google
         #     (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
         # @!attribute [rw] force
         #   @return [::Boolean]
-        #     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).
@@ -458,6 +458,12 @@ module Google
         #   @return [::Google::Apps::Chat::V1::CreateMessageRequest::MessageReplyOption]
         #     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.
         # @!attribute [rw] message_id
         #   @return [::String]
         #     Optional. A custom ID for a message. Lets Chat apps get, update, or delete
@@ -510,8 +516,8 @@ module Google
         #     Format: `spaces/{space}`
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     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.
         #
@@ -521,17 +527,15 @@ module Google
         #     Negative values return an `INVALID_ARGUMENT` error.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     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.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     A query filter.
+        #     Optional. A query filter.
         #
         #     You can filter messages by date (`create_time`) and thread (`thread.name`).
         #
@@ -570,10 +574,8 @@ module Google
         #     error.
         # @!attribute [rw] order_by
         #   @return [::String]
-        #     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.
         #
@@ -582,8 +584,9 @@ module Google
         #     The default ordering is `create_time ASC`.
         # @!attribute [rw] show_deleted
         #   @return [::Boolean]
-        #     Whether to include deleted messages. Deleted messages include deleted time
-        #     and metadata about their deletion, but message content is unavailable.
+        #     Optional. Whether to include deleted messages. Deleted messages include
+        #     deleted time and metadata about their deletion, but message content is
+        #     unavailable.
         class ListMessagesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -24,7 +24,7 @@ module Google
         # A reaction to a message.
         # @!attribute [rw] name
         #   @return [::String]
-        #     The resource name of the reaction.
+        #     Identifier. The resource name of the reaction.
         #
         #     Format: `spaces/{space}/messages/{message}/reactions/{reaction}`
         # @!attribute [r] user
@@ -32,7 +32,7 @@ module Google
         #     Output only. The user who created the reaction.
         # @!attribute [rw] emoji
         #   @return [::Google::Apps::Chat::V1::Emoji]
-        #     The emoji used in the reaction.
+        #     Required. The emoji used in the reaction.
         class Reaction
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,7 +41,7 @@ module Google
         # An emoji that is used as a reaction to a message.
         # @!attribute [rw] unicode
         #   @return [::String]
-        #     A basic emoji represented by a unicode string.
+        #     Optional. A basic emoji represented by a unicode string.
         # @!attribute [r] custom_emoji
         #   @return [::Google::Apps::Chat::V1::CustomEmoji]
         #     Output only. A custom emoji.
@@ -60,12 +60,12 @@ module Google
         end
 
         # The number of people who reacted to a message with a specific emoji.
-        # @!attribute [rw] emoji
+        # @!attribute [r] emoji
         #   @return [::Google::Apps::Chat::V1::Emoji]
-        #     Emoji associated with the reactions.
-        # @!attribute [rw] reaction_count
+        #     Output only. Emoji associated with the reactions.
+        # @!attribute [r] reaction_count
         #   @return [::Integer]
-        #     The total number of reactions using the associated emoji.
+        #     Output only. The total number of reactions using the associated emoji.
         class EmojiReactionSummary
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods