@google-apps/chat 0.2.0 → 0.3.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.
@@ -117,12 +117,12 @@ export declare class ChatServiceClient {
117
117
  getProjectId(): Promise<string>;
118
118
  getProjectId(callback: Callback<string, undefined, undefined>): void;
119
119
  /**
120
- * Creates a message in a Google Chat space. For an example, see [Create a
121
- * message](https://developers.google.com/chat/api/guides/v1/messages/create).
120
+ * Creates a message in a Google Chat space. For an example, see [Send a
121
+ * message](https://developers.google.com/workspace/chat/create-messages).
122
122
  *
123
123
  * Calling this method requires
124
- * [authentication](https://developers.google.com/chat/api/guides/auth) and
125
- * supports the following authentication types:
124
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize)
125
+ * and supports the following authentication types:
126
126
  *
127
127
  * - For text messages, user authentication or app authentication are
128
128
  * supported.
@@ -144,7 +144,7 @@ export declare class ChatServiceClient {
144
144
  * a message and specify a `threadKey` or the
145
145
  * {@link protos.google.chat.v1.Thread.name|thread.name}. For example usage, see [Start or
146
146
  * reply to a message
147
- * thread](https://developers.google.com/chat/api/guides/v1/messages/create#create-message-thread).
147
+ * thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
148
148
  * @param {string} [request.requestId]
149
149
  * Optional. A unique request ID for this message. Specifying an existing
150
150
  * request ID returns the message created with that ID instead of creating a
@@ -167,7 +167,7 @@ export declare class ChatServiceClient {
167
167
  * different messages.
168
168
  *
169
169
  * For details, see [Name a
170
- * message](https://developers.google.com/chat/api/guides/v1/messages/create#name_a_created_message).
170
+ * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
171
171
  * @param {object} [options]
172
172
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
173
173
  * @returns {Promise} - The promise which resolves to an array.
@@ -186,16 +186,16 @@ export declare class ChatServiceClient {
186
186
  createMessage(request: protos.google.chat.v1.ICreateMessageRequest, callback: Callback<protos.google.chat.v1.IMessage, protos.google.chat.v1.ICreateMessageRequest | null | undefined, {} | null | undefined>): void;
187
187
  /**
188
188
  * Returns details about a membership. For an example, see
189
- * [Get a
190
- * membership](https://developers.google.com/chat/api/guides/v1/members/get).
189
+ * [Get details about a user's or Google Chat app's
190
+ * membership](https://developers.google.com/workspace/chat/get-members).
191
191
  *
192
192
  * Requires
193
- * [authentication](https://developers.google.com/chat/api/guides/auth).
193
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
194
194
  * Supports
195
195
  * [app
196
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
196
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
197
197
  * and [user
198
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
198
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
199
199
  *
200
200
  * @param {Object} request
201
201
  * The request object that will be sent.
@@ -208,8 +208,8 @@ export declare class ChatServiceClient {
208
208
  * Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
209
209
  *
210
210
  * When [authenticated as a
211
- * user](https://developers.google.com/chat/api/guides/auth/users), you can
212
- * use the user's email as an alias for `{member}`. For example,
211
+ * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
212
+ * you can use the user's email as an alias for `{member}`. For example,
213
213
  * `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the
214
214
  * email of the Google Chat user.
215
215
  * @param {object} [options]
@@ -230,16 +230,16 @@ export declare class ChatServiceClient {
230
230
  getMembership(request: protos.google.chat.v1.IGetMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IGetMembershipRequest | null | undefined, {} | null | undefined>): void;
231
231
  /**
232
232
  * Returns details about a message.
233
- * For an example, see [Read a
234
- * message](https://developers.google.com/chat/api/guides/v1/messages/get).
233
+ * For an example, see [Get details about a
234
+ * message](https://developers.google.com/workspace/chat/get-messages).
235
235
  *
236
236
  * Requires
237
- * [authentication](https://developers.google.com/chat/api/guides/auth).
237
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
238
238
  * Supports
239
239
  * [app
240
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
240
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
241
241
  * and [user
242
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
242
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
243
243
  *
244
244
  * Note: Might return a message from a blocked member or space.
245
245
  *
@@ -253,7 +253,7 @@ export declare class ChatServiceClient {
253
253
  * If you've set a custom ID for your message, you can use the value from the
254
254
  * `clientAssignedMessageId` field for `{message}`. For details, see [Name a
255
255
  * message]
256
- * (https://developers.google.com/chat/api/guides/v1/messages/create#name_a_created_message).
256
+ * (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
257
257
  * @param {object} [options]
258
258
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
259
259
  * @returns {Promise} - The promise which resolves to an array.
@@ -276,15 +276,15 @@ export declare class ChatServiceClient {
276
276
  * method uses a `patch` request while the `update` method uses a `put`
277
277
  * request. We recommend using the `patch` method. For an example, see
278
278
  * [Update a
279
- * message](https://developers.google.com/chat/api/guides/v1/messages/update).
279
+ * message](https://developers.google.com/workspace/chat/update-messages).
280
280
  *
281
281
  * Requires
282
- * [authentication](https://developers.google.com/chat/api/guides/auth).
282
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
283
283
  * Supports
284
284
  * [app
285
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
285
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
286
286
  * and [user
287
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
287
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
288
288
  * When using app authentication, requests can only update messages
289
289
  * created by the calling Chat app.
290
290
  *
@@ -313,7 +313,7 @@ export declare class ChatServiceClient {
313
313
  * @param {boolean} [request.allowMissing]
314
314
  * Optional. If `true` and the message isn't found, a new message is created
315
315
  * and `updateMask` is ignored. The specified message ID must be
316
- * [client-assigned](https://developers.google.com/chat/api/guides/v1/messages/create#name_a_created_message)
316
+ * [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message)
317
317
  * or the request fails.
318
318
  * @param {object} [options]
319
319
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
@@ -334,15 +334,15 @@ export declare class ChatServiceClient {
334
334
  /**
335
335
  * Deletes a message.
336
336
  * For an example, see [Delete a
337
- * message](https://developers.google.com/chat/api/guides/v1/messages/delete).
337
+ * message](https://developers.google.com/workspace/chat/delete-messages).
338
338
  *
339
339
  * Requires
340
- * [authentication](https://developers.google.com/chat/api/guides/auth).
340
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
341
341
  * Supports
342
342
  * [app
343
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
343
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
344
344
  * and [user
345
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
345
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
346
346
  * When using app authentication, requests can only delete messages
347
347
  * created by the calling Chat app.
348
348
  *
@@ -356,15 +356,15 @@ export declare class ChatServiceClient {
356
356
  * If you've set a custom ID for your message, you can use the value from the
357
357
  * `clientAssignedMessageId` field for `{message}`. For details, see [Name a
358
358
  * message]
359
- * (https://developers.google.com/chat/api/guides/v1/messages/create#name_a_created_message).
359
+ * (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
360
360
  * @param {boolean} request.force
361
361
  * When `true`, deleting a message also deletes its threaded replies. When
362
362
  * `false`, if a message has threaded replies, deletion fails.
363
363
  *
364
364
  * Only applies when [authenticating as a
365
- * user](https://developers.google.com/chat/api/guides/auth/users). Has no
366
- * effect when [authenticating as a Chat app]
367
- * (https://developers.google.com/chat/api/guides/auth/service-accounts).
365
+ * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
366
+ * Has no effect when [authenticating as a Chat app]
367
+ * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
368
368
  * @param {object} [options]
369
369
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
370
370
  * @returns {Promise} - The promise which resolves to an array.
@@ -384,12 +384,12 @@ export declare class ChatServiceClient {
384
384
  /**
385
385
  * Gets the metadata of a message attachment. The attachment data is fetched
386
386
  * using the [media
387
- * API](https://developers.google.com/chat/api/reference/rest/v1/media/download).
387
+ * API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download).
388
388
  * For an example, see
389
- * [Get a message
390
- * attachment](https://developers.google.com/chat/api/guides/v1/media-and-attachments/get).
389
+ * [Get metadata about a message
390
+ * attachment](https://developers.google.com/workspace/chat/get-media-attachments).
391
391
  * Requires [app
392
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
392
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
393
393
  *
394
394
  * @param {Object} request
395
395
  * The request object that will be sent.
@@ -415,9 +415,9 @@ export declare class ChatServiceClient {
415
415
  /**
416
416
  * Uploads an attachment. For an example, see
417
417
  * [Upload media as a file
418
- * attachment](https://developers.google.com/chat/api/guides/v1/media-and-attachments/upload).
418
+ * attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
419
419
  * Requires user
420
- * [authentication](https://developers.google.com/chat/api/guides/auth/users).
420
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
421
421
  *
422
422
  * You can upload attachments up to 200 MB. Certain file types aren't
423
423
  * supported. For details, see [File types blocked by Google
@@ -448,15 +448,16 @@ export declare class ChatServiceClient {
448
448
  uploadAttachment(request: protos.google.chat.v1.IUploadAttachmentRequest, callback: Callback<protos.google.chat.v1.IUploadAttachmentResponse, protos.google.chat.v1.IUploadAttachmentRequest | null | undefined, {} | null | undefined>): void;
449
449
  /**
450
450
  * Returns details about a space. For an example, see
451
- * [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get).
451
+ * [Get details about a
452
+ * space](https://developers.google.com/workspace/chat/get-spaces).
452
453
  *
453
454
  * Requires
454
- * [authentication](https://developers.google.com/chat/api/guides/auth).
455
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
455
456
  * Supports
456
457
  * [app
457
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
458
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
458
459
  * and [user
459
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
460
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
460
461
  *
461
462
  * @param {Object} request
462
463
  * The request object that will be sent.
@@ -483,14 +484,14 @@ export declare class ChatServiceClient {
483
484
  /**
484
485
  * Creates a named space. Spaces grouped by topics aren't supported. For an
485
486
  * example, see [Create a
486
- * space](https://developers.google.com/chat/api/guides/v1/spaces/create).
487
+ * space](https://developers.google.com/workspace/chat/create-spaces).
487
488
  *
488
489
  * If you receive the error message `ALREADY_EXISTS` when creating
489
490
  * a space, try a different `displayName`. An existing space within
490
491
  * the Google Workspace organization might already use this display name.
491
492
  *
492
493
  * Requires [user
493
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
494
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
494
495
  *
495
496
  * @param {Object} request
496
497
  * The request object that will be sent.
@@ -531,8 +532,8 @@ export declare class ChatServiceClient {
531
532
  * Creates a space and adds specified users to it. The calling user is
532
533
  * automatically added to the space, and shouldn't be specified as a
533
534
  * membership in the request. For an example, see
534
- * [Set up a
535
- * space](https://developers.google.com/chat/api/guides/v1/spaces/set-up).
535
+ * [Set up a space with initial
536
+ * members](https://developers.google.com/workspace/chat/set-up-spaces).
536
537
  *
537
538
  * To specify the human members to add, add memberships with the appropriate
538
539
  * `member.name` in the `SetUpSpaceRequest`. To add a human user, use
@@ -556,8 +557,8 @@ export declare class ChatServiceClient {
556
557
  * can only use this method to set up a DM with the calling app. To add the
557
558
  * calling app as a member of a space or an existing DM between two human
558
559
  * users, see
559
- * [create a
560
- * membership](https://developers.google.com/chat/api/guides/v1/members/create).
560
+ * [Invite or add a user or app to a
561
+ * space](https://developers.google.com/workspace/chat/create-members).
561
562
  *
562
563
  * If a DM already exists between two users, even when one user blocks the
563
564
  * other at the time a request is made, then the existing DM is returned.
@@ -568,7 +569,7 @@ export declare class ChatServiceClient {
568
569
  * might already use this display name.
569
570
  *
570
571
  * Requires [user
571
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
572
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
572
573
  *
573
574
  * @param {Object} request
574
575
  * The request object that will be sent.
@@ -648,14 +649,14 @@ export declare class ChatServiceClient {
648
649
  /**
649
650
  * Updates a space. For an example, see
650
651
  * [Update a
651
- * space](https://developers.google.com/chat/api/guides/v1/spaces/update).
652
+ * space](https://developers.google.com/workspace/chat/update-spaces).
652
653
  *
653
654
  * If you're updating the `displayName` field and receive the error message
654
655
  * `ALREADY_EXISTS`, try a different display name.. An existing space within
655
656
  * the Google Workspace organization might already use this display name.
656
657
  *
657
658
  * Requires [user
658
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
659
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
659
660
  *
660
661
  * @param {Object} request
661
662
  * The request object that will be sent.
@@ -678,12 +679,13 @@ export declare class ChatServiceClient {
678
679
  * Google Workspace organization might already use this display name.)
679
680
  *
680
681
  * - `space_type` (Only supports changing a `GROUP_CHAT` space type to
681
- * `SPACE`. Include `display_name` together with `space_type` in the update
682
- * mask and ensure that the specified space has a non-empty display name and
683
- * the `SPACE` space type. Including the `space_type` mask and the `SPACE`
684
- * type in the specified space when updating the display name is optional if
685
- * the existing space already has the `SPACE` type. Trying to update the
686
- * space type in other ways results in an invalid argument error).
682
+ * `SPACE`. Include `display_name` together
683
+ * with `space_type` in the update mask and ensure that the specified space
684
+ * has a non-empty display name and the `SPACE` space type. Including the
685
+ * `space_type` mask and the `SPACE` type in the specified space when updating
686
+ * the display name is optional if the existing space already has the `SPACE`
687
+ * type. Trying to update the space type in other ways results in an invalid
688
+ * argument error).
687
689
  *
688
690
  * - `space_details`
689
691
  *
@@ -692,6 +694,7 @@ export declare class ChatServiceClient {
692
694
  * allows users to change their history
693
695
  * setting](https://support.google.com/a/answer/7664184).
694
696
  * Warning: mutually exclusive with all other field paths.)
697
+ *
695
698
  * - Developer Preview: `access_settings.audience` (Supports changing the
696
699
  * [access setting](https://support.google.com/chat/answer/11971020) of a
697
700
  * space. If no audience is specified in the access setting, the space's
@@ -718,9 +721,9 @@ export declare class ChatServiceClient {
718
721
  * that the space's child resources—like messages posted in the space and
719
722
  * memberships in the space—are also deleted. For an example, see
720
723
  * [Delete a
721
- * space](https://developers.google.com/chat/api/guides/v1/spaces/delete).
724
+ * space](https://developers.google.com/workspace/chat/delete-spaces).
722
725
  * Requires [user
723
- * authentication](https://developers.google.com/chat/api/guides/auth/users)
726
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
724
727
  * from a user who has permission to delete the space.
725
728
  *
726
729
  * @param {Object} request
@@ -747,11 +750,11 @@ export declare class ChatServiceClient {
747
750
  deleteSpace(request: protos.google.chat.v1.IDeleteSpaceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteSpaceRequest | null | undefined, {} | null | undefined>): void;
748
751
  /**
749
752
  * Completes the
750
- * [import process](https://developers.google.com/chat/api/guides/import-data)
753
+ * [import process](https://developers.google.com/workspace/chat/import-data)
751
754
  * for the specified space and makes it visible to users.
752
755
  * Requires app authentication and domain-wide delegation. For more
753
756
  * information, see [Authorize Google Chat apps to import
754
- * data](https://developers.google.com/chat/api/guides/authorize-import).
757
+ * data](https://developers.google.com/workspace/chat/authorize-import).
755
758
  *
756
759
  * @param {Object} request
757
760
  * The request object that will be sent.
@@ -782,19 +785,19 @@ export declare class ChatServiceClient {
782
785
  * [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message).
783
786
  *
784
787
  * With [user
785
- * authentication](https://developers.google.com/chat/api/guides/auth/users),
788
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
786
789
  * returns the direct message space between the specified user and the
787
790
  * authenticated user.
788
791
  *
789
792
  * With [app
790
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts),
793
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
791
794
  * returns the direct message space between the specified user and the calling
792
795
  * Chat app.
793
796
  *
794
797
  * Requires [user
795
- * authentication](https://developers.google.com/chat/api/guides/auth/users)
798
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
796
799
  * or [app
797
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
800
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
798
801
  *
799
802
  * @param {Object} request
800
803
  * The request object that will be sent.
@@ -808,8 +811,8 @@ export declare class ChatServiceClient {
808
811
  * in the Directory API. For example, if the People API profile ID is
809
812
  * `123456789`, you can find a direct message with that person by using
810
813
  * `users/123456789` as the `name`. When [authenticated as a
811
- * user](https://developers.google.com/chat/api/guides/auth/users), you can
812
- * use the email as an alias for `{user}`. For example,
814
+ * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
815
+ * you can use the email as an alias for `{user}`. For example,
813
816
  * `users/example@gmail.com` where `example@gmail.com` is the email of the
814
817
  * Google Chat user.
815
818
  * @param {object} [options]
@@ -831,13 +834,13 @@ export declare class ChatServiceClient {
831
834
  /**
832
835
  * Creates a human membership or app membership for the calling app. Creating
833
836
  * memberships for other apps isn't supported. For an example, see
834
- * [ Create a
835
- * membership](https://developers.google.com/chat/api/guides/v1/members/create).
837
+ * [Invite or add a user or a Google Chat app to a
838
+ * space](https://developers.google.com/workspace/chat/create-members).
836
839
  * When creating a membership, if the specified member has their auto-accept
837
840
  * policy turned off, then they're invited, and must accept the space
838
841
  * invitation before joining. Otherwise, creating a membership adds the member
839
842
  * directly to the specified space. Requires [user
840
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
843
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
841
844
  *
842
845
  * To specify the member to add, set the `membership.member.name` in the
843
846
  * `CreateMembershipRequest`:
@@ -894,13 +897,45 @@ export declare class ChatServiceClient {
894
897
  ]>;
895
898
  createMembership(request: protos.google.chat.v1.ICreateMembershipRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.ICreateMembershipRequest | null | undefined, {} | null | undefined>): void;
896
899
  createMembership(request: protos.google.chat.v1.ICreateMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.ICreateMembershipRequest | null | undefined, {} | null | undefined>): void;
900
+ /**
901
+ * Updates a membership. Requires [user
902
+ * authentication](https://developers.google.com/chat/api/guides/auth/users).
903
+ *
904
+ * @param {Object} request
905
+ * The request object that will be sent.
906
+ * @param {google.chat.v1.Membership} request.membership
907
+ * Required. The membership to update. Only fields specified by `update_mask`
908
+ * are updated.
909
+ * @param {google.protobuf.FieldMask} request.updateMask
910
+ * Required. The field paths to update. Separate multiple values with commas
911
+ * or use `*` to update all field paths.
912
+ *
913
+ * Currently supported field paths:
914
+ *
915
+ * - `role`
916
+ * @param {object} [options]
917
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
918
+ * @returns {Promise} - The promise which resolves to an array.
919
+ * The first element of the array is an object representing {@link protos.google.chat.v1.Membership|Membership}.
920
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
921
+ * for more details and examples.
922
+ * @example <caption>include:samples/generated/v1/chat_service.update_membership.js</caption>
923
+ * region_tag:chat_v1_generated_ChatService_UpdateMembership_async
924
+ */
925
+ updateMembership(request?: protos.google.chat.v1.IUpdateMembershipRequest, options?: CallOptions): Promise<[
926
+ protos.google.chat.v1.IMembership,
927
+ protos.google.chat.v1.IUpdateMembershipRequest | undefined,
928
+ {} | undefined
929
+ ]>;
930
+ updateMembership(request: protos.google.chat.v1.IUpdateMembershipRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IUpdateMembershipRequest | null | undefined, {} | null | undefined>): void;
931
+ updateMembership(request: protos.google.chat.v1.IUpdateMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IUpdateMembershipRequest | null | undefined, {} | null | undefined>): void;
897
932
  /**
898
933
  * Deletes a membership. For an example, see
899
- * [Delete a
900
- * membership](https://developers.google.com/chat/api/guides/v1/members/delete).
934
+ * [Remove a user or a Google Chat app from a
935
+ * space](https://developers.google.com/workspace/chat/delete-members).
901
936
  *
902
937
  * Requires [user
903
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
938
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
904
939
  *
905
940
  * @param {Object} request
906
941
  * The request object that will be sent.
@@ -936,12 +971,12 @@ export declare class ChatServiceClient {
936
971
  deleteMembership(request: protos.google.chat.v1.IDeleteMembershipRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IDeleteMembershipRequest | null | undefined, {} | null | undefined>): void;
937
972
  deleteMembership(request: protos.google.chat.v1.IDeleteMembershipRequest, callback: Callback<protos.google.chat.v1.IMembership, protos.google.chat.v1.IDeleteMembershipRequest | null | undefined, {} | null | undefined>): void;
938
973
  /**
939
- * Creates a reaction and adds it to a message. For an example, see
940
- * [Create a
941
- * reaction](https://developers.google.com/chat/api/guides/v1/reactions/create).
974
+ * Creates a reaction and adds it to a message. Only unicode emojis are
975
+ * supported. For an example, see
976
+ * [Add a reaction to a
977
+ * message](https://developers.google.com/workspace/chat/create-reactions).
942
978
  * Requires [user
943
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
944
- * Only unicode emoji are supported.
979
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
945
980
  *
946
981
  * @param {Object} request
947
982
  * The request object that will be sent.
@@ -968,11 +1003,12 @@ export declare class ChatServiceClient {
968
1003
  createReaction(request: protos.google.chat.v1.ICreateReactionRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IReaction, protos.google.chat.v1.ICreateReactionRequest | null | undefined, {} | null | undefined>): void;
969
1004
  createReaction(request: protos.google.chat.v1.ICreateReactionRequest, callback: Callback<protos.google.chat.v1.IReaction, protos.google.chat.v1.ICreateReactionRequest | null | undefined, {} | null | undefined>): void;
970
1005
  /**
971
- * Deletes a reaction to a message. For an example, see
1006
+ * Deletes a reaction to a message. Only unicode emojis are supported.
1007
+ * For an example, see
972
1008
  * [Delete a
973
- * reaction](https://developers.google.com/chat/api/guides/v1/reactions/delete).
1009
+ * reaction](https://developers.google.com/workspace/chat/delete-reactions).
974
1010
  * Requires [user
975
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1011
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
976
1012
  *
977
1013
  * @param {Object} request
978
1014
  * The request object that will be sent.
@@ -1001,7 +1037,7 @@ export declare class ChatServiceClient {
1001
1037
  * messages from blocked members and spaces. For an example, see
1002
1038
  * [List messages](/chat/api/guides/v1/messages/list).
1003
1039
  * Requires [user
1004
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1040
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1005
1041
  *
1006
1042
  * @param {Object} request
1007
1043
  * The request object that will be sent.
@@ -1015,8 +1051,8 @@ export declare class ChatServiceClient {
1015
1051
  *
1016
1052
  * If unspecified, at most 25 are returned.
1017
1053
  *
1018
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1019
- * automatically changed to 1,000.
1054
+ * The maximum value is 1000. If you use a value more than 1000, it's
1055
+ * automatically changed to 1000.
1020
1056
  *
1021
1057
  * Negative values return an `INVALID_ARGUMENT` error.
1022
1058
  * @param {string} request.pageToken
@@ -1113,8 +1149,8 @@ export declare class ChatServiceClient {
1113
1149
  *
1114
1150
  * If unspecified, at most 25 are returned.
1115
1151
  *
1116
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1117
- * automatically changed to 1,000.
1152
+ * The maximum value is 1000. If you use a value more than 1000, it's
1153
+ * automatically changed to 1000.
1118
1154
  *
1119
1155
  * Negative values return an `INVALID_ARGUMENT` error.
1120
1156
  * @param {string} request.pageToken
@@ -1206,8 +1242,8 @@ export declare class ChatServiceClient {
1206
1242
  *
1207
1243
  * If unspecified, at most 25 are returned.
1208
1244
  *
1209
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1210
- * automatically changed to 1,000.
1245
+ * The maximum value is 1000. If you use a value more than 1000, it's
1246
+ * automatically changed to 1000.
1211
1247
  *
1212
1248
  * Negative values return an `INVALID_ARGUMENT` error.
1213
1249
  * @param {string} request.pageToken
@@ -1285,25 +1321,25 @@ export declare class ChatServiceClient {
1285
1321
  */
1286
1322
  listMessagesAsync(request?: protos.google.chat.v1.IListMessagesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IMessage>;
1287
1323
  /**
1288
- * Lists memberships in a space. For an example, see [List
1289
- * memberships](https://developers.google.com/chat/api/guides/v1/members/list).
1290
- * Listing memberships with
1291
- * [app
1292
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
1324
+ * Lists memberships in a space. For an example, see [List users and Google
1325
+ * Chat apps in a
1326
+ * space](https://developers.google.com/workspace/chat/list-members). Listing
1327
+ * memberships with [app
1328
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1293
1329
  * lists memberships in spaces that the Chat app has
1294
1330
  * access to, but excludes Chat app memberships,
1295
1331
  * including its own. Listing memberships with
1296
1332
  * [User
1297
- * authentication](https://developers.google.com/chat/api/guides/auth/users)
1333
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
1298
1334
  * lists memberships in spaces that the authenticated user has access to.
1299
1335
  *
1300
1336
  * Requires
1301
- * [authentication](https://developers.google.com/chat/api/guides/auth).
1337
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1302
1338
  * Supports
1303
1339
  * [app
1304
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
1340
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1305
1341
  * and [user
1306
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1342
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1307
1343
  *
1308
1344
  * @param {Object} request
1309
1345
  * The request object that will be sent.
@@ -1318,8 +1354,8 @@ export declare class ChatServiceClient {
1318
1354
  *
1319
1355
  * If unspecified, at most 100 memberships are returned.
1320
1356
  *
1321
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1322
- * automatically changed to 1,000.
1357
+ * The maximum value is 1000. If you use a value more than 1000, it's
1358
+ * automatically changed to 1000.
1323
1359
  *
1324
1360
  * Negative values return an `INVALID_ARGUMENT` error.
1325
1361
  * @param {string} [request.pageToken]
@@ -1333,9 +1369,9 @@ export declare class ChatServiceClient {
1333
1369
  * Optional. A query filter.
1334
1370
  *
1335
1371
  * You can filter memberships by a member's role
1336
- * ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole))
1372
+ * ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
1337
1373
  * and type
1338
- * ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)).
1374
+ * ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
1339
1375
  *
1340
1376
  * To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
1341
1377
  *
@@ -1358,6 +1394,7 @@ export declare class ChatServiceClient {
1358
1394
  * role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
1359
1395
  * ```
1360
1396
  *
1397
+ *
1361
1398
  * Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
1362
1399
  * error.
1363
1400
  * @param {boolean} [request.showGroups]
@@ -1376,7 +1413,7 @@ export declare class ChatServiceClient {
1376
1413
  * that don't match the filter criteria aren't returned.
1377
1414
  *
1378
1415
  * Currently requires [user
1379
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1416
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1380
1417
  * @param {object} [options]
1381
1418
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1382
1419
  * @returns {Promise} - The promise which resolves to an array.
@@ -1411,8 +1448,8 @@ export declare class ChatServiceClient {
1411
1448
  *
1412
1449
  * If unspecified, at most 100 memberships are returned.
1413
1450
  *
1414
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1415
- * automatically changed to 1,000.
1451
+ * The maximum value is 1000. If you use a value more than 1000, it's
1452
+ * automatically changed to 1000.
1416
1453
  *
1417
1454
  * Negative values return an `INVALID_ARGUMENT` error.
1418
1455
  * @param {string} [request.pageToken]
@@ -1426,9 +1463,9 @@ export declare class ChatServiceClient {
1426
1463
  * Optional. A query filter.
1427
1464
  *
1428
1465
  * You can filter memberships by a member's role
1429
- * ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole))
1466
+ * ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
1430
1467
  * and type
1431
- * ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)).
1468
+ * ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
1432
1469
  *
1433
1470
  * To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
1434
1471
  *
@@ -1451,6 +1488,7 @@ export declare class ChatServiceClient {
1451
1488
  * role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
1452
1489
  * ```
1453
1490
  *
1491
+ *
1454
1492
  * Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
1455
1493
  * error.
1456
1494
  * @param {boolean} [request.showGroups]
@@ -1469,7 +1507,7 @@ export declare class ChatServiceClient {
1469
1507
  * that don't match the filter criteria aren't returned.
1470
1508
  *
1471
1509
  * Currently requires [user
1472
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1510
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1473
1511
  * @param {object} [options]
1474
1512
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1475
1513
  * @returns {Stream}
@@ -1499,8 +1537,8 @@ export declare class ChatServiceClient {
1499
1537
  *
1500
1538
  * If unspecified, at most 100 memberships are returned.
1501
1539
  *
1502
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1503
- * automatically changed to 1,000.
1540
+ * The maximum value is 1000. If you use a value more than 1000, it's
1541
+ * automatically changed to 1000.
1504
1542
  *
1505
1543
  * Negative values return an `INVALID_ARGUMENT` error.
1506
1544
  * @param {string} [request.pageToken]
@@ -1514,9 +1552,9 @@ export declare class ChatServiceClient {
1514
1552
  * Optional. A query filter.
1515
1553
  *
1516
1554
  * You can filter memberships by a member's role
1517
- * ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole))
1555
+ * ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
1518
1556
  * and type
1519
- * ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)).
1557
+ * ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
1520
1558
  *
1521
1559
  * To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
1522
1560
  *
@@ -1539,6 +1577,7 @@ export declare class ChatServiceClient {
1539
1577
  * role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
1540
1578
  * ```
1541
1579
  *
1580
+ *
1542
1581
  * Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
1543
1582
  * error.
1544
1583
  * @param {boolean} [request.showGroups]
@@ -1557,7 +1596,7 @@ export declare class ChatServiceClient {
1557
1596
  * that don't match the filter criteria aren't returned.
1558
1597
  *
1559
1598
  * Currently requires [user
1560
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1599
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1561
1600
  * @param {object} [options]
1562
1601
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1563
1602
  * @returns {Object}
@@ -1575,15 +1614,15 @@ export declare class ChatServiceClient {
1575
1614
  * Lists spaces the caller is a member of. Group chats and DMs aren't listed
1576
1615
  * until the first message is sent. For an example, see
1577
1616
  * [List
1578
- * spaces](https://developers.google.com/chat/api/guides/v1/spaces/list).
1617
+ * spaces](https://developers.google.com/workspace/chat/list-spaces).
1579
1618
  *
1580
1619
  * Requires
1581
- * [authentication](https://developers.google.com/chat/api/guides/auth).
1620
+ * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize).
1582
1621
  * Supports
1583
1622
  * [app
1584
- * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
1623
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
1585
1624
  * and [user
1586
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1625
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1587
1626
  *
1588
1627
  * Lists spaces visible to the caller or authenticated user. Group chats
1589
1628
  * and DMs aren't listed until the first message is sent.
@@ -1596,8 +1635,8 @@ export declare class ChatServiceClient {
1596
1635
  *
1597
1636
  * If unspecified, at most 100 spaces are returned.
1598
1637
  *
1599
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1600
- * automatically changed to 1,000.
1638
+ * The maximum value is 1000. If you use a value more than 1000, it's
1639
+ * automatically changed to 1000.
1601
1640
  *
1602
1641
  * Negative values return an `INVALID_ARGUMENT` error.
1603
1642
  * @param {string} [request.pageToken]
@@ -1610,7 +1649,7 @@ export declare class ChatServiceClient {
1610
1649
  * Optional. A query filter.
1611
1650
  *
1612
1651
  * You can filter spaces by the space type
1613
- * ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
1652
+ * ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
1614
1653
  *
1615
1654
  * To filter by space type, you must specify valid enum value, such as
1616
1655
  * `SPACE` or `GROUP_CHAT` (the `space_type` can't be
@@ -1655,8 +1694,8 @@ export declare class ChatServiceClient {
1655
1694
  *
1656
1695
  * If unspecified, at most 100 spaces are returned.
1657
1696
  *
1658
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1659
- * automatically changed to 1,000.
1697
+ * The maximum value is 1000. If you use a value more than 1000, it's
1698
+ * automatically changed to 1000.
1660
1699
  *
1661
1700
  * Negative values return an `INVALID_ARGUMENT` error.
1662
1701
  * @param {string} [request.pageToken]
@@ -1669,7 +1708,7 @@ export declare class ChatServiceClient {
1669
1708
  * Optional. A query filter.
1670
1709
  *
1671
1710
  * You can filter spaces by the space type
1672
- * ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
1711
+ * ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
1673
1712
  *
1674
1713
  * To filter by space type, you must specify valid enum value, such as
1675
1714
  * `SPACE` or `GROUP_CHAT` (the `space_type` can't be
@@ -1709,8 +1748,8 @@ export declare class ChatServiceClient {
1709
1748
  *
1710
1749
  * If unspecified, at most 100 spaces are returned.
1711
1750
  *
1712
- * The maximum value is 1,000. If you use a value more than 1,000, it's
1713
- * automatically changed to 1,000.
1751
+ * The maximum value is 1000. If you use a value more than 1000, it's
1752
+ * automatically changed to 1000.
1714
1753
  *
1715
1754
  * Negative values return an `INVALID_ARGUMENT` error.
1716
1755
  * @param {string} [request.pageToken]
@@ -1723,7 +1762,7 @@ export declare class ChatServiceClient {
1723
1762
  * Optional. A query filter.
1724
1763
  *
1725
1764
  * You can filter spaces by the space type
1726
- * ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
1765
+ * ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
1727
1766
  *
1728
1767
  * To filter by space type, you must specify valid enum value, such as
1729
1768
  * `SPACE` or `GROUP_CHAT` (the `space_type` can't be
@@ -1754,10 +1793,10 @@ export declare class ChatServiceClient {
1754
1793
  listSpacesAsync(request?: protos.google.chat.v1.IListSpacesRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.ISpace>;
1755
1794
  /**
1756
1795
  * Lists reactions to a message. For an example, see
1757
- * [List
1758
- * reactions](https://developers.google.com/chat/api/guides/v1/reactions/list).
1796
+ * [List reactions for a
1797
+ * message](https://developers.google.com/workspace/chat/list-reactions).
1759
1798
  * Requires [user
1760
- * authentication](https://developers.google.com/chat/api/guides/auth/users).
1799
+ * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
1761
1800
  *
1762
1801
  * @param {Object} request
1763
1802
  * The request object that will be sent.
@@ -1781,9 +1820,9 @@ export declare class ChatServiceClient {
1781
1820
  * Optional. A query filter.
1782
1821
  *
1783
1822
  * You can filter reactions by
1784
- * [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji)
1823
+ * [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
1785
1824
  * (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
1786
- * [user](https://developers.google.com/chat/api/reference/rest/v1/User)
1825
+ * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
1787
1826
  * (`user.name`).
1788
1827
  *
1789
1828
  * To filter reactions for multiple emojis or users, join similar fields
@@ -1865,9 +1904,9 @@ export declare class ChatServiceClient {
1865
1904
  * Optional. A query filter.
1866
1905
  *
1867
1906
  * You can filter reactions by
1868
- * [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji)
1907
+ * [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
1869
1908
  * (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
1870
- * [user](https://developers.google.com/chat/api/reference/rest/v1/User)
1909
+ * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
1871
1910
  * (`user.name`).
1872
1911
  *
1873
1912
  * To filter reactions for multiple emojis or users, join similar fields
@@ -1944,9 +1983,9 @@ export declare class ChatServiceClient {
1944
1983
  * Optional. A query filter.
1945
1984
  *
1946
1985
  * You can filter reactions by
1947
- * [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji)
1986
+ * [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
1948
1987
  * (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
1949
- * [user](https://developers.google.com/chat/api/reference/rest/v1/User)
1988
+ * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
1950
1989
  * (`user.name`).
1951
1990
  *
1952
1991
  * To filter reactions for multiple emojis or users, join similar fields