@maxim_mazurok/gapi.client.chat-v1 0.0.20230216 → 0.0.20230219

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 +25 -30
  2. package/package.json +1 -1
  3. package/tests.ts +1 -1
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: 20230216
12
+ // Revision: 20230219
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -266,12 +266,13 @@ declare namespace gapi.client {
266
266
  /** List of action parameters. */
267
267
  parameters?: GoogleAppsCardV1ActionParameter[];
268
268
  /**
269
- * Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. When using
270
- * [LoadIndicator.NONE](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it
271
- * ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when
272
- * the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use
273
- * [LoadIndicator.SPINNER](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes
274
- * are made by the user while the action is being processed. Not supported by Chat apps.
269
+ * 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
270
+ * 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
271
+ * messages](https://developers.google.com/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's
272
+ * [ResponseType](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same
273
+ * [`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
274
+ * when the action is triggered. To prevent the user from making changes while the action is being processed, set
275
+ * [LoadIndicator](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
275
276
  */
276
277
  persistValues?: boolean;
277
278
  }
@@ -404,7 +405,7 @@ declare namespace gapi.client {
404
405
  /** A button that can be clicked to trigger an action. */
405
406
  button?: GoogleAppsCardV1Button;
406
407
  /**
407
- * An icon displayed after the text. Supports [standard](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and
408
+ * An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and
408
409
  * [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons) icons.
409
410
  */
410
411
  endIcon?: GoogleAppsCardV1Icon;
@@ -414,10 +415,7 @@ declare namespace gapi.client {
414
415
  onClick?: GoogleAppsCardV1OnClick;
415
416
  /** The icon displayed in front of the text. */
416
417
  startIcon?: GoogleAppsCardV1Icon;
417
- /**
418
- * A switch widget can be clicked to change its state and trigger an action. Currently supported in [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for [card
419
- * messages](https://developers.google.com/chat/api/guides/message-formats/cards) is coming soon.
420
- */
418
+ /** A switch widget can be clicked to change its state and trigger an action. */
421
419
  switchControl?: GoogleAppsCardV1SwitchControl;
422
420
  /** Required. The primary text. Supports simple formatting. See Text formatting for formatting details. */
423
421
  text?: string;
@@ -469,11 +467,11 @@ declare namespace gapi.client {
469
467
  * `.png` and `.jpg`.
470
468
  */
471
469
  iconUrl?: string;
472
- /** The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a standard icon. */
470
+ /** The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon. */
473
471
  imageType?: string;
474
472
  /**
475
- * Display one of the standard icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported
476
- * icons, see [standard icons](https://developers.google.com/chat/api/guides/message-formats/cards).
473
+ * Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported
474
+ * icons, see [built-in icons](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons).
477
475
  */
478
476
  knownIcon?: string;
479
477
  }
@@ -676,11 +674,10 @@ declare namespace gapi.client {
676
674
  divider?: any;
677
675
  /**
678
676
  * Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the
679
- * number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. Currently supported in
680
- * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for [card messages](https://developers.google.com/chat/api/guides/message-formats/cards) is coming soon. For
681
- * example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE",
682
- * "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An
683
- * item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ```
677
+ * number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. For example, the following JSON creates a 2 column grid with a
678
+ * single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri":
679
+ * "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": {
680
+ * "openLink": { "url": "https://www.example.com" } } } ```
684
681
  */
685
682
  grid?: GoogleAppsCardV1Grid;
686
683
  /**
@@ -689,19 +686,17 @@ declare namespace gapi.client {
689
686
  */
690
687
  image?: GoogleAppsCardV1Image;
691
688
  /**
692
- * Displays a selection control that lets users select items. Selection controls can be check boxes, radio buttons, switches, or dropdown menus. Currently supported in
693
- * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for [card messages](https://developers.google.com/chat/api/guides/message-formats/cards) is coming soon. For
694
- * example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text":
695
- * "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value":
696
- * "extra_large", "selected": false } ] } ```
689
+ * Displays a selection control that lets users select items. Selection controls can be check boxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates
690
+ * a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected":
691
+ * false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] }
692
+ * ```
697
693
  */
698
694
  selectionInput?: GoogleAppsCardV1SelectionInput;
699
695
  /**
700
- * Displays a text box that users can type into. Currently supported in [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for [card
701
- * messages](https://developers.google.com/chat/api/guides/message-formats/cards) is coming soon. For example, the following JSON creates a text input for an email address: ```
702
- * "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static
703
- * suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, {
704
- * "text": "JavaScript" }, { "text": "Python" } ] } } ```
696
+ * Displays a text box that users can type into. For example, the following JSON creates a text input for an email address: ``` "textInput": { "name": "mailing_address", "label":
697
+ * "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` "textInput": { "name":
698
+ * "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text":
699
+ * "Python" } ] } } ```
705
700
  */
706
701
  textInput?: GoogleAppsCardV1TextInput;
707
702
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.chat-v1",
3
- "version": "0.0.20230216",
3
+ "version": "0.0.20230219",
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: 20230216
6
+ // Revision: 20230219
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */