@maxim_mazurok/gapi.client.chat-v1 0.3.20261019 → 0.3.20261025
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.
- package/index.d.ts +47 -9
- package/package.json +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:
|
|
12
|
+
// Revision: 20261025
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -234,6 +234,22 @@ declare namespace gapi.client {
|
|
|
234
234
|
/** The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` */
|
|
235
235
|
thread?: string;
|
|
236
236
|
}
|
|
237
|
+
interface Citation {
|
|
238
|
+
/** Optional. A list of sources that are relevant to the citation. Sources are displayed in the citation hover card. */
|
|
239
|
+
citedSources?: CitedSource[];
|
|
240
|
+
/** Required. The ID of the citation. This ID is defined by the app creating the citation and must match the `data-id` attribute of the `` tag in the message text. Must contain only ASCII letters and numbers, and less than 63 characters. */
|
|
241
|
+
id?: string;
|
|
242
|
+
}
|
|
243
|
+
interface CitedSource {
|
|
244
|
+
/** Optional. Additional information to show alongside the snippet in the form of a footer. */
|
|
245
|
+
footer?: Footer;
|
|
246
|
+
/** Optional. Snippet containing information directly from the source. */
|
|
247
|
+
snippet?: Snippet;
|
|
248
|
+
/** Required. The plaintext title of the `CitedSource`. Does not support markdown format. */
|
|
249
|
+
title?: string;
|
|
250
|
+
/** Required. The URI pointing to the resource referenced by this `CitedSource`. */
|
|
251
|
+
uri?: string;
|
|
252
|
+
}
|
|
237
253
|
interface Color {
|
|
238
254
|
/** The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). */
|
|
239
255
|
alpha?: number;
|
|
@@ -374,7 +390,7 @@ declare namespace gapi.client {
|
|
|
374
390
|
user?: User;
|
|
375
391
|
}
|
|
376
392
|
interface Dialog {
|
|
377
|
-
/** Input only. Body of the dialog, which is rendered in a modal.
|
|
393
|
+
/** Input only. Body of the dialog, which is rendered in a modal. */
|
|
378
394
|
body?: GoogleAppsCardV1Card;
|
|
379
395
|
}
|
|
380
396
|
interface DialogAction {
|
|
@@ -397,6 +413,16 @@ declare namespace gapi.client {
|
|
|
397
413
|
/** The mime type of the linked Google Drive resource. */
|
|
398
414
|
mimeType?: string;
|
|
399
415
|
}
|
|
416
|
+
interface Elements {
|
|
417
|
+
/** Optional. A list of inline citations referenced within the message text (via `` tags) that render as interactive hover cards. */
|
|
418
|
+
citations?: Citation[];
|
|
419
|
+
/** Optional. A list of sources to be displayed under the message as footer links. These are not referenced inline. For inline references, use `citations`. */
|
|
420
|
+
citedSources?: CitedSource[];
|
|
421
|
+
}
|
|
422
|
+
interface ElementsImage {
|
|
423
|
+
/** Required. The URI of the image. Must be a publicly accessible URI so that Chat can fetch and display it. */
|
|
424
|
+
imageUri?: string;
|
|
425
|
+
}
|
|
400
426
|
interface Emoji {
|
|
401
427
|
/** A custom emoji. */
|
|
402
428
|
customEmoji?: CustomEmoji;
|
|
@@ -416,6 +442,10 @@ declare namespace gapi.client {
|
|
|
416
442
|
/** List of spaces in the requested (or first) page. */
|
|
417
443
|
spaces?: Space[];
|
|
418
444
|
}
|
|
445
|
+
interface Footer {
|
|
446
|
+
/** Optional. The plaintext to display in the footer. Does not support markdown format. */
|
|
447
|
+
text?: string;
|
|
448
|
+
}
|
|
419
449
|
interface FormAction {
|
|
420
450
|
/** 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 use the same method name for several elements that trigger a common behavior. */
|
|
421
451
|
actionMethodName?: string;
|
|
@@ -543,9 +573,9 @@ declare namespace gapi.client {
|
|
|
543
573
|
altText?: string;
|
|
544
574
|
/** Whether the chip is in an inactive state and ignores user actions. Defaults to `false`. */
|
|
545
575
|
disabled?: boolean;
|
|
546
|
-
/** Whether the chip is in an active state and responds to user actions.
|
|
576
|
+
/** Deprecated: Use `disabled` instead. Whether the chip is in an active state and responds to user actions. */
|
|
547
577
|
enabled?: boolean;
|
|
548
|
-
/** The icon image. If both `icon` and `
|
|
578
|
+
/** The icon image. If both `icon` and `label` are set, then the icon appears before the label. */
|
|
549
579
|
icon?: GoogleAppsCardV1Icon;
|
|
550
580
|
/** The text displayed inside the chip. */
|
|
551
581
|
label?: string;
|
|
@@ -613,7 +643,7 @@ declare namespace gapi.client {
|
|
|
613
643
|
name?: string;
|
|
614
644
|
/** Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface. */
|
|
615
645
|
onChangeAction?: GoogleAppsCardV1Action;
|
|
616
|
-
/** The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. */
|
|
646
|
+
/** The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. Note: This field is in minutes, whereas user interaction event payloads typically provide time zone offsets in milliseconds (divide by `60000` to convert). */
|
|
617
647
|
timezoneOffsetDate?: number;
|
|
618
648
|
/** Whether the widget supports inputting a date, a time, or the date and time. */
|
|
619
649
|
type?: 'DATE_AND_TIME' | 'DATE_ONLY' | 'TIME_ONLY';
|
|
@@ -633,7 +663,7 @@ declare namespace gapi.client {
|
|
|
633
663
|
endIcon?: GoogleAppsCardV1Icon;
|
|
634
664
|
/** Deprecated in favor of `startIcon`. */
|
|
635
665
|
icon?: GoogleAppsCardV1Icon;
|
|
636
|
-
/** This action is triggered when users click `
|
|
666
|
+
/** This action is triggered when users click anywhere on the `DecoratedText` widget (including `text`, `top_label`, `bottom_label`, and icons), except when clicking a separate interactive control (`button` or `switch_control`). */
|
|
637
667
|
onClick?: GoogleAppsCardV1OnClick;
|
|
638
668
|
/** The icon displayed in front of the text. */
|
|
639
669
|
startIcon?: GoogleAppsCardV1Icon;
|
|
@@ -684,7 +714,7 @@ declare namespace gapi.client {
|
|
|
684
714
|
columnCount?: number;
|
|
685
715
|
/** The items to display in the grid. */
|
|
686
716
|
items?: GoogleAppsCardV1GridItem[];
|
|
687
|
-
/** This callback is reused by each individual grid item, but with the item's identifier
|
|
717
|
+
/** This callback is reused by each individual grid item, but with the item's identifier added to the callback's parameters (under the key `"grid_item_identifier"`). */
|
|
688
718
|
onClick?: GoogleAppsCardV1OnClick;
|
|
689
719
|
/** The text that displays in the grid header. */
|
|
690
720
|
title?: string;
|
|
@@ -925,9 +955,9 @@ declare namespace gapi.client {
|
|
|
925
955
|
interface GoogleAppsCardV1Widget {
|
|
926
956
|
/** A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` */
|
|
927
957
|
buttonList?: GoogleAppsCardV1ButtonList;
|
|
928
|
-
/**
|
|
958
|
+
/** Contains a collection of `CarouselCard` items, each of which contains nested widgets. For example, this is a JSON representation of a carousel that contains two carousel cards, each with a text paragraph: ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ] } ``` */
|
|
929
959
|
carousel?: GoogleAppsCardV1Carousel;
|
|
930
|
-
/** A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "
|
|
960
|
+
/** A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` "chipList": { "chips": [ { "label": "Edit", "disabled": true }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` */
|
|
931
961
|
chipList?: GoogleAppsCardV1ChipList;
|
|
932
962
|
/** Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ``` */
|
|
933
963
|
columns?: GoogleAppsCardV1Columns;
|
|
@@ -1274,6 +1304,8 @@ declare namespace gapi.client {
|
|
|
1274
1304
|
deleteTime?: string;
|
|
1275
1305
|
/** Output only. Information about a deleted message. A message is deleted when `delete_time` is set. */
|
|
1276
1306
|
deletionMetadata?: DeletionMetadata;
|
|
1307
|
+
/** Optional. Additional message components, including inline `citations` (where each citation is associated with a specific portion of the message text) and `cited_sources` (which are general references used to generate the response and are not directly linked to specific segments of the text). On input, provide `elements` when creating or updating a message. On output, both `citations` and `cited_sources` are populated when reading a message that contains them. Callers can read structured citation metadata from `elements`, while `formatted_text` also includes inline citation tags or source links depending on `markup_syntax`. These differ from `annotations`, which are output-only and offer supplementary information tied to message fragments or the entire message text. */
|
|
1308
|
+
elements?: Elements;
|
|
1277
1309
|
/** Output only. The list of emoji reaction summaries on the message. */
|
|
1278
1310
|
emojiReactionSummaries?: EmojiReactionSummary[];
|
|
1279
1311
|
/** Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. */
|
|
@@ -1561,6 +1593,12 @@ declare namespace gapi.client {
|
|
|
1561
1593
|
/** The type of slash command. */
|
|
1562
1594
|
type?: 'TYPE_UNSPECIFIED' | 'ADD' | 'INVOKE';
|
|
1563
1595
|
}
|
|
1596
|
+
interface Snippet {
|
|
1597
|
+
/** Optional. Image preview of the snippet provided as an input when creating the citation. */
|
|
1598
|
+
imagePreview?: ElementsImage;
|
|
1599
|
+
/** Optional. A short plaintext excerpt directly from the corpus that is rendered in the citation hover card or source preview. When footer sources are automatically populated from inline `citations` (because `Elements.cited_sources` is not set), snippets are omitted from the deduplicated footer sources. Does not support markdown format, and must not exceed 1,000 characters. */
|
|
1600
|
+
text?: string;
|
|
1601
|
+
}
|
|
1564
1602
|
interface Space {
|
|
1565
1603
|
/** Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. */
|
|
1566
1604
|
accessSettings?: AccessSettings;
|