@maxim_mazurok/gapi.client.chat-v1 0.0.20230514 → 0.0.20230516

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.
Files changed (4) hide show
  1. package/index.d.ts +181 -173
  2. package/package.json +1 -1
  3. package/readme.md +3 -3
  4. package/tests.ts +9 -9
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://chat.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230514
12
+ // Revision: 20230516
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -37,7 +37,7 @@ declare namespace gapi.client {
37
37
  /** Input only. The type of Chat app response. */
38
38
  type?:
39
39
  string;
40
- /** Input only. URL for users to auth or config. (Only for REQUEST_CONFIG response types.) */
40
+ /** Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.) */
41
41
  url?:
42
42
  string;
43
43
  }
@@ -67,7 +67,7 @@ declare namespace gapi.client {
67
67
  UserMentionMetadata;
68
68
  }
69
69
  interface Attachment {
70
- /** A reference to the attachment data. This is used with the media API to download the attachment data. */
70
+ /** A reference to the attachment data. This field is used with the media API to download the attachment data. */
71
71
  attachmentDataRef?:
72
72
  AttachmentDataRef;
73
73
  /** The original file name for the content, not the full path. */
@@ -76,19 +76,19 @@ declare namespace gapi.client {
76
76
  /** The content type (MIME type) of the file. */
77
77
  contentType?:
78
78
  string;
79
- /** Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps should not use this URL to download attachment content. */
79
+ /** Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content. */
80
80
  downloadUri?:
81
81
  string;
82
- /** A reference to the drive attachment. This is used with the Drive API. */
82
+ /** A reference to the drive attachment. This field is used with the Drive API. */
83
83
  driveDataRef?:
84
84
  DriveDataRef;
85
- /** Resource name of the attachment, in the form "spaces/*‍/messages/*‍/attachments/*". */
85
+ /** Resource name of the attachment, in the form `spaces/*‍/messages/*‍/attachments/*`. */
86
86
  name?:
87
87
  string;
88
88
  /** The source of the attachment. */
89
89
  source?:
90
90
  string;
91
- /** Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps should not use this URL to download attachment content. */
91
+ /** Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content. */
92
92
  thumbnailUri?:
93
93
  string;
94
94
  }
@@ -99,15 +99,15 @@ declare namespace gapi.client {
99
99
  */
100
100
  attachmentUploadToken?:
101
101
  string;
102
- /** The resource name of the attachment data. This is used with the media API to download the attachment data. */
102
+ /** The resource name of the attachment data. This field is used with the media API to download the attachment data. */
103
103
  resourceName?:
104
104
  string;
105
105
  }
106
106
  interface Button {
107
- /** A button with image and onclick action. */
107
+ /** A button with image and `onclick` action. */
108
108
  imageButton?:
109
109
  ImageButton;
110
- /** A button with text and onclick action. */
110
+ /** A button with text and `onclick` action. */
111
111
  textButton?:
112
112
  TextButton;
113
113
  }
@@ -134,7 +134,7 @@ declare namespace gapi.client {
134
134
  OnClick;
135
135
  }
136
136
  interface CardHeader {
137
- /** The image's type (e.g. square border or circular border). */
137
+ /** The image's type (for example, square border or circular border). */
138
138
  imageStyle?:
139
139
  string;
140
140
  /** The URL of the image in the card header. */
@@ -144,7 +144,7 @@ declare namespace gapi.client {
144
144
  subtitle?:
145
145
  string;
146
146
  /**
147
- * The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each will take up 1 line. If only the title is specified, it will take up both
147
+ * The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both
148
148
  * lines.
149
149
  */
150
150
  title?:
@@ -304,7 +304,7 @@ declare namespace gapi.client {
304
304
  User;
305
305
  }
306
306
  interface Dialog {
307
- /** Input only. Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. */
307
+ /** Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`. */
308
308
  body?:
309
309
  GoogleAppsCardV1Card;
310
310
  }
@@ -320,7 +320,7 @@ declare namespace gapi.client {
320
320
  Dialog;
321
321
  }
322
322
  interface DriveDataRef {
323
- /** The id for the drive file, for use with the Drive API. */
323
+ /** The ID for the drive file. Use with the Drive API. */
324
324
  driveFileId?:
325
325
  string;
326
326
  }
@@ -345,8 +345,8 @@ declare namespace gapi.client {
345
345
  }
346
346
  interface FormAction {
347
347
  /**
348
- * The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. The same
349
- * method name can be used for several elements that trigger a common behavior if desired.
348
+ * The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can
349
+ * use the same method name for several elements that trigger a common behavior.
350
350
  */
351
351
  actionMethodName?:
352
352
  string;
@@ -362,11 +362,11 @@ declare namespace gapi.client {
362
362
  function?:
363
363
  string;
364
364
  /**
365
- * Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking button
366
- * on a card message. If unspecified, the app responds by executing an `action` - like opening a link or running a function - as normal. By specifying an `interaction`, the app can
365
+ * Optional. Required when opening a [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in response to an interaction with a user, such as a user clicking a
366
+ * button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can
367
367
  * respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs). When
368
- * specified, a loading indicator is not shown. Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown
369
- * in the client.
368
+ * specified, a loading indicator isn't shown. Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in
369
+ * the client.
370
370
  */
371
371
  interaction?:
372
372
  string;
@@ -378,12 +378,12 @@ declare namespace gapi.client {
378
378
  GoogleAppsCardV1ActionParameter[];
379
379
  /**
380
380
  * Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while
381
- * the action is being processed, set [LoadIndicator](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card
381
+ * the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card
382
382
  * messages](https://developers.google.com/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's
383
- * [ResponseType](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same
383
+ * [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same
384
384
  * [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared
385
385
  * when the action is triggered. To prevent the user from making changes while the action is being processed, set
386
- * [LoadIndicator](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
386
+ * [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
387
387
  */
388
388
  persistValues?:
389
389
  boolean;
@@ -409,17 +409,17 @@ declare namespace gapi.client {
409
409
  }
410
410
  interface GoogleAppsCardV1Button {
411
411
  /**
412
- * The alternative text used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a
413
- * new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat".
412
+ * The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write:
413
+ * "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat".
414
414
  */
415
415
  altText?:
416
416
  string;
417
417
  /**
418
- * If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background will
419
- * likely result in white text. If unset, the image background is white and the font color is blue. For red, green and blue, the value of each field is a `float` number that can be
420
- * expressed in either of two ways: as a number between 0 and 255 divided by 255 (153/255) or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255
421
- * represent the full presence of that color on the RGB scale. Optionally set alpha, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) +
422
- * (1.0 - alpha) * (background color) ``` For alpha, a value of 1 corresponds with a solid color, and a value of 0 corresponds with a completely transparent color. For example, the
418
+ * If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely
419
+ * results in white text. If unset, the image background is white and the font color is blue. For red, green, and blue, the value of each field is a `float` number that you can express
420
+ * in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent
421
+ * the full presence of that color on the RGB scale. Optionally set `alpha`, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) + (1.0 -
422
+ * alpha) * (background color) ``` For `alpha`, a value of `1` corresponds with a solid color, and a value of `0` corresponds with a completely transparent color. For example, the
423
423
  * following color represents a half transparent red: ``` "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 } ```
424
424
  */
425
425
  color?:
@@ -430,7 +430,7 @@ declare namespace gapi.client {
430
430
  /** The icon image. If both `icon` and `text` are set, then the icon appears before the text. */
431
431
  icon?:
432
432
  GoogleAppsCardV1Icon;
433
- /** Required. The action to perform when the button is clicked, such as opening a hyperlink or running a custom function. */
433
+ /** Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function. */
434
434
  onClick?:
435
435
  GoogleAppsCardV1OnClick;
436
436
  /** The text displayed inside the button. */
@@ -444,10 +444,10 @@ declare namespace gapi.client {
444
444
  }
445
445
  interface GoogleAppsCardV1Card {
446
446
  /**
447
- * The card's actions. Actions are added to the card's toolbar menu. Because Chat app cards have no toolbar, `cardActions[]` is not supported by Chat apps. For example, the following
448
- * JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView",
449
- * "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url":
450
- * "https://example.com/feedback" } } } ] ```
447
+ * The card's actions. Actions are added to the card's toolbar menu. Because Chat app cards have no toolbar, `cardActions[]` isn't supported by Chat apps. For example, the following
448
+ * JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName":
449
+ * "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": {
450
+ * "url": "https://example.com/feedback" } } } ] ```
451
451
  */
452
452
  cardActions?:
453
453
  GoogleAppsCardV1CardAction[];
@@ -489,7 +489,7 @@ declare namespace gapi.client {
489
489
  /** The primary button of the fixed footer. The button must be a text button with text and color set. */
490
490
  primaryButton?:
491
491
  GoogleAppsCardV1Button;
492
- /** The secondary button of the fixed footer. The button must be a text button with text and color set. `primaryButton` must be set if `secondaryButton` is set. */
492
+ /** The secondary button of the fixed footer. The button must be a text button with text and color set. If `secondaryButton` is set, you must also set `primaryButton`. */
493
493
  secondaryButton?:
494
494
  GoogleAppsCardV1Button;
495
495
  /** A list of widgets included in the card footer. Primary button and secondary button are rendered below these widgets. */
@@ -497,7 +497,7 @@ declare namespace gapi.client {
497
497
  GoogleAppsCardV1FooterWidget[];
498
498
  }
499
499
  interface GoogleAppsCardV1CardHeader {
500
- /** The alternative text of this image which is used for accessibility. */
500
+ /** The alternative text of this image that's used for accessibility. */
501
501
  imageAltText?:
502
502
  string;
503
503
  /** The shape used to crop the image. */
@@ -573,7 +573,7 @@ declare namespace gapi.client {
573
573
  /** The text that appears below `text`. Always truncates. */
574
574
  bottomLabel?:
575
575
  string;
576
- /** A button that can be clicked to trigger an action. */
576
+ /** A button that a user can click to trigger an action. */
577
577
  button?:
578
578
  GoogleAppsCardV1Button;
579
579
  /**
@@ -585,18 +585,19 @@ declare namespace gapi.client {
585
585
  /** Deprecated in favor of `startIcon`. */
586
586
  icon?:
587
587
  GoogleAppsCardV1Icon;
588
- /** When users click on `topLabel` or `bottomLabel`, this action triggers. */
588
+ /** This action is triggered when users click `topLabel` or `bottomLabel`. */
589
589
  onClick?:
590
590
  GoogleAppsCardV1OnClick;
591
591
  /** The icon displayed in front of the text. */
592
592
  startIcon?:
593
593
  GoogleAppsCardV1Icon;
594
- /** A switch widget can be clicked to change its state and trigger an action. */
594
+ /** A switch widget that a user can click to change its state and trigger an action. */
595
595
  switchControl?:
596
596
  GoogleAppsCardV1SwitchControl;
597
597
  /**
598
- * Required. The primary text. Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace
599
- * Add-ons.
598
+ * Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat
599
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
600
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
600
601
  */
601
602
  text?:
602
603
  string;
@@ -648,7 +649,7 @@ declare namespace gapi.client {
648
649
  string;
649
650
  }
650
651
  interface GoogleAppsCardV1GridItem {
651
- /** A user-specified identifier for this grid item. This identifier is returned in the parent Grid's onClick callback parameters. */
652
+ /** A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters. */
652
653
  id?:
653
654
  string;
654
655
  /** The image that displays in the grid item. */
@@ -666,9 +667,9 @@ declare namespace gapi.client {
666
667
  }
667
668
  interface GoogleAppsCardV1Icon {
668
669
  /**
669
- * Optional. A description of the icon used for accessibility. If unspecified, the default value "Button" is provided. As a best practice, you should set a helpful description for what
670
+ * Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what
670
671
  * the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at
671
- * https://developers.google.com/chat`. If the icon is set in a Button, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets
672
+ * https://developers.google.com/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets
672
673
  * `text`, the icon's `altText` is ignored.
673
674
  */
674
675
  altText?:
@@ -690,13 +691,13 @@ declare namespace gapi.client {
690
691
  string;
691
692
  }
692
693
  interface GoogleAppsCardV1Image {
693
- /** The alternative text of this image, used for accessibility. */
694
+ /** The alternative text of this image that's used for accessibility. */
694
695
  altText?:
695
696
  string;
696
- /** The `https` URL that hosts the image. For example: ``` https://developers.google.com/chat/images/quickstart-app-avatar.png ``` */
697
+ /** The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/chat/images/quickstart-app-avatar.png ``` */
697
698
  imageUrl?:
698
699
  string;
699
- /** When a user clicks on the image, the click triggers this action. */
700
+ /** When a user clicks the image, the click triggers this action. */
700
701
  onClick?:
701
702
  GoogleAppsCardV1OnClick;
702
703
  }
@@ -716,8 +717,8 @@ declare namespace gapi.client {
716
717
  }
717
718
  interface GoogleAppsCardV1ImageCropStyle {
718
719
  /**
719
- * The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16 by 9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio":
720
- * 16/9 } ```
720
+ * The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9
721
+ * } ```
721
722
  */
722
723
  aspectRatio?:
723
724
  number;
@@ -761,8 +762,9 @@ declare namespace gapi.client {
761
762
  collapsible?:
762
763
  boolean;
763
764
  /**
764
- * Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting
765
- * text in Google Workspace Add-ons.
765
+ * Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat
766
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
767
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
766
768
  */
767
769
  header?:
768
770
  string;
@@ -773,7 +775,7 @@ declare namespace gapi.client {
773
775
  */
774
776
  uncollapsibleWidgetsCount?:
775
777
  number;
776
- /** All the widgets in the section. Must contain at least 1 widget. */
778
+ /** All the widgets in the section. Must contain at least one widget. */
777
779
  widgets?:
778
780
  GoogleAppsCardV1Widget[];
779
781
  }
@@ -824,7 +826,7 @@ declare namespace gapi.client {
824
826
  string;
825
827
  }
826
828
  interface GoogleAppsCardV1SuggestionItem {
827
- /** The value of a suggested input to a text input field. This is equivalent to what users would enter themselves. */
829
+ /** The value of a suggested input to a text input field. This is equivalent to what users enter themselves. */
828
830
  text?:
829
831
  string;
830
832
  }
@@ -871,16 +873,16 @@ declare namespace gapi.client {
871
873
  string;
872
874
  /**
873
875
  * Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the
874
- * users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing "Jav", the list of suggestions
875
- * filters to show just Java and JavaScript. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter
876
- * "javascript" and others "java script". Suggesting "JavaScript" can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it
877
- * is set to `MULTIPLE_LINE`.
876
+ * users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions
877
+ * filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter
878
+ * `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if
879
+ * it's set to `MULTIPLE_LINE`.
878
880
  */
879
881
  initialSuggestions?:
880
882
  GoogleAppsCardV1Suggestions;
881
883
  /**
882
884
  * The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking
883
- * someone's name, but specifically need their surname, write "surname" instead of "name". Required if `hintText` is unspecified. Otherwise, optional.
885
+ * someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.
884
886
  */
885
887
  label?:
886
888
  string;
@@ -891,8 +893,8 @@ declare namespace gapi.client {
891
893
  name?:
892
894
  string;
893
895
  /**
894
- * What to do when a change occurs in the text input field. Examples of changes include a user adding to the field, or deleting text. Examples of actions to take include running a
895
- * custom function or opening a [dialog](https://developers.google.com/chat/how-tos/dialogs) in Google Chat.
896
+ * What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or
897
+ * opening a [dialog](https://developers.google.com/chat/how-tos/dialogs) in Google Chat.
896
898
  */
897
899
  onChangeAction?:
898
900
  GoogleAppsCardV1Action;
@@ -978,8 +980,10 @@ declare namespace gapi.client {
978
980
  textInput?:
979
981
  GoogleAppsCardV1TextInput;
980
982
  /**
981
- * Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google
982
- * Workspace Add-ons. For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
983
+ * Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat
984
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
985
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": "
986
+ * *bold text*" } ```
983
987
  */
984
988
  textParagraph?:
985
989
  GoogleAppsCardV1TextParagraph;
@@ -1009,29 +1013,29 @@ declare namespace gapi.client {
1009
1013
  }
1010
1014
  interface Image {
1011
1015
  /**
1012
- * The aspect ratio of this image (width/height). This field allows clients to reserve the right height for the image while waiting for it to load. It's not meant to override the
1013
- * native aspect ratio of the image. If unset, the server fills it by prefetching the image.
1016
+ * The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in
1017
+ * aspect ratio of the image. If unset, the server fills it by prefetching the image.
1014
1018
  */
1015
1019
  aspectRatio?:
1016
1020
  number;
1017
1021
  /** The URL of the image. */
1018
1022
  imageUrl?:
1019
1023
  string;
1020
- /** The onclick action. */
1024
+ /** The `onclick` action. */
1021
1025
  onClick?:
1022
1026
  OnClick;
1023
1027
  }
1024
1028
  interface ImageButton {
1025
- /** The icon specified by an enum that indices to an icon provided by Chat API. */
1029
+ /** The icon specified by an `enum` that indices to an icon provided by Chat API. */
1026
1030
  icon?:
1027
1031
  string;
1028
1032
  /** The icon specified by a URL. */
1029
1033
  iconUrl?:
1030
1034
  string;
1031
- /** The name of this image_button which will be used for accessibility. Default value will be provided if developers don't specify. */
1035
+ /** The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified. */
1032
1036
  name?:
1033
1037
  string;
1034
- /** The onclick action. */
1038
+ /** The `onclick` action. */
1035
1039
  onClick?:
1036
1040
  OnClick;
1037
1041
  }
@@ -1051,8 +1055,9 @@ declare namespace gapi.client {
1051
1055
  }
1052
1056
  interface KeyValue {
1053
1057
  /**
1054
- * The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace
1055
- * Add-ons.
1058
+ * The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat
1059
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
1060
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
1056
1061
  */
1057
1062
  bottomLabel?:
1058
1063
  string;
@@ -1060,26 +1065,28 @@ declare namespace gapi.client {
1060
1065
  button?:
1061
1066
  Button;
1062
1067
  /**
1063
- * The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in
1064
- * Google Workspace Add-ons.
1068
+ * The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat
1069
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
1070
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
1065
1071
  */
1066
1072
  content?:
1067
1073
  string;
1068
1074
  /** If the content should be multiline. */
1069
1075
  contentMultiline?:
1070
1076
  boolean;
1071
- /** An enum value that will be replaced by the Chat API with the corresponding icon image. */
1077
+ /** An enum value that's replaced by the Chat API with the corresponding icon image. */
1072
1078
  icon?:
1073
1079
  string;
1074
1080
  /** The icon specified by a URL. */
1075
1081
  iconUrl?:
1076
1082
  string;
1077
- /** The onclick action. Only the top label, bottom label and content region are clickable. */
1083
+ /** The `onclick` action. Only the top label, bottom label, and content region are clickable. */
1078
1084
  onClick?:
1079
1085
  OnClick;
1080
1086
  /**
1081
- * The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace
1082
- * Add-ons.
1087
+ * The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat
1088
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
1089
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
1083
1090
  */
1084
1091
  topLabel?:
1085
1092
  string;
@@ -1088,7 +1095,7 @@ declare namespace gapi.client {
1088
1095
  /** List of memberships in the requested (or first) page. */
1089
1096
  memberships?:
1090
1097
  Membership[];
1091
- /** A token that can be sent as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
1098
+ /** A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
1092
1099
  nextPageToken?:
1093
1100
  string;
1094
1101
  }
@@ -1096,12 +1103,12 @@ declare namespace gapi.client {
1096
1103
  /** List of messages. */
1097
1104
  messages?:
1098
1105
  Message[];
1099
- /** A token that can be sent as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
1106
+ /** You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
1100
1107
  nextPageToken?:
1101
1108
  string;
1102
1109
  }
1103
1110
  interface ListReactionsResponse {
1104
- /** Continuation token to retrieve the next page of results. It will be empty for the last page of results. */
1111
+ /** Continuation token to retrieve the next page of results. It's empty for the last page of results. */
1105
1112
  nextPageToken?:
1106
1113
  string;
1107
1114
  /** List of reactions in the requested (or first) page. */
@@ -1109,7 +1116,7 @@ declare namespace gapi.client {
1109
1116
  Reaction[];
1110
1117
  }
1111
1118
  interface ListSpacesResponse {
1112
- /** A token that can be sent as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
1119
+ /** You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
1113
1120
  nextPageToken?:
1114
1121
  string;
1115
1122
  /** List of spaces in the requested (or first) page. */
@@ -1117,7 +1124,7 @@ declare namespace gapi.client {
1117
1124
  Space[];
1118
1125
  }
1119
1126
  interface MatchedUrl {
1120
- /** Output only. The url that was matched. */
1127
+ /** Output only. The URL that was matched. */
1121
1128
  url?:
1122
1129
  string;
1123
1130
  }
@@ -1136,7 +1143,7 @@ declare namespace gapi.client {
1136
1143
  */
1137
1144
  member?:
1138
1145
  User;
1139
- /** Resource name of the membership, assigned by the server. Format: spaces/{space}/members/{member} */
1146
+ /** Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}` */
1140
1147
  name?:
1141
1148
  string;
1142
1149
  /** Output only. User's role within a Chat space, which determines their permitted actions in the space. */
@@ -1160,7 +1167,7 @@ declare namespace gapi.client {
1160
1167
  attachment?:
1161
1168
  Attachment[];
1162
1169
  /**
1163
- * Deprecated: Use `cards_v2` instead. Rich, formatted and interactive cards that can be used to display UI elements such as: formatted texts, buttons, clickable images. Cards are
1170
+ * Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are
1164
1171
  * normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.
1165
1172
  */
1166
1173
  cards?:
@@ -1181,7 +1188,7 @@ declare namespace gapi.client {
1181
1188
  */
1182
1189
  clientAssignedMessageId?:
1183
1190
  string;
1184
- /** Output only. The time at which the message was created in Google Chat server. */
1191
+ /** Output only. The time at which the message was created in Google Chat. */
1185
1192
  createTime?:
1186
1193
  string;
1187
1194
  /**
@@ -1196,14 +1203,14 @@ declare namespace gapi.client {
1196
1203
  /** Output only. The list of emoji reaction summaries on the message. [Developer Preview](https://developers.google.com/workspace/preview). */
1197
1204
  emojiReactionSummaries?:
1198
1205
  EmojiReactionSummary[];
1199
- /** A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). */
1206
+ /** A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. */
1200
1207
  fallbackText?:
1201
1208
  string;
1202
1209
  /** Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. */
1203
1210
  lastUpdateTime?:
1204
1211
  string;
1205
1212
  /**
1206
- * Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview
1213
+ * Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview
1207
1214
  * links](https://developers.google.com/chat/how-tos/preview-links).
1208
1215
  */
1209
1216
  matchedUrl?:
@@ -1243,10 +1250,10 @@ declare namespace gapi.client {
1243
1250
  boolean;
1244
1251
  }
1245
1252
  interface OnClick {
1246
- /** A form action will be triggered by this onclick if specified. */
1253
+ /** A form action is triggered by this `onclick` action if specified. */
1247
1254
  action?:
1248
1255
  FormAction;
1249
- /** This onclick triggers an open link action if specified. */
1256
+ /** This `onclick` action triggers an open link action if specified. */
1250
1257
  openLink?:
1251
1258
  OpenLink;
1252
1259
  }
@@ -1259,7 +1266,7 @@ declare namespace gapi.client {
1259
1266
  /** The emoji used in the reaction. */
1260
1267
  emoji?:
1261
1268
  Emoji;
1262
- /** The resource name of the reaction. Format: spaces/{space}/messages/{message}/reactions/{reaction} */
1269
+ /** The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}` */
1263
1270
  name?:
1264
1271
  string;
1265
1272
  /** Output only. The user who created the reaction. */
@@ -1268,12 +1275,13 @@ declare namespace gapi.client {
1268
1275
  }
1269
1276
  interface Section {
1270
1277
  /**
1271
- * The header of the section. Formatted text is supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace
1272
- * Add-ons.
1278
+ * The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat
1279
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
1280
+ * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
1273
1281
  */
1274
1282
  header?:
1275
1283
  string;
1276
- /** A section must contain at least 1 widget. */
1284
+ /** A section must contain at least one widget. */
1277
1285
  widgets?:
1278
1286
  WidgetMarkup[];
1279
1287
  }
@@ -1304,7 +1312,7 @@ declare namespace gapi.client {
1304
1312
  Space;
1305
1313
  }
1306
1314
  interface SlashCommand {
1307
- /** The id of the slash command invoked. */
1315
+ /** The ID of the slash command invoked. */
1308
1316
  commandId?:
1309
1317
  string;
1310
1318
  }
@@ -1312,13 +1320,13 @@ declare namespace gapi.client {
1312
1320
  /** The Chat app whose command was invoked. */
1313
1321
  bot?:
1314
1322
  User;
1315
- /** The command id of the invoked slash command. */
1323
+ /** The command ID of the invoked slash command. */
1316
1324
  commandId?:
1317
1325
  string;
1318
1326
  /** The name of the invoked slash command. */
1319
1327
  commandName?:
1320
1328
  string;
1321
- /** Indicating whether the slash command is for a dialog. */
1329
+ /** Indicates whether the slash command is for a dialog. */
1322
1330
  triggersDialog?:
1323
1331
  boolean;
1324
1332
  /** The type of slash command. */
@@ -1333,12 +1341,12 @@ declare namespace gapi.client {
1333
1341
  adminInstalled?:
1334
1342
  boolean;
1335
1343
  /**
1336
- * The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). For direct messages, this field may be empty.
1344
+ * The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). For direct messages, this field might be empty.
1337
1345
  * Supports up to 128 characters.
1338
1346
  */
1339
1347
  displayName?:
1340
1348
  string;
1341
- /** Resource name of the space. Format: spaces/{space} */
1349
+ /** Resource name of the space. Format: `spaces/{space}` */
1342
1350
  name?:
1343
1351
  string;
1344
1352
  /** Optional. Whether the space is a DM between a Chat app and a single human. */
@@ -1364,7 +1372,7 @@ declare namespace gapi.client {
1364
1372
  string;
1365
1373
  }
1366
1374
  interface SpaceDetails {
1367
- /** Optional. A description of the space. It could describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. */
1375
+ /** Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. */
1368
1376
  description?:
1369
1377
  string;
1370
1378
  /** Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. */
@@ -1391,7 +1399,7 @@ declare namespace gapi.client {
1391
1399
  string[];
1392
1400
  }
1393
1401
  interface TextButton {
1394
- /** The onclick action of the button. */
1402
+ /** The `onclick` action of the button. */
1395
1403
  onClick?:
1396
1404
  OnClick;
1397
1405
  /** The text of the button. */
@@ -1403,7 +1411,7 @@ declare namespace gapi.client {
1403
1411
  string;
1404
1412
  }
1405
1413
  interface Thread {
1406
- /** Resource name of the thread. Example: spaces/{space}/threads/{thread} */
1414
+ /** Resource name of the thread. Example: `spaces/{space}/threads/{thread}` */
1407
1415
  name?:
1408
1416
  string;
1409
1417
  /**
@@ -1611,12 +1619,12 @@ declare namespace gapi.client {
1611
1619
  }
1612
1620
  interface MembersResource {
1613
1621
  /**
1614
- * [Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps is not
1622
+ * [Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't
1615
1623
  * supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for
1616
1624
  * app membership) scope. To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to the space, use `users/app`. - To
1617
1625
  * add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or
1618
- * the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API `Person`
1619
- * `resourceName` is `people/123456789`, the user can be added to the space by setting the `membership.member.name` to `users/123456789`.
1626
+ * the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `Person` `resourceName` is
1627
+ * `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/123456789`.
1620
1628
  */
1621
1629
  create(request: {
1622
1630
  /** V1 error format. */
@@ -1724,7 +1732,7 @@ declare namespace gapi.client {
1724
1732
  /**
1725
1733
  * Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a
1726
1734
  * human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format. When deleting an app membership, requires the `chat.memberships.app` scope
1727
- * and `spaces/{space}/members/app` format. Format: spaces/{space}/members/{member} or spaces/{space}/members/app
1735
+ * and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
1728
1736
  */
1729
1737
  name:
1730
1738
  string;
@@ -1769,7 +1777,7 @@ declare namespace gapi.client {
1769
1777
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1770
1778
  key?:
1771
1779
  string;
1772
- /** Required. Resource name of the membership to retrieve. Format: spaces/{space}/members/{member} */
1780
+ /** Required. Resource name of the membership to retrieve. Format: `spaces/{space}/members/{member}` */
1773
1781
  name:
1774
1782
  string;
1775
1783
  /** OAuth 2.0 token for the current user. */
@@ -1826,14 +1834,14 @@ declare namespace gapi.client {
1826
1834
  oauth_token?:
1827
1835
  string;
1828
1836
  /**
1829
- * The maximum number of memberships to return. The service may return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000;
1830
- * values above 1000 are coerced to 1000. Negative values return an INVALID_ARGUMENT error.
1837
+ * The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1,000. If
1838
+ * you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.
1831
1839
  */
1832
1840
  pageSize?:
1833
1841
  number;
1834
1842
  /**
1835
- * A page token, received from a previous call to list memberships. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the
1836
- * call that provided the page token. Passing different values to the other parameters may lead to unexpected results.
1843
+ * A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should
1844
+ * match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
1837
1845
  */
1838
1846
  pageToken?:
1839
1847
  string;
@@ -1884,7 +1892,7 @@ declare namespace gapi.client {
1884
1892
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1885
1893
  key?:
1886
1894
  string;
1887
- /** Required. Resource name of the attachment, in the form "spaces/*‍/messages/*‍/attachments/*". */
1895
+ /** Required. Resource name of the attachment, in the form `spaces/*‍/messages/*‍/attachments/*`. */
1888
1896
  name:
1889
1897
  string;
1890
1898
  /** OAuth 2.0 token for the current user. */
@@ -1932,7 +1940,7 @@ declare namespace gapi.client {
1932
1940
  /** OAuth 2.0 token for the current user. */
1933
1941
  oauth_token?:
1934
1942
  string;
1935
- /** Required. The message where the reaction is created. Format: spaces/{space}/messages/{message} */
1943
+ /** Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}` */
1936
1944
  parent:
1937
1945
  string;
1938
1946
  /** Returns response with indentations and line breaks. */
@@ -1973,7 +1981,7 @@ declare namespace gapi.client {
1973
1981
  /** OAuth 2.0 token for the current user. */
1974
1982
  oauth_token?:
1975
1983
  string;
1976
- /** Required. The message where the reaction is created. Format: spaces/{space}/messages/{message} */
1984
+ /** Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}` */
1977
1985
  parent:
1978
1986
  string;
1979
1987
  /** Returns response with indentations and line breaks. */
@@ -2013,7 +2021,7 @@ declare namespace gapi.client {
2013
2021
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2014
2022
  key?:
2015
2023
  string;
2016
- /** Required. Name of the reaction to delete. Format: spaces/{space}/messages/{message}/reactions/{reaction} */
2024
+ /** Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}` */
2017
2025
  name:
2018
2026
  string;
2019
2027
  /** OAuth 2.0 token for the current user. */
@@ -2073,18 +2081,18 @@ declare namespace gapi.client {
2073
2081
  oauth_token?:
2074
2082
  string;
2075
2083
  /**
2076
- * Optional. The maximum number of reactions returned. The service may return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200;
2084
+ * Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200;
2077
2085
  * values above 200 are changed to 200.
2078
2086
  */
2079
2087
  pageSize?:
2080
2088
  number;
2081
2089
  /**
2082
2090
  * Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the
2083
- * filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.
2091
+ * filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.
2084
2092
  */
2085
2093
  pageToken?:
2086
2094
  string;
2087
- /** Required. The message users reacted to. Format: spaces/{space}/messages/{message} */
2095
+ /** Required. The message users reacted to. Format: `spaces/{space}/messages/{message}` */
2088
2096
  parent:
2089
2097
  string;
2090
2098
  /** Returns response with indentations and line breaks. */
@@ -2143,7 +2151,7 @@ declare namespace gapi.client {
2143
2151
  /** OAuth 2.0 token for the current user. */
2144
2152
  oauth_token?:
2145
2153
  string;
2146
- /** Required. The resource name of the space in which to create a message. Format: spaces/{space} */
2154
+ /** Required. The resource name of the space in which to create a message. Format: `spaces/{space}` */
2147
2155
  parent:
2148
2156
  string;
2149
2157
  /** Returns response with indentations and line breaks. */
@@ -2203,7 +2211,7 @@ declare namespace gapi.client {
2203
2211
  /** OAuth 2.0 token for the current user. */
2204
2212
  oauth_token?:
2205
2213
  string;
2206
- /** Required. The resource name of the space in which to create a message. Format: spaces/{space} */
2214
+ /** Required. The resource name of the space in which to create a message. Format: `spaces/{space}` */
2207
2215
  parent:
2208
2216
  string;
2209
2217
  /** Returns response with indentations and line breaks. */
@@ -2262,7 +2270,7 @@ declare namespace gapi.client {
2262
2270
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2263
2271
  key?:
2264
2272
  string;
2265
- /** Required. Resource name of the message to be deleted, in the form "spaces/*‍/messages/*" Example: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB */
2273
+ /** Required. Resource name of the message that you want to delete, in the form `spaces/*‍/messages/*` Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` */
2266
2274
  name:
2267
2275
  string;
2268
2276
  /** OAuth 2.0 token for the current user. */
@@ -2309,9 +2317,9 @@ declare namespace gapi.client {
2309
2317
  key?:
2310
2318
  string;
2311
2319
  /**
2312
- * Required. Resource name of the message to retrieve. Format: spaces/{space}/messages/{message} If the message begins with `client-`, then it has a custom name assigned by a Chat
2313
- * app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a
2314
- * message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
2320
+ * Required. Resource name of the message to retrieve. Format: `spaces/{space}/messages/{message}` If the message begins with `client-`, then it has a custom name assigned by a
2321
+ * Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and
2322
+ * name a message] (https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
2315
2323
  */
2316
2324
  name:
2317
2325
  string;
@@ -2371,24 +2379,24 @@ declare namespace gapi.client {
2371
2379
  oauth_token?:
2372
2380
  string;
2373
2381
  /**
2374
- * Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by and an ordering operation. Valid ordering operation values are: -
2375
- * `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.
2382
+ * Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as
2383
+ * follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.
2376
2384
  */
2377
2385
  orderBy?:
2378
2386
  string;
2379
2387
  /**
2380
- * The maximum number of messages returned. The service may return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000; values above
2381
- * 1000 are coerced to 1000. Negative values return an `INVALID_ARGUMENT` error.
2388
+ * The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1,000. If you use
2389
+ * a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.
2382
2390
  */
2383
2391
  pageSize?:
2384
2392
  number;
2385
2393
  /**
2386
- * Optional, if resuming from a previous query. A page token received from a previous list messages call. Provide this to retrieve the subsequent page. When paginating, all other
2387
- * parameters provided should match the call that provided the page token. Passing different values to the other parameters may lead to unexpected results.
2394
+ * Optional, if resuming from a previous query. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating,
2395
+ * all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
2388
2396
  */
2389
2397
  pageToken?:
2390
2398
  string;
2391
- /** Required. The resource name of the space to list messages from. Format: spaces/{space} */
2399
+ /** Required. The resource name of the space to list messages from. Format: `spaces/{space}` */
2392
2400
  parent:
2393
2401
  string;
2394
2402
  /** Returns response with indentations and line breaks. */
@@ -2423,7 +2431,7 @@ declare namespace gapi.client {
2423
2431
  access_token?:
2424
2432
  string;
2425
2433
  /**
2426
- * Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be
2434
+ * Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be
2427
2435
  * [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.
2428
2436
  */
2429
2437
  allowMissing?:
@@ -2453,8 +2461,8 @@ declare namespace gapi.client {
2453
2461
  quotaUser?:
2454
2462
  string;
2455
2463
  /**
2456
- * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account
2457
- * authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
2464
+ * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
2465
+ * authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
2458
2466
  */
2459
2467
  updateMask?:
2460
2468
  string;
@@ -2476,7 +2484,7 @@ declare namespace gapi.client {
2476
2484
  access_token?:
2477
2485
  string;
2478
2486
  /**
2479
- * Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be
2487
+ * Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be
2480
2488
  * [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.
2481
2489
  */
2482
2490
  allowMissing?:
@@ -2506,8 +2514,8 @@ declare namespace gapi.client {
2506
2514
  quotaUser?:
2507
2515
  string;
2508
2516
  /**
2509
- * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account
2510
- * authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
2517
+ * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
2518
+ * authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
2511
2519
  */
2512
2520
  updateMask?:
2513
2521
  string;
@@ -2535,7 +2543,7 @@ declare namespace gapi.client {
2535
2543
  access_token?:
2536
2544
  string;
2537
2545
  /**
2538
- * Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be
2546
+ * Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be
2539
2547
  * [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.
2540
2548
  */
2541
2549
  allowMissing?:
@@ -2565,8 +2573,8 @@ declare namespace gapi.client {
2565
2573
  quotaUser?:
2566
2574
  string;
2567
2575
  /**
2568
- * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account
2569
- * authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
2576
+ * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
2577
+ * authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
2570
2578
  */
2571
2579
  updateMask?:
2572
2580
  string;
@@ -2588,7 +2596,7 @@ declare namespace gapi.client {
2588
2596
  access_token?:
2589
2597
  string;
2590
2598
  /**
2591
- * Optional. If `true` and the message is not found, a new message is created and `updateMask` is ignored. The specified message ID must be
2599
+ * Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be
2592
2600
  * [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message) or the request fails.
2593
2601
  */
2594
2602
  allowMissing?:
@@ -2618,8 +2626,8 @@ declare namespace gapi.client {
2618
2626
  quotaUser?:
2619
2627
  string;
2620
2628
  /**
2621
- * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account
2622
- * authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
2629
+ * Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
2630
+ * authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
2623
2631
  */
2624
2632
  updateMask?:
2625
2633
  string;
@@ -2638,7 +2646,7 @@ declare namespace gapi.client {
2638
2646
  }
2639
2647
  interface SpacesResource {
2640
2648
  /**
2641
- * [Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access are not supported. Requires [user
2649
+ * [Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access aren't supported. Requires [user
2642
2650
  * authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
2643
2651
  */
2644
2652
  create(request: {
@@ -2728,9 +2736,9 @@ declare namespace gapi.client {
2728
2736
  },
2729
2737
  body: Space): Request<Space>;
2730
2738
  /**
2731
- * [Developer Preview](https://developers.google.com/workspace/preview): Deletes a named space. Always performs a cascading delete, which means that the space's child resources - like
2732
- * messages posted in the space and memberships in the space - are also deleted. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user
2733
- * who has permission to delete the space, and the `chat.delete` scope.
2739
+ * [Developer Preview](https://developers.google.com/workspace/preview): Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like
2740
+ * messages posted in the space and memberships in the space—are also deleted. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who
2741
+ * has permission to delete the space, and the `chat.delete` scope.
2734
2742
  */
2735
2743
  delete(request?: {
2736
2744
  /** V1 error format. */
@@ -2751,7 +2759,7 @@ declare namespace gapi.client {
2751
2759
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2752
2760
  key?:
2753
2761
  string;
2754
- /** Required. Resource name of the space to delete. Format: spaces/{space} */
2762
+ /** Required. Resource name of the space to delete. Format: `spaces/{space}` */
2755
2763
  name:
2756
2764
  string;
2757
2765
  /** OAuth 2.0 token for the current user. */
@@ -2797,9 +2805,9 @@ declare namespace gapi.client {
2797
2805
  key?:
2798
2806
  string;
2799
2807
  /**
2800
- * Required. Resource name of the user to find direct message with. Format: users/{user}, where `{user}` is either the `{person_id}` for the
2808
+ * Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `{person_id}` for the
2801
2809
  * [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the
2802
- * [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API `Person.resourceName` is
2810
+ * [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `Person.resourceName` is
2803
2811
  * `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`.
2804
2812
  */
2805
2813
  name?:
@@ -2845,7 +2853,7 @@ declare namespace gapi.client {
2845
2853
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2846
2854
  key?:
2847
2855
  string;
2848
- /** Required. Resource name of the space, in the form "spaces/*". Format: spaces/{space} */
2856
+ /** Required. Resource name of the space, in the form "spaces/*". Format: `spaces/{space}` */
2849
2857
  name:
2850
2858
  string;
2851
2859
  /** OAuth 2.0 token for the current user. */
@@ -2889,11 +2897,11 @@ declare namespace gapi.client {
2889
2897
  string;
2890
2898
  /**
2891
2899
  * Optional. A query filter. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). You can filter spaces by the space type
2892
- * ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid `enum` value, such as `SPACE` or
2893
- * `GROUP_CHAT` (the `space_type` cannot be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ```
2900
+ * ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or
2901
+ * `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ```
2894
2902
  * space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. With [service
2895
- * account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But Chat API still
2896
- * validates the query syntax with service accounts, so invalid queries are still rejected. [Developer Preview](https://developers.google.com/workspace/preview).
2903
+ * account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But the Chat API
2904
+ * still validates the query syntax with service accounts, so invalid queries are still rejected. [Developer Preview](https://developers.google.com/workspace/preview).
2897
2905
  */
2898
2906
  filter?:
2899
2907
  string;
@@ -2904,14 +2912,14 @@ declare namespace gapi.client {
2904
2912
  oauth_token?:
2905
2913
  string;
2906
2914
  /**
2907
- * Optional. The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000;
2908
- * values above 1000 are coerced to 1000. Negative values return an `INVALID_ARGUMENT` error.
2915
+ * Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1,000. If
2916
+ * you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.
2909
2917
  */
2910
2918
  pageSize?:
2911
2919
  number;
2912
2920
  /**
2913
- * Optional. A page token, received from a previous list spaces call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that
2914
- * provided the page token. Passing a different value may lead to unexpected results.
2921
+ * Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the
2922
+ * call that provided the page token. Passing a different value may lead to unexpected results.
2915
2923
  */
2916
2924
  pageToken?:
2917
2925
  string;
@@ -2951,7 +2959,7 @@ declare namespace gapi.client {
2951
2959
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2952
2960
  key?:
2953
2961
  string;
2954
- /** Resource name of the space. Format: spaces/{space} */
2962
+ /** Resource name of the space. Format: `spaces/{space}` */
2955
2963
  name:
2956
2964
  string;
2957
2965
  /** OAuth 2.0 token for the current user. */
@@ -2964,12 +2972,12 @@ declare namespace gapi.client {
2964
2972
  quotaUser?:
2965
2973
  string;
2966
2974
  /**
2967
- * Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: - display_name (Only supports changing the display name of a
2968
- * space with the SPACE type, or when also including the `space_type` mask to change a GROUP_CHAT space type to SPACE. Trying to update the display name of a GROUP_CHAT or a
2969
- * DIRECT_MESSAGE space results in an invalid argument error.) - space_type (Only supports changing a GROUP_CHAT space type to SPACE. Include `display_name` together with
2970
- * `space_type` in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the `space_type` mask and the SPACE type in
2971
- * the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an
2972
- * invalid argument error). - space_details - space_history_state (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the
2975
+ * Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space
2976
+ * with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a
2977
+ * `DIRECT_MESSAGE` space results in an invalid argument error.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with
2978
+ * `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type
2979
+ * in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an
2980
+ * invalid argument error). - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the
2973
2981
  * organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.)
2974
2982
  */
2975
2983
  updateMask?:
@@ -3003,7 +3011,7 @@ declare namespace gapi.client {
3003
3011
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3004
3012
  key?:
3005
3013
  string;
3006
- /** Resource name of the space. Format: spaces/{space} */
3014
+ /** Resource name of the space. Format: `spaces/{space}` */
3007
3015
  name:
3008
3016
  string;
3009
3017
  /** OAuth 2.0 token for the current user. */
@@ -3016,12 +3024,12 @@ declare namespace gapi.client {
3016
3024
  quotaUser?:
3017
3025
  string;
3018
3026
  /**
3019
- * Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: - display_name (Only supports changing the display name of a
3020
- * space with the SPACE type, or when also including the `space_type` mask to change a GROUP_CHAT space type to SPACE. Trying to update the display name of a GROUP_CHAT or a
3021
- * DIRECT_MESSAGE space results in an invalid argument error.) - space_type (Only supports changing a GROUP_CHAT space type to SPACE. Include `display_name` together with
3022
- * `space_type` in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the `space_type` mask and the SPACE type in
3023
- * the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an
3024
- * invalid argument error). - space_details - space_history_state (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the
3027
+ * Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space
3028
+ * with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a
3029
+ * `DIRECT_MESSAGE` space results in an invalid argument error.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with
3030
+ * `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type
3031
+ * in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an
3032
+ * invalid argument error). - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the
3025
3033
  * organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.)
3026
3034
  */
3027
3035
  updateMask?:
@@ -3044,7 +3052,7 @@ declare namespace gapi.client {
3044
3052
  * membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set
3045
3053
  * `Space.singleUserBotDm` to true and don't specify any memberships. You can only use this method to add app memberships to DMs. To add the calling app as a member of other space
3046
3054
  * types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) If a DM already exists between two users, even when one user blocks
3047
- * the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access are not supported. Requires [user
3055
+ * the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access aren't supported. Requires [user
3048
3056
  * authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
3049
3057
  */
3050
3058
  setup(request: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.chat-v1",
3
- "version": "0.0.20230514",
3
+ "version": "0.0.20230516",
4
4
  "description": "TypeScript typings for Google Chat API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -116,12 +116,12 @@ await gapi.client.chat.media.download({ resourceName: "resourceName", });
116
116
  await gapi.client.chat.media.upload({ parent: "parent", });
117
117
 
118
118
  /*
119
- [Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access are not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
119
+ [Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
120
120
  */
121
121
  await gapi.client.chat.spaces.create({ });
122
122
 
123
123
  /*
124
- [Developer Preview](https://developers.google.com/workspace/preview): Deletes a named space. Always performs a cascading delete, which means that the space's child resources - like messages posted in the space and memberships in the space - are also deleted. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.
124
+ [Developer Preview](https://developers.google.com/workspace/preview): Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.
125
125
  */
126
126
  await gapi.client.chat.spaces.delete({ name: "name", });
127
127
 
@@ -146,7 +146,7 @@ await gapi.client.chat.spaces.list({ });
146
146
  await gapi.client.chat.spaces.patch({ name: "name", });
147
147
 
148
148
  /*
149
- [Developer Preview](https://developers.google.com/workspace/preview): Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to true and don't specify any memberships. You can only use this method to add app memberships to DMs. To add the calling app as a member of other space types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access are not supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
149
+ [Developer Preview](https://developers.google.com/workspace/preview): Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to true and don't specify any memberships. You can only use this method to add app memberships to DMs. To add the calling app as a member of other space types, use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
150
150
  */
151
151
  await gapi.client.chat.spaces.setup({ });
152
152
  ```
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230514
6
+ // Revision: 20230516
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -70,7 +70,7 @@ gapi.load('client', async () => {
70
70
  filename: "Test string",
71
71
  });
72
72
  /**
73
- * [Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access are not supported. Requires [user
73
+ * [Developer Preview](https://developers.google.com/workspace/preview): Creates a named space. Spaces grouped by topics or that have guest access aren't supported. Requires [user
74
74
  * authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
75
75
  */
76
76
  await gapi.client.chat.spaces.create({
@@ -91,9 +91,9 @@ gapi.load('client', async () => {
91
91
  type: "Test string",
92
92
  });
93
93
  /**
94
- * [Developer Preview](https://developers.google.com/workspace/preview): Deletes a named space. Always performs a cascading delete, which means that the space's child resources - like
95
- * messages posted in the space and memberships in the space - are also deleted. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who
96
- * has permission to delete the space, and the `chat.delete` scope.
94
+ * [Developer Preview](https://developers.google.com/workspace/preview): Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like
95
+ * messages posted in the space and memberships in the space—are also deleted. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has
96
+ * permission to delete the space, and the `chat.delete` scope.
97
97
  */
98
98
  await gapi.client.chat.spaces.delete({
99
99
  name: "Test string",
@@ -161,7 +161,7 @@ gapi.load('client', async () => {
161
161
  * membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set
162
162
  * `Space.singleUserBotDm` to true and don't specify any memberships. You can only use this method to add app memberships to DMs. To add the calling app as a member of other space types,
163
163
  * use [create membership](https://developers.google.com/chat/api/reference/rest/v1/spaces.members/create) If a DM already exists between two users, even when one user blocks the other at
164
- * the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access are not supported. Requires [user
164
+ * the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access aren't supported. Requires [user
165
165
  * authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
166
166
  */
167
167
  await gapi.client.chat.spaces.setup({
@@ -199,12 +199,12 @@ gapi.load('client', async () => {
199
199
  },
200
200
  });
201
201
  /**
202
- * [Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps is not
202
+ * [Developer Preview](https://developers.google.com/workspace/preview): Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't
203
203
  * supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app
204
204
  * membership) scope. To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to the space, use `users/app`. - To add a
205
205
  * human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for
206
- * the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API `Person` `resourceName` is
207
- * `people/123456789`, the user can be added to the space by setting the `membership.member.name` to `users/123456789`.
206
+ * the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`,
207
+ * you can add the user to the space by setting the `membership.member.name` to `users/123456789`.
208
208
  */
209
209
  await gapi.client.chat.spaces.members.create({
210
210
  parent: "Test string",