google-apps-chat-v1 0.3.1 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/apps/chat/v1/chat_service/client.rb +325 -10
- data/lib/google/apps/chat/v1/chat_service/rest/client.rb +326 -10
- data/lib/google/apps/chat/v1/chat_service/rest/service_stub.rb +57 -0
- data/lib/google/apps/chat/v1/version.rb +1 -1
- data/lib/google/chat/v1/annotation_pb.rb +2 -1
- data/lib/google/chat/v1/chat_service_pb.rb +1 -1
- data/lib/google/chat/v1/chat_service_services_pb.rb +6 -0
- data/lib/google/chat/v1/membership_pb.rb +1 -1
- data/lib/google/chat/v1/space_pb.rb +4 -1
- data/proto_docs/google/chat/v1/annotation.rb +27 -0
- data/proto_docs/google/chat/v1/membership.rb +69 -2
- data/proto_docs/google/chat/v1/space.rb +208 -0
- metadata +2 -2
@@ -12,7 +12,7 @@ require 'google/protobuf/field_mask_pb'
|
|
12
12
|
require 'google/protobuf/timestamp_pb'
|
13
13
|
|
14
14
|
|
15
|
-
descriptor_data = "\n\x1fgoogle/chat/v1/membership.proto\x12\x0egoogle.chat.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1agoogle/chat/v1/group.proto\x1a\x19google/chat/v1/user.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x90\x05\n\nMembership\x12\x31\n\x04name\x18\x01 \x01(\tB#\xfa\x41 \n\x1e\x63hat.googleapis.com/Membership\x12>\n\x05state\x18\x02 \x01(\x0e\x32*.google.chat.v1.Membership.MembershipStateB\x03\xe0\x41\x03\x12<\n\x04role\x18\x07 \x01(\x0e\x32).google.chat.v1.Membership.MembershipRoleB\x03\xe0\x41\x01\x12&\n\x06member\x18\x03 \x01(\x0b\x32\x14.google.chat.v1.UserH\x00\x12-\n\x0cgroup_member\x18\x05 \x01(\x0b\x32\x15.google.chat.v1.GroupH\x00\x12\x37\n\x0b\x63reate_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\xe0\x41\x05\xe0\x41\x01\x12\x37\n\x0b\x64\x65lete_time\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\xe0\x41\x05\xe0\x41\x01\"^\n\x0fMembershipState\x12 \n\x1cMEMBERSHIP_STATE_UNSPECIFIED\x10\x00\x12\n\n\x06JOINED\x10\x01\x12\x0b\n\x07INVITED\x10\x02\x12\x10\n\x0cNOT_A_MEMBER\x10\x03\"T\n\x0eMembershipRole\x12\x1f\n\x1bMEMBERSHIP_ROLE_UNSPECIFIED\x10\x00\x12\x0f\n\x0bROLE_MEMBER\x10\x01\x12\x10\n\x0cROLE_MANAGER\x10\x02:D\xea\x41\x41\n\x1e\x63hat.googleapis.com/Membership\x12\x1fspaces/{space}/members/{member}B\x0c\n\nmemberType\"\
|
15
|
+
descriptor_data = "\n\x1fgoogle/chat/v1/membership.proto\x12\x0egoogle.chat.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1agoogle/chat/v1/group.proto\x1a\x19google/chat/v1/user.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x90\x05\n\nMembership\x12\x31\n\x04name\x18\x01 \x01(\tB#\xfa\x41 \n\x1e\x63hat.googleapis.com/Membership\x12>\n\x05state\x18\x02 \x01(\x0e\x32*.google.chat.v1.Membership.MembershipStateB\x03\xe0\x41\x03\x12<\n\x04role\x18\x07 \x01(\x0e\x32).google.chat.v1.Membership.MembershipRoleB\x03\xe0\x41\x01\x12&\n\x06member\x18\x03 \x01(\x0b\x32\x14.google.chat.v1.UserH\x00\x12-\n\x0cgroup_member\x18\x05 \x01(\x0b\x32\x15.google.chat.v1.GroupH\x00\x12\x37\n\x0b\x63reate_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\xe0\x41\x05\xe0\x41\x01\x12\x37\n\x0b\x64\x65lete_time\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\xe0\x41\x05\xe0\x41\x01\"^\n\x0fMembershipState\x12 \n\x1cMEMBERSHIP_STATE_UNSPECIFIED\x10\x00\x12\n\n\x06JOINED\x10\x01\x12\x0b\n\x07INVITED\x10\x02\x12\x10\n\x0cNOT_A_MEMBER\x10\x03\"T\n\x0eMembershipRole\x12\x1f\n\x1bMEMBERSHIP_ROLE_UNSPECIFIED\x10\x00\x12\x0f\n\x0bROLE_MEMBER\x10\x01\x12\x10\n\x0cROLE_MANAGER\x10\x02:D\xea\x41\x41\n\x1e\x63hat.googleapis.com/Membership\x12\x1fspaces/{space}/members/{member}B\x0c\n\nmemberType\"\xa0\x01\n\x17\x43reateMembershipRequest\x12\x36\n\x06parent\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \x12\x1e\x63hat.googleapis.com/Membership\x12\x33\n\nmembership\x18\x02 \x01(\x0b\x32\x1a.google.chat.v1.MembershipB\x03\xe0\x41\x02\x12\x18\n\x10use_admin_access\x18\x05 \x01(\x08\"\x9e\x01\n\x17UpdateMembershipRequest\x12\x33\n\nmembership\x18\x01 \x01(\x0b\x32\x1a.google.chat.v1.MembershipB\x03\xe0\x41\x02\x12\x34\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMaskB\x03\xe0\x41\x02\x12\x18\n\x10use_admin_access\x18\x03 \x01(\x08\"\xe5\x01\n\x16ListMembershipsRequest\x12\x36\n\x06parent\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \x12\x1e\x63hat.googleapis.com/Membership\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x05 \x01(\tB\x03\xe0\x41\x01\x12\x18\n\x0bshow_groups\x18\x06 \x01(\x08\x42\x03\xe0\x41\x01\x12\x19\n\x0cshow_invited\x18\x07 \x01(\x08\x42\x03\xe0\x41\x01\x12\x18\n\x10use_admin_access\x18\x08 \x01(\x08\"h\n\x17ListMembershipsResponse\x12\x34\n\x0bmemberships\x18\x01 \x03(\x0b\x32\x1a.google.chat.v1.MembershipB\x03\xe0\x41\x06\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"f\n\x14GetMembershipRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x63hat.googleapis.com/Membership\x12\x18\n\x10use_admin_access\x18\x03 \x01(\x08\"i\n\x17\x44\x65leteMembershipRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x63hat.googleapis.com/Membership\x12\x18\n\x10use_admin_access\x18\x02 \x01(\x08\x42\xa8\x01\n\x12\x63om.google.chat.v1B\x0fMembershipProtoP\x01Z,cloud.google.com/go/chat/apiv1/chatpb;chatpb\xa2\x02\x0b\x44YNAPIProto\xaa\x02\x13Google.Apps.Chat.V1\xca\x02\x13Google\\Apps\\Chat\\V1\xea\x02\x16Google::Apps::Chat::V1b\x06proto3"
|
16
16
|
|
17
17
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
18
18
|
|
@@ -11,7 +11,7 @@ require 'google/protobuf/field_mask_pb'
|
|
11
11
|
require 'google/protobuf/timestamp_pb'
|
12
12
|
|
13
13
|
|
14
|
-
descriptor_data = "\n\x1agoogle/chat/v1/space.proto\x12\x0egoogle.chat.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\"google/chat/v1/history_state.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\
|
14
|
+
descriptor_data = "\n\x1agoogle/chat/v1/space.proto\x12\x0egoogle.chat.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\"google/chat/v1/history_state.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x92\x0b\n\x05Space\x12\x0c\n\x04name\x18\x01 \x01(\t\x12/\n\x04type\x18\x02 \x01(\x0e\x32\x1a.google.chat.v1.Space.TypeB\x05\x18\x01\xe0\x41\x03\x12\x33\n\nspace_type\x18\n \x01(\x0e\x32\x1f.google.chat.v1.Space.SpaceType\x12\x1f\n\x12single_user_bot_dm\x18\x04 \x01(\x08\x42\x03\xe0\x41\x01\x12\x17\n\x08threaded\x18\x05 \x01(\x08\x42\x05\x18\x01\xe0\x41\x03\x12\x14\n\x0c\x64isplay_name\x18\x03 \x01(\t\x12\"\n\x15\x65xternal_user_allowed\x18\x08 \x01(\x08\x42\x03\xe0\x41\x05\x12M\n\x15space_threading_state\x18\t \x01(\x0e\x32).google.chat.v1.Space.SpaceThreadingStateB\x03\xe0\x41\x03\x12\x39\n\rspace_details\x18\x0b \x01(\x0b\x32\".google.chat.v1.Space.SpaceDetails\x12\x39\n\x13space_history_state\x18\r \x01(\x0e\x32\x1c.google.chat.v1.HistoryState\x12\x18\n\x0bimport_mode\x18\x10 \x01(\x08\x42\x03\xe0\x41\x01\x12\x37\n\x0b\x63reate_time\x18\x11 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\xe0\x41\x05\xe0\x41\x01\x12\x39\n\x10last_active_time\x18\x12 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x1c\n\x0f\x61\x64min_installed\x18\x13 \x01(\x08\x42\x03\xe0\x41\x03\x12\x44\n\x10membership_count\x18\x14 \x01(\x0b\x32%.google.chat.v1.Space.MembershipCountB\x03\xe0\x41\x03\x12\x42\n\x0f\x61\x63\x63\x65ss_settings\x18\x17 \x01(\x0b\x32$.google.chat.v1.Space.AccessSettingsB\x03\xe0\x41\x01\x12\x16\n\tspace_uri\x18\x19 \x01(\tB\x03\xe0\x41\x03\x1a\x37\n\x0cSpaceDetails\x12\x13\n\x0b\x64\x65scription\x18\x01 \x01(\t\x12\x12\n\nguidelines\x18\x02 \x01(\t\x1aU\n\x0fMembershipCount\x12&\n\x1ejoined_direct_human_user_count\x18\x04 \x01(\x05\x12\x1a\n\x12joined_group_count\x18\x05 \x01(\x05\x1a\xc0\x01\n\x0e\x41\x63\x63\x65ssSettings\x12K\n\x0c\x61\x63\x63\x65ss_state\x18\x01 \x01(\x0e\x32\x30.google.chat.v1.Space.AccessSettings.AccessStateB\x03\xe0\x41\x03\x12\x15\n\x08\x61udience\x18\x03 \x01(\tB\x03\xe0\x41\x01\"J\n\x0b\x41\x63\x63\x65ssState\x12\x1c\n\x18\x41\x43\x43\x45SS_STATE_UNSPECIFIED\x10\x00\x12\x0b\n\x07PRIVATE\x10\x01\x12\x10\n\x0c\x44ISCOVERABLE\x10\x02\".\n\x04Type\x12\x14\n\x10TYPE_UNSPECIFIED\x10\x00\x12\x08\n\x04ROOM\x10\x01\x12\x06\n\x02\x44M\x10\x02\"V\n\tSpaceType\x12\x1a\n\x16SPACE_TYPE_UNSPECIFIED\x10\x00\x12\t\n\x05SPACE\x10\x01\x12\x0e\n\nGROUP_CHAT\x10\x02\x12\x12\n\x0e\x44IRECT_MESSAGE\x10\x03\"\x82\x01\n\x13SpaceThreadingState\x12%\n!SPACE_THREADING_STATE_UNSPECIFIED\x10\x00\x12\x15\n\x11THREADED_MESSAGES\x10\x02\x12\x14\n\x10GROUPED_MESSAGES\x10\x03\x12\x17\n\x13UNTHREADED_MESSAGES\x10\x04:.\xea\x41+\n\x19\x63hat.googleapis.com/Space\x12\x0espaces/{space}\"X\n\x12\x43reateSpaceRequest\x12)\n\x05space\x18\x01 \x01(\x0b\x32\x15.google.chat.v1.SpaceB\x03\xe0\x41\x02\x12\x17\n\nrequest_id\x18\x02 \x01(\tB\x03\xe0\x41\x01\"Y\n\x11ListSpacesRequest\x12\x16\n\tpage_size\x18\x01 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x03 \x01(\tB\x03\xe0\x41\x01\"T\n\x12ListSpacesResponse\x12%\n\x06spaces\x18\x01 \x03(\x0b\x32\x15.google.chat.v1.Space\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\\\n\x0fGetSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\x12\x18\n\x10use_admin_access\x18\x02 \x01(\x08\"-\n\x18\x46indDirectMessageRequest\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x02\"\x8a\x01\n\x12UpdateSpaceRequest\x12)\n\x05space\x18\x01 \x01(\x0b\x32\x15.google.chat.v1.SpaceB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\x12\x18\n\x10use_admin_access\x18\x03 \x01(\x08\"\x81\x01\n\x13SearchSpacesRequest\x12\x18\n\x10use_admin_access\x18\x01 \x01(\x08\x12\x11\n\tpage_size\x18\x02 \x01(\x05\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x12\n\x05query\x18\x04 \x01(\tB\x03\xe0\x41\x02\x12\x15\n\x08order_by\x18\x05 \x01(\tB\x03\xe0\x41\x01\"j\n\x14SearchSpacesResponse\x12%\n\x06spaces\x18\x01 \x03(\x0b\x32\x15.google.chat.v1.Space\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12\x12\n\ntotal_size\x18\x03 \x01(\x05\"_\n\x12\x44\x65leteSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\x12\x18\n\x10use_admin_access\x18\x02 \x01(\x08\"M\n\x1a\x43ompleteImportSpaceRequest\x12/\n\x04name\x18\x01 \x01(\tB!\xe0\x41\x02\xfa\x41\x1b\n\x19\x63hat.googleapis.com/Space\"C\n\x1b\x43ompleteImportSpaceResponse\x12$\n\x05space\x18\x01 \x01(\x0b\x32\x15.google.chat.v1.SpaceB\xa3\x01\n\x12\x63om.google.chat.v1B\nSpaceProtoP\x01Z,cloud.google.com/go/chat/apiv1/chatpb;chatpb\xa2\x02\x0b\x44YNAPIProto\xaa\x02\x13Google.Apps.Chat.V1\xca\x02\x13Google\\Apps\\Chat\\V1\xea\x02\x16Google::Apps::Chat::V1b\x06proto3"
|
15
15
|
|
16
16
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
17
17
|
|
@@ -45,6 +45,7 @@ module Google
|
|
45
45
|
module V1
|
46
46
|
Space = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space").msgclass
|
47
47
|
Space::SpaceDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.SpaceDetails").msgclass
|
48
|
+
Space::MembershipCount = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.MembershipCount").msgclass
|
48
49
|
Space::AccessSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.AccessSettings").msgclass
|
49
50
|
Space::AccessSettings::AccessState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.AccessSettings.AccessState").enummodule
|
50
51
|
Space::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.Space.Type").enummodule
|
@@ -56,6 +57,8 @@ module Google
|
|
56
57
|
GetSpaceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.GetSpaceRequest").msgclass
|
57
58
|
FindDirectMessageRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.FindDirectMessageRequest").msgclass
|
58
59
|
UpdateSpaceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.UpdateSpaceRequest").msgclass
|
60
|
+
SearchSpacesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.SearchSpacesRequest").msgclass
|
61
|
+
SearchSpacesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.SearchSpacesResponse").msgclass
|
59
62
|
DeleteSpaceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.DeleteSpaceRequest").msgclass
|
60
63
|
CompleteImportSpaceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.CompleteImportSpaceRequest").msgclass
|
61
64
|
CompleteImportSpaceResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.chat.v1.CompleteImportSpaceResponse").msgclass
|
@@ -138,6 +138,9 @@ module Google
|
|
138
138
|
# @!attribute [rw] drive_link_data
|
139
139
|
# @return [::Google::Apps::Chat::V1::DriveLinkData]
|
140
140
|
# Data for a drive link.
|
141
|
+
# @!attribute [rw] chat_space_link_data
|
142
|
+
# @return [::Google::Apps::Chat::V1::ChatSpaceLinkData]
|
143
|
+
# Data for a chat space link.
|
141
144
|
class RichLinkMetadata
|
142
145
|
include ::Google::Protobuf::MessageExts
|
143
146
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -149,6 +152,9 @@ module Google
|
|
149
152
|
|
150
153
|
# A Google Drive rich link type.
|
151
154
|
DRIVE_FILE = 1
|
155
|
+
|
156
|
+
# A Chat space rich link type. For example, a space smart chip.
|
157
|
+
CHAT_SPACE = 2
|
152
158
|
end
|
153
159
|
end
|
154
160
|
|
@@ -166,6 +172,27 @@ module Google
|
|
166
172
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
167
173
|
end
|
168
174
|
|
175
|
+
# Data for Chat space links.
|
176
|
+
# @!attribute [rw] space
|
177
|
+
# @return [::String]
|
178
|
+
# The space of the linked Chat space resource.
|
179
|
+
#
|
180
|
+
# Format: `spaces/{space}`
|
181
|
+
# @!attribute [rw] thread
|
182
|
+
# @return [::String]
|
183
|
+
# The thread of the linked Chat space resource.
|
184
|
+
#
|
185
|
+
# Format: `spaces/{space}/threads/{thread}`
|
186
|
+
# @!attribute [rw] message
|
187
|
+
# @return [::String]
|
188
|
+
# The message of the linked Chat space resource.
|
189
|
+
#
|
190
|
+
# Format: `spaces/{space}/messages/{message}`
|
191
|
+
class ChatSpaceLinkData
|
192
|
+
include ::Google::Protobuf::MessageExts
|
193
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
194
|
+
end
|
195
|
+
|
169
196
|
# Type of the annotation.
|
170
197
|
module AnnotationType
|
171
198
|
# Default value for the enum. Don't use.
|
@@ -126,6 +126,21 @@ module Google
|
|
126
126
|
# `users/user@example.com` or `users/123456789`. When a Chat app creates a
|
127
127
|
# membership relation for itself, it must use the `chat.memberships.app`
|
128
128
|
# scope, set `user.type` to `BOT`, and set `user.name` to `users/app`.
|
129
|
+
# @!attribute [rw] use_admin_access
|
130
|
+
# @return [::Boolean]
|
131
|
+
# When `true`, the method runs using the user's Google Workspace
|
132
|
+
# administrator privileges.
|
133
|
+
#
|
134
|
+
# The calling user must be a Google Workspace administrator with the
|
135
|
+
# [manage chat and spaces conversations
|
136
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
137
|
+
#
|
138
|
+
# Requires the `chat.admin.memberships` [OAuth 2.0
|
139
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
140
|
+
#
|
141
|
+
# Creating app memberships or creating memberships for users outside the
|
142
|
+
# administrator's Google Workspace organization isn't supported using admin
|
143
|
+
# access.
|
129
144
|
class CreateMembershipRequest
|
130
145
|
include ::Google::Protobuf::MessageExts
|
131
146
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -144,6 +159,17 @@ module Google
|
|
144
159
|
# Currently supported field paths:
|
145
160
|
#
|
146
161
|
# - `role`
|
162
|
+
# @!attribute [rw] use_admin_access
|
163
|
+
# @return [::Boolean]
|
164
|
+
# When `true`, the method runs using the user's Google Workspace
|
165
|
+
# administrator privileges.
|
166
|
+
#
|
167
|
+
# The calling user must be a Google Workspace administrator with the
|
168
|
+
# [manage chat and spaces conversations
|
169
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
170
|
+
#
|
171
|
+
# Requires the `chat.admin.memberships` [OAuth 2.0
|
172
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
147
173
|
class UpdateMembershipRequest
|
148
174
|
include ::Google::Protobuf::MessageExts
|
149
175
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -186,8 +212,8 @@ module Google
|
|
186
212
|
#
|
187
213
|
# To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
|
188
214
|
#
|
189
|
-
# To filter by type, set `member.type` to `HUMAN` or `BOT`.
|
190
|
-
#
|
215
|
+
# To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also
|
216
|
+
# filter for `member.type` using the `!=` operator.
|
191
217
|
#
|
192
218
|
# To filter by both role and type, use the `AND` operator. To filter by
|
193
219
|
# either role or type, use the `OR` operator.
|
@@ -233,6 +259,20 @@ module Google
|
|
233
259
|
#
|
234
260
|
# Currently requires [user
|
235
261
|
# authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
262
|
+
# @!attribute [rw] use_admin_access
|
263
|
+
# @return [::Boolean]
|
264
|
+
# When `true`, the method runs using the user's Google Workspace
|
265
|
+
# administrator privileges.
|
266
|
+
#
|
267
|
+
# The calling user must be a Google Workspace administrator with the
|
268
|
+
# [manage chat and spaces conversations
|
269
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
270
|
+
#
|
271
|
+
# Requires either the `chat.admin.memberships.readonly` or
|
272
|
+
# `chat.admin.memberships` [OAuth 2.0
|
273
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
274
|
+
#
|
275
|
+
# Listing app memberships in a space isn't supported when using admin access.
|
236
276
|
class ListMembershipsRequest
|
237
277
|
include ::Google::Protobuf::MessageExts
|
238
278
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -267,6 +307,20 @@ module Google
|
|
267
307
|
# you can use the user's email as an alias for `{member}`. For example,
|
268
308
|
# `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
|
269
309
|
# email of the Google Chat user.
|
310
|
+
# @!attribute [rw] use_admin_access
|
311
|
+
# @return [::Boolean]
|
312
|
+
# When `true`, the method runs using the user's Google Workspace
|
313
|
+
# administrator privileges.
|
314
|
+
#
|
315
|
+
# The calling user must be a Google Workspace administrator with the
|
316
|
+
# [manage chat and spaces conversations
|
317
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
318
|
+
#
|
319
|
+
# Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly`
|
320
|
+
# [OAuth 2.0
|
321
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
322
|
+
#
|
323
|
+
# Getting app memberships in a space isn't supported when using admin access.
|
270
324
|
class GetMembershipRequest
|
271
325
|
include ::Google::Protobuf::MessageExts
|
272
326
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -289,6 +343,19 @@ module Google
|
|
289
343
|
# and `spaces/{space}/members/app` format.
|
290
344
|
#
|
291
345
|
# Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
|
346
|
+
# @!attribute [rw] use_admin_access
|
347
|
+
# @return [::Boolean]
|
348
|
+
# When `true`, the method runs using the user's Google Workspace
|
349
|
+
# administrator privileges.
|
350
|
+
#
|
351
|
+
# The calling user must be a Google Workspace administrator with the
|
352
|
+
# [manage chat and spaces conversations
|
353
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
354
|
+
#
|
355
|
+
# Requires the `chat.admin.memberships` [OAuth 2.0
|
356
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
357
|
+
#
|
358
|
+
# Deleting app memberships in a space isn't supported using admin access.
|
292
359
|
class DeleteMembershipRequest
|
293
360
|
include ::Google::Protobuf::MessageExts
|
294
361
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -102,6 +102,9 @@ module Google
|
|
102
102
|
# creation time.
|
103
103
|
#
|
104
104
|
# Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
|
105
|
+
# @!attribute [r] last_active_time
|
106
|
+
# @return [::Google::Protobuf::Timestamp]
|
107
|
+
# Output only. Timestamp of the last message in the space.
|
105
108
|
# @!attribute [r] admin_installed
|
106
109
|
# @return [::Boolean]
|
107
110
|
# Output only. For direct message (DM) spaces with a Chat app, whether the
|
@@ -110,6 +113,11 @@ module Google
|
|
110
113
|
# their organization.
|
111
114
|
#
|
112
115
|
# To support admin install, your Chat app must feature direct messaging.
|
116
|
+
# @!attribute [r] membership_count
|
117
|
+
# @return [::Google::Apps::Chat::V1::Space::MembershipCount]
|
118
|
+
# Output only. The count of joined memberships grouped by member type.
|
119
|
+
# Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or
|
120
|
+
# `GROUP_CHAT`.
|
113
121
|
# @!attribute [rw] access_settings
|
114
122
|
# @return [::Google::Apps::Chat::V1::Space::AccessSettings]
|
115
123
|
# Optional. Specifies the [access
|
@@ -139,6 +147,19 @@ module Google
|
|
139
147
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
140
148
|
end
|
141
149
|
|
150
|
+
# Represents the count of memberships of a space, grouped into categories.
|
151
|
+
# @!attribute [rw] joined_direct_human_user_count
|
152
|
+
# @return [::Integer]
|
153
|
+
# Count of human users that have directly joined the space, not counting
|
154
|
+
# users joined by having membership in a joined group.
|
155
|
+
# @!attribute [rw] joined_group_count
|
156
|
+
# @return [::Integer]
|
157
|
+
# Count of all groups that have directly joined the space.
|
158
|
+
class MembershipCount
|
159
|
+
include ::Google::Protobuf::MessageExts
|
160
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
161
|
+
end
|
162
|
+
|
142
163
|
# Represents the [access
|
143
164
|
# setting](https://support.google.com/chat/answer/11971020) of the space.
|
144
165
|
# @!attribute [r] access_state
|
@@ -315,6 +336,17 @@ module Google
|
|
315
336
|
# Required. Resource name of the space, in the form `spaces/{space}`.
|
316
337
|
#
|
317
338
|
# Format: `spaces/{space}`
|
339
|
+
# @!attribute [rw] use_admin_access
|
340
|
+
# @return [::Boolean]
|
341
|
+
# When `true`, the method runs using the user's Google Workspace
|
342
|
+
# administrator privileges.
|
343
|
+
#
|
344
|
+
# The calling user must be a Google Workspace administrator with the
|
345
|
+
# [manage chat and spaces conversations
|
346
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
347
|
+
#
|
348
|
+
# Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0
|
349
|
+
# scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
318
350
|
class GetSpaceRequest
|
319
351
|
include ::Google::Protobuf::MessageExts
|
320
352
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -400,17 +432,193 @@ module Google
|
|
400
432
|
# `permission_settings.reply_messages`
|
401
433
|
# (Warning: mutually exclusive with all other non-permission settings field
|
402
434
|
# paths). `permission_settings` is not supported with admin access.
|
435
|
+
# @!attribute [rw] use_admin_access
|
436
|
+
# @return [::Boolean]
|
437
|
+
# When `true`, the method runs using the user's Google Workspace
|
438
|
+
# administrator privileges.
|
439
|
+
#
|
440
|
+
# The calling user must be a Google Workspace administrator with the
|
441
|
+
# [manage chat and spaces conversations
|
442
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
443
|
+
#
|
444
|
+
# Requires the `chat.admin.spaces` [OAuth 2.0
|
445
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
446
|
+
#
|
447
|
+
# Some `FieldMask` values are not supported using admin access. For details,
|
448
|
+
# see the description of `update_mask`.
|
403
449
|
class UpdateSpaceRequest
|
404
450
|
include ::Google::Protobuf::MessageExts
|
405
451
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
406
452
|
end
|
407
453
|
|
454
|
+
# Request to search for a list of spaces based on a query.
|
455
|
+
# @!attribute [rw] use_admin_access
|
456
|
+
# @return [::Boolean]
|
457
|
+
# When `true`, the method runs using the user's Google Workspace
|
458
|
+
# administrator privileges.
|
459
|
+
#
|
460
|
+
# The calling user must be a Google Workspace administrator with the
|
461
|
+
# [manage chat and spaces conversations
|
462
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
463
|
+
#
|
464
|
+
# Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces`
|
465
|
+
# [OAuth 2.0
|
466
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
467
|
+
#
|
468
|
+
# This method currently only supports admin access, thus only `true` is
|
469
|
+
# accepted for this field.
|
470
|
+
# @!attribute [rw] page_size
|
471
|
+
# @return [::Integer]
|
472
|
+
# The maximum number of spaces to return. The service may return fewer than
|
473
|
+
# this value.
|
474
|
+
#
|
475
|
+
# If unspecified, at most 100 spaces are returned.
|
476
|
+
#
|
477
|
+
# The maximum value is 1000. If you use a value more than 1000, it's
|
478
|
+
# automatically changed to 1000.
|
479
|
+
# @!attribute [rw] page_token
|
480
|
+
# @return [::String]
|
481
|
+
# A token, received from the previous search spaces call. Provide this
|
482
|
+
# parameter to retrieve the subsequent page.
|
483
|
+
#
|
484
|
+
# When paginating, all other parameters provided should match the call that
|
485
|
+
# provided the page token. Passing different values to the other parameters
|
486
|
+
# might lead to unexpected results.
|
487
|
+
# @!attribute [rw] query
|
488
|
+
# @return [::String]
|
489
|
+
# Required. A search query.
|
490
|
+
#
|
491
|
+
# You can search by using the following parameters:
|
492
|
+
#
|
493
|
+
# - `create_time`
|
494
|
+
# - `customer`
|
495
|
+
# - `display_name`
|
496
|
+
# - `external_user_allowed`
|
497
|
+
# - `last_active_time`
|
498
|
+
# - `space_history_state`
|
499
|
+
# - `space_type`
|
500
|
+
#
|
501
|
+
# `create_time` and `last_active_time` accept a timestamp in
|
502
|
+
# [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported
|
503
|
+
# comparison operators are: `=`, `<`, `>`, `<=`, `>=`.
|
504
|
+
#
|
505
|
+
# `customer` is required and is used to indicate which customer
|
506
|
+
# to fetch spaces from. `customers/my_customer` is the only supported value.
|
507
|
+
#
|
508
|
+
# `display_name` only accepts the `HAS` (`:`) operator. The text to
|
509
|
+
# match is first tokenized into tokens and each token is prefix-matched
|
510
|
+
# case-insensitively and independently as a substring anywhere in the space's
|
511
|
+
# `display_name`. For example, `Fun Eve` matches `Fun event` or `The
|
512
|
+
# evening was fun`, but not `notFun event` or `even`.
|
513
|
+
#
|
514
|
+
# `external_user_allowed` accepts either `true` or `false`.
|
515
|
+
#
|
516
|
+
# `space_history_state` only accepts values from the [`historyState`]
|
517
|
+
# (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)
|
518
|
+
# field of a `space` resource.
|
519
|
+
#
|
520
|
+
# `space_type` is required and the only valid value is `SPACE`.
|
521
|
+
#
|
522
|
+
# Across different fields, only `AND` operators are supported. A valid
|
523
|
+
# example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid
|
524
|
+
# example is `space_type = "SPACE" OR display_name:"Hello"`.
|
525
|
+
#
|
526
|
+
# Among the same field,
|
527
|
+
# `space_type` doesn't support `AND` or `OR` operators.
|
528
|
+
# `display_name`, 'space_history_state', and 'external_user_allowed' only
|
529
|
+
# support `OR` operators.
|
530
|
+
# `last_active_time` and `create_time` support both `AND` and `OR` operators.
|
531
|
+
# `AND` can only be used to represent an interval, such as `last_active_time
|
532
|
+
# < "2022-01-01T00:00:00+00:00" AND last_active_time >
|
533
|
+
# "2023-01-01T00:00:00+00:00"`.
|
534
|
+
#
|
535
|
+
# The following example queries are valid:
|
536
|
+
#
|
537
|
+
# ```
|
538
|
+
# customer = "customers/my_customer" AND space_type = "SPACE"
|
539
|
+
#
|
540
|
+
# customer = "customers/my_customer" AND space_type = "SPACE" AND
|
541
|
+
# display_name:"Hello World"
|
542
|
+
#
|
543
|
+
# customer = "customers/my_customer" AND space_type = "SPACE" AND
|
544
|
+
# (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
|
545
|
+
# "2022-01-01T00:00:00+00:00")
|
546
|
+
#
|
547
|
+
# customer = "customers/my_customer" AND space_type = "SPACE" AND
|
548
|
+
# (display_name:"Hello World" OR display_name:"Fun event") AND
|
549
|
+
# (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
|
550
|
+
# "2022-01-01T00:00:00+00:00")
|
551
|
+
#
|
552
|
+
# customer = "customers/my_customer" AND space_type = "SPACE" AND
|
553
|
+
# (create_time > "2019-01-01T00:00:00+00:00" AND create_time <
|
554
|
+
# "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
|
555
|
+
# (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
|
556
|
+
# ```
|
557
|
+
# @!attribute [rw] order_by
|
558
|
+
# @return [::String]
|
559
|
+
# Optional. How the list of spaces is ordered.
|
560
|
+
#
|
561
|
+
# Supported attributes to order by are:
|
562
|
+
#
|
563
|
+
# - `membership_count.joined_direct_human_user_count` — Denotes the count of
|
564
|
+
# human users that have directly joined a space.
|
565
|
+
# - `last_active_time` — Denotes the time when last eligible item is added to
|
566
|
+
# any topic of this space.
|
567
|
+
# - `create_time` — Denotes the time of the space creation.
|
568
|
+
#
|
569
|
+
# Valid ordering operation values are:
|
570
|
+
#
|
571
|
+
# - `ASC` for ascending. Default value.
|
572
|
+
#
|
573
|
+
# - `DESC` for descending.
|
574
|
+
#
|
575
|
+
# The supported syntax are:
|
576
|
+
#
|
577
|
+
# - `membership_count.joined_direct_human_user_count DESC`
|
578
|
+
# - `membership_count.joined_direct_human_user_count ASC`
|
579
|
+
# - `last_active_time DESC`
|
580
|
+
# - `last_active_time ASC`
|
581
|
+
# - `create_time DESC`
|
582
|
+
# - `create_time ASC`
|
583
|
+
class SearchSpacesRequest
|
584
|
+
include ::Google::Protobuf::MessageExts
|
585
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
586
|
+
end
|
587
|
+
|
588
|
+
# Response with a list of spaces corresponding to the search spaces request.
|
589
|
+
# @!attribute [rw] spaces
|
590
|
+
# @return [::Array<::Google::Apps::Chat::V1::Space>]
|
591
|
+
# A page of the requested spaces.
|
592
|
+
# @!attribute [rw] next_page_token
|
593
|
+
# @return [::String]
|
594
|
+
# A token that can be used to retrieve the next page. If this field is empty,
|
595
|
+
# there are no subsequent pages.
|
596
|
+
# @!attribute [rw] total_size
|
597
|
+
# @return [::Integer]
|
598
|
+
# The total number of spaces that match the query, across all pages. If the
|
599
|
+
# result is over 10,000 spaces, this value is an estimate.
|
600
|
+
class SearchSpacesResponse
|
601
|
+
include ::Google::Protobuf::MessageExts
|
602
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
603
|
+
end
|
604
|
+
|
408
605
|
# Request for deleting a space.
|
409
606
|
# @!attribute [rw] name
|
410
607
|
# @return [::String]
|
411
608
|
# Required. Resource name of the space to delete.
|
412
609
|
#
|
413
610
|
# Format: `spaces/{space}`
|
611
|
+
# @!attribute [rw] use_admin_access
|
612
|
+
# @return [::Boolean]
|
613
|
+
# When `true`, the method runs using the user's Google Workspace
|
614
|
+
# administrator privileges.
|
615
|
+
#
|
616
|
+
# The calling user must be a Google Workspace administrator with the
|
617
|
+
# [manage chat and spaces conversations
|
618
|
+
# privilege](https://support.google.com/a/answer/13369245).
|
619
|
+
#
|
620
|
+
# Requires the `chat.admin.delete` [OAuth 2.0
|
621
|
+
# scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
414
622
|
class DeleteSpaceRequest
|
415
623
|
include ::Google::Protobuf::MessageExts
|
416
624
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apps-chat-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-09-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|