google-apis-chat_v1 0.153.0 → 0.154.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 88360559d1e18497b9058420db18bb318518fdf9352fa103b9076f2f1168ab6f
4
- data.tar.gz: 6c260dfac4349ba184062ed8a30994a82005e5a37ae49a0bacf06779877b48da
3
+ metadata.gz: 7be0f75b05ba62db7bedc92d4a4983ad883658f1fa82d63b5428bb198d144d9d
4
+ data.tar.gz: 053672fa3f9d3469aab40c7cda7b92c0523cb165e18761d0f81454288a9cc07e
5
5
  SHA512:
6
- metadata.gz: fa51ce96aad9a3268024921ae37b29e8f3ba57cd9d59371dc33b012ec8d84270275a11ad44ab64ad64634bde91a9df50945eb0d1c911fe1d4b21ea79e9e1fa8d
7
- data.tar.gz: 190e17801565bada2ec425f4722a155d20fc31255877dde41da6b22c4f8e85927071868c1c2af5267b823041b541a515142f475b1a49508bd1961ec3eb544bf1
6
+ metadata.gz: 171602ec8560d9191a0e3356b3c9f75b0f9de01643016327e08aa88d69b73f46fe75d76569c0a81e52717821b29a3fca0f49fb6c49fda32268636afd2c208f2d
7
+ data.tar.gz: 2f3ead44b63c00eb41816fbafde199eff4032275f5c3ef80012602dc5a10232dfc50bce0fd6c085994c91da1ce5011173afc3d5a895ce3a32418a6696db34e37
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-chat_v1
2
2
 
3
+ ### v0.154.0 (2026-09-06)
4
+
5
+ * Regenerated from discovery document revision 20260828
6
+
3
7
  ### v0.153.0 (2026-08-23)
4
8
 
5
9
  * Regenerated from discovery document revision 20260815
@@ -4904,6 +4904,32 @@ module Google
4904
4904
  end
4905
4905
  end
4906
4906
 
4907
+ # Response message for listing message pins.
4908
+ class ListMessagePinsResponse
4909
+ include Google::Apis::Core::Hashable
4910
+
4911
+ # The pinned messages from the specified space.
4912
+ # Corresponds to the JSON property `messagePins`
4913
+ # @return [Array<Google::Apis::ChatV1::MessagePin>]
4914
+ attr_accessor :message_pins
4915
+
4916
+ # You can send a token as `pageToken` to retrieve the next page of results. If
4917
+ # empty, there are no subsequent pages.
4918
+ # Corresponds to the JSON property `nextPageToken`
4919
+ # @return [String]
4920
+ attr_accessor :next_page_token
4921
+
4922
+ def initialize(**args)
4923
+ update!(**args)
4924
+ end
4925
+
4926
+ # Update properties of this object
4927
+ def update!(**args)
4928
+ @message_pins = args[:message_pins] if args.key?(:message_pins)
4929
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
4930
+ end
4931
+ end
4932
+
4907
4933
  # Response message for listing messages.
4908
4934
  class ListMessagesResponse
4909
4935
  include Google::Apis::Core::Hashable
@@ -5789,6 +5815,37 @@ module Google
5789
5815
  end
5790
5816
  end
5791
5817
 
5818
+ # A pin on a Chat message. For more information see [Pin a message](https://
5819
+ # support.google.com/chat?p=chat-board-hc).
5820
+ class MessagePin
5821
+ include Google::Apis::Core::Hashable
5822
+
5823
+ # Required. Immutable. The resource name of the message that is pinned. Format: `
5824
+ # spaces/`space`/messages/`message``
5825
+ # Corresponds to the JSON property `message`
5826
+ # @return [String]
5827
+ attr_accessor :message
5828
+
5829
+ # Identifier. The resource name of the message pin. Format: `spaces/`space`/
5830
+ # messagePins/`message_pin`` The resource ID component matches the resource ID
5831
+ # component of the message. For example, a message with `spaces/AAA/messages/bbb.
5832
+ # ccc` corresponds to the message pin with the resource name `spaces/AAA/
5833
+ # messagePins/bbb.ccc`.
5834
+ # Corresponds to the JSON property `name`
5835
+ # @return [String]
5836
+ attr_accessor :name
5837
+
5838
+ def initialize(**args)
5839
+ update!(**args)
5840
+ end
5841
+
5842
+ # Update properties of this object
5843
+ def update!(**args)
5844
+ @message = args[:message] if args.key?(:message)
5845
+ @name = args[:name] if args.key?(:name)
5846
+ end
5847
+ end
5848
+
5792
5849
  # Event payload for an updated message. Event type: `google.workspace.chat.
