@maxim_mazurok/gapi.client.chat-v1 0.0.20230413 → 0.0.20230420

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://chat.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230413
+// Revision: 20230420
 
 /// <reference types="gapi.client" />
 
@@ -159,9 +159,13 @@ declare namespace gapi.client {
             parameters?: { [P in string]: string };
             /** The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps. */
             platform?: string;
-            /** The timezone ID and offset from Coordinated Universal Time (UTC). */
+            /**
+             * The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types
+             * [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and
+             * [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).
+             */
             timeZone?: TimeZone;
-            /** The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US". Not supported by Chat apps. */
+            /** The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US". */
             userLocale?: string;
         }
         interface DateInput {
@@ -329,8 +333,9 @@ declare namespace gapi.client {
             /** In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. Not supported by Chat apps. */
             displayStyle?: string;
             /**
-             * The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Chat apps support `fixedFooter`
-             * in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not in [card messages](https://developers.google.com/chat/api/guides/message-formats/cards).
+             * The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace
+             * Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card
+             * messages](https://developers.google.com/chat/api/guides/message-formats/cards).
              */
             fixedFooter?: GoogleAppsCardV1CardFixedFooter;
             /** The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card. */
@@ -417,7 +422,10 @@ declare namespace gapi.client {
             startIcon?: GoogleAppsCardV1Icon;
             /** A switch widget can be clicked to change its state and trigger an action. */
             switchControl?: GoogleAppsCardV1SwitchControl;
-            /** Required. The primary text. Supports simple formatting. See Text formatting for formatting details. */
+            /**
+             * 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
+             * Add-ons.
+             */
             text?: string;
             /** The text that appears above `text`. Always truncates. */
             topLabel?: string;
@@ -529,7 +537,10 @@ declare namespace gapi.client {
              * more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.
              */
             collapsible?: boolean;
-            /** Text that appears at the top of a section. Supports [simple HTML formatted text](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
+            /**
+             * 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
+             * text in Google Workspace Add-ons.
+             */
             header?: string;
             /**
              * The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is
@@ -541,7 +552,7 @@ declare namespace gapi.client {
             widgets?: GoogleAppsCardV1Widget[];
         }
         interface GoogleAppsCardV1SelectionInput {
-            /** An array of the selected items. For example, all the selected check boxes. */
+            /** An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items. */
             items?: GoogleAppsCardV1SelectionItem[];
             /**
              * The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are
@@ -549,7 +560,7 @@ declare namespace gapi.client {
              */
             label?: string;
             /**
-             * The name by which the selection input is identified in a form input event. For details about working with form inputs, see [Receive form
+             * The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form
              * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
              */
             name?: string;
@@ -559,8 +570,8 @@ declare namespace gapi.client {
              */
             onChangeAction?: GoogleAppsCardV1Action;
             /**
-             * The way that an option appears to users. Different options support different types of interactions. For example, users can enable multiple check boxes, but can only select one value
-             * from a dropdown menu. Each selection input supports one type of selection. Mixing check boxes and switches, for example, is not supported.
+             * The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more
+             * checkboxes, but they can only select one value from a dropdown menu.
              */
             type?: string;
         }
@@ -570,7 +581,7 @@ declare namespace gapi.client {
              * ignored.
              */
             selected?: boolean;
-            /** The text displayed to users. */
+            /** The text that identifies or describes the item to users. */
             text?: string;
             /**
              * 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
@@ -685,7 +696,7 @@ declare namespace gapi.client {
              */
             image?: GoogleAppsCardV1Image;
             /**
-             * 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
+             * Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates
              * a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected":
              * false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] }
              * ```
@@ -699,8 +710,8 @@ declare namespace gapi.client {
              */
             textInput?: GoogleAppsCardV1TextInput;
             /**
-             * Displays a text paragraph. Supports [simple HTML formatted text](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON
-             * creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
+             * 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
+             * Workspace Add-ons. For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
              */
             textParagraph?: GoogleAppsCardV1TextParagraph;
         }
@@ -726,21 +737,27 @@ declare namespace gapi.client {
             onClick?: OnClick;
         }
         interface Inputs {
-            /** Date input values. Not supported by Chat apps. */
+            /** Date input values. */
             dateInput?: DateInput;
-            /** Date and time input values. Not supported by Chat apps. */
+            /** Date and time input values. */
             dateTimeInput?: DateTimeInput;
             /** Input parameter for regular widgets. For single-valued widgets, it is a single value list. For multi-valued widgets, such as checkbox, all the values are presented. */
             stringInputs?: StringInputs;
-            /** Time input values. Not supported by Chat apps. */
+            /** Time input values. */
             timeInput?: TimeInput;
         }
         interface KeyValue {
-            /** The text of the bottom label. Formatted text supported. */
+            /**
+             * 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
+             * Add-ons.
+             */
             bottomLabel?: string;
             /** A button that can be clicked to trigger an action. */
             button?: Button;
-            /** The text of the content. Formatted text supported and always required. */
+            /**
+             * 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
+             * Google Workspace Add-ons.
+             */
             content?: string;
             /** If the content should be multiline. */
             contentMultiline?: boolean;
@@ -750,7 +767,10 @@ declare namespace gapi.client {
             iconUrl?: string;
             /** The onclick action. Only the top label, bottom label and content region are clickable. */
             onClick?: OnClick;
-            /** The text of the top label. Formatted text supported. */
+            /**
+             * 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
+             * Add-ons.
+             */
             topLabel?: string;
         }
         interface ListMembershipsResponse {
@@ -862,7 +882,10 @@ declare namespace gapi.client {
             url?: string;
         }
         interface Section {
-            /** The header of the section, text formatted supported. */
+            /**
+             * 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
+             * Add-ons.
+             */
             header?: string;
             /** A section must contain at least 1 widget. */
             widgets?: WidgetMarkup[];
@@ -982,7 +1005,7 @@ declare namespace gapi.client {
             user?: User;
         }
         interface WidgetMarkup {
-            /** A list of buttons. Buttons is also oneof data and only one of these fields should be set. */
+            /** A list of buttons. Buttons is also `oneof data` and only one of these fields should be set. */
             buttons?: Button[];
             /** Display an image in this widget. */
             image?: Image;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.chat-v1",
-  "version": "0.0.20230413",
+  "version": "0.0.20230420",
   "description": "TypeScript typings for Google Chat API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230413
+// Revision: 20230420
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */