@maxim_mazurok/gapi.client.chat-v1 0.0.20240331 → 0.0.20240404
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 +99 -99
- package/package.json +1 -1
- package/readme.md +9 -9
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: 20240404
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -35,7 +35,7 @@ declare namespace gapi.client {
|
|
|
35
35
|
value?: string;
|
|
36
36
|
}
|
|
37
37
|
interface ActionResponse {
|
|
38
|
-
/** Input only. A response to an interaction event related to a [dialog](https://developers.google.com/chat/
|
|
38
|
+
/** Input only. A response to an interaction event related to a [dialog](https://developers.google.com/workspace/chat/dialogs). Must be accompanied by `ResponseType.Dialog`. */
|
|
39
39
|
dialogAction?: DialogAction;
|
|
40
40
|
/** Input only. The type of Chat app response. */
|
|
41
41
|
type?: string;
|
|
@@ -194,17 +194,17 @@ declare namespace gapi.client {
|
|
|
194
194
|
deletionType?: string;
|
|
195
195
|
}
|
|
196
196
|
interface DeprecatedEvent {
|
|
197
|
-
/** For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/chat/
|
|
197
|
+
/** For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data). */
|
|
198
198
|
action?: FormAction;
|
|
199
|
-
/** Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/chat/
|
|
199
|
+
/** Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card. */
|
|
200
200
|
common?: CommonEventObject;
|
|
201
|
-
/** The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/chat/
|
|
201
|
+
/** The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools). */
|
|
202
202
|
configCompleteRedirectUrl?: string;
|
|
203
|
-
/** The type of [dialog](https://developers.google.com/chat/
|
|
203
|
+
/** The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received. */
|
|
204
204
|
dialogEventType?: string;
|
|
205
205
|
/** The timestamp indicating when the interaction event occurred. */
|
|
206
206
|
eventTime?: string;
|
|
207
|
-
/** For `CARD_CLICKED` interaction events, whether the user interacted with a [dialog](https://developers.google.com/chat/
|
|
207
|
+
/** For `CARD_CLICKED` interaction events, whether the user interacted with a [dialog](https://developers.google.com/workspace/chat/dialogs). */
|
|
208
208
|
isDialogEvent?: boolean;
|
|
209
209
|
/** The message that triggered the interaction event, if applicable. */
|
|
210
210
|
message?: Message;
|
|
@@ -224,9 +224,9 @@ declare namespace gapi.client {
|
|
|
224
224
|
body?: GoogleAppsCardV1Card;
|
|
225
225
|
}
|
|
226
226
|
interface DialogAction {
|
|
227
|
-
/** Input only. Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/
|
|
227
|
+
/** Input only. Status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. */
|
|
228
228
|
actionStatus?: ActionStatus;
|
|
229
|
-
/** Input only. [Dialog](https://developers.google.com/chat/
|
|
229
|
+
/** Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request. */
|
|
230
230
|
dialog?: Dialog;
|
|
231
231
|
}
|
|
232
232
|
interface DriveDataRef {
|
|
@@ -234,7 +234,7 @@ declare namespace gapi.client {
|
|
|
234
234
|
driveFileId?: string;
|
|
235
235
|
}
|
|
236
236
|
interface DriveLinkData {
|
|
237
|
-
/** A [DriveDataRef](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. */
|
|
237
|
+
/** A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. */
|
|
238
238
|
driveDataRef?: DriveDataRef;
|
|
239
239
|
/** The mime type of the linked Google Drive resource. */
|
|
240
240
|
mimeType?: string;
|
|
@@ -259,15 +259,15 @@ declare namespace gapi.client {
|
|
|
259
259
|
parameters?: ActionParameter[];
|
|
260
260
|
}
|
|
261
261
|
interface GoogleAppsCardV1Action {
|
|
262
|
-
/** A custom function to invoke when the containing element is clicked or othrwise activated. For example usage, see [
|
|
262
|
+
/** A custom function to invoke when the containing element is clicked or othrwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
263
263
|
function?: string;
|
|
264
|
-
/** Optional. Required when opening a [dialog](https://developers.google.com/chat/
|
|
264
|
+
/** Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat): */
|
|
265
265
|
interaction?: string;
|
|
266
266
|
/** Specifies the loading indicator that the action displays while making the call to the action. */
|
|
267
267
|
loadIndicator?: string;
|
|
268
268
|
/** List of action parameters. */
|
|
269
269
|
parameters?: GoogleAppsCardV1ActionParameter[];
|
|
270
|
-
/** 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 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 messages](https://developers.google.com/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`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 when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`. */
|
|
270
|
+
/** 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 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 messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`. */
|
|
271
271
|
persistValues?: boolean;
|
|
272
272
|
}
|
|
273
273
|
interface GoogleAppsCardV1ActionParameter {
|
|
@@ -285,7 +285,7 @@ declare namespace gapi.client {
|
|
|
285
285
|
type?: string;
|
|
286
286
|
}
|
|
287
287
|
interface GoogleAppsCardV1Button {
|
|
288
|
-
/** The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat". */
|
|
288
|
+
/** The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat". */
|
|
289
289
|
altText?: string;
|
|
290
290
|
/** If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text. If unset, the image background is white and the font color is blue. For red, green, and blue, the value of each field is a `float` number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale. Optionally set `alpha`, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) * (background color) ``` For `alpha`, a value of `1` corresponds with a solid color, and a value of `0` corresponds with a completely transparent color. For example, the following color represents a half transparent red: ``` "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 } ``` */
|
|
291
291
|
color?: Color;
|
|
@@ -307,7 +307,7 @@ declare namespace gapi.client {
|
|
|
307
307
|
cardActions?: GoogleAppsCardV1CardAction[];
|
|
308
308
|
/** In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons): */
|
|
309
309
|
displayStyle?: string;
|
|
310
|
-
/** The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/
|
|
310
|
+
/** The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
311
311
|
fixedFooter?: GoogleAppsCardV1CardFixedFooter;
|
|
312
312
|
/** The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card. */
|
|
313
313
|
header?: GoogleAppsCardV1CardHeader;
|
|
@@ -317,7 +317,7 @@ declare namespace gapi.client {
|
|
|
317
317
|
peekCardHeader?: GoogleAppsCardV1CardHeader;
|
|
318
318
|
/** The divider style between sections. */
|
|
319
319
|
sectionDividerStyle?: string;
|
|
320
|
-
/** 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 [
|
|
320
|
+
/** 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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). */
|
|
321
321
|
sections?: GoogleAppsCardV1Section[];
|
|
322
322
|
}
|
|
323
323
|
interface GoogleAppsCardV1CardAction {
|
|
@@ -361,7 +361,7 @@ declare namespace gapi.client {
|
|
|
361
361
|
interface GoogleAppsCardV1DateTimePicker {
|
|
362
362
|
/** The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`. */
|
|
363
363
|
label?: string;
|
|
364
|
-
/** The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
364
|
+
/** The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
365
365
|
name?: string;
|
|
366
366
|
/** Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface. */
|
|
367
367
|
onChangeAction?: GoogleAppsCardV1Action;
|
|
@@ -377,7 +377,7 @@ declare namespace gapi.client {
|
|
|
377
377
|
bottomLabel?: string;
|
|
378
378
|
/** A button that a user can click to trigger an action. */
|
|
379
379
|
button?: GoogleAppsCardV1Button;
|
|
380
|
-
/** An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons. */
|
|
380
|
+
/** An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. */
|
|
381
381
|
endIcon?: GoogleAppsCardV1Icon;
|
|
382
382
|
/** Deprecated in favor of `startIcon`. */
|
|
383
383
|
icon?: GoogleAppsCardV1Icon;
|
|
@@ -387,7 +387,7 @@ declare namespace gapi.client {
|
|
|
387
387
|
startIcon?: GoogleAppsCardV1Icon;
|
|
388
388
|
/** A switch widget that a user can click to change its state and trigger an action. */
|
|
389
389
|
switchControl?: GoogleAppsCardV1SwitchControl;
|
|
390
|
-
/** Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
390
|
+
/** Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
391
391
|
text?: string;
|
|
392
392
|
/** The text that appears above `text`. Always truncates. */
|
|
393
393
|
topLabel?: string;
|
|
@@ -420,13 +420,13 @@ declare namespace gapi.client {
|
|
|
420
420
|
title?: string;
|
|
421
421
|
}
|
|
422
422
|
interface GoogleAppsCardV1Icon {
|
|
423
|
-
/** Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. */
|
|
423
|
+
/** Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. */
|
|
424
424
|
altText?: string;
|
|
425
|
-
/** Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. */
|
|
425
|
+
/** Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. */
|
|
426
426
|
iconUrl?: string;
|
|
427
427
|
/** 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. */
|
|
428
428
|
imageType?: string;
|
|
429
|
-
/** 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 icons, see [built-in icons](https://developers.google.com/chat/format-messages#builtinicons). */
|
|
429
|
+
/** 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 icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). */
|
|
430
430
|
knownIcon?: string;
|
|
431
431
|
/** Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat): */
|
|
432
432
|
materialIcon?: GoogleAppsCardV1MaterialIcon;
|
|
@@ -434,7 +434,7 @@ declare namespace gapi.client {
|
|
|
434
434
|
interface GoogleAppsCardV1Image {
|
|
435
435
|
/** The alternative text of this image that's used for accessibility. */
|
|
436
436
|
altText?: string;
|
|
437
|
-
/** The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/chat/images/quickstart-app-avatar.png ``` */
|
|
437
|
+
/** The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ``` */
|
|
438
438
|
imageUrl?: string;
|
|
439
439
|
/** When a user clicks the image, the click triggers this action. */
|
|
440
440
|
onClick?: GoogleAppsCardV1OnClick;
|
|
@@ -492,7 +492,7 @@ declare namespace gapi.client {
|
|
|
492
492
|
interface GoogleAppsCardV1Section {
|
|
493
493
|
/** Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`. */
|
|
494
494
|
collapsible?: boolean;
|
|
495
|
-
/** 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](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
495
|
+
/** 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](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
496
496
|
header?: string;
|
|
497
497
|
/** 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 set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`. */
|
|
498
498
|
uncollapsibleWidgetsCount?: number;
|
|
@@ -510,9 +510,9 @@ declare namespace gapi.client {
|
|
|
510
510
|
multiSelectMaxSelectedItems?: number;
|
|
511
511
|
/** For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu. If unspecified, defaults to 0 characters for static data sources and 3 characters for external data sources. */
|
|
512
512
|
multiSelectMinQueryLength?: number;
|
|
513
|
-
/** 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/
|
|
513
|
+
/** 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/workspace/chat/read-form-data). */
|
|
514
514
|
name?: string;
|
|
515
|
-
/** 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 inputs, see [Receive form data](https://developers.google.com/chat/
|
|
515
|
+
/** 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 inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
516
516
|
onChangeAction?: GoogleAppsCardV1Action;
|
|
517
517
|
/** A data source from Google Workspace. */
|
|
518
518
|
platformDataSource?: GoogleAppsCardV1PlatformDataSource;
|
|
@@ -524,11 +524,11 @@ declare namespace gapi.client {
|
|
|
524
524
|
bottomText?: string;
|
|
525
525
|
/** Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item. */
|
|
526
526
|
selected?: boolean;
|
|
527
|
-
/** For multiselect menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `https://developers.google.com/chat/images/quickstart-app-avatar.png`. */
|
|
527
|
+
/** For multiselect menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`. */
|
|
528
528
|
startIconUri?: string;
|
|
529
529
|
/** The text that identifies or describes the item to users. */
|
|
530
530
|
text?: string;
|
|
531
|
-
/** 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 data](https://developers.google.com/chat/
|
|
531
|
+
/** 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 data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
532
532
|
value?: string;
|
|
533
533
|
}
|
|
534
534
|
interface GoogleAppsCardV1SuggestionItem {
|
|
@@ -542,13 +542,13 @@ declare namespace gapi.client {
|
|
|
542
542
|
interface GoogleAppsCardV1SwitchControl {
|
|
543
543
|
/** How the switch appears in the user interface. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
544
544
|
controlType?: string;
|
|
545
|
-
/** The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
545
|
+
/** The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
546
546
|
name?: string;
|
|
547
547
|
/** The action to perform when the switch state is changed, such as what function to run. */
|
|
548
548
|
onChangeAction?: GoogleAppsCardV1Action;
|
|
549
549
|
/** When `true`, the switch is selected. */
|
|
550
550
|
selected?: boolean;
|
|
551
|
-
/** The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
551
|
+
/** The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
552
552
|
value?: string;
|
|
553
553
|
}
|
|
554
554
|
interface GoogleAppsCardV1TextInput {
|
|
@@ -560,15 +560,15 @@ declare namespace gapi.client {
|
|
|
560
560
|
initialSuggestions?: GoogleAppsCardV1Suggestions;
|
|
561
561
|
/** The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional. */
|
|
562
562
|
label?: string;
|
|
563
|
-
/** The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
563
|
+
/** The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
564
564
|
name?: string;
|
|
565
|
-
/** What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/chat/
|
|
565
|
+
/** What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat. */
|
|
566
566
|
onChangeAction?: GoogleAppsCardV1Action;
|
|
567
567
|
/** Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat): */
|
|
568
568
|
placeholderText?: string;
|
|
569
569
|
/** How a text input field appears in the user interface. For example, whether the field is single or multi-line. */
|
|
570
570
|
type?: string;
|
|
571
|
-
/** The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/chat/
|
|
571
|
+
/** The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
572
572
|
value?: string;
|
|
573
573
|
}
|
|
574
574
|
interface GoogleAppsCardV1TextParagraph {
|
|
@@ -590,13 +590,13 @@ declare namespace gapi.client {
|
|
|
590
590
|
grid?: GoogleAppsCardV1Grid;
|
|
591
591
|
/** Specifies whether widgets align to the left, right, or center of a column. */
|
|
592
592
|
horizontalAlignment?: string;
|
|
593
|
-
/** Displays an image. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" } ``` */
|
|
593
|
+
/** Displays an image. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" } ``` */
|
|
594
594
|
image?: GoogleAppsCardV1Image;
|
|
595
595
|
/** 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 } ] } ``` */
|
|
596
596
|
selectionInput?: GoogleAppsCardV1SelectionInput;
|
|
597
597
|
/** 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": "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } } ``` */
|
|
598
598
|
textInput?: GoogleAppsCardV1TextInput;
|
|
599
|
-
/** Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace 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": " *bold text*" } ``` */
|
|
599
|
+
/** Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace 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": " *bold text*" } ``` */
|
|
600
600
|
textParagraph?: GoogleAppsCardV1TextParagraph;
|
|
601
601
|
}
|
|
602
602
|
interface GoogleAppsCardV1Widgets {
|
|
@@ -652,11 +652,11 @@ declare namespace gapi.client {
|
|
|
652
652
|
timeInput?: TimeInput;
|
|
653
653
|
}
|
|
654
654
|
interface KeyValue {
|
|
655
|
-
/** The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
655
|
+
/** The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
656
656
|
bottomLabel?: string;
|
|
657
657
|
/** A button that can be clicked to trigger an action. */
|
|
658
658
|
button?: Button;
|
|
659
|
-
/** The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
659
|
+
/** The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
660
660
|
content?: string;
|
|
661
661
|
/** If the content should be multiline. */
|
|
662
662
|
contentMultiline?: boolean;
|
|
@@ -666,7 +666,7 @@ declare namespace gapi.client {
|
|
|
666
666
|
iconUrl?: string;
|
|
667
667
|
/** The `onclick` action. Only the top label, bottom label, and content region are clickable. */
|
|
668
668
|
onClick?: OnClick;
|
|
669
|
-
/** The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
669
|
+
/** The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
670
670
|
topLabel?: string;
|
|
671
671
|
}
|
|
672
672
|
interface ListMembershipsResponse {
|
|
@@ -714,7 +714,7 @@ declare namespace gapi.client {
|
|
|
714
714
|
deleteTime?: string;
|
|
715
715
|
/** The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. */
|
|
716
716
|
groupMember?: Group;
|
|
717
|
-
/** The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
717
|
+
/** The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type`. */
|
|
718
718
|
member?: User;
|
|
719
719
|
/** Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}` */
|
|
720
720
|
name?: string;
|
|
@@ -748,7 +748,7 @@ declare namespace gapi.client {
|
|
|
748
748
|
membership?: Membership;
|
|
749
749
|
}
|
|
750
750
|
interface Message {
|
|
751
|
-
/** One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/
|
|
751
|
+
/** One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). */
|
|
752
752
|
accessoryWidgets?: AccessoryWidget[];
|
|
753
753
|
/** Input only. Parameters that a Chat app can use to configure how its response is posted. */
|
|
754
754
|
actionResponse?: ActionResponse;
|
|
@@ -762,9 +762,9 @@ declare namespace gapi.client {
|
|
|
762
762
|
attachment?: Attachment[];
|
|
763
763
|
/** Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB. */
|
|
764
764
|
cards?: Card[];
|
|
765
|
-
/** An array of [cards](https://developers.google.com/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
765
|
+
/** An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the messages can't contain cards. To learn about cards and how to create them, see [Send card messages](https://developers.google.com/workspace/chat/create-messages#create). [Card builder](https://addons.gsuite.google.com/uikit/builder) */
|
|
766
766
|
cardsV2?: CardWithId[];
|
|
767
|
-
/** Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/chat/
|
|
767
|
+
/** Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
768
768
|
clientAssignedMessageId?: string;
|
|
769
769
|
/** Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time. */
|
|
770
770
|
createTime?: string;
|
|
@@ -776,27 +776,27 @@ declare namespace gapi.client {
|
|
|
776
776
|
emojiReactionSummaries?: EmojiReactionSummary[];
|
|
777
777
|
/** A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. */
|
|
778
778
|
fallbackText?: string;
|
|
779
|
-
/** Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message) */
|
|
779
|
+
/** Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message) */
|
|
780
780
|
formattedText?: string;
|
|
781
781
|
/** Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. */
|
|
782
782
|
lastUpdateTime?: string;
|
|
783
|
-
/** Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/chat/
|
|
783
|
+
/** Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). */
|
|
784
784
|
matchedUrl?: MatchedUrl;
|
|
785
|
-
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
785
|
+
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
786
786
|
name?: string;
|
|
787
|
-
/** Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
787
|
+
/** Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) to send a message, the message can't be private and must omit this field. For details, see [Send private messages to Google Chat users](https://developers.google.com/workspace/chat/private-messages). */
|
|
788
788
|
privateMessageViewer?: User;
|
|
789
789
|
/** Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. */
|
|
790
790
|
quotedMessageMetadata?: QuotedMessageMetadata;
|
|
791
|
-
/** Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
791
|
+
/** Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type`. */
|
|
792
792
|
sender?: User;
|
|
793
793
|
/** Output only. Slash command information, if applicable. */
|
|
794
794
|
slashCommand?: SlashCommand;
|
|
795
|
-
/** If your Chat app [authenticates as a user](https://developers.google.com/chat/
|
|
795
|
+
/** If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. */
|
|
796
796
|
space?: Space;
|
|
797
|
-
/** Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/
|
|
797
|
+
/** Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). */
|
|
798
798
|
text?: string;
|
|
799
|
-
/** The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/
|
|
799
|
+
/** The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). */
|
|
800
800
|
thread?: Thread;
|
|
801
801
|
/** Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`. */
|
|
802
802
|
threadReply?: boolean;
|
|
@@ -874,7 +874,7 @@ declare namespace gapi.client {
|
|
|
874
874
|
uri?: string;
|
|
875
875
|
}
|
|
876
876
|
interface Section {
|
|
877
|
-
/** The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
877
|
+
/** The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */
|
|
878
878
|
header?: string;
|
|
879
879
|
/** A section must contain at least one widget. */
|
|
880
880
|
widgets?: WidgetMarkup[];
|
|
@@ -912,9 +912,9 @@ declare namespace gapi.client {
|
|
|
912
912
|
adminInstalled?: boolean;
|
|
913
913
|
/** Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. */
|
|
914
914
|
createTime?: string;
|
|
915
|
-
/** The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. */
|
|
915
|
+
/** The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. */
|
|
916
916
|
displayName?: string;
|
|
917
|
-
/** Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/
|
|
917
|
+
/** Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/workspace/chat/import-data). Import mode spaces must only permit members from the same Google Workspace organization. For existing spaces, this field is output only. */
|
|
918
918
|
externalUserAllowed?: boolean;
|
|
919
919
|
/** Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. */
|
|
920
920
|
importMode?: boolean;
|
|
@@ -1106,7 +1106,7 @@ declare namespace gapi.client {
|
|
|
1106
1106
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1107
1107
|
uploadType?: string;
|
|
1108
1108
|
}): Request<Media>;
|
|
1109
|
-
/** Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/chat/
|
|
1109
|
+
/** Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat). */
|
|
1110
1110
|
upload(request: {
|
|
1111
1111
|
/** V1 error format. */
|
|
1112
1112
|
'$.xgafv'?: string;
|
|
@@ -1166,7 +1166,7 @@ declare namespace gapi.client {
|
|
|
1166
1166
|
): Request<UploadAttachmentResponse>;
|
|
1167
1167
|
}
|
|
1168
1168
|
interface MembersResource {
|
|
1169
|
-
/** Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [
|
|
1169
|
+
/** Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [Invite or add a user or a Google Chat app to a space](https://developers.google.com/workspace/chat/create-members). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. */
|
|
1170
1170
|
create(request: {
|
|
1171
1171
|
/** V1 error format. */
|
|
1172
1172
|
'$.xgafv'?: string;
|
|
@@ -1224,7 +1224,7 @@ declare namespace gapi.client {
|
|
|
1224
1224
|
},
|
|
1225
1225
|
body: Membership
|
|
1226
1226
|
): Request<Membership>;
|
|
1227
|
-
/** Deletes a membership. For an example, see [
|
|
1227
|
+
/** Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1228
1228
|
delete(request?: {
|
|
1229
1229
|
/** V1 error format. */
|
|
1230
1230
|
'$.xgafv'?: string;
|
|
@@ -1251,7 +1251,7 @@ declare namespace gapi.client {
|
|
|
1251
1251
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1252
1252
|
uploadType?: string;
|
|
1253
1253
|
}): Request<Membership>;
|
|
1254
|
-
/** Returns details about a membership. For an example, see [Get a membership](https://developers.google.com/chat/
|
|
1254
|
+
/** Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1255
1255
|
get(request?: {
|
|
1256
1256
|
/** V1 error format. */
|
|
1257
1257
|
'$.xgafv'?: string;
|
|
@@ -1265,7 +1265,7 @@ declare namespace gapi.client {
|
|
|
1265
1265
|
fields?: string;
|
|
1266
1266
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1267
1267
|
key?: string;
|
|
1268
|
-
/** Required. Resource name of the membership to retrieve. To get the app's own membership, you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a user](https://developers.google.com/chat/
|
|
1268
|
+
/** Required. Resource name of the membership to retrieve. To get the app's own membership, you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. */
|
|
1269
1269
|
name: string;
|
|
1270
1270
|
/** OAuth 2.0 token for the current user. */
|
|
1271
1271
|
oauth_token?: string;
|
|
@@ -1278,7 +1278,7 @@ declare namespace gapi.client {
|
|
|
1278
1278
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1279
1279
|
uploadType?: string;
|
|
1280
1280
|
}): Request<Membership>;
|
|
1281
|
-
/** Lists memberships in a space. For an example, see [List
|
|
1281
|
+
/** Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](hhttps://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1282
1282
|
list(request?: {
|
|
1283
1283
|
/** V1 error format. */
|
|
1284
1284
|
'$.xgafv'?: string;
|
|
@@ -1290,7 +1290,7 @@ declare namespace gapi.client {
|
|
|
1290
1290
|
callback?: string;
|
|
1291
1291
|
/** Selector specifying which fields to include in a partial response. */
|
|
1292
1292
|
fields?: string;
|
|
1293
|
-
/** Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. For example, the following queries are valid: ``` role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" ``` The following queries are invalid: ``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */
|
|
1293
|
+
/** Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. For example, the following queries are valid: ``` role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" ``` The following queries are invalid: ``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */
|
|
1294
1294
|
filter?: string;
|
|
1295
1295
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1296
1296
|
key?: string;
|
|
@@ -1308,7 +1308,7 @@ declare namespace gapi.client {
|
|
|
1308
1308
|
quotaUser?: string;
|
|
1309
1309
|
/** Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned. */
|
|
1310
1310
|
showGroups?: boolean;
|
|
1311
|
-
/** Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/chat/
|
|
1311
|
+
/** Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1312
1312
|
showInvited?: boolean;
|
|
1313
1313
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1314
1314
|
upload_protocol?: string;
|
|
@@ -1317,7 +1317,7 @@ declare namespace gapi.client {
|
|
|
1317
1317
|
}): Request<ListMembershipsResponse>;
|
|
1318
1318
|
}
|
|
1319
1319
|
interface AttachmentsResource {
|
|
1320
|
-
/** Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/chat/api/reference/rest/v1/media/download). For an example, see [Get a message attachment](https://developers.google.com/chat/
|
|
1320
|
+
/** Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). */
|
|
1321
1321
|
get(request?: {
|
|
1322
1322
|
/** V1 error format. */
|
|
1323
1323
|
'$.xgafv'?: string;
|
|
@@ -1346,7 +1346,7 @@ declare namespace gapi.client {
|
|
|
1346
1346
|
}): Request<Attachment>;
|
|
1347
1347
|
}
|
|
1348
1348
|
interface ReactionsResource {
|
|
1349
|
-
/** Creates a reaction and adds it to a message. For an example, see [
|
|
1349
|
+
/** Creates a reaction and adds it to a message. Only unicode emojis are supported.For an example, see [Add a reaction to a reaction](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1350
1350
|
create(request: {
|
|
1351
1351
|
/** V1 error format. */
|
|
1352
1352
|
'$.xgafv'?: string;
|
|
@@ -1404,7 +1404,7 @@ declare namespace gapi.client {
|
|
|
1404
1404
|
},
|
|
1405
1405
|
body: Reaction
|
|
1406
1406
|
): Request<Reaction>;
|
|
1407
|
-
/** Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/chat/
|
|
1407
|
+
/** Deletes a reaction to a message. Only unicode emojis are supported. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1408
1408
|
delete(request?: {
|
|
1409
1409
|
/** V1 error format. */
|
|
1410
1410
|
'$.xgafv'?: string;
|
|
@@ -1431,7 +1431,7 @@ declare namespace gapi.client {
|
|
|
1431
1431
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1432
1432
|
uploadType?: string;
|
|
1433
1433
|
}): Request<{}>;
|
|
1434
|
-
/** Lists reactions to a message. For an example, see [List reactions](https://developers.google.com/chat/
|
|
1434
|
+
/** Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1435
1435
|
list(request?: {
|
|
1436
1436
|
/** V1 error format. */
|
|
1437
1437
|
'$.xgafv'?: string;
|
|
@@ -1443,7 +1443,7 @@ declare namespace gapi.client {
|
|
|
1443
1443
|
callback?: string;
|
|
1444
1444
|
/** Selector specifying which fields to include in a partial response. */
|
|
1445
1445
|
fields?: string;
|
|
1446
|
-
/** Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = "🙂" OR emoji.unicode = "👍"` and `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}" ``` The following queries are invalid: ``` emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */
|
|
1446
|
+
/** Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = "🙂" OR emoji.unicode = "👍"` and `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}" ``` The following queries are invalid: ``` emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */
|
|
1447
1447
|
filter?: string;
|
|
1448
1448
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1449
1449
|
key?: string;
|
|
@@ -1466,7 +1466,7 @@ declare namespace gapi.client {
|
|
|
1466
1466
|
}): Request<ListReactionsResponse>;
|
|
1467
1467
|
}
|
|
1468
1468
|
interface MessagesResource {
|
|
1469
|
-
/** Creates a message in a Google Chat space. For an example, see [
|
|
1469
|
+
/** Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Calling this method requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) and supports the following authentication types: - For text messages, user authentication or app authentication are supported. - For card messages, only app authentication is supported. (Only Chat apps can create card messages.) */
|
|
1470
1470
|
create(request: {
|
|
1471
1471
|
/** V1 error format. */
|
|
1472
1472
|
'$.xgafv'?: string;
|
|
@@ -1480,7 +1480,7 @@ declare namespace gapi.client {
|
|
|
1480
1480
|
fields?: string;
|
|
1481
1481
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1482
1482
|
key?: string;
|
|
1483
|
-
/** Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/chat/
|
|
1483
|
+
/** Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1484
1484
|
messageId?: string;
|
|
1485
1485
|
/** Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. */
|
|
1486
1486
|
messageReplyOption?: string;
|
|
@@ -1494,7 +1494,7 @@ declare namespace gapi.client {
|
|
|
1494
1494
|
quotaUser?: string;
|
|
1495
1495
|
/** Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. */
|
|
1496
1496
|
requestId?: string;
|
|
1497
|
-
/** Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/
|
|
1497
|
+
/** Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). */
|
|
1498
1498
|
threadKey?: string;
|
|
1499
1499
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1500
1500
|
upload_protocol?: string;
|
|
@@ -1517,7 +1517,7 @@ declare namespace gapi.client {
|
|
|
1517
1517
|
fields?: string;
|
|
1518
1518
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1519
1519
|
key?: string;
|
|
1520
|
-
/** Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/chat/
|
|
1520
|
+
/** Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1521
1521
|
messageId?: string;
|
|
1522
1522
|
/** Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. */
|
|
1523
1523
|
messageReplyOption?: string;
|
|
@@ -1531,7 +1531,7 @@ declare namespace gapi.client {
|
|
|
1531
1531
|
quotaUser?: string;
|
|
1532
1532
|
/** Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. */
|
|
1533
1533
|
requestId?: string;
|
|
1534
|
-
/** Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/
|
|
1534
|
+
/** Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). */
|
|
1535
1535
|
threadKey?: string;
|
|
1536
1536
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1537
1537
|
upload_protocol?: string;
|
|
@@ -1540,7 +1540,7 @@ declare namespace gapi.client {
|
|
|
1540
1540
|
},
|
|
1541
1541
|
body: Message
|
|
1542
1542
|
): Request<Message>;
|
|
1543
|
-
/** Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/
|
|
1543
|
+
/** Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only delete messages created by the calling Chat app. */
|
|
1544
1544
|
delete(request?: {
|
|
1545
1545
|
/** V1 error format. */
|
|
1546
1546
|
'$.xgafv'?: string;
|
|
@@ -1552,11 +1552,11 @@ declare namespace gapi.client {
|
|
|
1552
1552
|
callback?: string;
|
|
1553
1553
|
/** Selector specifying which fields to include in a partial response. */
|
|
1554
1554
|
fields?: string;
|
|
1555
|
-
/** When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/chat/
|
|
1555
|
+
/** When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). */
|
|
1556
1556
|
force?: boolean;
|
|
1557
1557
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1558
1558
|
key?: string;
|
|
1559
|
-
/** Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/chat/
|
|
1559
|
+
/** Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1560
1560
|
name: string;
|
|
1561
1561
|
/** OAuth 2.0 token for the current user. */
|
|
1562
1562
|
oauth_token?: string;
|
|
@@ -1569,7 +1569,7 @@ declare namespace gapi.client {
|
|
|
1569
1569
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1570
1570
|
uploadType?: string;
|
|
1571
1571
|
}): Request<{}>;
|
|
1572
|
-
/** Returns details about a message. For an example, see [
|
|
1572
|
+
/** Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Note: Might return a message from a blocked member or space. */
|
|
1573
1573
|
get(request?: {
|
|
1574
1574
|
/** V1 error format. */
|
|
1575
1575
|
'$.xgafv'?: string;
|
|
@@ -1583,7 +1583,7 @@ declare namespace gapi.client {
|
|
|
1583
1583
|
fields?: string;
|
|
1584
1584
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1585
1585
|
key?: string;
|
|
1586
|
-
/** Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/chat/
|
|
1586
|
+
/** Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1587
1587
|
name: string;
|
|
1588
1588
|
/** OAuth 2.0 token for the current user. */
|
|
1589
1589
|
oauth_token?: string;
|
|
@@ -1596,7 +1596,7 @@ declare namespace gapi.client {
|
|
|
1596
1596
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1597
1597
|
uploadType?: string;
|
|
1598
1598
|
}): Request<Message>;
|
|
1599
|
-
/** 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). Requires [user authentication](https://developers.google.com/chat/
|
|
1599
|
+
/** 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). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1600
1600
|
list(request?: {
|
|
1601
1601
|
/** V1 error format. */
|
|
1602
1602
|
'$.xgafv'?: string;
|
|
@@ -1633,13 +1633,13 @@ declare namespace gapi.client {
|
|
|
1633
1633
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1634
1634
|
uploadType?: string;
|
|
1635
1635
|
}): Request<ListMessagesResponse>;
|
|
1636
|
-
/** Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/
|
|
1636
|
+
/** Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app. */
|
|
1637
1637
|
patch(request: {
|
|
1638
1638
|
/** V1 error format. */
|
|
1639
1639
|
'$.xgafv'?: string;
|
|
1640
1640
|
/** OAuth access token. */
|
|
1641
1641
|
access_token?: string;
|
|
1642
|
-
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/
|
|
1642
|
+
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails. */
|
|
1643
1643
|
allowMissing?: boolean;
|
|
1644
1644
|
/** Data format for response. */
|
|
1645
1645
|
alt?: string;
|
|
@@ -1649,7 +1649,7 @@ declare namespace gapi.client {
|
|
|
1649
1649
|
fields?: string;
|
|
1650
1650
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1651
1651
|
key?: string;
|
|
1652
|
-
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
1652
|
+
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1653
1653
|
name: string;
|
|
1654
1654
|
/** OAuth 2.0 token for the current user. */
|
|
1655
1655
|
oauth_token?: string;
|
|
@@ -1672,7 +1672,7 @@ declare namespace gapi.client {
|
|
|
1672
1672
|
'$.xgafv'?: string;
|
|
1673
1673
|
/** OAuth access token. */
|
|
1674
1674
|
access_token?: string;
|
|
1675
|
-
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/
|
|
1675
|
+
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails. */
|
|
1676
1676
|
allowMissing?: boolean;
|
|
1677
1677
|
/** Data format for response. */
|
|
1678
1678
|
alt?: string;
|
|
@@ -1682,7 +1682,7 @@ declare namespace gapi.client {
|
|
|
1682
1682
|
fields?: string;
|
|
1683
1683
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1684
1684
|
key?: string;
|
|
1685
|
-
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
1685
|
+
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1686
1686
|
name: string;
|
|
1687
1687
|
/** OAuth 2.0 token for the current user. */
|
|
1688
1688
|
oauth_token?: string;
|
|
@@ -1699,13 +1699,13 @@ declare namespace gapi.client {
|
|
|
1699
1699
|
},
|
|
1700
1700
|
body: Message
|
|
1701
1701
|
): Request<Message>;
|
|
1702
|
-
/** Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/
|
|
1702
|
+
/** Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app. */
|
|
1703
1703
|
update(request: {
|
|
1704
1704
|
/** V1 error format. */
|
|
1705
1705
|
'$.xgafv'?: string;
|
|
1706
1706
|
/** OAuth access token. */
|
|
1707
1707
|
access_token?: string;
|
|
1708
|
-
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/
|
|
1708
|
+
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails. */
|
|
1709
1709
|
allowMissing?: boolean;
|
|
1710
1710
|
/** Data format for response. */
|
|
1711
1711
|
alt?: string;
|
|
@@ -1715,7 +1715,7 @@ declare namespace gapi.client {
|
|
|
1715
1715
|
fields?: string;
|
|
1716
1716
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1717
1717
|
key?: string;
|
|
1718
|
-
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
1718
|
+
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1719
1719
|
name: string;
|
|
1720
1720
|
/** OAuth 2.0 token for the current user. */
|
|
1721
1721
|
oauth_token?: string;
|
|
@@ -1738,7 +1738,7 @@ declare namespace gapi.client {
|
|
|
1738
1738
|
'$.xgafv'?: string;
|
|
1739
1739
|
/** OAuth access token. */
|
|
1740
1740
|
access_token?: string;
|
|
1741
|
-
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/chat/
|
|
1741
|
+
/** Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails. */
|
|
1742
1742
|
allowMissing?: boolean;
|
|
1743
1743
|
/** Data format for response. */
|
|
1744
1744
|
alt?: string;
|
|
@@ -1748,7 +1748,7 @@ declare namespace gapi.client {
|
|
|
1748
1748
|
fields?: string;
|
|
1749
1749
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1750
1750
|
key?: string;
|
|
1751
|
-
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/chat/
|
|
1751
|
+
/** Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). */
|
|
1752
1752
|
name: string;
|
|
1753
1753
|
/** OAuth 2.0 token for the current user. */
|
|
1754
1754
|
oauth_token?: string;
|
|
@@ -1769,7 +1769,7 @@ declare namespace gapi.client {
|
|
|
1769
1769
|
reactions: ReactionsResource;
|
|
1770
1770
|
}
|
|
1771
1771
|
interface SpaceEventsResource {
|
|
1772
|
-
/** Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Requires [user authentication](
|
|
1772
|
+
/** Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Requires [user authentication](hhttps://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event). */
|
|
1773
1773
|
get(request?: {
|
|
1774
1774
|
/** V1 error format. */
|
|
1775
1775
|
'$.xgafv'?: string;
|
|
@@ -1796,7 +1796,7 @@ declare namespace gapi.client {
|
|
|
1796
1796
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1797
1797
|
uploadType?: string;
|
|
1798
1798
|
}): Request<SpaceEvent>;
|
|
1799
|
-
/** Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/chat/
|
|
1799
|
+
/** Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events). */
|
|
1800
1800
|
list(request?: {
|
|
1801
1801
|
/** V1 error format. */
|
|
1802
1802
|
'$.xgafv'?: string;
|
|
@@ -1831,7 +1831,7 @@ declare namespace gapi.client {
|
|
|
1831
1831
|
}): Request<ListSpaceEventsResponse>;
|
|
1832
1832
|
}
|
|
1833
1833
|
interface SpacesResource {
|
|
1834
|
-
/** Completes the [import process](https://developers.google.com/chat/
|
|
1834
|
+
/** Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import). */
|
|
1835
1835
|
completeImport(request: {
|
|
1836
1836
|
/** V1 error format. */
|
|
1837
1837
|
'$.xgafv'?: string;
|
|
@@ -1889,7 +1889,7 @@ declare namespace gapi.client {
|
|
|
1889
1889
|
},
|
|
1890
1890
|
body: CompleteImportSpaceRequest
|
|
1891
1891
|
): Request<CompleteImportSpaceResponse>;
|
|
1892
|
-
/** Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/chat/
|
|
1892
|
+
/** Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
1893
1893
|
create(request: {
|
|
1894
1894
|
/** V1 error format. */
|
|
1895
1895
|
'$.xgafv'?: string;
|
|
@@ -1947,7 +1947,7 @@ declare namespace gapi.client {
|
|
|
1947
1947
|
},
|
|
1948
1948
|
body: Space
|
|
1949
1949
|
): Request<Space>;
|
|
1950
|
-
/** Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/chat/
|
|
1950
|
+
/** Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) from a user who has permission to delete the space. */
|
|
1951
1951
|
delete(request?: {
|
|
1952
1952
|
/** V1 error format. */
|
|
1953
1953
|
'$.xgafv'?: string;
|
|
@@ -1974,7 +1974,7 @@ declare namespace gapi.client {
|
|
|
1974
1974
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1975
1975
|
uploadType?: string;
|
|
1976
1976
|
}): Request<{}>;
|
|
1977
|
-
/** Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/chat/
|
|
1977
|
+
/** Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). */
|
|
1978
1978
|
findDirectMessage(request?: {
|
|
1979
1979
|
/** V1 error format. */
|
|
1980
1980
|
'$.xgafv'?: string;
|
|
@@ -1988,7 +1988,7 @@ declare namespace gapi.client {
|
|
|
1988
1988
|
fields?: string;
|
|
1989
1989
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1990
1990
|
key?: string;
|
|
1991
|
-
/** Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/chat/
|
|
1991
|
+
/** Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. */
|
|
1992
1992
|
name?: string;
|
|
1993
1993
|
/** OAuth 2.0 token for the current user. */
|
|
1994
1994
|
oauth_token?: string;
|
|
@@ -2001,7 +2001,7 @@ declare namespace gapi.client {
|
|
|
2001
2001
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2002
2002
|
uploadType?: string;
|
|
2003
2003
|
}): Request<Space>;
|
|
2004
|
-
/** Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/
|
|
2004
|
+
/** Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
2005
2005
|
get(request?: {
|
|
2006
2006
|
/** V1 error format. */
|
|
2007
2007
|
'$.xgafv'?: string;
|
|
@@ -2028,7 +2028,7 @@ declare namespace gapi.client {
|
|
|
2028
2028
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2029
2029
|
uploadType?: string;
|
|
2030
2030
|
}): Request<Space>;
|
|
2031
|
-
/** Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/chat/
|
|
2031
|
+
/** Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. */
|
|
2032
2032
|
list(request?: {
|
|
2033
2033
|
/** V1 error format. */
|
|
2034
2034
|
'$.xgafv'?: string;
|
|
@@ -2040,7 +2040,7 @@ declare namespace gapi.client {
|
|
|
2040
2040
|
callback?: string;
|
|
2041
2041
|
/** Selector specifying which fields to include in a partial response. */
|
|
2042
2042
|
fields?: string;
|
|
2043
|
-
/** Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */
|
|
2043
|
+
/** Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */
|
|
2044
2044
|
filter?: string;
|
|
2045
2045
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2046
2046
|
key?: string;
|
|
@@ -2059,7 +2059,7 @@ declare namespace gapi.client {
|
|
|
2059
2059
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2060
2060
|
uploadType?: string;
|
|
2061
2061
|
}): Request<ListSpacesResponse>;
|
|
2062
|
-
/** Updates a space. For an example, see [Update a space](https://developers.google.com/chat/
|
|
2062
|
+
/** Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
2063
2063
|
patch(request: {
|
|
2064
2064
|
/** V1 error format. */
|
|
2065
2065
|
'$.xgafv'?: string;
|
|
@@ -2121,7 +2121,7 @@ declare namespace gapi.client {
|
|
|
2121
2121
|
},
|
|
2122
2122
|
body: Space
|
|
2123
2123
|
): Request<Space>;
|
|
2124
|
-
/** Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space](https://developers.google.com/chat/
|
|
2124
|
+
/** Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
2125
2125
|
setup(request: {
|
|
2126
2126
|
/** V1 error format. */
|
|
2127
2127
|
'$.xgafv'?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -117,47 +117,47 @@ Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.
|
|
|
117
117
|
await gapi.client.chat.media.download({resourceName: 'resourceName'});
|
|
118
118
|
|
|
119
119
|
/*
|
|
120
|
-
Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/chat/
|
|
120
|
+
Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).
|
|
121
121
|
*/
|
|
122
122
|
await gapi.client.chat.media.upload({parent: 'parent'});
|
|
123
123
|
|
|
124
124
|
/*
|
|
125
|
-
Completes the [import process](https://developers.google.com/chat/
|
|
125
|
+
Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import).
|
|
126
126
|
*/
|
|
127
127
|
await gapi.client.chat.spaces.completeImport({name: 'name'});
|
|
128
128
|
|
|
129
129
|
/*
|
|
130
|
-
Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/chat/
|
|
130
|
+
Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
131
131
|
*/
|
|
132
132
|
await gapi.client.chat.spaces.create({});
|
|
133
133
|
|
|
134
134
|
/*
|
|
135
|
-
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/chat/
|
|
135
|
+
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) from a user who has permission to delete the space.
|
|
136
136
|
*/
|
|
137
137
|
await gapi.client.chat.spaces.delete({name: 'name'});
|
|
138
138
|
|
|
139
139
|
/*
|
|
140
|
-
Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/chat/
|
|
140
|
+
Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
|
|
141
141
|
*/
|
|
142
142
|
await gapi.client.chat.spaces.findDirectMessage({});
|
|
143
143
|
|
|
144
144
|
/*
|
|
145
|
-
Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/
|
|
145
|
+
Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
146
146
|
*/
|
|
147
147
|
await gapi.client.chat.spaces.get({name: 'name'});
|
|
148
148
|
|
|
149
149
|
/*
|
|
150
|
-
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/chat/
|
|
150
|
+
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent.
|
|
151
151
|
*/
|
|
152
152
|
await gapi.client.chat.spaces.list({});
|
|
153
153
|
|
|
154
154
|
/*
|
|
155
|
-
Updates a space. For an example, see [Update a space](https://developers.google.com/chat/
|
|
155
|
+
Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
156
156
|
*/
|
|
157
157
|
await gapi.client.chat.spaces.patch({name: 'name'});
|
|
158
158
|
|
|
159
159
|
/*
|
|
160
|
-
Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space](https://developers.google.com/chat/
|
|
160
|
+
Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
|
|
161
161
|
*/
|
|
162
162
|
await gapi.client.chat.spaces.setup({});
|
|
163
163
|
```
|