@maxim_mazurok/gapi.client.chat-v1 0.0.20230723 → 0.0.20230727

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 (3) hide show
  1. package/index.d.ts +22 -16
  2. package/package.json +1 -1
  3. package/tests.ts +7 -4
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: 20230723
12
+ // Revision: 20230727
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -483,7 +483,10 @@ declare namespace gapi.client {
483
483
  /** The divider style between sections. */
484
484
  sectionDividerStyle?:
485
485
  string;
486
- /** Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. */
486
+ /**
487
+ * Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Card
488
+ * section](https://developers.google.com/chat/ui/widgets/card-section).
489
+ */
487
490
  sections?:
488
491
  GoogleAppsCardV1Section[];
489
492
  }
@@ -551,7 +554,7 @@ declare namespace gapi.client {
551
554
  string;
552
555
  /**
553
556
  * The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form
554
- * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
557
+ * data](https://developers.google.com/chat/ui/read-form-data).
555
558
  */
556
559
  name?:
557
560
  string;
@@ -603,7 +606,7 @@ declare namespace gapi.client {
603
606
  GoogleAppsCardV1SwitchControl;
604
607
  /**
605
608
  * Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat
606
- * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
609
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace
607
610
  * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
608
611
  */
609
612
  text?:
@@ -767,7 +770,7 @@ declare namespace gapi.client {
767
770
  boolean;
768
771
  /**
769
772
  * 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
770
- * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
773
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace
771
774
  * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
772
775
  */
773
776
  header?:
@@ -810,13 +813,13 @@ declare namespace gapi.client {
810
813
  number;
811
814
  /**
812
815
  * The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form
813
- * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
816
+ * data](https://developers.google.com/chat/ui/read-form-data).
814
817
  */
815
818
  name?:
816
819
  string;
817
820
  /**
818
821
  * If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form
819
- * inputs, see [Receive form data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
822
+ * inputs, see [Receive form data](https://developers.google.com/chat/ui/read-form-data).
820
823
  */
821
824
  onChangeAction?:
822
825
  GoogleAppsCardV1Action;
@@ -851,7 +854,7 @@ declare namespace gapi.client {
851
854
  string;
852
855
  /**
853
856
  * The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form
854
- * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
857
+ * data](https://developers.google.com/chat/ui/read-form-data).
855
858
  */
856
859
  value?:
857
860
  string;
@@ -872,7 +875,7 @@ declare namespace gapi.client {
872
875
  string;
873
876
  /**
874
877
  * The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form
875
- * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
878
+ * data](https://developers.google.com/chat/ui/read-form-data).
876
879
  */
877
880
  name?:
878
881
  string;
@@ -884,7 +887,7 @@ declare namespace gapi.client {
884
887
  boolean;
885
888
  /**
886
889
  * The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form
887
- * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
890
+ * data](https://developers.google.com/chat/ui/read-form-data).
888
891
  */
889
892
  value?:
890
893
  string;
@@ -919,7 +922,7 @@ declare namespace gapi.client {
919
922
  string;
920
923
  /**
921
924
  * The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form
922
- * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
925
+ * data](https://developers.google.com/chat/ui/read-form-data).
923
926
  */
924
927
  name?:
925
928
  string;
@@ -934,7 +937,7 @@ declare namespace gapi.client {
934
937
  string;
935
938
  /**
936
939
  * The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form
937
- * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
940
+ * data](https://developers.google.com/chat/ui/read-form-data).
938
941
  */
939
942
  value?:
940
943
  string;
@@ -1012,7 +1015,7 @@ declare namespace gapi.client {
1012
1015
  GoogleAppsCardV1TextInput;
1013
1016
  /**
1014
1017
  * Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat
1015
- * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace
1018
+ * apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace
1016
1019
  * 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": "
1017
1020
  * *bold text*" } ```
1018
1021
  */
@@ -2318,7 +2321,8 @@ declare namespace gapi.client {
2318
2321
  * Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
2319
2322
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2320
2323
  * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
2321
- * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
2324
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope. Requests authenticated with service accounts can only
2325
+ * delete messages created by the calling Chat app.
2322
2326
  */
2323
2327
  delete(request?: {
2324
2328
  /** V1 error format. */
@@ -2494,7 +2498,8 @@ declare namespace gapi.client {
2494
2498
  * recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
2495
2499
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2496
2500
  * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
2497
- * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
2501
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope. Requests authenticated with service accounts can only
2502
+ * update messages created by the calling Chat app.
2498
2503
  */
2499
2504
  patch(request: {
2500
2505
  /** V1 error format. */
@@ -2605,7 +2610,8 @@ declare namespace gapi.client {
2605
2610
  * recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
2606
2611
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2607
2612
  * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
2608
- * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
2613
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope. Requests authenticated with service accounts can only
2614
+ * update messages created by the calling Chat app.
2609
2615
  */
2610
2616
  update(request: {
2611
2617
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.chat-v1",
3
- "version": "0.0.20230723",
3
+ "version": "0.0.20230727",
4
4
  "description": "TypeScript typings for Google Chat API v1",
5
5
  "license": "MIT",
6
6
  "author": {
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: 20230723
6
+ // Revision: 20230727
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -2369,7 +2369,8 @@ gapi.load('client', async () => {
2369
2369
  * Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
2370
2370
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2371
2371
  * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
2372
- * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
2372
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope. Requests authenticated with service accounts can only delete
2373
+ * messages created by the calling Chat app.
2373
2374
  */
2374
2375
  await gapi.client.chat.spaces.messages.delete({
2375
2376
  force: true,
@@ -2402,7 +2403,8 @@ gapi.load('client', async () => {
2402
2403
  * using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
2403
2404
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2404
2405
  * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
2405
- * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
2406
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope. Requests authenticated with service accounts can only update
2407
+ * messages created by the calling Chat app.
2406
2408
  */
2407
2409
  await gapi.client.chat.spaces.messages.patch({
2408
2410
  allowMissing: true,
@@ -4502,7 +4504,8 @@ gapi.load('client', async () => {
4502
4504
  * using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
4503
4505
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
4504
4506
  * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
4505
- * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
4507
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope. Requests authenticated with service accounts can only update
4508
+ * messages created by the calling Chat app.
4506
4509
  */
4507
4510
  await gapi.client.chat.spaces.messages.update({
4508
4511
  allowMissing: true,