5793
5850
  # message.v1.updated`
5794
5851
  class MessageUpdatedEventData
@@ -6572,7 +6629,8 @@ module Google
6572
6629
  include Google::Apis::Core::Hashable
6573
6630
 
6574
6631
  # A token that can be used to retrieve the next page. If this field is empty,
6575
- # there are no subsequent pages.
6632
+ # there are no subsequent pages. Only populated when `useAdminAccess` is set to `
6633
+ # true`.
6576
6634
  # Corresponds to the JSON property `nextPageToken`
6577
6635
  # @return [String]
6578
6636
  attr_accessor :next_page_token
@@ -6590,7 +6648,8 @@ module Google
6590
6648
  attr_accessor :spaces
6591
6649
 
6592
6650
  # The total number of spaces that match the query, across all pages. If the
6593
- # result is over 10,000 spaces, this value is an estimate.
6651
+ # result is over 10,000 spaces, this value is an estimate. Only populated when `
6652
+ # useAdminAccess` is set to `true`.
6594
6653
  # Corresponds to the JSON property `totalSize`
6595
6654
  # @return [Fixnum]
6596
6655
  attr_accessor :total_size
@@ -6713,10 +6772,19 @@ module Google
6713
6772
  # @return [Array<Google::Apis::ChatV1::Membership>]
6714
6773
  attr_accessor :memberships
6715
6774
 
6716
- # Optional. A unique identifier for this request. A random UUID is recommended.
6717
- # Specifying an existing request ID returns the space created with that ID
6718
- # instead of creating a new space. Specifying an existing request ID from the
6719
- # same Chat app with a different authenticated user returns an error.
6775
+ # Optional. A unique ID for this request. A random UUID is recommended.
6776
+ # Specifying a request ID makes the request idempotent, which ensures that
6777
+ # multiple identical requests with the same request ID result in only a single
6778
+ # space being created. Subsequent requests with the same request ID return the
6779
+ # existing space and do not update the space, even if the requested details
6780
+ # differ from the current state. To use this field effectively: - Ensure that
6781
+ # subsequent requests are identical and use the same authentication credentials
6782
+ # as the original request. - If a space was already created with the provided
6783
+ # request ID, the request returns that space. Note that the returned space might
6784
+ # not be fully populated; the API echoes the space in your request with the
6785
+ # system-assigned resource name populated. To retrieve the latest metadata for
6786
+ # the space, call `GetSpace`. - Reusing an existing request ID with a different
6787
+ # authenticated user results in an error.
6720
6788
  # Corresponds to the JSON property `requestId`
6721
6789
  # @return [String]
6722
6790
  attr_accessor :request_id
@@ -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.153.0"
19
+ GEM_VERSION = "0.154.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.19.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20260815"
25
+ REVISION = "20260828"
26
26
  end
27
27
  end
28
28
  end
@@ -658,6 +658,12 @@ module Google
658
658
  include Google::Apis::Core::JsonObjectSupport
659
659
  end
660
660
 
661
+ class ListMessagePinsResponse
662
+ class Representation < Google::Apis::Core::JsonRepresentation; end
663
+
664
+ include Google::Apis::Core::JsonObjectSupport
665
+ end
666
+
661
667
  class ListMessagesResponse
662
668
  class Representation < Google::Apis::Core::JsonRepresentation; end
663
669
 
@@ -814,6 +820,12 @@ module Google
814
820
  include Google::Apis::Core::JsonObjectSupport
815
821
  end
816
822
 
823
+ class MessagePin
824
+ class Representation < Google::Apis::Core::JsonRepresentation; end
825
+
826
+ include Google::Apis::Core::JsonObjectSupport
827
+ end
828
+
817
829
  class MessageUpdatedEventData
818
830
  class Representation < Google::Apis::Core::JsonRepresentation; end
819
831
 
@@ -2280,6 +2292,15 @@ module Google
2280
2292
  end
2281
2293
  end
2282
2294
 
