google-apis-chat_v1 0.101.0 → 0.102.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/chat_v1/classes.rb +74 -0
- data/lib/google/apis/chat_v1/gem_version.rb +2 -2
- data/lib/google/apis/chat_v1/representations.rb +33 -0
- data/lib/google/apis/chat_v1/service.rb +204 -37
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a817263093776a4c5fe86c5708b9b92a9b7e131b6a4fa0510e184281825a8f85
|
4
|
+
data.tar.gz: c5f3b43a774dda3fe630ec7dc3b22ad499cb7490bd3def2eafab4ceb4316105c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 845b434cace27ff5236909880e439773ede2042dff6f969750f7935ec1ac369cc2b1e44a49ba91d0de42cdb9f259b7f6167e808f464a2bf32898a505c673c4bf
|
7
|
+
data.tar.gz: 91f1c39d39601bacc5d2f5be819d852fe8c6120298bab5dfa4d9e525ee9c9279a4a300ff87a9a014816ab52124ecfa820e25c66c769671492c629d8fb48a126e
|
data/CHANGELOG.md
CHANGED
@@ -3732,6 +3732,33 @@ module Google
|
|
3732
3732
|
end
|
3733
3733
|
end
|
3734
3734
|
|
3735
|
+
# [Developer Preview](https://developers.google.com/workspace/preview).
|
3736
|
+
# Represents the count of memberships of a space, grouped into categories.
|
3737
|
+
class MembershipCount
|
3738
|
+
include Google::Apis::Core::Hashable
|
3739
|
+
|
3740
|
+
# Count of human users that have directly joined the space, not counting users
|
3741
|
+
# joined by having membership in a joined group.
|
3742
|
+
# Corresponds to the JSON property `joinedDirectHumanUserCount`
|
3743
|
+
# @return [Fixnum]
|
3744
|
+
attr_accessor :joined_direct_human_user_count
|
3745
|
+
|
3746
|
+
# Count of all groups that have directly joined the space.
|
3747
|
+
# Corresponds to the JSON property `joinedGroupCount`
|
3748
|
+
# @return [Fixnum]
|
3749
|
+
attr_accessor :joined_group_count
|
3750
|
+
|
3751
|
+
def initialize(**args)
|
3752
|
+
update!(**args)
|
3753
|
+
end
|
3754
|
+
|
3755
|
+
# Update properties of this object
|
3756
|
+
def update!(**args)
|
3757
|
+
@joined_direct_human_user_count = args[:joined_direct_human_user_count] if args.key?(:joined_direct_human_user_count)
|
3758
|
+
@joined_group_count = args[:joined_group_count] if args.key?(:joined_group_count)
|
3759
|
+
end
|
3760
|
+
end
|
3761
|
+
|
3735
3762
|
# Event payload for a new membership. Event type: `google.workspace.chat.
|
3736
3763
|
# membership.v1.created`.
|
3737
3764
|
class MembershipCreatedEventData
|
@@ -4376,6 +4403,39 @@ module Google
|
|
4376
4403
|
end
|
4377
4404
|
end
|
4378
4405
|
|
4406
|
+
# Response with a list of spaces corresponding to the search spaces request.
|
4407
|
+
class SearchSpacesResponse
|
4408
|
+
include Google::Apis::Core::Hashable
|
4409
|
+
|
4410
|
+
# A token that can be used to retrieve the next page. If this field is empty,
|
4411
|
+
# there are no subsequent pages.
|
4412
|
+
# Corresponds to the JSON property `nextPageToken`
|
4413
|
+
# @return [String]
|
4414
|
+
attr_accessor :next_page_token
|
4415
|
+
|
4416
|
+
# A page of the requested spaces.
|
4417
|
+
# Corresponds to the JSON property `spaces`
|
4418
|
+
# @return [Array<Google::Apis::ChatV1::Space>]
|
4419
|
+
attr_accessor :spaces
|
4420
|
+
|
4421
|
+
# The total number of spaces that match the query, across all pages. If the
|
4422
|
+
# result is over 10,000 spaces, this value is an estimate.
|
4423
|
+
# Corresponds to the JSON property `totalSize`
|
4424
|
+
# @return [Fixnum]
|
4425
|
+
attr_accessor :total_size
|
4426
|
+
|
4427
|
+
def initialize(**args)
|
4428
|
+
update!(**args)
|
4429
|
+
end
|
4430
|
+
|
4431
|
+
# Update properties of this object
|
4432
|
+
def update!(**args)
|
4433
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
4434
|
+
@spaces = args[:spaces] if args.key?(:spaces)
|
4435
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
4436
|
+
end
|
4437
|
+
end
|
4438
|
+
|
4379
4439
|
# A section contains a collection of widgets that are rendered (vertically) in
|
4380
4440
|
# the order that they are specified. Across all platforms, cards have a narrow
|
4381
4441
|
# fixed width, so there's currently no need for layout properties (for example,
|
@@ -4606,6 +4666,18 @@ module Google
|
|
4606
4666
|
attr_accessor :import_mode
|
4607
4667
|
alias_method :import_mode?, :import_mode
|
4608
4668
|
|
4669
|
+
# Output only. Timestamp of the last message in the space. [Developer Preview](
|
4670
|
+
# https://developers.google.com/workspace/preview).
|
4671
|
+
# Corresponds to the JSON property `lastActiveTime`
|
4672
|
+
# @return [String]
|
4673
|
+
attr_accessor :last_active_time
|
4674
|
+
|
4675
|
+
# [Developer Preview](https://developers.google.com/workspace/preview).
|
4676
|
+
# Represents the count of memberships of a space, grouped into categories.
|
4677
|
+
# Corresponds to the JSON property `membershipCount`
|
4678
|
+
# @return [Google::Apis::ChatV1::MembershipCount]
|
4679
|
+
attr_accessor :membership_count
|
4680
|
+
|
4609
4681
|
# Resource name of the space. Format: `spaces/`space``
|
4610
4682
|
# Corresponds to the JSON property `name`
|
4611
4683
|
# @return [String]
|
@@ -4667,6 +4739,8 @@ module Google
|
|
4667
4739
|
@display_name = args[:display_name] if args.key?(:display_name)
|
4668
4740
|
@external_user_allowed = args[:external_user_allowed] if args.key?(:external_user_allowed)
|
4669
4741
|
@import_mode = args[:import_mode] if args.key?(:import_mode)
|
4742
|
+
@last_active_time = args[:last_active_time] if args.key?(:last_active_time)
|
4743
|
+
@membership_count = args[:membership_count] if args.key?(:membership_count)
|
4670
4744
|
@name = args[:name] if args.key?(:name)
|
4671
4745
|
@single_user_bot_dm = args[:single_user_bot_dm] if args.key?(:single_user_bot_dm)
|
4672
4746
|
@space_details = args[:space_details] if args.key?(:space_details)
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module ChatV1
|
18
18
|
# Version of the google-apis-chat_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.102.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.15.1"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20240818"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -526,6 +526,12 @@ module Google
|
|
526
526
|
include Google::Apis::Core::JsonObjectSupport
|
527
527
|
end
|
528
528
|
|
529
|
+
class MembershipCount
|
530
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
531
|
+
|
532
|
+
include Google::Apis::Core::JsonObjectSupport
|
533
|
+
end
|
534
|
+
|
529
535
|
class MembershipCreatedEventData
|
530
536
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
531
537
|
|
@@ -640,6 +646,12 @@ module Google
|
|
640
646
|
include Google::Apis::Core::JsonObjectSupport
|
641
647
|
end
|
642
648
|
|
649
|
+
class SearchSpacesResponse
|
650
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
651
|
+
|
652
|
+
include Google::Apis::Core::JsonObjectSupport
|
653
|
+
end
|
654
|
+
|
643
655
|
class Section
|
644
656
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
645
657
|
|
@@ -1690,6 +1702,14 @@ module Google
|
|
1690
1702
|
end
|
1691
1703
|
end
|
1692
1704
|
|
1705
|
+
class MembershipCount
|
1706
|
+
# @private
|
1707
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1708
|
+
property :joined_direct_human_user_count, as: 'joinedDirectHumanUserCount'
|
1709
|
+
property :joined_group_count, as: 'joinedGroupCount'
|
1710
|
+
end
|
1711
|
+
end
|
1712
|
+
|
1693
1713
|
class MembershipCreatedEventData
|
1694
1714
|
# @private
|
1695
1715
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1888,6 +1908,16 @@ module Google
|
|
1888
1908
|
end
|
1889
1909
|
end
|
1890
1910
|
|
1911
|
+
class SearchSpacesResponse
|
1912
|
+
# @private
|
1913
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1914
|
+
property :next_page_token, as: 'nextPageToken'
|
1915
|
+
collection :spaces, as: 'spaces', class: Google::Apis::ChatV1::Space, decorator: Google::Apis::ChatV1::Space::Representation
|
1916
|
+
|
1917
|
+
property :total_size, as: 'totalSize'
|
1918
|
+
end
|
1919
|
+
end
|
1920
|
+
|
1891
1921
|
class Section
|
1892
1922
|
# @private
|
1893
1923
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1945,6 +1975,9 @@ module Google
|
|
1945
1975
|
property :display_name, as: 'displayName'
|
1946
1976
|
property :external_user_allowed, as: 'externalUserAllowed'
|
1947
1977
|
property :import_mode, as: 'importMode'
|
1978
|
+
property :last_active_time, as: 'lastActiveTime'
|
1979
|
+
property :membership_count, as: 'membershipCount', class: Google::Apis::ChatV1::MembershipCount, decorator: Google::Apis::ChatV1::MembershipCount::Representation
|
1980
|
+
|
1948
1981
|
property :name, as: 'name'
|
1949
1982
|
property :single_user_bot_dm, as: 'singleUserBotDm'
|
1950
1983
|
property :space_details, as: 'spaceDetails', class: Google::Apis::ChatV1::SpaceDetails, decorator: Google::Apis::ChatV1::SpaceDetails::Representation
|
@@ -227,6 +227,13 @@ module Google
|
|
227
227
|
# authorize-chat-user) from a user who has permission to delete the space.
|
228
228
|
# @param [String] name
|
229
229
|
# Required. Resource name of the space to delete. Format: `spaces/`space``
|
230
|
+
# @param [Boolean] use_admin_access
|
231
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
232
|
+
# true`, the method runs using the user's Google Workspace administrator
|
233
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
234
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
235
|
+
# answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://
|
236
|
+
# developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
230
237
|
# @param [String] fields
|
231
238
|
# Selector specifying which fields to include in a partial response.
|
232
239
|
# @param [String] quota_user
|
@@ -244,11 +251,12 @@ module Google
|
|
244
251
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
245
252
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
246
253
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
247
|
-
def delete_space(name, fields: nil, quota_user: nil, options: nil, &block)
|
254
|
+
def delete_space(name, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
248
255
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
249
256
|
command.response_representation = Google::Apis::ChatV1::Empty::Representation
|
250
257
|
command.response_class = Google::Apis::ChatV1::Empty
|
251
258
|
command.params['name'] = name unless name.nil?
|
259
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
252
260
|
command.query['fields'] = fields unless fields.nil?
|
253
261
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
254
262
|
execute_or_queue_command(command, &block)
|
@@ -312,6 +320,14 @@ module Google
|
|
312
320
|
# @param [String] name
|
313
321
|
# Required. Resource name of the space, in the form `spaces/`space``. Format: `
|
314
322
|
# spaces/`space``
|
323
|
+
# @param [Boolean] use_admin_access
|
324
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
325
|
+
# true`, the method runs using the user's Google Workspace administrator
|
326
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
327
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
328
|
+
# answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.
|
329
|
+
# readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/
|
330
|
+
# authenticate-authorize#chat-api-scopes).
|
315
331
|
# @param [String] fields
|
316
332
|
# Selector specifying which fields to include in a partial response.
|
317
333
|
# @param [String] quota_user
|
@@ -329,11 +345,12 @@ module Google
|
|
329
345
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
330
346
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
331
347
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
332
|
-
def get_space(name, fields: nil, quota_user: nil, options: nil, &block)
|
348
|
+
def get_space(name, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
333
349
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
334
350
|
command.response_representation = Google::Apis::ChatV1::Space::Representation
|
335
351
|
command.response_class = Google::Apis::ChatV1::Space
|
336
352
|
command.params['name'] = name unless name.nil?
|
353
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
337
354
|
command.query['fields'] = fields unless fields.nil?
|
338
355
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
339
356
|
execute_or_queue_command(command, &block)
|
@@ -446,6 +463,15 @@ module Google
|
|
446
463
|
# permission_settings.reply_messages` (Warning: mutually exclusive with all
|
447
464
|
# other non-permission settings field paths). `permission_settings` is not
|
448
465
|
# supported with admin access.
|
466
|
+
# @param [Boolean] use_admin_access
|
467
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
468
|
+
# true`, the method runs using the user's Google Workspace administrator
|
469
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
470
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
471
|
+
# answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://
|
472
|
+
# developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
|
473
|
+
# Some `FieldMask` values are not supported using admin access. For details, see
|
474
|
+
# the description of `update_mask`.
|
449
475
|
# @param [String] fields
|
450
476
|
# Selector specifying which fields to include in a partial response.
|
451
477
|
# @param [String] quota_user
|
@@ -463,7 +489,7 @@ module Google
|
|
463
489
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
464
490
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
465
491
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
466
|
-
def patch_space(name, space_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
492
|
+
def patch_space(name, space_object = nil, update_mask: nil, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
467
493
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
468
494
|
command.request_representation = Google::Apis::ChatV1::Space::Representation
|
469
495
|
command.request_object = space_object
|
@@ -471,6 +497,108 @@ module Google
|
|
471
497
|
command.response_class = Google::Apis::ChatV1::Space
|
472
498
|
command.params['name'] = name unless name.nil?
|
473
499
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
500
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
501
|
+
command.query['fields'] = fields unless fields.nil?
|
502
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
503
|
+
execute_or_queue_command(command, &block)
|
504
|
+
end
|
505
|
+
|
506
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). Returns
|
507
|
+
# a list of spaces based on a user's search. Requires [user authentication](
|
508
|
+
# https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
509
|
+
# The user must be an administrator for the Google Workspace organization. In
|
510
|
+
# the request, set `use_admin_access` to `true`.
|
511
|
+
# @param [String] order_by
|
512
|
+
# Optional. How the list of spaces is ordered. Supported attributes to order by
|
513
|
+
# are: - `membership_count.joined_direct_human_user_count` — Denotes the count
|
514
|
+
# of human users that have directly joined a space. - `last_active_time` —
|
515
|
+
# Denotes the time when last eligible item is added to any topic of this space. -
|
516
|
+
# `create_time` — Denotes the time of the space creation. Valid ordering
|
517
|
+
# operation values are: - `ASC` for ascending. Default value. - `DESC` for
|
518
|
+
# descending. The supported syntax are: - `membership_count.
|
519
|
+
# joined_direct_human_user_count DESC` - `membership_count.
|
520
|
+
# joined_direct_human_user_count ASC` - `last_active_time DESC` - `
|
521
|
+
# last_active_time ASC` - `create_time DESC` - `create_time ASC`
|
522
|
+
# @param [Fixnum] page_size
|
523
|
+
# The maximum number of spaces to return. The service may return fewer than this
|
524
|
+
# value. If unspecified, at most 100 spaces are returned. The maximum value is
|
525
|
+
# 1000. If you use a value more than 1000, it's automatically changed to 1000.
|
526
|
+
# @param [String] page_token
|
527
|
+
# A token, received from the previous search spaces call. Provide this parameter
|
528
|
+
# to retrieve the subsequent page. When paginating, all other parameters
|
529
|
+
# provided should match the call that provided the page token. Passing different
|
530
|
+
# values to the other parameters might lead to unexpected results.
|
531
|
+
# @param [String] query
|
532
|
+
# Required. A search query. You can search by using the following parameters: - `
|
533
|
+
# create_time` - `customer` - `display_name` - `external_user_allowed` - `
|
534
|
+
# last_active_time` - `space_history_state` - `space_type` `create_time` and `
|
535
|
+
# last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/
|
536
|
+
# rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`,
|
537
|
+
# `<=`, `>=`. `customer` is required and is used to indicate which customer to
|
538
|
+
# fetch spaces from. `customers/my_customer` is the only supported value. `
|
539
|
+
# display_name` only accepts the `HAS` (`:`) operator. The text to match is
|
540
|
+
# first tokenized into tokens and each token is prefix-matched case-
|
541
|
+
# insensitively and independently as a substring anywhere in the space's `
|
542
|
+
# display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was
|
543
|
+
# fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either
|
544
|
+
# `true` or `false`. `space_history_state` only accepts values from the [`
|
545
|
+
# historyState`] (https://developers.google.com/workspace/chat/api/reference/
|
546
|
+
# rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type`
|
547
|
+
# is required and the only valid value is `SPACE`. Across different fields, only
|
548
|
+
# `AND` operators are supported. A valid example is `space_type = "SPACE" AND
|
549
|
+
# display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR
|
550
|
+
# display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND`
|
551
|
+
# or `OR` operators. `display_name`, 'space_history_state', and '
|
552
|
+
# external_user_allowed' only support `OR` operators. `last_active_time` and `
|
553
|
+
# create_time` support both `AND` and `OR` operators. `AND` can only be used to
|
554
|
+
# represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00"
|
555
|
+
# AND last_active_time > "2023-01-01T00:00:00+00:00"`. The following example
|
556
|
+
# queries are valid: ``` customer = "customers/my_customer" AND space_type = "
|
557
|
+
# SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND
|
558
|
+
# display_name:"Hello World" customer = "customers/my_customer" AND space_type =
|
559
|
+
# "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR
|
560
|
+
# last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/
|
561
|
+
# my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR
|
562
|
+
# display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00"
|
563
|
+
# AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/
|
564
|
+
# my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+
|
565
|
+
# 00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (
|
566
|
+
# external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR
|
567
|
+
# space_history_state = "HISTORY_OFF") ```
|
568
|
+
# @param [Boolean] use_admin_access
|
569
|
+
# When `true`, the method runs using the user's Google Workspace administrator
|
570
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
571
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
572
|
+
# answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.
|
573
|
+
# admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/
|
574
|
+
# authenticate-authorize#chat-api-scopes). This method currently only supports
|
575
|
+
# admin access, thus only `true` is accepted for this field.
|
576
|
+
# @param [String] fields
|
577
|
+
# Selector specifying which fields to include in a partial response.
|
578
|
+
# @param [String] quota_user
|
579
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
580
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
581
|
+
# @param [Google::Apis::RequestOptions] options
|
582
|
+
# Request-specific options
|
583
|
+
#
|
584
|
+
# @yield [result, err] Result & error if block supplied
|
585
|
+
# @yieldparam result [Google::Apis::ChatV1::SearchSpacesResponse] parsed result object
|
586
|
+
# @yieldparam err [StandardError] error object if request failed
|
587
|
+
#
|
588
|
+
# @return [Google::Apis::ChatV1::SearchSpacesResponse]
|
589
|
+
#
|
590
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
591
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
592
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
593
|
+
def search_spaces(order_by: nil, page_size: nil, page_token: nil, query: nil, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
594
|
+
command = make_simple_command(:get, 'v1/spaces:search', options)
|
595
|
+
command.response_representation = Google::Apis::ChatV1::SearchSpacesResponse::Representation
|
596
|
+
command.response_class = Google::Apis::ChatV1::SearchSpacesResponse
|
597
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
598
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
599
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
600
|
+
command.query['query'] = query unless query.nil?
|
601
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
474
602
|
command.query['fields'] = fields unless fields.nil?
|
475
603
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
476
604
|
execute_or_queue_command(command, &block)
|
@@ -542,36 +670,32 @@ module Google
|
|
542
670
|
execute_or_queue_command(command, &block)
|
543
671
|
end
|
544
672
|
|
545
|
-
# Creates a
|
546
|
-
# memberships for other apps isn't supported.
|
547
|
-
#
|
548
|
-
#
|
549
|
-
#
|
550
|
-
#
|
551
|
-
#
|
552
|
-
# (https://developers.google.com/workspace/chat/
|
553
|
-
# .
|
554
|
-
#
|
555
|
-
# -
|
556
|
-
#
|
557
|
-
# human user, use `users/`user``, where ``user`` can be the email address for
|
558
|
-
# the user. For users in the same Workspace organization ``user`` can also be
|
559
|
-
# the `id` for the person from the People API, or the `id` for the user in the
|
560
|
-
# Directory API. For example, if the People API Person profile ID for `user@
|
561
|
-
# example.com` is `123456789`, you can add the user to the space by setting the `
|
562
|
-
# membership.member.name` to `users/user@example.com` or `users/123456789`. - To
|
563
|
-
# add or invite a Google group in a named space, use `groups/`group``, where ``
|
564
|
-
# group`` is the `id` for the group from the Cloud Identity Groups API. For
|
565
|
-
# example, you can use [Cloud Identity Groups lookup API](https://cloud.google.
|
566
|
-
# com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `
|
567
|
-
# 123456789` for group email `group@example.com`, then you can add or invite the
|
568
|
-
# group to a named space by setting the `membership.group_member.name` to `
|
569
|
-
# groups/123456789`. Group email is not supported, and Google groups can only be
|
570
|
-
# added as members in named spaces.
|
673
|
+
# Creates a membership for the calling Chat app, a user, or a Google Group.
|
674
|
+
# Creating memberships for other Chat apps isn't supported. When creating a
|
675
|
+
# membership, if the specified member has their auto-accept policy turned off,
|
676
|
+
# then they're invited, and must accept the space invitation before joining.
|
677
|
+
# Otherwise, creating a membership adds the member directly to the specified
|
678
|
+
# space. Requires [user authentication](https://developers.google.com/workspace/
|
679
|
+
# chat/authenticate-authorize-chat-user). For example usage, see: - [Invite or
|
680
|
+
# add a user to a space](https://developers.google.com/workspace/chat/create-
|
681
|
+
# members#create-user-membership). - [Invite or add a Google Group to a space](
|
682
|
+
# https://developers.google.com/workspace/chat/create-members#create-group-
|
683
|
+
# membership). - [Add the Chat app to a space](https://developers.google.com/
|
684
|
+
# workspace/chat/create-members#create-membership-calling-api).
|
571
685
|
# @param [String] parent
|
572
686
|
# Required. The resource name of the space for which to create the membership.
|
573
687
|
# Format: spaces/`space`
|
574
688
|
# @param [Google::Apis::ChatV1::Membership] membership_object
|
689
|
+
# @param [Boolean] use_admin_access
|
690
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
691
|
+
# true`, the method runs using the user's Google Workspace administrator
|
692
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
693
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
694
|
+
# answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](
|
695
|
+
# https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-
|
696
|
+
# scopes). Creating app memberships or creating memberships for users outside
|
697
|
+
# the administrator's Google Workspace organization isn't supported using admin
|
698
|
+
# access.
|
575
699
|
# @param [String] fields
|
576
700
|
# Selector specifying which fields to include in a partial response.
|
577
701
|
# @param [String] quota_user
|
@@ -589,13 +713,14 @@ module Google
|
|
589
713
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
590
714
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
591
715
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
592
|
-
def create_space_member(parent, membership_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
716
|
+
def create_space_member(parent, membership_object = nil, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
593
717
|
command = make_simple_command(:post, 'v1/{+parent}/members', options)
|
594
718
|
command.request_representation = Google::Apis::ChatV1::Membership::Representation
|
595
719
|
command.request_object = membership_object
|
596
720
|
command.response_representation = Google::Apis::ChatV1::Membership::Representation
|
597
721
|
command.response_class = Google::Apis::ChatV1::Membership
|
598
722
|
command.params['parent'] = parent unless parent.nil?
|
723
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
599
724
|
command.query['fields'] = fields unless fields.nil?
|
600
725
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
601
726
|
execute_or_queue_command(command, &block)
|
@@ -615,6 +740,15 @@ module Google
|
|
615
740
|
# deleting an app membership, requires the `chat.memberships.app` scope and `
|
616
741
|
# spaces/`space`/members/app` format. Format: `spaces/`space`/members/`member``
|
617
742
|
# or `spaces/`space`/members/app`.
|
743
|
+
# @param [Boolean] use_admin_access
|
744
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
745
|
+
# true`, the method runs using the user's Google Workspace administrator
|
746
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
747
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
748
|
+
# answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](
|
749
|
+
# https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-
|
750
|
+
# scopes). Deleting app memberships in a space isn't supported using admin
|
751
|
+
# access.
|
618
752
|
# @param [String] fields
|
619
753
|
# Selector specifying which fields to include in a partial response.
|
620
754
|
# @param [String] quota_user
|
@@ -632,11 +766,12 @@ module Google
|
|
632
766
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
633
767
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
634
768
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
635
|
-
def delete_space_member(name, fields: nil, quota_user: nil, options: nil, &block)
|
769
|
+
def delete_space_member(name, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
636
770
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
637
771
|
command.response_representation = Google::Apis::ChatV1::Membership::Representation
|
638
772
|
command.response_class = Google::Apis::ChatV1::Membership
|
639
773
|
command.params['name'] = name unless name.nil?
|
774
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
640
775
|
command.query['fields'] = fields unless fields.nil?
|
641
776
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
642
777
|
execute_or_queue_command(command, &block)
|
@@ -659,6 +794,15 @@ module Google
|
|
659
794
|
# user's email as an alias for ``member``. For example, `spaces/`space`/members/
|
660
795
|
# example@gmail.com` where `example@gmail.com` is the email of the Google Chat
|
661
796
|
# user.
|
797
|
+
# @param [Boolean] use_admin_access
|
798
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
799
|
+
# true`, the method runs using the user's Google Workspace administrator
|
800
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
801
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
802
|
+
# answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.
|
803
|
+
# memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/
|
804
|
+
# workspace/chat/authenticate-authorize#chat-api-scopes). Getting app
|
805
|
+
# memberships in a space isn't supported when using admin access.
|
662
806
|
# @param [String] fields
|
663
807
|
# Selector specifying which fields to include in a partial response.
|
664
808
|
# @param [String] quota_user
|
@@ -676,11 +820,12 @@ module Google
|
|
676
820
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
677
821
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
678
822
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
679
|
-
def get_space_member(name, fields: nil, quota_user: nil, options: nil, &block)
|
823
|
+
def get_space_member(name, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
680
824
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
681
825
|
command.response_representation = Google::Apis::ChatV1::Membership::Representation
|
682
826
|
command.response_class = Google::Apis::ChatV1::Membership
|
683
827
|
command.params['name'] = name unless name.nil?
|
828
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
684
829
|
command.query['fields'] = fields unless fields.nil?
|
685
830
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
686
831
|
execute_or_queue_command(command, &block)
|
@@ -739,6 +884,15 @@ module Google
|
|
739
884
|
# invited memberships that don't match the filter criteria aren't returned.
|
740
885
|
# Currently requires [user authentication](https://developers.google.com/
|
741
886
|
# workspace/chat/authenticate-authorize-chat-user).
|
887
|
+
# @param [Boolean] use_admin_access
|
888
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
889
|
+
# true`, the method runs using the user's Google Workspace administrator
|
890
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
891
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
892
|
+
# answer/13369245). Requires either the `chat.admin.memberships.readonly` or `
|
893
|
+
# chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/
|
894
|
+
# workspace/chat/authenticate-authorize#chat-api-scopes). Listing app
|
895
|
+
# memberships in a space isn't supported when using admin access.
|
742
896
|
# @param [String] fields
|
743
897
|
# Selector specifying which fields to include in a partial response.
|
744
898
|
# @param [String] quota_user
|
@@ -756,7 +910,7 @@ module Google
|
|
756
910
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
757
911
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
758
912
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
759
|
-
def list_space_members(parent, filter: nil, page_size: nil, page_token: nil, show_groups: nil, show_invited: nil, fields: nil, quota_user: nil, options: nil, &block)
|
913
|
+
def list_space_members(parent, filter: nil, page_size: nil, page_token: nil, show_groups: nil, show_invited: nil, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
760
914
|
command = make_simple_command(:get, 'v1/{+parent}/members', options)
|
761
915
|
command.response_representation = Google::Apis::ChatV1::ListMembershipsResponse::Representation
|
762
916
|
command.response_class = Google::Apis::ChatV1::ListMembershipsResponse
|
@@ -766,6 +920,7 @@ module Google
|
|
766
920
|
command.query['pageToken'] = page_token unless page_token.nil?
|
767
921
|
command.query['showGroups'] = show_groups unless show_groups.nil?
|
768
922
|
command.query['showInvited'] = show_invited unless show_invited.nil?
|
923
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
769
924
|
command.query['fields'] = fields unless fields.nil?
|
770
925
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
771
926
|
execute_or_queue_command(command, &block)
|
@@ -782,6 +937,14 @@ module Google
|
|
782
937
|
# @param [String] update_mask
|
783
938
|
# Required. The field paths to update. Separate multiple values with commas or
|
784
939
|
# use `*` to update all field paths. Currently supported field paths: - `role`
|
940
|
+
# @param [Boolean] use_admin_access
|
941
|
+
# [Developer Preview](https://developers.google.com/workspace/preview). When `
|
942
|
+
# true`, the method runs using the user's Google Workspace administrator
|
943
|
+
# privileges. The calling user must be a Google Workspace administrator with the
|
944
|
+
# [manage chat and spaces conversations privilege](https://support.google.com/a/
|
945
|
+
# answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](
|
946
|
+
# https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-
|
947
|
+
# scopes).
|
785
948
|
# @param [String] fields
|
786
949
|
# Selector specifying which fields to include in a partial response.
|
787
950
|
# @param [String] quota_user
|
@@ -799,7 +962,7 @@ module Google
|
|
799
962
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
800
963
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
801
964
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
802
|
-
def patch_space_member(name, membership_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
965
|
+
def patch_space_member(name, membership_object = nil, update_mask: nil, use_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
|
803
966
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
804
967
|
command.request_representation = Google::Apis::ChatV1::Membership::Representation
|
805
968
|
command.request_object = membership_object
|
@@ -807,6 +970,7 @@ module Google
|
|
807
970
|
command.response_class = Google::Apis::ChatV1::Membership
|
808
971
|
command.params['name'] = name unless name.nil?
|
809
972
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
973
|
+
command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
|
810
974
|
command.query['fields'] = fields unless fields.nil?
|
811
975
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
812
976
|
execute_or_queue_command(command, &block)
|
@@ -969,9 +1133,12 @@ module Google
|
|
969
1133
|
end
|
970
1134
|
|
971
1135
|
# Lists messages in a space that the caller is a member of, including messages
|
972
|
-
# from blocked members and spaces.
|
973
|
-
#
|
974
|
-
#
|
1136
|
+
# from blocked members and spaces. If you list messages from a space with no
|
1137
|
+
# messages, the response is an empty object. When using a REST/HTTP interface,
|
1138
|
+
# the response contains an empty JSON object, ````. For an example, see [List
|
1139
|
+
# messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/
|
1140
|
+
# list). Requires [user authentication](https://developers.google.com/workspace/
|
1141
|
+
# chat/authenticate-authorize-chat-user).
|
975
1142
|
# @param [String] parent
|
976
1143
|
# Required. The resource name of the space to list messages from. Format: `
|
977
1144
|
# spaces/`space``
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-chat_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.102.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-08-
|
11
|
+
date: 2024-08-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-chat_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-chat_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-chat_v1/v0.102.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-chat_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|