@google-apps/chat 0.9.0 → 0.11.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.
@@ -116,18 +116,39 @@ export declare class ChatServiceClient {
116
116
  getProjectId(): Promise<string>;
117
117
  getProjectId(callback: Callback<string, undefined, undefined>): void;
118
118
  /**
119
- * Creates a message in a Google Chat space. The maximum message size,
120
- * including text and cards, is 32,000 bytes. For an example, see [Send a
119
+ * Creates a message in a Google Chat space. For an example, see [Send a
121
120
  * message](https://developers.google.com/workspace/chat/create-messages).
122
121
  *
123
- * Calling this method requires
124
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
125
- * and supports the following authentication types:
122
+ * The `create()` method requires either [user
123
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
124
+ * or [app
125
+ * authentication](https://developers.google.com/workspace/chat/authorize-import).
126
+ * Chat attributes the message sender differently depending on the type of
127
+ * authentication that you use in your request.
128
+ *
129
+ * The following image shows how Chat attributes a message when you use app
130
+ * authentication. Chat displays the Chat app as the message
131
+ * sender. The content of the message can contain text (`text`), cards
132
+ * (`cardsV2`), and accessory widgets (`accessoryWidgets`).
133
+ *
134
+ * ![Message sent with app
135
+ * authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg)
136
+ *
137
+ * The following image shows how Chat attributes a message when you use user
138
+ * authentication. Chat displays the user as the message sender and attributes
139
+ * the Chat app to the message by displaying its name. The content of message
140
+ * can only contain text (`text`).
141
+ *
142
+ * ![Message sent with user
143
+ * authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg)
126
144
  *
127
- * - For text messages, user authentication or app authentication are
128
- * supported.
129
- * - For card messages, only app authentication is supported. (Only Chat apps
130
- * can create card messages.)
145
+ * The maximum message size, including the message contents, is 32,000 bytes.
146
+ *
147
+ * For
148
+ * [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks)
149
+ * requests, the response doesn't contain the full message. The response only
150
+ * populates the `name` and `thread.name` fields in addition to the
151
+ * information that was in the request.
131
152
  *
132
153
  * @param {Object} request
133
154
  * The request object that will be sent.
@@ -152,6 +173,12 @@ export declare class ChatServiceClient {
152
173
  * @param {google.chat.v1.CreateMessageRequest.MessageReplyOption} [request.messageReplyOption]
153
174
  * Optional. Specifies whether a message starts a thread or replies to one.
154
175
  * Only supported in named spaces.
176
+ *
177
+ * When [responding to user
178
+ * interactions](https://developers.google.com/workspace/chat/receive-respond-interactions),
179
+ * this field is ignored. For interactions within a thread, the reply is
180
+ * created in the same thread. Otherwise, the reply is created as a new
181
+ * thread.
155
182
  * @param {string} [request.messageId]
156
183
  * Optional. A custom ID for a message. Lets Chat apps get, update, or delete
157
184
  * a message without needing to store the system-assigned ID in the message's
@@ -189,13 +216,16 @@ export declare class ChatServiceClient {
189
216
  * [Get details about a user's or Google Chat app's
190
217
  * membership](https://developers.google.com/workspace/chat/get-members).
191
218
  *
192
- * Requires
193
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
194
- * Supports
195
- * [app
219
+ * Supports the following types of
220
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
221
+ *
222
+ * - [App
196
223
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
197
- * and [user
198
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
224
+ *
225
+ * - [User
226
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
227
+ * You can authenticate and authorize this method with administrator
228
+ * privileges by setting the `use_admin_access` field in the request.
199
229
  *
200
230
  * @param {Object} request
201
231
  * The request object that will be sent.
@@ -208,13 +238,11 @@ export declare class ChatServiceClient {
208
238
  *
209
239
  * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
210
240
  *
211
- * When [authenticated as a
212
- * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
213
- * you can use the user's email as an alias for `{member}`. For example,
241
+ * You can use the user's email as an alias for `{member}`. For example,
214
242
  * `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
215
243
  * email of the Google Chat user.
216
- * @param {boolean} request.useAdminAccess
217
- * When `true`, the method runs using the user's Google Workspace
244
+ * @param {boolean} [request.useAdminAccess]
245
+ * Optional. When `true`, the method runs using the user's Google Workspace
218
246
  * administrator privileges.
219
247
  *
220
248
  * The calling user must be a Google Workspace administrator with the
@@ -247,13 +275,14 @@ export declare class ChatServiceClient {
247
275
  * For an example, see [Get details about a
248
276
  * message](https://developers.google.com/workspace/chat/get-messages).
249
277
  *
250
- * Requires
251
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
252
- * Supports
253
- * [app
278
+ * Supports the following types of
279
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
280
+ *
281
+ * - [App
254
282
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
255
- * and [user
256
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
283
+ *
284
+ * - [User
285
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
257
286
  *
258
287
  * Note: Might return a message from a blocked member or space.
259
288
  *
@@ -292,13 +321,15 @@ export declare class ChatServiceClient {
292
321
  * [Update a
293
322
  * message](https://developers.google.com/workspace/chat/update-messages).
294
323
  *
295
- * Requires
296
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
297
- * Supports
298
- * [app
324
+ * Supports the following types of
325
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
326
+ *
327
+ * - [App
299
328
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
300
- * and [user
301
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
329
+ *
330
+ * - [User
331
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
332
+ *
302
333
  * When using app authentication, requests can only update messages
303
334
  * created by the calling Chat app.
304
335
  *
@@ -350,13 +381,15 @@ export declare class ChatServiceClient {
350
381
  * For an example, see [Delete a
351
382
  * message](https://developers.google.com/workspace/chat/delete-messages).
352
383
  *
353
- * Requires
354
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
355
- * Supports
356
- * [app
384
+ * Supports the following types of
385
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
386
+ *
387
+ * - [App
357
388
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
358
- * and [user
359
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
389
+ *
390
+ * - [User
391
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
392
+ *
360
393
  * When using app authentication, requests can only delete messages
361
394
  * created by the calling Chat app.
362
395
  *
@@ -371,9 +404,9 @@ export declare class ChatServiceClient {
371
404
  * `clientAssignedMessageId` field for `{message}`. For details, see [Name a
372
405
  * message]
373
406
  * (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
374
- * @param {boolean} request.force
375
- * When `true`, deleting a message also deletes its threaded replies. When
376
- * `false`, if a message has threaded replies, deletion fails.
407
+ * @param {boolean} [request.force]
408
+ * Optional. When `true`, deleting a message also deletes its threaded
409
+ * replies. When `false`, if a message has threaded replies, deletion fails.
377
410
  *
378
411
  * Only applies when [authenticating as a
379
412
  * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -430,6 +463,7 @@ export declare class ChatServiceClient {
430
463
  * Uploads an attachment. For an example, see
431
464
  * [Upload media as a file
432
465
  * attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
466
+ *
433
467
  * Requires user
434
468
  * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
435
469
  *
@@ -465,13 +499,16 @@ export declare class ChatServiceClient {
465
499
  * [Get details about a
466
500
  * space](https://developers.google.com/workspace/chat/get-spaces).
467
501
  *
468
- * Requires
469
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
470
- * Supports
471
- * [app
502
+ * Supports the following types of
503
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
504
+ *
505
+ * - [App
472
506
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
473
- * and [user
474
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
507
+ *
508
+ * - [User
509
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
510
+ * You can authenticate and authorize this method with administrator
511
+ * privileges by setting the `use_admin_access` field in the request.
475
512
  *
476
513
  * @param {Object} request
477
514
  * The request object that will be sent.
@@ -479,8 +516,8 @@ export declare class ChatServiceClient {
479
516
  * Required. Resource name of the space, in the form `spaces/{space}`.
480
517
  *
481
518
  * Format: `spaces/{space}`
482
- * @param {boolean} request.useAdminAccess
483
- * When `true`, the method runs using the user's Google Workspace
519
+ * @param {boolean} [request.useAdminAccess]
520
+ * Optional. When `true`, the method runs using the user's Google Workspace
484
521
  * administrator privileges.
485
522
  *
486
523
  * The calling user must be a Google Workspace administrator with the
@@ -506,27 +543,40 @@ export declare class ChatServiceClient {
506
543
  getSpace(request: protos.google.chat.v1.IGetSpaceRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IGetSpaceRequest | null | undefined, {} | null | undefined>): void;
507
544
  getSpace(request: protos.google.chat.v1.IGetSpaceRequest, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IGetSpaceRequest | null | undefined, {} | null | undefined>): void;
508
545
  /**
509
- * Creates a named space. Spaces grouped by topics aren't supported. For an
510
- * example, see [Create a
546
+ * Creates a space with no members. Can be used to create a named space, or a
547
+ * group chat in `Import mode`. For an example, see [Create a
511
548
  * space](https://developers.google.com/workspace/chat/create-spaces).
512
549
  *
513
550
  * If you receive the error message `ALREADY_EXISTS` when creating
514
551
  * a space, try a different `displayName`. An existing space within
515
552
  * the Google Workspace organization might already use this display name.
516
553
  *
517
- * Requires [user
518
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
554
+ * Supports the following types of
555
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
556
+ *
557
+ * - [App
558
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
559
+ * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
560
+ * in [Developer Preview](https://developers.google.com/workspace/preview)
561
+ *
562
+ * - [User
563
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
564
+ *
565
+ * When authenticating as an app, the `space.customer` field must be set in
566
+ * the request.
519
567
  *
520
568
  * @param {Object} request
521
569
  * The request object that will be sent.
522
570
  * @param {google.chat.v1.Space} request.space
523
571
  * Required. The `displayName` and `spaceType` fields must be populated. Only
524
- * `SpaceType.SPACE` is supported.
572
+ * `SpaceType.SPACE` and `SpaceType.GROUP_CHAT` are supported.
573
+ * `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true.
525
574
  *
526
- * If you receive the error message `ALREADY_EXISTS` when creating a space,
575
+ * If you receive the error message `ALREADY_EXISTS`,
527
576
  * try a different `displayName`. An existing space within the Google
528
577
  * Workspace organization might already use this display name.
529
578
  *
579
+ *
530
580
  * The space `name` is assigned on the server so anything specified in this
531
581
  * field will be ignored.
532
582
  * @param {string} [request.requestId]
@@ -694,8 +744,18 @@ export declare class ChatServiceClient {
694
744
  * `ALREADY_EXISTS`, try a different display name.. An existing space within
695
745
  * the Google Workspace organization might already use this display name.
696
746
  *
697
- * Requires [user
698
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
747
+ * Supports the following types of
748
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
749
+ *
750
+ * - [App
751
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
752
+ * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
753
+ * in [Developer Preview](https://developers.google.com/workspace/preview)
754
+ *
755
+ * - [User
756
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
757
+ * You can authenticate and authorize this method with administrator
758
+ * privileges by setting the `use_admin_access` field in the request.
699
759
  *
700
760
  * @param {Object} request
701
761
  * The request object that will be sent.
@@ -707,56 +767,66 @@ export declare class ChatServiceClient {
707
767
  * Required. The updated field paths, comma separated if there are
708
768
  * multiple.
709
769
  *
710
- * Currently supported field paths:
770
+ * You can update the following fields for a space:
771
+ *
772
+ * `space_details`: Updates the space's description. Supports up to 150
773
+ * characters.
711
774
  *
712
- * - `display_name` (Only supports changing the display name of a space with
713
- * the `SPACE` type, or when also including the `space_type` mask to change a
714
- * `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a
715
- * `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument
716
- * error. If you receive the error message `ALREADY_EXISTS` when updating the
717
- * `displayName`, try a different `displayName`. An existing space within the
718
- * Google Workspace organization might already use this display name.)
775
+ * `display_name`: Only supports updating the display name for spaces where
776
+ * `spaceType` field is `SPACE`.
777
+ * If you receive the error message `ALREADY_EXISTS`, try a different
778
+ * value. An existing space within the
779
+ * Google Workspace organization might already use this display name.
719
780
  *
720
- * - `space_type` (Only supports changing a `GROUP_CHAT` space type to
781
+ * `space_type`: Only supports changing a `GROUP_CHAT` space type to
721
782
  * `SPACE`. Include `display_name` together
722
783
  * with `space_type` in the update mask and ensure that the specified space
723
784
  * has a non-empty display name and the `SPACE` space type. Including the
724
785
  * `space_type` mask and the `SPACE` type in the specified space when updating
725
786
  * the display name is optional if the existing space already has the `SPACE`
726
787
  * type. Trying to update the space type in other ways results in an invalid
727
- * argument error).
728
- * `space_type` is not supported with admin access.
729
- *
730
- * - `space_details`
788
+ * argument error.
789
+ * `space_type` is not supported with `useAdminAccess`.
731
790
  *
732
- * - `space_history_state` (Supports [turning history on or off for the
733
- * space](https://support.google.com/chat/answer/7664687) if [the organization
734
- * allows users to change their history
735
- * setting](https://support.google.com/a/answer/7664184).
736
- * Warning: mutually exclusive with all other field paths.)
737
- * `space_history_state` is not supported with admin access.
791
+ * `space_history_state`: Updates [space history
792
+ * settings](https://support.google.com/chat/answer/7664687) by turning
793
+ * history on or off for the space. Only supported if history settings are
794
+ * enabled for the Google Workspace organization. To update the
795
+ * space history state, you must omit all other field masks in your request.
796
+ * `space_history_state` is not supported with `useAdminAccess`.
738
797
  *
739
- * - `access_settings.audience` (Supports changing the [access
798
+ * `access_settings.audience`: Updates the [access
740
799
  * setting](https://support.google.com/chat/answer/11971020) of who can
741
- * discover the space, join the space, and preview the messages in space. If
742
- * no audience is specified in the access setting, the space's access setting
743
- * is updated to private. Warning: mutually exclusive with all other field
744
- * paths.)
745
- * `access_settings.audience` is not supported with admin access.
746
- *
747
- * - Developer Preview: Supports changing the [permission
748
- * settings](https://support.google.com/chat/answer/13340792) of a space,
749
- * supported field paths
750
- * include: `permission_settings.manage_members_and_groups`,
751
- * `permission_settings.modify_space_details`,
752
- * `permission_settings.toggle_history`,
753
- * `permission_settings.use_at_mention_all`,
754
- * `permission_settings.manage_apps`, `permission_settings.manage_webhooks`,
755
- * `permission_settings.reply_messages`
756
- * (Warning: mutually exclusive with all other non-permission settings field
757
- * paths). `permission_settings` is not supported with admin access.
758
- * @param {boolean} request.useAdminAccess
759
- * When `true`, the method runs using the user's Google Workspace
800
+ * discover the space, join the space, and preview the messages in named space
801
+ * where `spaceType` field is `SPACE`. If the existing space has a
802
+ * target audience, you can remove the audience and restrict space access by
803
+ * omitting a value for this field mask. To update access settings for a
804
+ * space, the authenticating user must be a space manager and omit all other
805
+ * field masks in your request. You can't update this field if the space is in
806
+ * [import
807
+ * mode](https://developers.google.com/workspace/chat/import-data-overview).
808
+ * To learn more, see [Make a space discoverable to specific
809
+ * users](https://developers.google.com/workspace/chat/space-target-audience).
810
+ * `access_settings.audience` is not supported with `useAdminAccess`.
811
+ *
812
+ * `permission_settings`: Supports changing the
813
+ * [permission settings](https://support.google.com/chat/answer/13340792)
814
+ * of a space.
815
+ * When updating permission settings, you can only specify
816
+ * `permissionSettings` field masks; you cannot update other field masks
817
+ * at the same time. `permissionSettings` is not supported with
818
+ * `useAdminAccess`.
819
+ * The supported field masks include:
820
+ *
821
+ * - `permission_settings.manageMembersAndGroups`
822
+ * - `permission_settings.modifySpaceDetails`
823
+ * - `permission_settings.toggleHistory`
824
+ * - `permission_settings.useAtMentionAll`
825
+ * - `permission_settings.manageApps`
826
+ * - `permission_settings.manageWebhooks`
827
+ * - `permission_settings.replyMessages`
828
+ * @param {boolean} [request.useAdminAccess]
829
+ * Optional. When `true`, the method runs using the user's Google Workspace
760
830
  * administrator privileges.
761
831
  *
762
832
  * The calling user must be a Google Workspace administrator with the
@@ -790,9 +860,19 @@ export declare class ChatServiceClient {
790
860
  * memberships in the space—are also deleted. For an example, see
791
861
  * [Delete a
792
862
  * space](https://developers.google.com/workspace/chat/delete-spaces).
793
- * Requires [user
863
+ *
864
+ * Supports the following types of
865
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
866
+ *
867
+ * - [App
868
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
869
+ * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
870
+ * in [Developer Preview](https://developers.google.com/workspace/preview)
871
+ *
872
+ * - [User
794
873
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
795
- * from a user who has permission to delete the space.
874
+ * You can authenticate and authorize this method with administrator
875
+ * privileges by setting the `use_admin_access` field in the request.
796
876
  *
797
877
  * @param {Object} request
798
878
  * The request object that will be sent.
@@ -800,8 +880,8 @@ export declare class ChatServiceClient {
800
880
  * Required. Resource name of the space to delete.
801
881
  *
802
882
  * Format: `spaces/{space}`
803
- * @param {boolean} request.useAdminAccess
804
- * When `true`, the method runs using the user's Google Workspace
883
+ * @param {boolean} [request.useAdminAccess]
884
+ * Optional. When `true`, the method runs using the user's Google Workspace
805
885
  * administrator privileges.
806
886
  *
807
887
  * The calling user must be a Google Workspace administrator with the
@@ -830,8 +910,11 @@ export declare class ChatServiceClient {
830
910
  * Completes the
831
911
  * [import process](https://developers.google.com/workspace/chat/import-data)
832
912
  * for the specified space and makes it visible to users.
833
- * Requires app authentication and domain-wide delegation. For more
834
- * information, see [Authorize Google Chat apps to import
913
+ *
914
+ * Requires [app
915
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
916
+ * and domain-wide delegation. For more information, see [Authorize Google
917
+ * Chat apps to import
835
918
  * data](https://developers.google.com/workspace/chat/authorize-import).
836
919
  *
837
920
  * @param {Object} request
@@ -862,20 +945,24 @@ export declare class ChatServiceClient {
862
945
  * see
863
946
  * [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message).
864
947
  *
948
+ * With [app
949
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
950
+ * returns the direct message space between the specified user and the calling
951
+ * Chat app.
952
+ *
865
953
  * With [user
866
954
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
867
955
  * returns the direct message space between the specified user and the
868
956
  * authenticated user.
869
957
  *
870
- * With [app
871
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
872
- * returns the direct message space between the specified user and the calling
873
- * Chat app.
958
+ * // Supports the following types of
959
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
874
960
  *
875
- * Requires [user
961
+ * - [App
962
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
963
+ *
964
+ * - [User
876
965
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
877
- * or [app
878
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
879
966
  *
880
967
  * @param {Object} request
881
968
  * The request object that will be sent.
@@ -910,40 +997,36 @@ export declare class ChatServiceClient {
910
997
  findDirectMessage(request: protos.google.chat.v1.IFindDirectMessageRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IFindDirectMessageRequest | null | undefined, {} | null | undefined>): void;
911
998
  findDirectMessage(request: protos.google.chat.v1.IFindDirectMessageRequest, callback: Callback<protos.google.chat.v1.ISpace, protos.google.chat.v1.IFindDirectMessageRequest | null | undefined, {} | null | undefined>): void;
912
999
  /**
913
- * Creates a human membership or app membership for the calling app. Creating
914
- * memberships for other apps isn't supported. For an example, see
915
- * [Invite or add a user or a Google Chat app to a
916
- * space](https://developers.google.com/workspace/chat/create-members).
1000
+ * Creates a membership for the calling Chat app, a user, or a Google Group.
1001
+ * Creating memberships for other Chat apps isn't supported.
917
1002
  * When creating a membership, if the specified member has their auto-accept
918
1003
  * policy turned off, then they're invited, and must accept the space
919
1004
  * invitation before joining. Otherwise, creating a membership adds the member
920
- * directly to the specified space. Requires [user
921
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1005
+ * directly to the specified space.
922
1006
  *
923
- * To specify the member to add, set the `membership.member.name` for the
924
- * human or app member, or set the `membership.group_member.name` for the
925
- * group member.
926
- *
927
- * - To add the calling app to a space or a direct message between two human
928
- * users, use `users/app`. Unable to add other
929
- * apps to the space.
930
- *
931
- * - To add a human user, use `users/{user}`, where `{user}` can be the email
932
- * address for the user. For users in the same Workspace organization `{user}`
933
- * can also be the `id` for the person from the People API, or the `id` for
934
- * the user in the Directory API. For example, if the People API Person
935
- * profile ID for `user@example.com` is `123456789`, you can add the user to
936
- * the space by setting the `membership.member.name` to
937
- * `users/user@example.com` or `users/123456789`.
938
- *
939
- * - To add or invite a Google group in a named space, use
940
- * `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
941
- * Identity Groups API. For example, you can use [Cloud Identity Groups lookup
942
- * API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
943
- * to retrieve the ID `123456789` for group email `group@example.com`, then
944
- * you can add or invite the group to a named space by setting the
945
- * `membership.group_member.name` to `groups/123456789`. Group email is not
946
- * supported, and Google groups can only be added as members in named spaces.
1007
+ * Supports the following types of
1008
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1009
+ *
1010
+ * - [App
1011
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1012
+ * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
1013
+ * in [Developer Preview](https://developers.google.com/workspace/preview)
1014
+ *
1015
+ * - [User
1016
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1017
+ * You can authenticate and authorize this method with administrator
1018
+ * privileges by setting the `use_admin_access` field in the request.
1019
+ *
1020
+ * For example usage, see:
1021
+ *
1022
+ * - [Invite or add a user to a
1023
+ * space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
1024
+ *
1025
+ * - [Invite or add a Google Group to a
1026
+ * space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
1027
+ *
1028
+ * - [Add the Chat app to a
1029
+ * space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
947
1030
  *
948
1031
  * @param {Object} request
949
1032
  * The request object that will be sent.
@@ -954,23 +1037,44 @@ export declare class ChatServiceClient {
954
1037
  * Format: spaces/{space}
955
1038
  * @param {google.chat.v1.Membership} request.membership
956
1039
  * Required. The membership relation to create.
1040
+ *
957
1041
  * The `memberType` field must contain a user with the `user.name` and
958
1042
  * `user.type` fields populated. The server will assign a resource name
959
1043
  * and overwrite anything specified.
1044
+ *
960
1045
  * When a Chat app creates a membership relation for a human user, it must use
961
- * the `chat.memberships` scope, set `user.type` to `HUMAN`, and set
962
- * `user.name` with format `users/{user}`, where `{user}` can be the email
963
- * address for the user. For users in the same Workspace organization `{user}`
964
- * can also be the `id` of the
965
- * [person](https://developers.google.com/people/api/rest/v1/people) from the
966
- * People API, or the `id` for the user in the Directory API. For example, if
967
- * the People API Person profile ID for `user@example.com` is `123456789`, you
968
- * can add the user to the space by setting the `membership.member.name` to
969
- * `users/user@example.com` or `users/123456789`. When a Chat app creates a
970
- * membership relation for itself, it must use the `chat.memberships.app`
971
- * scope, set `user.type` to `BOT`, and set `user.name` to `users/app`.
972
- * @param {boolean} request.useAdminAccess
973
- * When `true`, the method runs using the user's Google Workspace
1046
+ * certain authorization scopes and set specific values for certain fields:
1047
+ *
1048
+ * - When [authenticating as a
1049
+ * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
1050
+ * the `chat.memberships` authorization scope is required.
1051
+ *
1052
+ * - When [authenticating as an
1053
+ * app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
1054
+ * the `chat.app.memberships` authorization scope is required.
1055
+ * Authenticating as an app is available in [Developer
1056
+ * Preview](https://developers.google.com/workspace/preview).
1057
+ *
1058
+ * - Set `user.type` to `HUMAN`, and set `user.name` with format
1059
+ * `users/{user}`, where `{user}` can be the email address for the user. For
1060
+ * users in the same Workspace organization `{user}` can also be the `id` of
1061
+ * the [person](https://developers.google.com/people/api/rest/v1/people) from
1062
+ * the People API, or the `id` for the user in the Directory API. For example,
1063
+ * if the People API Person profile ID for `user@example.com` is `123456789`,
1064
+ * you can add the user to the space by setting the `membership.member.name`
1065
+ * to `users/user@example.com` or `users/123456789`.
1066
+ *
1067
+ * Inviting users external to the Workspace organization that owns the space
1068
+ * requires [user
1069
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1070
+ *
1071
+ * When a Chat app creates a membership relation for itself, it must
1072
+ * [authenticate as a
1073
+ * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1074
+ * and use the `chat.memberships.app` scope, set `user.type` to `BOT`, and set
1075
+ * `user.name` to `users/app`.
1076
+ * @param {boolean} [request.useAdminAccess]
1077
+ * Optional. When `true`, the method runs using the user's Google Workspace
974
1078
  * administrator privileges.
975
1079
  *
976
1080
  * The calling user must be a Google Workspace administrator with the
@@ -1003,8 +1107,18 @@ export declare class ChatServiceClient {
1003
1107
  * Updates a membership. For an example, see [Update a user's membership in
1004
1108
  * a space](https://developers.google.com/workspace/chat/update-members).
1005
1109
  *
1006
- * Requires [user
1007
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1110
+ * Supports the following types of
1111
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1112
+ *
1113
+ * - [App
1114
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1115
+ * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
1116
+ * in [Developer Preview](https://developers.google.com/workspace/preview)
1117
+ *
1118
+ * - [User
1119
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1120
+ * You can authenticate and authorize this method with administrator
1121
+ * privileges by setting the `use_admin_access` field in the request.
1008
1122
  *
1009
1123
  * @param {Object} request
1010
1124
  * The request object that will be sent.
@@ -1018,8 +1132,8 @@ export declare class ChatServiceClient {
1018
1132
  * Currently supported field paths:
1019
1133
  *
1020
1134
  * - `role`
1021
- * @param {boolean} request.useAdminAccess
1022
- * When `true`, the method runs using the user's Google Workspace
1135
+ * @param {boolean} [request.useAdminAccess]
1136
+ * Optional. When `true`, the method runs using the user's Google Workspace
1023
1137
  * administrator privileges.
1024
1138
  *
1025
1139
  * The calling user must be a Google Workspace administrator with the
@@ -1049,8 +1163,18 @@ export declare class ChatServiceClient {
1049
1163
  * [Remove a user or a Google Chat app from a
1050
1164
  * space](https://developers.google.com/workspace/chat/delete-members).
1051
1165
  *
1052
- * Requires [user
1053
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1166
+ * Supports the following types of
1167
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1168
+ *
1169
+ * - [App
1170
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1171
+ * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
1172
+ * in [Developer Preview](https://developers.google.com/workspace/preview)
1173
+ *
1174
+ * - [User
1175
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1176
+ * You can authenticate and authorize this method with administrator
1177
+ * privileges by setting the `use_admin_access` field in the request.
1054
1178
  *
1055
1179
  * @param {Object} request
1056
1180
  * The request object that will be sent.
@@ -1069,8 +1193,8 @@ export declare class ChatServiceClient {
1069
1193
  * and `spaces/{space}/members/app` format.
1070
1194
  *
1071
1195
  * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
1072
- * @param {boolean} request.useAdminAccess
1073
- * When `true`, the method runs using the user's Google Workspace
1196
+ * @param {boolean} [request.useAdminAccess]
1197
+ * Optional. When `true`, the method runs using the user's Google Workspace
1074
1198
  * administrator privileges.
1075
1199
  *
1076
1200
  * The calling user must be a Google Workspace administrator with the
@@ -1102,6 +1226,7 @@ export declare class ChatServiceClient {
1102
1226
  * supported. For an example, see
1103
1227
  * [Add a reaction to a
1104
1228
  * message](https://developers.google.com/workspace/chat/create-reactions).
1229
+ *
1105
1230
  * Requires [user
1106
1231
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1107
1232
  *
@@ -1134,6 +1259,7 @@ export declare class ChatServiceClient {
1134
1259
  * For an example, see
1135
1260
  * [Delete a
1136
1261
  * reaction](https://developers.google.com/workspace/chat/delete-reactions).
1262
+ *
1137
1263
  * Requires [user
1138
1264
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1139
1265
  *
@@ -1310,6 +1436,9 @@ export declare class ChatServiceClient {
1310
1436
  * updated, the server returns the updated `Message` resource in the event
1311
1437
  * payload.
1312
1438
  *
1439
+ * Note: The `permissionSettings` field is not returned in the Space
1440
+ * object of the Space event data for this request.
1441
+ *
1313
1442
  * Requires [user
1314
1443
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1315
1444
  * To get an event, the authenticated user must be a member of the space.
@@ -1342,8 +1471,13 @@ export declare class ChatServiceClient {
1342
1471
  getSpaceEvent(request: protos.google.chat.v1.IGetSpaceEventRequest, callback: Callback<protos.google.chat.v1.ISpaceEvent, protos.google.chat.v1.IGetSpaceEventRequest | null | undefined, {} | null | undefined>): void;
1343
1472
  /**
1344
1473
  * Lists messages in a space that the caller is a member of, including
1345
- * messages from blocked members and spaces. For an example, see
1346
- * [List messages](/chat/api/guides/v1/messages/list).
1474
+ * messages from blocked members and spaces. If you list messages from a
1475
+ * space with no messages, the response is an empty object. When using a
1476
+ * REST/HTTP interface, the response contains an empty JSON object, `{}`.
1477
+ * For an example, see
1478
+ * [List
1479
+ * messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
1480
+ *
1347
1481
  * Requires [user
1348
1482
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1349
1483
  *
@@ -1353,9 +1487,9 @@ export declare class ChatServiceClient {
1353
1487
  * Required. The resource name of the space to list messages from.
1354
1488
  *
1355
1489
  * Format: `spaces/{space}`
1356
- * @param {number} request.pageSize
1357
- * The maximum number of messages returned. The service might return fewer
1358
- * messages than this value.
1490
+ * @param {number} [request.pageSize]
1491
+ * Optional. The maximum number of messages returned. The service might return
1492
+ * fewer messages than this value.
1359
1493
  *
1360
1494
  * If unspecified, at most 25 are returned.
1361
1495
  *
@@ -1363,17 +1497,15 @@ export declare class ChatServiceClient {
1363
1497
  * automatically changed to 1000.
1364
1498
  *
1365
1499
  * Negative values return an `INVALID_ARGUMENT` error.
1366
- * @param {string} request.pageToken
1367
- * Optional, if resuming from a previous query.
1368
- *
1369
- * A page token received from a previous list messages call. Provide this
1370
- * parameter to retrieve the subsequent page.
1500
+ * @param {string} [request.pageToken]
1501
+ * Optional. A page token received from a previous list messages call. Provide
1502
+ * this parameter to retrieve the subsequent page.
1371
1503
  *
1372
1504
  * When paginating, all other parameters provided should match the call that
1373
1505
  * provided the page token. Passing different values to the other parameters
1374
1506
  * might lead to unexpected results.
1375
- * @param {string} request.filter
1376
- * A query filter.
1507
+ * @param {string} [request.filter]
1508
+ * Optional. A query filter.
1377
1509
  *
1378
1510
  * You can filter messages by date (`create_time`) and thread (`thread.name`).
1379
1511
  *
@@ -1410,20 +1542,19 @@ export declare class ChatServiceClient {
1410
1542
  *
1411
1543
  * Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
1412
1544
  * error.
1413
- * @param {string} request.orderBy
1414
- * Optional, if resuming from a previous query.
1415
- *
1416
- * How the list of messages is ordered. Specify a value to order by an
1417
- * ordering operation. Valid ordering operation values are as follows:
1545
+ * @param {string} [request.orderBy]
1546
+ * Optional. How the list of messages is ordered. Specify a value to order by
1547
+ * an ordering operation. Valid ordering operation values are as follows:
1418
1548
  *
1419
1549
  * - `ASC` for ascending.
1420
1550
  *
1421
1551
  * - `DESC` for descending.
1422
1552
  *
1423
1553
  * The default ordering is `create_time ASC`.
1424
- * @param {boolean} request.showDeleted
1425
- * Whether to include deleted messages. Deleted messages include deleted time
1426
- * and metadata about their deletion, but message content is unavailable.
1554
+ * @param {boolean} [request.showDeleted]
1555
+ * Optional. Whether to include deleted messages. Deleted messages include
1556
+ * deleted time and metadata about their deletion, but message content is
1557
+ * unavailable.
1427
1558
  * @param {object} [options]
1428
1559
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1429
1560
  * @returns {Promise} - The promise which resolves to an array.
@@ -1451,9 +1582,9 @@ export declare class ChatServiceClient {
1451
1582
  * Required. The resource name of the space to list messages from.
1452
1583
  *
1453
1584
  * Format: `spaces/{space}`
1454
- * @param {number} request.pageSize
1455
- * The maximum number of messages returned. The service might return fewer
1456
- * messages than this value.
1585
+ * @param {number} [request.pageSize]
1586
+ * Optional. The maximum number of messages returned. The service might return
1587
+ * fewer messages than this value.
1457
1588
  *
1458
1589
  * If unspecified, at most 25 are returned.
1459
1590
  *
@@ -1461,17 +1592,15 @@ export declare class ChatServiceClient {
1461
1592
  * automatically changed to 1000.
1462
1593
  *
1463
1594
  * Negative values return an `INVALID_ARGUMENT` error.
1464
- * @param {string} request.pageToken
1465
- * Optional, if resuming from a previous query.
1466
- *
1467
- * A page token received from a previous list messages call. Provide this
1468
- * parameter to retrieve the subsequent page.
1595
+ * @param {string} [request.pageToken]
1596
+ * Optional. A page token received from a previous list messages call. Provide
1597
+ * this parameter to retrieve the subsequent page.
1469
1598
  *
1470
1599
  * When paginating, all other parameters provided should match the call that
1471
1600
  * provided the page token. Passing different values to the other parameters
1472
1601
  * might lead to unexpected results.
1473
- * @param {string} request.filter
1474
- * A query filter.
1602
+ * @param {string} [request.filter]
1603
+ * Optional. A query filter.
1475
1604
  *
1476
1605
  * You can filter messages by date (`create_time`) and thread (`thread.name`).
1477
1606
  *
@@ -1508,20 +1637,19 @@ export declare class ChatServiceClient {
1508
1637
  *
1509
1638
  * Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
1510
1639
  * error.
1511
- * @param {string} request.orderBy
1512
- * Optional, if resuming from a previous query.
1513
- *
1514
- * How the list of messages is ordered. Specify a value to order by an
1515
- * ordering operation. Valid ordering operation values are as follows:
1640
+ * @param {string} [request.orderBy]
1641
+ * Optional. How the list of messages is ordered. Specify a value to order by
1642
+ * an ordering operation. Valid ordering operation values are as follows:
1516
1643
  *
1517
1644
  * - `ASC` for ascending.
1518
1645
  *
1519
1646
  * - `DESC` for descending.
1520
1647
  *
1521
1648
  * The default ordering is `create_time ASC`.
1522
- * @param {boolean} request.showDeleted
1523
- * Whether to include deleted messages. Deleted messages include deleted time
1524
- * and metadata about their deletion, but message content is unavailable.
1649
+ * @param {boolean} [request.showDeleted]
1650
+ * Optional. Whether to include deleted messages. Deleted messages include
1651
+ * deleted time and metadata about their deletion, but message content is
1652
+ * unavailable.
1525
1653
  * @param {object} [options]
1526
1654
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1527
1655
  * @returns {Stream}
@@ -1544,9 +1672,9 @@ export declare class ChatServiceClient {
1544
1672
  * Required. The resource name of the space to list messages from.
1545
1673
  *
1546
1674
  * Format: `spaces/{space}`
1547
- * @param {number} request.pageSize
1548
- * The maximum number of messages returned. The service might return fewer
1549
- * messages than this value.
1675
+ * @param {number} [request.pageSize]
1676
+ * Optional. The maximum number of messages returned. The service might return
1677
+ * fewer messages than this value.
1550
1678
  *
1551
1679
  * If unspecified, at most 25 are returned.
1552
1680
  *
@@ -1554,17 +1682,15 @@ export declare class ChatServiceClient {
1554
1682
  * automatically changed to 1000.
1555
1683
  *
1556
1684
  * Negative values return an `INVALID_ARGUMENT` error.
1557
- * @param {string} request.pageToken
1558
- * Optional, if resuming from a previous query.
1559
- *
1560
- * A page token received from a previous list messages call. Provide this
1561
- * parameter to retrieve the subsequent page.
1685
+ * @param {string} [request.pageToken]
1686
+ * Optional. A page token received from a previous list messages call. Provide
1687
+ * this parameter to retrieve the subsequent page.
1562
1688
  *
1563
1689
  * When paginating, all other parameters provided should match the call that
1564
1690
  * provided the page token. Passing different values to the other parameters
1565
1691
  * might lead to unexpected results.
1566
- * @param {string} request.filter
1567
- * A query filter.
1692
+ * @param {string} [request.filter]
1693
+ * Optional. A query filter.
1568
1694
  *
1569
1695
  * You can filter messages by date (`create_time`) and thread (`thread.name`).
1570
1696
  *
@@ -1601,20 +1727,19 @@ export declare class ChatServiceClient {
1601
1727
  *
1602
1728
  * Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
1603
1729
  * error.
1604
- * @param {string} request.orderBy
1605
- * Optional, if resuming from a previous query.
1606
- *
1607
- * How the list of messages is ordered. Specify a value to order by an
1608
- * ordering operation. Valid ordering operation values are as follows:
1730
+ * @param {string} [request.orderBy]
1731
+ * Optional. How the list of messages is ordered. Specify a value to order by
1732
+ * an ordering operation. Valid ordering operation values are as follows:
1609
1733
  *
1610
1734
  * - `ASC` for ascending.
1611
1735
  *
1612
1736
  * - `DESC` for descending.
1613
1737
  *
1614
1738
  * The default ordering is `create_time ASC`.
1615
- * @param {boolean} request.showDeleted
1616
- * Whether to include deleted messages. Deleted messages include deleted time
1617
- * and metadata about their deletion, but message content is unavailable.
1739
+ * @param {boolean} [request.showDeleted]
1740
+ * Optional. Whether to include deleted messages. Deleted messages include
1741
+ * deleted time and metadata about their deletion, but message content is
1742
+ * unavailable.
1618
1743
  * @param {object} [options]
1619
1744
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1620
1745
  * @returns {Object}
@@ -1641,13 +1766,16 @@ export declare class ChatServiceClient {
1641
1766
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1642
1767
  * lists memberships in spaces that the authenticated user has access to.
1643
1768
  *
1644
- * Requires
1645
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1646
- * Supports
1647
- * [app
1769
+ * Supports the following types of
1770
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
1771
+ *
1772
+ * - [App
1648
1773
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1649
- * and [user
1650
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1774
+ *
1775
+ * - [User
1776
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1777
+ * You can authenticate and authorize this method with administrator
1778
+ * privileges by setting the `use_admin_access` field in the request.
1651
1779
  *
1652
1780
  * @param {Object} request
1653
1781
  * The request object that will be sent.
@@ -1728,8 +1856,8 @@ export declare class ChatServiceClient {
1728
1856
  *
1729
1857
  * Currently requires [user
1730
1858
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1731
- * @param {boolean} request.useAdminAccess
1732
- * When `true`, the method runs using the user's Google Workspace
1859
+ * @param {boolean} [request.useAdminAccess]
1860
+ * Optional. When `true`, the method runs using the user's Google Workspace
1733
1861
  * administrator privileges.
1734
1862
  *
1735
1863
  * The calling user must be a Google Workspace administrator with the
@@ -1841,8 +1969,8 @@ export declare class ChatServiceClient {
1841
1969
  *
1842
1970
  * Currently requires [user
1843
1971
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1844
- * @param {boolean} request.useAdminAccess
1845
- * When `true`, the method runs using the user's Google Workspace
1972
+ * @param {boolean} [request.useAdminAccess]
1973
+ * Optional. When `true`, the method runs using the user's Google Workspace
1846
1974
  * administrator privileges.
1847
1975
  *
1848
1976
  * The calling user must be a Google Workspace administrator with the
@@ -1949,8 +2077,8 @@ export declare class ChatServiceClient {
1949
2077
  *
1950
2078
  * Currently requires [user
1951
2079
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1952
- * @param {boolean} request.useAdminAccess
1953
- * When `true`, the method runs using the user's Google Workspace
2080
+ * @param {boolean} [request.useAdminAccess]
2081
+ * Optional. When `true`, the method runs using the user's Google Workspace
1954
2082
  * administrator privileges.
1955
2083
  *
1956
2084
  * The calling user must be a Google Workspace administrator with the
@@ -1981,16 +2109,14 @@ export declare class ChatServiceClient {
1981
2109
  * [List
1982
2110
  * spaces](https://developers.google.com/workspace/chat/list-spaces).
1983
2111
  *
1984
- * Requires
1985
- * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1986
- * Supports
1987
- * [app
2112
+ * Supports the following types of
2113
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
2114
+ *
2115
+ * - [App
1988
2116
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1989
- * and [user
1990
- * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1991
2117
  *
1992
- * Lists spaces visible to the caller or authenticated user. Group chats
1993
- * and DMs aren't listed until the first message is sent.
2118
+ * - [User
2119
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1994
2120
  *
1995
2121
  * To list all named spaces by Google Workspace organization, use the
1996
2122
  * [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
@@ -2162,7 +2288,9 @@ export declare class ChatServiceClient {
2162
2288
  listSpacesAsync(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
2163
2289
  /**
2164
2290
  * Returns a list of spaces in a Google Workspace organization based on an
2165
- * administrator's search. Requires [user
2291
+ * administrator's search.
2292
+ *
2293
+ * Requires [user
2166
2294
  * authentication with administrator
2167
2295
  * privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
2168
2296
  * In the request, set `use_admin_access` to `true`.
@@ -2596,6 +2724,7 @@ export declare class ChatServiceClient {
2596
2724
  * Lists reactions to a message. For an example, see
2597
2725
  * [List reactions for a
2598
2726
  * message](https://developers.google.com/workspace/chat/list-reactions).
2727
+ *
2599
2728
  * Requires [user
2600
2729
  * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
2601
2730
  *
@@ -2862,14 +2991,14 @@ export declare class ChatServiceClient {
2862
2991
  * where the events occurred.
2863
2992
  *
2864
2993
  * Format: `spaces/{space}`.
2865
- * @param {number} request.pageSize
2994
+ * @param {number} [request.pageSize]
2866
2995
  * Optional. The maximum number of space events returned. The service might
2867
2996
  * return fewer than this value.
2868
2997
  *
2869
2998
  * Negative values return an `INVALID_ARGUMENT` error.
2870
- * @param {string} request.pageToken
2871
- * A page token, received from a previous list space events call. Provide this
2872
- * to retrieve the subsequent page.
2999
+ * @param {string} [request.pageToken]
3000
+ * Optional. A page token, received from a previous list space events call.
3001
+ * Provide this to retrieve the subsequent page.
2873
3002
  *
2874
3003
  * When paginating, all other parameters provided to list space events must
2875
3004
  * match the call that provided the page token. Passing different values to
@@ -2956,14 +3085,14 @@ export declare class ChatServiceClient {
2956
3085
  * where the events occurred.
2957
3086
  *
2958
3087
  * Format: `spaces/{space}`.
2959
- * @param {number} request.pageSize
3088
+ * @param {number} [request.pageSize]
2960
3089
  * Optional. The maximum number of space events returned. The service might
2961
3090
  * return fewer than this value.
2962
3091
  *
2963
3092
  * Negative values return an `INVALID_ARGUMENT` error.
2964
- * @param {string} request.pageToken
2965
- * A page token, received from a previous list space events call. Provide this
2966
- * to retrieve the subsequent page.
3093
+ * @param {string} [request.pageToken]
3094
+ * Optional. A page token, received from a previous list space events call.
3095
+ * Provide this to retrieve the subsequent page.
2967
3096
  *
2968
3097
  * When paginating, all other parameters provided to list space events must
2969
3098
  * match the call that provided the page token. Passing different values to
@@ -3045,14 +3174,14 @@ export declare class ChatServiceClient {
3045
3174
  * where the events occurred.
3046
3175
  *
3047
3176
  * Format: `spaces/{space}`.
3048
- * @param {number} request.pageSize
3177
+ * @param {number} [request.pageSize]
3049
3178
  * Optional. The maximum number of space events returned. The service might
3050
3179
  * return fewer than this value.
3051
3180
  *
3052
3181
  * Negative values return an `INVALID_ARGUMENT` error.
3053
- * @param {string} request.pageToken
3054
- * A page token, received from a previous list space events call. Provide this
3055
- * to retrieve the subsequent page.
3182
+ * @param {string} [request.pageToken]
3183
+ * Optional. A page token, received from a previous list space events call.
3184
+ * Provide this to retrieve the subsequent page.
3056
3185
  *
3057
3186
  * When paginating, all other parameters provided to list space events must
3058
3187
  * match the call that provided the page token. Passing different values to