2295
+ class ListMessagePinsResponse
2296
+ # @private
2297
+ class Representation < Google::Apis::Core::JsonRepresentation
2298
+ collection :message_pins, as: 'messagePins', class: Google::Apis::ChatV1::MessagePin, decorator: Google::Apis::ChatV1::MessagePin::Representation
2299
+
2300
+ property :next_page_token, as: 'nextPageToken'
2301
+ end
2302
+ end
2303
+
2283
2304
  class ListMessagesResponse
2284
2305
  # @private
2285
2306
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2541,6 +2562,14 @@ module Google
2541
2562
  end
2542
2563
  end
2543
2564
 
2565
+ class MessagePin
2566
+ # @private
2567
+ class Representation < Google::Apis::Core::JsonRepresentation
2568
+ property :message, as: 'message'
2569
+ property :name, as: 'name'
2570
+ end
2571
+ end
2572
+
2544
2573
  class MessageUpdatedEventData
2545
2574
  # @private
2546
2575
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -393,10 +393,19 @@ module Google
393
393
  # organization might already use this display name.
394
394
  # @param [Google::Apis::ChatV1::Space] space_object
395
395
  # @param [String] request_id
396
- # Optional. A unique identifier for this request. A random UUID is recommended.
397
- # Specifying an existing request ID returns the space created with that ID
398
- # instead of creating a new space. Specifying an existing request ID from the
399
- # same Chat app with a different authenticated user returns an error.
396
+ # Optional. A unique ID for this request. A random UUID is recommended.
397
+ # Specifying a request ID makes the request idempotent, which ensures that
398
+ # multiple identical requests with the same request ID result in only a single
399
+ # space being created. Subsequent requests with the same request ID return the
400
+ # existing space and do not update the space, even if the requested details
401
+ # differ from the current state. To use this field effectively: - Ensure that
402
+ # subsequent requests are identical and use the same authentication credentials
403
+ # as the original request. - If a space was already created with the provided
404
+ # request ID, the request returns that space. Note that the returned space might
405
+ # not be fully populated; the API echoes the space in your request with the
406
+ # system-assigned resource name populated. To retrieve the latest metadata for
407
+ # the space, call `GetSpace`. - Reusing an existing request ID with a different
408
+ # authenticated user results in an error.
400
409
  # @param [String] fields
401
410
  # Selector specifying which fields to include in a partial response.
402
411
  # @param [String] quota_user
@@ -879,7 +888,9 @@ module Google
879
888
  # @param [Fixnum] page_size
880
889
  # The maximum number of spaces to return. The service may return fewer than this
881
890
  # value. If unspecified, at most 100 spaces are returned. The maximum value is
882
- # 1000. If you use a value more than 1000, it's automatically changed to 1000.
891
+ # 1000 when `useAdminAccess` is set to `true`. Otherwise, the maximum value is
892
+ # 100. If you use a value more than the maximum value, it's automatically
893
+ # changed to the maximum value.
883
894
  # @param [String] page_token
884
895
  # A token, received from the previous search spaces call. Provide this parameter
885
896
  # to retrieve the subsequent page. When paginating, all other parameters
@@ -931,7 +942,9 @@ module Google
931
942
  # AND space_type = "SPACE" (display_name:"Hello" OR display_name:"Fun") AND
932
943
  # space_type = "SPACE" (external_user_allowed = "true" AND space_type = "SPACE")
933
944
  # // Returns an empty response. (external_user_allowed = "true" AND display_name:
934
- # "Hello" AND space_type = "SPACE") ```
945
+ # "Hello" AND space_type = "SPACE") ``` The maximum query length is 1,000
946
+ # characters. Invalid queries are rejected by the server with an `
947
+ # INVALID_ARGUMENT` error.
935
948
  # @param [Boolean] use_admin_access
936
949
  # When `true`, the method runs using the user's Google Workspace administrator
937
950
  # privileges. The calling user must be a Google Workspace administrator with the
@@ -1406,6 +1419,132 @@ module Google
1406
1419
  execute_or_queue_command(command, &block)
1407
1420
  end
1408
1421
 
