@maxim_mazurok/gapi.client.chat-v1 0.0.20230718 → 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 +26 -18
  2. package/package.json +1 -1
  3. package/tests.ts +14 -6
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: 20230718
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
  */
@@ -1399,6 +1402,9 @@ declare namespace gapi.client {
1399
1402
  */
1400
1403
  displayName?:
1401
1404
  string;
1405
+ /** Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space. For existing spaces, this field is output only. */
1406
+ externalUserAllowed?:
1407
+ boolean;
1402
1408
  /** Resource name of the space. Format: `spaces/{space}` */
1403
1409
  name?:
1404
1410
  string;
@@ -2315,7 +2321,8 @@ declare namespace gapi.client {
2315
2321
  * Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
2316
2322
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2317
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
2318
- * 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.
2319
2326
  */
2320
2327
  delete(request?: {
2321
2328
  /** V1 error format. */
@@ -2413,8 +2420,7 @@ declare namespace gapi.client {
2413
2420
  }): Request<Message>;
2414
2421
  /**
2415
2422
  * Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list).
2416
- * Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.readonly` authorization scope. This method is only
2417
- * supported in spaces that don't allow users from outside the Workspace organization to join.
2423
+ * Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.readonly` authorization scope.
2418
2424
  */
2419
2425
  list(request?: {
2420
2426
  /** V1 error format. */
@@ -2492,7 +2498,8 @@ declare namespace gapi.client {
2492
2498
  * recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
2493
2499
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2494
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
2495
- * 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.
2496
2503
  */
2497
2504
  patch(request: {
2498
2505
  /** V1 error format. */
@@ -2603,7 +2610,8 @@ declare namespace gapi.client {
2603
2610
  * recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
2604
2611
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2605
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
2606
- * 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.
2607
2615
  */
2608
2616
  update(request: {
2609
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.20230718",
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: 20230718
6
+ // Revision: 20230727
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -82,6 +82,7 @@ gapi.load('client', async () => {
82
82
  }, {
83
83
  adminInstalled: true,
84
84
  displayName: "Test string",
85
+ externalUserAllowed: true,
85
86
  name: "Test string",
86
87
  singleUserBotDm: true,
87
88
  spaceDetails: {
@@ -142,6 +143,7 @@ gapi.load('client', async () => {
142
143
  }, {
143
144
  adminInstalled: true,
144
145
  displayName: "Test string",
146
+ externalUserAllowed: true,
145
147
  name: "Test string",
146
148
  singleUserBotDm: true,
147
149
  spaceDetails: {
@@ -188,6 +190,7 @@ gapi.load('client', async () => {
188
190
  space: {
189
191
  adminInstalled: true,
190
192
  displayName: "Test string",
193
+ externalUserAllowed: true,
191
194
  name: "Test string",
192
195
  singleUserBotDm: true,
193
196
  spaceDetails: {
@@ -2342,6 +2345,7 @@ gapi.load('client', async () => {
2342
2345
  space: {
2343
2346
  adminInstalled: true,
2344
2347
  displayName: "Test string",
2348
+ externalUserAllowed: true,
2345
2349
  name: "Test string",
2346
2350
  singleUserBotDm: true,
2347
2351
  spaceDetails: {
@@ -2365,7 +2369,8 @@ gapi.load('client', async () => {
2365
2369
  * Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
2366
2370
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2367
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
2368
- * 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.
2369
2374
  */
2370
2375
  await gapi.client.chat.spaces.messages.delete({
2371
2376
  force: true,
@@ -2383,8 +2388,7 @@ gapi.load('client', async () => {
2383
2388
  });
2384
2389
  /**
2385
2390
  * Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list).
2386
- * Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.readonly` authorization scope. This method is only
2387
- * supported in spaces that don't allow users from outside the Workspace organization to join.
2391
+ * Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.readonly` authorization scope.
2388
2392
  */
2389
2393
  await gapi.client.chat.spaces.messages.list({
2390
2394
  filter: "Test string",
@@ -2399,7 +2403,8 @@ gapi.load('client', async () => {
2399
2403
  * using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
2400
2404
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
2401
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
2402
- * 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.
2403
2408
  */
2404
2409
  await gapi.client.chat.spaces.messages.patch({
2405
2410
  allowMissing: true,
@@ -4474,6 +4479,7 @@ gapi.load('client', async () => {
4474
4479
  space: {
4475
4480
  adminInstalled: true,
4476
4481
  displayName: "Test string",
4482
+ externalUserAllowed: true,
4477
4483
  name: "Test string",
4478
4484
  singleUserBotDm: true,
4479
4485
  spaceDetails: {
@@ -4498,7 +4504,8 @@ gapi.load('client', async () => {
4498
4504
  * using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
4499
4505
  * [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
4500
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
4501
- * 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.
4502
4509
  */
4503
4510
  await gapi.client.chat.spaces.messages.update({
4504
4511
  allowMissing: true,
@@ -6573,6 +6580,7 @@ gapi.load('client', async () => {
6573
6580
  space: {
6574
6581
  adminInstalled: true,
6575
6582
  displayName: "Test string",
6583
+ externalUserAllowed: true,
6576
6584
  name: "Test string",
6577
6585
  singleUserBotDm: true,
6578
6586
  spaceDetails: {