google-apps-chat-v1 0.24.0 → 0.25.0

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

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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 a user's current availability information in Google Chat,
+        # including their state (for example, Active, Away, Do Not Disturb) and any
+        # custom status.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Resource name of the user's availability.
+        #
+        #     Format: `users/{user}/availability`
+        #
+        #     `{user}` is the id for the Person in the People API or Admin SDK directory
+        #     API. For example, `users/123456789`.
+        #
+        #     The user's email address or `me` can also be used as an alias to refer to
+        #     the caller.  For example, `users/user@example.com` or `users/me`.
+        # @!attribute [r] state
+        #   @return [::Google::Apps::Chat::V1::Availability::State]
+        #     Output only. The user's current availability state.
+        # @!attribute [r] do_not_disturb_metadata
+        #   @return [::Google::Apps::Chat::V1::DoNotDisturbMetadata]
+        #     Output only. Metadata if the user state is set to DO_NOT_DISTURB.
+        # @!attribute [rw] custom_status
+        #   @return [::Google::Apps::Chat::V1::CustomStatus]
+        #     Optional. The user's custom status.
+        class Availability
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents the current availability state of the user.
+          module State
+            # Default value. The state is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The user is currently active, based on recent activity.
+            ACTIVE = 1
+
+            # The user is currently idle. This state indicates a period of inactivity
+            # after being ACTIVE, before potentially transitioning to AWAY.
+            IDLE = 2
+
+            # The user is currently away. This can be either automatically set after
+            # a period of inactivity in ACTIVE or IDLE state, or it can be manually set
+            # by the user. When manually set via `MarkAsAway`, this state persists
+            # regardless of user activity.
+            AWAY = 3
+
+            # The user is in Do Not Disturb state, which is manually set.
+            DO_NOT_DISTURB = 4
+          end
+        end
+
+        # Represents a user's custom status in Google Chat.
+        # This includes a short text message with an optional emoji that a user sets to
+        # give more context about their availability.
+        # @!attribute [rw] text
+        #   @return [::String]
+        #     Required. The text of the custom status. This will be a string with maximum
+        #     length of 64.
+        # @!attribute [rw] emoji
+        #   @return [::Google::Apps::Chat::V1::Emoji]
+        #     Required. The emoji of the custom status. Only Unicode emojis are
+        #     supported; custom emojis are not supported.
+        # @!attribute [rw] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The timestamp when the custom status expires.
+        #
+        #     Note: The following fields are mutually exclusive: `expire_time`, `ttl`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] ttl
+        #   @return [::Google::Protobuf::Duration]
+        #     Input only. The time-to-live duration after which the custom status
+        #     expires.
+        #
+        #     Note: The following fields are mutually exclusive: `ttl`, `expire_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class CustomStatus
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata associated with the `DO_NOT_DISTURB` availability state,
+        # specifying when the state is set to expire.
+        # @!attribute [r] expiration_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp until which the user should be marked as
+        #     DO_NOT_DISTURB. This can be maximum of 1 year in the future.
+        class DoNotDisturbMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the `GetAvailability` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the availability to retrieve.
+        #
+        #     Format: users/\\{user}/availability
+        #
+        #     `{user}` is the id for the Person in the People API or Admin SDK directory
+        #     API. For example, `users/123456789`.
+        #
+        #     The user's email address or `me` can also be used as an alias to refer to
+        #     the caller.  For example, `users/user@example.com` or `users/me`.
+        class GetAvailabilityRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the `UpdateAvailability` method.
+        # @!attribute [rw] availability
+        #   @return [::Google::Apps::Chat::V1::Availability]
+        #     Required. The availability to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The list of fields to update.
+        #     The only field that can be updated is `custom_status`.
+        class UpdateAvailabilityRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the `MarkAsActive` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the availability to mark as active.
+        #     Format: users/\\{user}/availability
+        #
+        #     `{user}` is the id for the Person in the People API or Admin SDK directory
+        #     API. For example, `users/123456789`.
+        #
+        #     The user's email address or `me` can also be used as an alias to refer to
+        #     the caller.  For example, `users/user@example.com` or `users/me`.
+        # @!attribute [rw] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The absolute timestamp when the ACTIVE state expires.
+        #
+        #     Note: The following fields are mutually exclusive: `expire_time`, `ttl`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] ttl
+        #   @return [::Google::Protobuf::Duration]
+        #     The duration from the current time until the ACTIVE state expires.
+        #     Using a short TTL can effectively reset the user's state to be based
+        #     on activity after this brief duration.
+        #
+        #     Note: The following fields are mutually exclusive: `ttl`, `expire_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class MarkAsActiveRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the `MarkAsAway` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the availability to mark as away.
+        #     Format: users/\\{user}/availability
+        #
+        #     `{user}` is the id for the Person in the People API or Admin SDK directory
+        #     API. For example, `users/123456789`.
+        #
+        #     The user's email address or `me` can also be used as an alias to refer to
+        #     the caller.  For example, `users/user@example.com` or `users/me`.
+        class MarkAsAwayRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the `MarkAsDoNotDisturb` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the availability to mark as Do Not Disturb.
+        #     Format: users/\\{user}/availability
+        #
+        #     `{user}` is the id for the Person in the People API or Admin SDK directory
+        #     API. For example, `users/123456789`.
+        #
+        #     The user's email address or `me` can also be used as an alias to refer to
+        #     the caller.  For example, `users/user@example.com` or `users/me`.
+        # @!attribute [rw] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The absolute timestamp when the DND state expires.
+        #
+        #     Note: The following fields are mutually exclusive: `expire_time`, `ttl`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] ttl
+        #   @return [::Google::Protobuf::Duration]
+        #     The duration from the current time until the DND state expires.
+        #
+        #     Note: The following fields are mutually exclusive: `ttl`, `expire_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class MarkAsDoNotDisturbRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apps-chat-v1
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Google LLC
@@ -85,6 +85,7 @@ files:
 - lib/google/chat/v1/action_status_pb.rb
 - lib/google/chat/v1/annotation_pb.rb
 - lib/google/chat/v1/attachment_pb.rb
+- lib/google/chat/v1/availability_pb.rb
 - lib/google/chat/v1/chat_service_pb.rb
 - lib/google/chat/v1/chat_service_services_pb.rb
 - lib/google/chat/v1/contextual_addon_pb.rb
@@ -116,6 +117,7 @@ files:
 - proto_docs/google/chat/v1/action_status.rb
 - proto_docs/google/chat/v1/annotation.rb
 - proto_docs/google/chat/v1/attachment.rb
+- proto_docs/google/chat/v1/availability.rb
 - proto_docs/google/chat/v1/contextual_addon.rb
 - proto_docs/google/chat/v1/deletion_metadata.rb
 - proto_docs/google/chat/v1/event_payload.rb