1422
+ # Creates a message pin. Requires [user authentication](https://developers.
1423
+ # google.com/workspace/chat/authenticate-authorize-chat-user) with one of the
1424
+ # following [authorization scopes](https://developers.google.com/workspace/chat/
1425
+ # authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/
1426
+ # chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`
1427
+ # @param [String] parent
1428
+ # Required. The parent space in which to create the message pin. Format: spaces/`
1429
+ # space`
1430
+ # @param [Google::Apis::ChatV1::MessagePin] message_pin_object
1431
+ # @param [String] fields
1432
+ # Selector specifying which fields to include in a partial response.
1433
+ # @param [String] quota_user
1434
+ # Available to use for quota purposes for server-side applications. Can be any
1435
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1436
+ # @param [Google::Apis::RequestOptions] options
1437
+ # Request-specific options
1438
+ #
1439
+ # @yield [result, err] Result & error if block supplied
1440
+ # @yieldparam result [Google::Apis::ChatV1::MessagePin] parsed result object
1441
+ # @yieldparam err [StandardError] error object if request failed
1442
+ #
1443
+ # @return [Google::Apis::ChatV1::MessagePin]
1444
+ #
1445
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1446
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1447
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1448
+ def create_space_message_pin(parent, message_pin_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1449
+ command = make_simple_command(:post, 'v1/{+parent}/messagePins', options)
1450
+ command.request_representation = Google::Apis::ChatV1::MessagePin::Representation
1451
+ command.request_object = message_pin_object
1452
+ command.response_representation = Google::Apis::ChatV1::MessagePin::Representation
1453
+ command.response_class = Google::Apis::ChatV1::MessagePin
1454
+ command.params['parent'] = parent unless parent.nil?
1455
+ command.query['fields'] = fields unless fields.nil?
1456
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1457
+ execute_or_queue_command(command, &block)
1458
+ end
1459
+
1460
+ # Deletes a message pin. Requires [user authentication](https://developers.
1461
+ # google.com/workspace/chat/authenticate-authorize-chat-user) with one of the
1462
+ # following [authorization scopes](https://developers.google.com/workspace/chat/
1463
+ # authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/
1464
+ # chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`
1465
+ # @param [String] name
1466
+ # Required. The resource name of the message pin to remove. Format: spaces/`
1467
+ # space`/messagePins/`message_pin`
1468
+ # @param [String] fields
1469
+ # Selector specifying which fields to include in a partial response.
1470
+ # @param [String] quota_user
1471
+ # Available to use for quota purposes for server-side applications. Can be any
1472
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1473
+ # @param [Google::Apis::RequestOptions] options
1474
+ # Request-specific options
1475
+ #
1476
+ # @yield [result, err] Result & error if block supplied
1477
+ # @yieldparam result [Google::Apis::ChatV1::Empty] parsed result object
1478
+ # @yieldparam err [StandardError] error object if request failed
1479
+ #
1480
+ # @return [Google::Apis::ChatV1::Empty]
1481
+ #
1482
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1483
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1484
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1485
+ def delete_space_message_pin(name, fields: nil, quota_user: nil, options: nil, &block)
1486
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1487
+ command.response_representation = Google::Apis::ChatV1::Empty::Representation
1488
+ command.response_class = Google::Apis::ChatV1::Empty
1489
+ command.params['name'] = name unless name.nil?
1490
+ command.query['fields'] = fields unless fields.nil?
1491
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1492
+ execute_or_queue_command(command, &block)
1493
+ end
1494
+
1495
+ # Lists message pins in a space. Users can pin important messages in spaces for
1496
+ # easy access. For more information, see [Pin or unpin a conversation in Google
1497
+ # Chat](https://support.google.com/chat/answer/15622437). Requires [user
1498
+ # authentication](https://developers.google.com/workspace/chat/authenticate-
1499
+ # authorize-chat-user) with one of the following [authorization scopes](https://
1500
+ # developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): -
1501
+ # `https://www.googleapis.com/auth/chat.spaces.pins.readonly` - `https://www.
1502
+ # googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.
1503
+ # spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`
1504
+ # @param [String] parent
1505
+ # Required. The parent space which owns the collection of pinned items Format: `
1506
+ # spaces/`space``
1507
+ # @param [Fixnum] page_size
1508
+ # Optional. The maximum number of message pins returned. The service might
1509
+ # return fewer messages than this value. The maximum value is 100. If you use a
1510
+ # value more than 100, it's automatically changed to 100. If unspecified, at
1511
+ # most 100 message pins will be returned. Negative values return an `
1512
+ # INVALID_ARGUMENT` error.
1513
+ # @param [String] page_token
1514
+ # Optional. A page token received from a previous list message pins call.
1515
+ # Provide this parameter to retrieve the subsequent page. When paginating, all
1516
+ # other parameters provided should match the call that provided the page token.
1517
+ # Passing different values to the other parameters might lead to unexpected
1518
+ # results.
1519
+ # @param [String] fields
1520
+ # Selector specifying which fields to include in a partial response.
1521
+ # @param [String] quota_user
1522
+ # Available to use for quota purposes for server-side applications. Can be any
1523
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1524
+ # @param [Google::Apis::RequestOptions] options
1525
+ # Request-specific options
1526
+ #
1527
+ # @yield [result, err] Result & error if block supplied
1528
+ # @yieldparam result [Google::Apis::ChatV1::ListMessagePinsResponse] parsed result object
1529
+ # @yieldparam err [StandardError] error object if request failed
1530
+ #
1531
+ # @return [Google::Apis::ChatV1::ListMessagePinsResponse]
1532
+ #
1533
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1534
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1535
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1536
+ def list_space_message_pins(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1537
+ command = make_simple_command(:get, 'v1/{+parent}/messagePins', options)
1538
+ command.response_representation = Google::Apis::ChatV1::ListMessagePinsResponse::Representation
1539
+ command.response_class = Google::Apis::ChatV1::ListMessagePinsResponse
1540
+ command.params['parent'] = parent unless parent.nil?
1541
+ command.query['pageSize'] = page_size unless page_size.nil?
1542
+ command.query['pageToken'] = page_token unless page_token.nil?
1543
+ command.query['fields'] = fields unless fields.nil?
1544
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1545
+ execute_or_queue_command(command, &block)
1546
+ end
1547
+
1409
1548
  # Creates a message in a Google Chat space. For an example, see [Send a message](
1410
1549
  # https://developers.google.com/workspace/chat/create-messages). Supports the
1411
1550
  # following types of [authentication](https://developers.google.com/workspace/
@@ -1455,8 +1594,19 @@ module Google
1455
1594
  # is ignored. For interactions within a thread, the reply is created in the same
1456
1595
  # thread. Otherwise, the reply is created as a new thread.
1457
1596
  # @param [String] request_id
1458
- # Optional. A unique request ID for this message. Specifying an existing request
1459
- # ID returns the message created with that ID instead of creating a new message.
1597
+ # Optional. A unique ID for this request. A random UUID is recommended.
1598
+ # Specifying a request ID makes the request idempotent, which ensures that
1599
+ # multiple identical requests with the same request ID result in only a single
1600
+ # message being created. Subsequent requests with the same request ID return the
1601
+ # existing message and do not update the message, even if the requested details
1602
+ # differ from the current state. To use this field effectively: - Ensure that
1603
+ # subsequent requests are identical and use the same authentication credentials
1604
+ # as the original request. - If a message was already created with the provided
1605
+ # request ID, the request returns that message. Note that the returned message
1606
+ # might not be fully populated; the API echoes the message in your request with
1607
+ # the system-assigned resource names populated. To retrieve the latest metadata
1608
+ # for the message, call `GetMessage`. - Reusing an existing request ID with a
1609
+ # different authenticated user results in an error.
1460
1610
  # @param [String] thread_key
1461
1611
  # Optional. Deprecated: Use thread.thread_key instead. ID for the thread.
1462
1612
  # Supports up to 4000 characters. To start or add to a thread, create a message
@@ -123,6 +123,12 @@ module Google
123
123
  # Create new conversations and spaces in Google Chat
124
124
  AUTH_CHAT_SPACES_CREATE = 'https://www.googleapis.com/auth/chat.spaces.create'
125
125
 
126
+ # See, add, and remove pins in your Google Chat spaces
127
+ AUTH_CHAT_SPACES_PINS = 'https://www.googleapis.com/auth/chat.spaces.pins'
128
+
129
+ # See pins in your Google Chat spaces
130
+ AUTH_CHAT_SPACES_PINS_READONLY = 'https://www.googleapis.com/auth/chat.spaces.pins.readonly'
131
+
126
132
  # View chat and spaces in Google Chat
127
133
  AUTH_CHAT_SPACES_READONLY = 'https://www.googleapis.com/auth/chat.spaces.readonly'
128
134
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-chat_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.153.0
4
+ version: 0.154.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-chat_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-chat_v1/v0.153.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-chat_v1/v0.154.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-chat_v1
62
62
  rdoc_options: []
63
63
  require_paths: