@maxim_mazurok/gapi.client.chat-v1 0.1.20260315 → 0.2.20260602
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 +834 -173
- package/package.json +1 -1
- package/readme.md +29 -0
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: 20260602
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -30,7 +30,7 @@ declare namespace gapi.client {
|
|
|
30
30
|
}
|
|
31
31
|
interface AccessSettings {
|
|
32
32
|
/** Output only. Indicates the access state of the space. */
|
|
33
|
-
accessState?:
|
|
33
|
+
accessState?: 'ACCESS_STATE_UNSPECIFIED' | 'PRIVATE' | 'DISCOVERABLE';
|
|
34
34
|
/** Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
|
|
35
35
|
audience?: string;
|
|
36
36
|
}
|
|
@@ -44,7 +44,14 @@ declare namespace gapi.client {
|
|
|
44
44
|
/** 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`. */
|
|
45
45
|
dialogAction?: DialogAction;
|
|
46
46
|
/** Input only. The type of Chat app response. */
|
|
47
|
-
type?:
|
|
47
|
+
type?:
|
|
48
|
+
| 'TYPE_UNSPECIFIED'
|
|
49
|
+
| 'NEW_MESSAGE'
|
|
50
|
+
| 'UPDATE_MESSAGE'
|
|
51
|
+
| 'UPDATE_USER_MESSAGE_CARDS'
|
|
52
|
+
| 'REQUEST_CONFIG'
|
|
53
|
+
| 'DIALOG'
|
|
54
|
+
| 'UPDATE_WIDGET';
|
|
48
55
|
/** Input only. The response of the updated widget. */
|
|
49
56
|
updatedWidget?: UpdatedWidget;
|
|
50
57
|
/** Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.) */
|
|
@@ -52,7 +59,24 @@ declare namespace gapi.client {
|
|
|
52
59
|
}
|
|
53
60
|
interface ActionStatus {
|
|
54
61
|
/** The status code. */
|
|
55
|
-
statusCode?:
|
|
62
|
+
statusCode?:
|
|
63
|
+
| 'OK'
|
|
64
|
+
| 'CANCELLED'
|
|
65
|
+
| 'UNKNOWN'
|
|
66
|
+
| 'INVALID_ARGUMENT'
|
|
67
|
+
| 'DEADLINE_EXCEEDED'
|
|
68
|
+
| 'NOT_FOUND'
|
|
69
|
+
| 'ALREADY_EXISTS'
|
|
70
|
+
| 'PERMISSION_DENIED'
|
|
71
|
+
| 'UNAUTHENTICATED'
|
|
72
|
+
| 'RESOURCE_EXHAUSTED'
|
|
73
|
+
| 'FAILED_PRECONDITION'
|
|
74
|
+
| 'ABORTED'
|
|
75
|
+
| 'OUT_OF_RANGE'
|
|
76
|
+
| 'UNIMPLEMENTED'
|
|
77
|
+
| 'INTERNAL'
|
|
78
|
+
| 'UNAVAILABLE'
|
|
79
|
+
| 'DATA_LOSS';
|
|
56
80
|
/** The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. */
|
|
57
81
|
userFacingMessage?: string;
|
|
58
82
|
}
|
|
@@ -68,7 +92,12 @@ declare namespace gapi.client {
|
|
|
68
92
|
/** Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to. */
|
|
69
93
|
startIndex?: number;
|
|
70
94
|
/** The type of this annotation. */
|
|
71
|
-
type?:
|
|
95
|
+
type?:
|
|
96
|
+
| 'ANNOTATION_TYPE_UNSPECIFIED'
|
|
97
|
+
| 'USER_MENTION'
|
|
98
|
+
| 'SLASH_COMMAND'
|
|
99
|
+
| 'RICH_LINK'
|
|
100
|
+
| 'CUSTOM_EMOJI';
|
|
72
101
|
/** The metadata of user mention. */
|
|
73
102
|
userMention?: UserMentionMetadata;
|
|
74
103
|
}
|
|
@@ -76,7 +105,10 @@ declare namespace gapi.client {
|
|
|
76
105
|
/** The ID for the command specified in the Chat API configuration. */
|
|
77
106
|
appCommandId?: number;
|
|
78
107
|
/** The type of Chat app command. */
|
|
79
|
-
appCommandType?:
|
|
108
|
+
appCommandType?:
|
|
109
|
+
| 'APP_COMMAND_TYPE_UNSPECIFIED'
|
|
110
|
+
| 'SLASH_COMMAND'
|
|
111
|
+
| 'QUICK_COMMAND';
|
|
80
112
|
}
|
|
81
113
|
interface AttachedGif {
|
|
82
114
|
/** Output only. The URL that hosts the GIF image. */
|
|
@@ -96,7 +128,7 @@ declare namespace gapi.client {
|
|
|
96
128
|
/** Identifier. Resource name of the attachment. Format: `spaces/{space}/messages/{message}/attachments/{attachment}`. */
|
|
97
129
|
name?: string;
|
|
98
130
|
/** Output only. The source of the attachment. */
|
|
99
|
-
source?:
|
|
131
|
+
source?: 'SOURCE_UNSPECIFIED' | 'DRIVE_FILE' | 'UPLOADED_CONTENT';
|
|
100
132
|
/** Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content. */
|
|
101
133
|
thumbnailUri?: string;
|
|
102
134
|
}
|
|
@@ -136,7 +168,7 @@ declare namespace gapi.client {
|
|
|
136
168
|
}
|
|
137
169
|
interface CardHeader {
|
|
138
170
|
/** The image's type (for example, square border or circular border). */
|
|
139
|
-
imageStyle?:
|
|
171
|
+
imageStyle?: 'IMAGE_STYLE_UNSPECIFIED' | 'IMAGE' | 'AVATAR';
|
|
140
172
|
/** The URL of the image in the card header. */
|
|
141
173
|
imageUrl?: string;
|
|
142
174
|
/** The subtitle of the card header. */
|
|
@@ -184,13 +216,24 @@ declare namespace gapi.client {
|
|
|
184
216
|
/** A map containing the current values of the widgets in the displayed card. The map keys are the string IDs assigned with each widget. The structure of the map value object is dependent on the widget type: **Note**: The following examples are formatted for Apps Script's V8 runtime. If you're using Rhino runtime, you must add `[""]` after the value. For example, instead of `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`, format the event object as `e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]`. To learn more about runtimes in Apps Script, see the [V8 Runtime Overview](https://developers.google.com/apps-script/guides/v8-runtime). * Single-valued widgets (for example, a text box): a list of strings (only one element). **Example**: for a text input widget with `employeeName` as its ID, access the text input value with: `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`. * Multi-valued widgets (for example, checkbox groups): a list of strings. **Example**: for a multi-value widget with `participants` as its ID, access the value array with: `e.commonEventObject.formInputs.participants.stringInputs.value`. * **A date-time picker**: a [`DateTimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input). **Example**: For a picker with an ID of `myDTPicker`, access the [`DateTimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input) object using `e.commonEventObject.formInputs.myDTPicker.dateTimeInput`. * **A date-only picker**: a [`DateInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input). **Example**: For a picker with an ID of `myDatePicker`, access the [`DateInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input) object using `e.commonEventObject.formInputs.myDatePicker.dateInput`. * **A time-only picker**: a [`TimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input). **Example**: For a picker with an ID of `myTimePicker`, access the [`TimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input) object using `e.commonEventObject.formInputs.myTimePicker.timeInput`. */
|
|
185
217
|
formInputs?: {[P in string]: Inputs};
|
|
186
218
|
/** Indicates the host app the add-on is active in when the event object is generated. Possible values include the following: * `GMAIL` * `CALENDAR` * `DRIVE` * `DOCS` * `SHEETS` * `SLIDES` * `CHAT` */
|
|
187
|
-
hostApp?:
|
|
219
|
+
hostApp?:
|
|
220
|
+
| 'UNSPECIFIED_HOST_APP'
|
|
221
|
+
| 'GMAIL'
|
|
222
|
+
| 'CALENDAR'
|
|
223
|
+
| 'DRIVE'
|
|
224
|
+
| 'DEMO'
|
|
225
|
+
| 'DOCS'
|
|
226
|
+
| 'MEET'
|
|
227
|
+
| 'SHEETS'
|
|
228
|
+
| 'SLIDES'
|
|
229
|
+
| 'DRAWINGS'
|
|
230
|
+
| 'CHAT';
|
|
188
231
|
/** Name of the function to invoke. This field doesn't populate for Google Workspace Add-ons that extend Google Chat. Instead, to receive function data like identifiers, add-ons that extend Chat should use the `parameters` field. See [Build interactive interfaces for Chat apps](https://developers.google.com/workspace/add-ons/chat/build). */
|
|
189
232
|
invokedFunction?: string;
|
|
190
233
|
/** Any additional parameters you supply to an action using [`actionParameters`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#google.apps.card.v1.Action.ActionParameter) or [`Action.setParameters()`](https://developers.google.com/apps-script/reference/card-service/action#setparametersparameters). **Developer Preview:** For [add-ons that extend Google Chat](https://developers.google.com/workspace/add-ons/chat), to suggest items based on what the users type in multiselect menus, use the value of the `"autocomplete_widget_query"` key (`event.commonEventObject.parameters["autocomplete_widget_query"]`). You can use this value to query a database and suggest selectable items to users as they type. For details, see [Collect and process information from Google Chat users](https://developers.google.com/workspace/add-ons/chat/collect-information). */
|
|
191
234
|
parameters?: {[P in string]: string};
|
|
192
235
|
/** The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps. */
|
|
193
|
-
platform?:
|
|
236
|
+
platform?: 'UNKNOWN_PLATFORM' | 'WEB' | 'IOS' | 'ANDROID';
|
|
194
237
|
/** **Disabled by default.** The timezone ID and offset from Coordinated Universal Time (UTC). To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details. Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG). */
|
|
195
238
|
timeZone?: TimeZone;
|
|
196
239
|
/** **Disabled by default.** The user's language and country/region identifier in the format of [ISO 639](https://wikipedia.org/wiki/ISO_639_macrolanguage) language code-[ISO 3166](https://wikipedia.org/wiki/ISO_3166) country/region code. For example, `en-US`. To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details. */
|
|
@@ -237,7 +280,15 @@ declare namespace gapi.client {
|
|
|
237
280
|
}
|
|
238
281
|
interface DeletionMetadata {
|
|
239
282
|
/** Indicates who deleted the message. */
|
|
240
|
-
deletionType?:
|
|
283
|
+
deletionType?:
|
|
284
|
+
| 'DELETION_TYPE_UNSPECIFIED'
|
|
285
|
+
| 'CREATOR'
|
|
286
|
+
| 'SPACE_OWNER'
|
|
287
|
+
| 'ADMIN'
|
|
288
|
+
| 'APP_MESSAGE_EXPIRY'
|
|
289
|
+
| 'CREATOR_VIA_APP'
|
|
290
|
+
| 'SPACE_OWNER_VIA_APP'
|
|
291
|
+
| 'SPACE_MEMBER';
|
|
241
292
|
}
|
|
242
293
|
interface DeprecatedEvent {
|
|
243
294
|
/** 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). */
|
|
@@ -249,7 +300,11 @@ declare namespace gapi.client {
|
|
|
249
300
|
/** This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools). */
|
|
250
301
|
configCompleteRedirectUrl?: string;
|
|
251
302
|
/** The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received. */
|
|
252
|
-
dialogEventType?:
|
|
303
|
+
dialogEventType?:
|
|
304
|
+
| 'TYPE_UNSPECIFIED'
|
|
305
|
+
| 'REQUEST_DIALOG'
|
|
306
|
+
| 'SUBMIT_DIALOG'
|
|
307
|
+
| 'CANCEL_DIALOG';
|
|
253
308
|
/** The timestamp indicating when the interaction event occurred. */
|
|
254
309
|
eventTime?: string;
|
|
255
310
|
/** For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs). */
|
|
@@ -265,7 +320,14 @@ declare namespace gapi.client {
|
|
|
265
320
|
/** A secret value that legacy Chat apps can use to verify if a request is from Google. Google randomly generates the token, and its value remains static. You can obtain, revoke, or regenerate the token from the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat) in the Google Cloud Console. Modern Chat apps don't use this field. It is absent from API responses and the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat). */
|
|
266
321
|
token?: string;
|
|
267
322
|
/** The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`. */
|
|
268
|
-
type?:
|
|
323
|
+
type?:
|
|
324
|
+
| 'UNSPECIFIED'
|
|
325
|
+
| 'MESSAGE'
|
|
326
|
+
| 'ADDED_TO_SPACE'
|
|
327
|
+
| 'REMOVED_FROM_SPACE'
|
|
328
|
+
| 'CARD_CLICKED'
|
|
329
|
+
| 'WIDGET_UPDATED'
|
|
330
|
+
| 'APP_COMMAND';
|
|
269
331
|
/** The user that interacted with the Chat app. */
|
|
270
332
|
user?: User;
|
|
271
333
|
}
|
|
@@ -302,6 +364,12 @@ declare namespace gapi.client {
|
|
|
302
364
|
reactionCount?: number;
|
|
303
365
|
}
|
|
304
366
|
interface Empty {}
|
|
367
|
+
interface FindGroupChatsResponse {
|
|
368
|
+
/** A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
|
|
369
|
+
nextPageToken?: string;
|
|
370
|
+
/** List of spaces in the requested (or first) page. */
|
|
371
|
+
spaces?: Space[];
|
|
372
|
+
}
|
|
305
373
|
interface FormAction {
|
|
306
374
|
/** The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior. */
|
|
307
375
|
actionMethodName?: string;
|
|
@@ -320,9 +388,9 @@ declare namespace gapi.client {
|
|
|
320
388
|
/** A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data). */
|
|
321
389
|
function?: string;
|
|
322
390
|
/** 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): */
|
|
323
|
-
interaction?:
|
|
391
|
+
interaction?: 'INTERACTION_UNSPECIFIED' | 'OPEN_DIALOG';
|
|
324
392
|
/** Specifies the loading indicator that the action displays while making the call to the action. */
|
|
325
|
-
loadIndicator?:
|
|
393
|
+
loadIndicator?: 'SPINNER' | 'NONE';
|
|
326
394
|
/** List of action parameters. */
|
|
327
395
|
parameters?: GoogleAppsCardV1ActionParameter[];
|
|
328
396
|
/** 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`. */
|
|
@@ -342,7 +410,7 @@ declare namespace gapi.client {
|
|
|
342
410
|
/** The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0, "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored. */
|
|
343
411
|
strokeColor?: Color;
|
|
344
412
|
/** The border type. */
|
|
345
|
-
type?:
|
|
413
|
+
type?: 'BORDER_TYPE_UNSPECIFIED' | 'NO_BORDER' | 'STROKE';
|
|
346
414
|
}
|
|
347
415
|
interface GoogleAppsCardV1Button {
|
|
348
416
|
/** 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". */
|
|
@@ -358,7 +426,12 @@ declare namespace gapi.client {
|
|
|
358
426
|
/** The text displayed inside the button. */
|
|
359
427
|
text?: string;
|
|
360
428
|
/** Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored. */
|
|
361
|
-
type?:
|
|
429
|
+
type?:
|
|
430
|
+
| 'TYPE_UNSPECIFIED'
|
|
431
|
+
| 'OUTLINED'
|
|
432
|
+
| 'FILLED'
|
|
433
|
+
| 'FILLED_TONAL'
|
|
434
|
+
| 'BORDERLESS';
|
|
362
435
|
}
|
|
363
436
|
interface GoogleAppsCardV1ButtonList {
|
|
364
437
|
/** An array of buttons. */
|
|
@@ -368,7 +441,7 @@ declare namespace gapi.client {
|
|
|
368
441
|
/** The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` */
|
|
369
442
|
cardActions?: GoogleAppsCardV1CardAction[];
|
|
370
443
|
/** In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): */
|
|
371
|
-
displayStyle?:
|
|
444
|
+
displayStyle?: 'DISPLAY_STYLE_UNSPECIFIED' | 'PEEK' | 'REPLACE';
|
|
372
445
|
/** The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. */
|
|
373
446
|
expressionData?: GoogleAppsCardV1ExpressionData[];
|
|
374
447
|
/** 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): */
|
|
@@ -380,7 +453,10 @@ declare namespace gapi.client {
|
|
|
380
453
|
/** When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): */
|
|
381
454
|
peekCardHeader?: GoogleAppsCardV1CardHeader;
|
|
382
455
|
/** The divider style between the header, sections and footer. */
|
|
383
|
-
sectionDividerStyle?:
|
|
456
|
+
sectionDividerStyle?:
|
|
457
|
+
| 'DIVIDER_STYLE_UNSPECIFIED'
|
|
458
|
+
| 'SOLID_DIVIDER'
|
|
459
|
+
| 'NO_DIVIDER';
|
|
384
460
|
/** 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). */
|
|
385
461
|
sections?: GoogleAppsCardV1Section[];
|
|
386
462
|
}
|
|
@@ -400,7 +476,7 @@ declare namespace gapi.client {
|
|
|
400
476
|
/** The alternative text of this image that's used for accessibility. */
|
|
401
477
|
imageAltText?: string;
|
|
402
478
|
/** The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
403
|
-
imageType?:
|
|
479
|
+
imageType?: 'SQUARE' | 'CIRCLE';
|
|
404
480
|
/** The HTTPS URL of the image in the card header. */
|
|
405
481
|
imageUrl?: string;
|
|
406
482
|
/** The subtitle of the card header. If specified, appears on its own line below the `title`. */
|
|
@@ -436,7 +512,7 @@ declare namespace gapi.client {
|
|
|
436
512
|
/** An array of chips. */
|
|
437
513
|
chips?: GoogleAppsCardV1Chip[];
|
|
438
514
|
/** Specified chip list layout. */
|
|
439
|
-
layout?:
|
|
515
|
+
layout?: 'LAYOUT_UNSPECIFIED' | 'WRAPPED' | 'HORIZONTAL_SCROLLABLE';
|
|
440
516
|
}
|
|
441
517
|
interface GoogleAppsCardV1CollapseControl {
|
|
442
518
|
/** Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. */
|
|
@@ -444,15 +520,30 @@ declare namespace gapi.client {
|
|
|
444
520
|
/** Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used. */
|
|
445
521
|
expandButton?: GoogleAppsCardV1Button;
|
|
446
522
|
/** The horizontal alignment of the expand and collapse button. */
|
|
447
|
-
horizontalAlignment?:
|
|
523
|
+
horizontalAlignment?:
|
|
524
|
+
| 'HORIZONTAL_ALIGNMENT_UNSPECIFIED'
|
|
525
|
+
| 'START'
|
|
526
|
+
| 'CENTER'
|
|
527
|
+
| 'END';
|
|
448
528
|
}
|
|
449
529
|
interface GoogleAppsCardV1Column {
|
|
450
530
|
/** Specifies whether widgets align to the left, right, or center of a column. */
|
|
451
|
-
horizontalAlignment?:
|
|
531
|
+
horizontalAlignment?:
|
|
532
|
+
| 'HORIZONTAL_ALIGNMENT_UNSPECIFIED'
|
|
533
|
+
| 'START'
|
|
534
|
+
| 'CENTER'
|
|
535
|
+
| 'END';
|
|
452
536
|
/** Specifies how a column fills the width of the card. */
|
|
453
|
-
horizontalSizeStyle?:
|
|
537
|
+
horizontalSizeStyle?:
|
|
538
|
+
| 'HORIZONTAL_SIZE_STYLE_UNSPECIFIED'
|
|
539
|
+
| 'FILL_AVAILABLE_SPACE'
|
|
540
|
+
| 'FILL_MINIMUM_SPACE';
|
|
454
541
|
/** Specifies whether widgets align to the top, bottom, or center of a column. */
|
|
455
|
-
verticalAlignment?:
|
|
542
|
+
verticalAlignment?:
|
|
543
|
+
| 'VERTICAL_ALIGNMENT_UNSPECIFIED'
|
|
544
|
+
| 'CENTER'
|
|
545
|
+
| 'TOP'
|
|
546
|
+
| 'BOTTOM';
|
|
456
547
|
/** An array of widgets included in a column. Widgets appear in the order that they are specified. */
|
|
457
548
|
widgets?: GoogleAppsCardV1Widgets[];
|
|
458
549
|
}
|
|
@@ -490,7 +581,7 @@ declare namespace gapi.client {
|
|
|
490
581
|
/** The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. */
|
|
491
582
|
timezoneOffsetDate?: number;
|
|
492
583
|
/** Whether the widget supports inputting a date, a time, or the date and time. */
|
|
493
|
-
type?:
|
|
584
|
+
type?: 'DATE_AND_TIME' | 'DATE_ONLY' | 'TIME_ONLY';
|
|
494
585
|
/** The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). */
|
|
495
586
|
valueMsEpoch?: string;
|
|
496
587
|
}
|
|
@@ -512,7 +603,11 @@ declare namespace gapi.client {
|
|
|
512
603
|
/** The icon displayed in front of the text. */
|
|
513
604
|
startIcon?: GoogleAppsCardV1Icon;
|
|
514
605
|
/** Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): */
|
|
515
|
-
startIconVerticalAlignment?:
|
|
606
|
+
startIconVerticalAlignment?:
|
|
607
|
+
| 'VERTICAL_ALIGNMENT_UNSPECIFIED'
|
|
608
|
+
| 'TOP'
|
|
609
|
+
| 'MIDDLE'
|
|
610
|
+
| 'BOTTOM';
|
|
516
611
|
/** A switch widget that a user can click to change its state and trigger an action. */
|
|
517
612
|
switchControl?: GoogleAppsCardV1SwitchControl;
|
|
518
613
|
/** 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). */
|
|
@@ -545,7 +640,10 @@ declare namespace gapi.client {
|
|
|
545
640
|
}
|
|
546
641
|
interface GoogleAppsCardV1ExpressionDataCondition {
|
|
547
642
|
/** The type of the condition. */
|
|
548
|
-
conditionType?:
|
|
643
|
+
conditionType?:
|
|
644
|
+
| 'CONDITION_TYPE_UNSPECIFIED'
|
|
645
|
+
| 'EXPRESSION_EVALUATION_SUCCESS'
|
|
646
|
+
| 'EXPRESSION_EVALUATION_FAILURE';
|
|
549
647
|
}
|
|
550
648
|
interface GoogleAppsCardV1Grid {
|
|
551
649
|
/** The border style to apply to each grid item. */
|
|
@@ -565,7 +663,7 @@ declare namespace gapi.client {
|
|
|
565
663
|
/** The image that displays in the grid item. */
|
|
566
664
|
image?: GoogleAppsCardV1ImageComponent;
|
|
567
665
|
/** The layout to use for the grid item. */
|
|
568
|
-
layout?:
|
|
666
|
+
layout?: 'GRID_ITEM_LAYOUT_UNSPECIFIED' | 'TEXT_BELOW' | 'TEXT_ABOVE';
|
|
569
667
|
/** The grid item's subtitle. */
|
|
570
668
|
subtitle?: string;
|
|
571
669
|
/** The grid item's title. */
|
|
@@ -577,7 +675,7 @@ declare namespace gapi.client {
|
|
|
577
675
|
/** 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`. */
|
|
578
676
|
iconUrl?: string;
|
|
579
677
|
/** 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. */
|
|
580
|
-
imageType?:
|
|
678
|
+
imageType?: 'SQUARE' | 'CIRCLE';
|
|
581
679
|
/** 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). */
|
|
582
680
|
knownIcon?: string;
|
|
583
681
|
/** 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): */
|
|
@@ -605,7 +703,12 @@ declare namespace gapi.client {
|
|
|
605
703
|
/** The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ``` */
|
|
606
704
|
aspectRatio?: number;
|
|
607
705
|
/** The crop type. */
|
|
608
|
-
type?:
|
|
706
|
+
type?:
|
|
707
|
+
| 'IMAGE_CROP_TYPE_UNSPECIFIED'
|
|
708
|
+
| 'SQUARE'
|
|
709
|
+
| 'CIRCLE'
|
|
710
|
+
| 'RECTANGLE_CUSTOM'
|
|
711
|
+
| 'RECTANGLE_4_3';
|
|
609
712
|
}
|
|
610
713
|
interface GoogleAppsCardV1MaterialIcon {
|
|
611
714
|
/** Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. */
|
|
@@ -639,9 +742,9 @@ declare namespace gapi.client {
|
|
|
639
742
|
}
|
|
640
743
|
interface GoogleAppsCardV1OpenLink {
|
|
641
744
|
/** Whether the client forgets about a link after opening it, or observes it until the window closes. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): */
|
|
642
|
-
onClose?:
|
|
745
|
+
onClose?: 'NOTHING' | 'RELOAD';
|
|
643
746
|
/** How to open a link. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): */
|
|
644
|
-
openAs?:
|
|
747
|
+
openAs?: 'FULL_SIZE' | 'OVERLAY';
|
|
645
748
|
/** The URL to open. HTTP URLs are converted to HTTPS. */
|
|
646
749
|
url?: string;
|
|
647
750
|
}
|
|
@@ -661,7 +764,7 @@ declare namespace gapi.client {
|
|
|
661
764
|
}
|
|
662
765
|
interface GoogleAppsCardV1PlatformDataSource {
|
|
663
766
|
/** A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. */
|
|
664
|
-
commonDataSource?:
|
|
767
|
+
commonDataSource?: 'UNKNOWN' | 'USER';
|
|
665
768
|
/** A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). */
|
|
666
769
|
hostAppDataSource?: HostAppDataSourceMarkup;
|
|
667
770
|
}
|
|
@@ -701,7 +804,12 @@ declare namespace gapi.client {
|
|
|
701
804
|
/** A data source from Google Workspace. */
|
|
702
805
|
platformDataSource?: GoogleAppsCardV1PlatformDataSource;
|
|
703
806
|
/** The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu. */
|
|
704
|
-
type?:
|
|
807
|
+
type?:
|
|
808
|
+
| 'CHECK_BOX'
|
|
809
|
+
| 'RADIO_BUTTON'
|
|
810
|
+
| 'SWITCH'
|
|
811
|
+
| 'DROPDOWN'
|
|
812
|
+
| 'MULTI_SELECT';
|
|
705
813
|
}
|
|
706
814
|
interface GoogleAppsCardV1SelectionItem {
|
|
707
815
|
/** For multiselect menus, a text description or label that's displayed below the item's `text` field. */
|
|
@@ -724,7 +832,7 @@ declare namespace gapi.client {
|
|
|
724
832
|
}
|
|
725
833
|
interface GoogleAppsCardV1SwitchControl {
|
|
726
834
|
/** How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
727
|
-
controlType?:
|
|
835
|
+
controlType?: 'SWITCH' | 'CHECKBOX' | 'CHECK_BOX';
|
|
728
836
|
/** 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). */
|
|
729
837
|
name?: string;
|
|
730
838
|
/** The action to perform when the switch state is changed, such as what function to run. */
|
|
@@ -752,7 +860,7 @@ declare namespace gapi.client {
|
|
|
752
860
|
/** 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): */
|
|
753
861
|
placeholderText?: string;
|
|
754
862
|
/** How a text input field appears in the user interface. For example, whether the field is single or multi-line. */
|
|
755
|
-
type?:
|
|
863
|
+
type?: 'SINGLE_LINE' | 'MULTIPLE_LINE';
|
|
756
864
|
/** Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
757
865
|
validation?: GoogleAppsCardV1Validation;
|
|
758
866
|
/** 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). */
|
|
@@ -764,7 +872,7 @@ declare namespace gapi.client {
|
|
|
764
872
|
/** The text that's shown in the widget. */
|
|
765
873
|
text?: string;
|
|
766
874
|
/** The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): */
|
|
767
|
-
textSyntax?:
|
|
875
|
+
textSyntax?: 'TEXT_SYNTAX_UNSPECIFIED' | 'HTML' | 'MARKDOWN';
|
|
768
876
|
}
|
|
769
877
|
interface GoogleAppsCardV1Trigger {
|
|
770
878
|
/** The unique identifier of the ActionRule. */
|
|
@@ -772,13 +880,19 @@ declare namespace gapi.client {
|
|
|
772
880
|
}
|
|
773
881
|
interface GoogleAppsCardV1UpdateVisibilityAction {
|
|
774
882
|
/** The new visibility. */
|
|
775
|
-
visibility?:
|
|
883
|
+
visibility?: 'VISIBILITY_UNSPECIFIED' | 'VISIBLE' | 'HIDDEN';
|
|
776
884
|
}
|
|
777
885
|
interface GoogleAppsCardV1Validation {
|
|
778
886
|
/** Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
779
887
|
characterLimit?: number;
|
|
780
888
|
/** Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): */
|
|
781
|
-
inputType?:
|
|
889
|
+
inputType?:
|
|
890
|
+
| 'INPUT_TYPE_UNSPECIFIED'
|
|
891
|
+
| 'TEXT'
|
|
892
|
+
| 'INTEGER'
|
|
893
|
+
| 'FLOAT'
|
|
894
|
+
| 'EMAIL'
|
|
895
|
+
| 'EMOJI_PICKER';
|
|
782
896
|
}
|
|
783
897
|
interface GoogleAppsCardV1Widget {
|
|
784
898
|
/** A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` */
|
|
@@ -800,7 +914,11 @@ declare namespace gapi.client {
|
|
|
800
914
|
/** Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ``` */
|
|
801
915
|
grid?: GoogleAppsCardV1Grid;
|
|
802
916
|
/** Specifies whether widgets align to the left, right, or center of a column. */
|
|
803
|
-
horizontalAlignment?:
|
|
917
|
+
horizontalAlignment?:
|
|
918
|
+
| 'HORIZONTAL_ALIGNMENT_UNSPECIFIED'
|
|
919
|
+
| 'START'
|
|
920
|
+
| 'CENTER'
|
|
921
|
+
| 'END';
|
|
804
922
|
/** A unique ID assigned to the widget that's used to identify the widget to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. */
|
|
805
923
|
id?: string;
|
|
806
924
|
/** 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" } ``` */
|
|
@@ -812,7 +930,7 @@ declare namespace gapi.client {
|
|
|
812
930
|
/** 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*" } ``` */
|
|
813
931
|
textParagraph?: GoogleAppsCardV1TextParagraph;
|
|
814
932
|
/** Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. */
|
|
815
|
-
visibility?:
|
|
933
|
+
visibility?: 'VISIBILITY_UNSPECIFIED' | 'VISIBLE' | 'HIDDEN';
|
|
816
934
|
}
|
|
817
935
|
interface GoogleAppsCardV1Widgets {
|
|
818
936
|
/** ButtonList widget. */
|
|
@@ -832,6 +950,21 @@ declare namespace gapi.client {
|
|
|
832
950
|
/** TextParagraph widget. */
|
|
833
951
|
textParagraph?: GoogleAppsCardV1TextParagraph;
|
|
834
952
|
}
|
|
953
|
+
interface GoogleChatV1Section {
|
|
954
|
+
/** Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. */
|
|
955
|
+
displayName?: string;
|
|
956
|
+
/** Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` */
|
|
957
|
+
name?: string;
|
|
958
|
+
/** Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. */
|
|
959
|
+
sortOrder?: number;
|
|
960
|
+
/** Required. The type of the section. */
|
|
961
|
+
type?:
|
|
962
|
+
| 'SECTION_TYPE_UNSPECIFIED'
|
|
963
|
+
| 'CUSTOM_SECTION'
|
|
964
|
+
| 'DEFAULT_DIRECT_MESSAGES'
|
|
965
|
+
| 'DEFAULT_SPACES'
|
|
966
|
+
| 'DEFAULT_APPS';
|
|
967
|
+
}
|
|
835
968
|
interface Group {
|
|
836
969
|
/** Resource name for a Google Group. Represents a [group](https://cloud.google.com/identity/docs/reference/rest/v1/groups) in Cloud Identity Groups API. Format: groups/{group} */
|
|
837
970
|
name?: string;
|
|
@@ -852,7 +985,38 @@ declare namespace gapi.client {
|
|
|
852
985
|
}
|
|
853
986
|
interface ImageButton {
|
|
854
987
|
/** The icon specified by an `enum` that indices to an icon provided by Chat API. */
|
|
855
|
-
icon?:
|
|
988
|
+
icon?:
|
|
989
|
+
| 'ICON_UNSPECIFIED'
|
|
990
|
+
| 'AIRPLANE'
|
|
991
|
+
| 'BOOKMARK'
|
|
992
|
+
| 'BUS'
|
|
993
|
+
| 'CAR'
|
|
994
|
+
| 'CLOCK'
|
|
995
|
+
| 'CONFIRMATION_NUMBER_ICON'
|
|
996
|
+
| 'DOLLAR'
|
|
997
|
+
| 'DESCRIPTION'
|
|
998
|
+
| 'EMAIL'
|
|
999
|
+
| 'EVENT_PERFORMER'
|
|
1000
|
+
| 'EVENT_SEAT'
|
|
1001
|
+
| 'FLIGHT_ARRIVAL'
|
|
1002
|
+
| 'FLIGHT_DEPARTURE'
|
|
1003
|
+
| 'HOTEL'
|
|
1004
|
+
| 'HOTEL_ROOM_TYPE'
|
|
1005
|
+
| 'INVITE'
|
|
1006
|
+
| 'MAP_PIN'
|
|
1007
|
+
| 'MEMBERSHIP'
|
|
1008
|
+
| 'MULTIPLE_PEOPLE'
|
|
1009
|
+
| 'OFFER'
|
|
1010
|
+
| 'PERSON'
|
|
1011
|
+
| 'PHONE'
|
|
1012
|
+
| 'RESTAURANT_ICON'
|
|
1013
|
+
| 'SHOPPING_CART'
|
|
1014
|
+
| 'STAR'
|
|
1015
|
+
| 'STORE'
|
|
1016
|
+
| 'TICKET'
|
|
1017
|
+
| 'TRAIN'
|
|
1018
|
+
| 'VIDEO_CAMERA'
|
|
1019
|
+
| 'VIDEO_PLAY';
|
|
856
1020
|
/** The icon specified by a URL. */
|
|
857
1021
|
iconUrl?: string;
|
|
858
1022
|
/** The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified. */
|
|
@@ -880,7 +1044,38 @@ declare namespace gapi.client {
|
|
|
880
1044
|
/** If the content should be multiline. */
|
|
881
1045
|
contentMultiline?: boolean;
|
|
882
1046
|
/** An enum value that's replaced by the Chat API with the corresponding icon image. */
|
|
883
|
-
icon?:
|
|
1047
|
+
icon?:
|
|
1048
|
+
| 'ICON_UNSPECIFIED'
|
|
1049
|
+
| 'AIRPLANE'
|
|
1050
|
+
| 'BOOKMARK'
|
|
1051
|
+
| 'BUS'
|
|
1052
|
+
| 'CAR'
|
|
1053
|
+
| 'CLOCK'
|
|
1054
|
+
| 'CONFIRMATION_NUMBER_ICON'
|
|
1055
|
+
| 'DOLLAR'
|
|
1056
|
+
| 'DESCRIPTION'
|
|
1057
|
+
| 'EMAIL'
|
|
1058
|
+
| 'EVENT_PERFORMER'
|
|
1059
|
+
| 'EVENT_SEAT'
|
|
1060
|
+
| 'FLIGHT_ARRIVAL'
|
|
1061
|
+
| 'FLIGHT_DEPARTURE'
|
|
1062
|
+
| 'HOTEL'
|
|
1063
|
+
| 'HOTEL_ROOM_TYPE'
|
|
1064
|
+
| 'INVITE'
|
|
1065
|
+
| 'MAP_PIN'
|
|
1066
|
+
| 'MEMBERSHIP'
|
|
1067
|
+
| 'MULTIPLE_PEOPLE'
|
|
1068
|
+
| 'OFFER'
|
|
1069
|
+
| 'PERSON'
|
|
1070
|
+
| 'PHONE'
|
|
1071
|
+
| 'RESTAURANT_ICON'
|
|
1072
|
+
| 'SHOPPING_CART'
|
|
1073
|
+
| 'STAR'
|
|
1074
|
+
| 'STORE'
|
|
1075
|
+
| 'TICKET'
|
|
1076
|
+
| 'TRAIN'
|
|
1077
|
+
| 'VIDEO_CAMERA'
|
|
1078
|
+
| 'VIDEO_PLAY';
|
|
884
1079
|
/** The icon specified by a URL. */
|
|
885
1080
|
iconUrl?: string;
|
|
886
1081
|
/** The `onclick` action. Only the top label, bottom label, and content region are clickable. */
|
|
@@ -912,6 +1107,18 @@ declare namespace gapi.client {
|
|
|
912
1107
|
/** List of reactions in the requested (or first) page. */
|
|
913
1108
|
reactions?: Reaction[];
|
|
914
1109
|
}
|
|
1110
|
+
interface ListSectionItemsResponse {
|
|
1111
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
1112
|
+
nextPageToken?: string;
|
|
1113
|
+
/** The section items from the specified section. */
|
|
1114
|
+
sectionItems?: SectionItem[];
|
|
1115
|
+
}
|
|
1116
|
+
interface ListSectionsResponse {
|
|
1117
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
1118
|
+
nextPageToken?: string;
|
|
1119
|
+
/** The sections from the specified user. */
|
|
1120
|
+
sections?: GoogleChatV1Section[];
|
|
1121
|
+
}
|
|
915
1122
|
interface ListSpaceEventsResponse {
|
|
916
1123
|
/** Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages. */
|
|
917
1124
|
nextPageToken?: string;
|
|
@@ -934,13 +1141,23 @@ declare namespace gapi.client {
|
|
|
934
1141
|
}
|
|
935
1142
|
interface MeetSpaceLinkData {
|
|
936
1143
|
/** Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset. */
|
|
937
|
-
huddleStatus?:
|
|
1144
|
+
huddleStatus?:
|
|
1145
|
+
| 'HUDDLE_STATUS_UNSPECIFIED'
|
|
1146
|
+
| 'STARTED'
|
|
1147
|
+
| 'ENDED'
|
|
1148
|
+
| 'MISSED';
|
|
938
1149
|
/** Meeting code of the linked Meet space. */
|
|
939
1150
|
meetingCode?: string;
|
|
940
1151
|
/** Indicates the type of the Meet space. */
|
|
941
|
-
type?:
|
|
1152
|
+
type?: 'TYPE_UNSPECIFIED' | 'MEETING' | 'HUDDLE';
|
|
942
1153
|
}
|
|
943
1154
|
interface Membership {
|
|
1155
|
+
/** Output only. A user's relationship to the Workspace organization that owns the space. In spaces owned by consumer accounts, the affiliation of all members is `EXTERNAL`. */
|
|
1156
|
+
affiliation?:
|
|
1157
|
+
| 'AFFILIATION_UNSPECIFIED'
|
|
1158
|
+
| 'INTERNAL'
|
|
1159
|
+
| 'EXTERNAL'
|
|
1160
|
+
| 'MANAGED_EXTERNAL';
|
|
944
1161
|
/** Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. */
|
|
945
1162
|
createTime?: string;
|
|
946
1163
|
/** Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. */
|
|
@@ -952,9 +1169,17 @@ declare namespace gapi.client {
|
|
|
952
1169
|
/** Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}` */
|
|
953
1170
|
name?: string;
|
|
954
1171
|
/** Optional. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership`. */
|
|
955
|
-
role?:
|
|
1172
|
+
role?:
|
|
1173
|
+
| 'MEMBERSHIP_ROLE_UNSPECIFIED'
|
|
1174
|
+
| 'ROLE_MEMBER'
|
|
1175
|
+
| 'ROLE_MANAGER'
|
|
1176
|
+
| 'ROLE_ASSISTANT_MANAGER';
|
|
956
1177
|
/** Output only. State of the membership. */
|
|
957
|
-
state?:
|
|
1178
|
+
state?:
|
|
1179
|
+
| 'MEMBERSHIP_STATE_UNSPECIFIED'
|
|
1180
|
+
| 'JOINED'
|
|
1181
|
+
| 'INVITED'
|
|
1182
|
+
| 'NOT_A_MEMBER';
|
|
958
1183
|
}
|
|
959
1184
|
interface MembershipBatchCreatedEventData {
|
|
960
1185
|
/** A list of new memberships. */
|
|
@@ -1015,11 +1240,11 @@ declare namespace gapi.client {
|
|
|
1015
1240
|
emojiReactionSummaries?: EmojiReactionSummary[];
|
|
1016
1241
|
/** Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. */
|
|
1017
1242
|
fallbackText?: string;
|
|
1018
|
-
/** 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
|
|
1243
|
+
/** 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, bulleted list, and block quote. * [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. * Bullet list items using asterisks (`*`)—for example, `* item`. 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) */
|
|
1019
1244
|
formattedText?: string;
|
|
1020
1245
|
/** 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. */
|
|
1021
1246
|
lastUpdateTime?: string;
|
|
1022
|
-
/** Output only. A URL in `
|
|
1247
|
+
/** Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links). */
|
|
1023
1248
|
matchedUrl?: MatchedUrl;
|
|
1024
1249
|
/** Identifier. 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). */
|
|
1025
1250
|
name?: string;
|
|
@@ -1029,6 +1254,8 @@ declare namespace gapi.client {
|
|
|
1029
1254
|
quotedMessageMetadata?: QuotedMessageMetadata;
|
|
1030
1255
|
/** 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`. */
|
|
1031
1256
|
sender?: User;
|
|
1257
|
+
/** Output only. Whether this is a silent message. Silent messages are messages where Chat suppresses push notifications for recipients. */
|
|
1258
|
+
silent?: boolean;
|
|
1032
1259
|
/** Output only. Slash command information, if applicable. */
|
|
1033
1260
|
slashCommand?: SlashCommand;
|
|
1034
1261
|
/** Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. */
|
|
@@ -1064,6 +1291,14 @@ declare namespace gapi.client {
|
|
|
1064
1291
|
/** The updated message. */
|
|
1065
1292
|
message?: Message;
|
|
1066
1293
|
}
|
|
1294
|
+
interface MoveSectionItemRequest {
|
|
1295
|
+
/** Required. The resource name of the section to move the section item to. Format: `users/{user}/sections/{section}` */
|
|
1296
|
+
targetSection?: string;
|
|
1297
|
+
}
|
|
1298
|
+
interface MoveSectionItemResponse {
|
|
1299
|
+
/** The updated section item. */
|
|
1300
|
+
sectionItem?: SectionItem;
|
|
1301
|
+
}
|
|
1067
1302
|
interface OnClick {
|
|
1068
1303
|
/** A form action is triggered by this `onclick` action if specified. */
|
|
1069
1304
|
action?: FormAction;
|
|
@@ -1100,6 +1335,16 @@ declare namespace gapi.client {
|
|
|
1100
1335
|
/** Optional. Setting for using @all in a space. */
|
|
1101
1336
|
useAtMentionAll?: PermissionSetting;
|
|
1102
1337
|
}
|
|
1338
|
+
interface PositionSectionRequest {
|
|
1339
|
+
/** Optional. The relative position of the section in the list of sections. */
|
|
1340
|
+
relativePosition?: 'POSITION_UNSPECIFIED' | 'START' | 'END';
|
|
1341
|
+
/** Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position. */
|
|
1342
|
+
sortOrder?: number;
|
|
1343
|
+
}
|
|
1344
|
+
interface PositionSectionResponse {
|
|
1345
|
+
/** The updated section. */
|
|
1346
|
+
section?: GoogleChatV1Section;
|
|
1347
|
+
}
|
|
1103
1348
|
interface QuotedMessageMetadata {
|
|
1104
1349
|
/** Output only. Metadata about the source space of the quoted message. Populated only for FORWARD quote type. */
|
|
1105
1350
|
forwardedMetadata?: ForwardedMetadata;
|
|
@@ -1110,7 +1355,7 @@ declare namespace gapi.client {
|
|
|
1110
1355
|
/** Output only. A snapshot of the quoted message's content. */
|
|
1111
1356
|
quotedMessageSnapshot?: QuotedMessageSnapshot;
|
|
1112
1357
|
/** Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility. */
|
|
1113
|
-
quoteType?:
|
|
1358
|
+
quoteType?: 'QUOTE_TYPE_UNSPECIFIED' | 'REPLY';
|
|
1114
1359
|
}
|
|
1115
1360
|
interface QuotedMessageSnapshot {
|
|
1116
1361
|
/** Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type. */
|
|
@@ -1158,7 +1403,13 @@ declare namespace gapi.client {
|
|
|
1158
1403
|
/** Data for a Meet space link. */
|
|
1159
1404
|
meetSpaceLinkData?: MeetSpaceLinkData;
|
|
1160
1405
|
/** The rich link type. */
|
|
1161
|
-
richLinkType?:
|
|
1406
|
+
richLinkType?:
|
|
1407
|
+
| 'RICH_LINK_TYPE_UNSPECIFIED'
|
|
1408
|
+
| 'DRIVE_FILE'
|
|
1409
|
+
| 'CHAT_SPACE'
|
|
1410
|
+
| 'GMAIL_MESSAGE'
|
|
1411
|
+
| 'MEET_SPACE'
|
|
1412
|
+
| 'CALENDAR_EVENT';
|
|
1162
1413
|
/** The URI of this link. */
|
|
1163
1414
|
uri?: string;
|
|
1164
1415
|
}
|
|
@@ -1176,6 +1427,12 @@ declare namespace gapi.client {
|
|
|
1176
1427
|
/** A section must contain at least one widget. */
|
|
1177
1428
|
widgets?: WidgetMarkup[];
|
|
1178
1429
|
}
|
|
1430
|
+
interface SectionItem {
|
|
1431
|
+
/** Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}` */
|
|
1432
|
+
name?: string;
|
|
1433
|
+
/** Optional. The space resource name. Format: `spaces/{space}` */
|
|
1434
|
+
space?: string;
|
|
1435
|
+
}
|
|
1179
1436
|
interface SelectionItems {
|
|
1180
1437
|
/** An array of the SelectionItem objects. */
|
|
1181
1438
|
items?: GoogleAppsCardV1SelectionItem[];
|
|
@@ -1202,7 +1459,7 @@ declare namespace gapi.client {
|
|
|
1202
1459
|
/** Indicates whether the slash command is for a dialog. */
|
|
1203
1460
|
triggersDialog?: boolean;
|
|
1204
1461
|
/** The type of slash command. */
|
|
1205
|
-
type?:
|
|
1462
|
+
type?: 'TYPE_UNSPECIFIED' | 'ADD' | 'INVOKE';
|
|
1206
1463
|
}
|
|
1207
1464
|
interface Space {
|
|
1208
1465
|
/** Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. */
|
|
@@ -1230,23 +1487,37 @@ declare namespace gapi.client {
|
|
|
1230
1487
|
/** Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) */
|
|
1231
1488
|
permissionSettings?: PermissionSettings;
|
|
1232
1489
|
/** Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) */
|
|
1233
|
-
predefinedPermissionSettings?:
|
|
1490
|
+
predefinedPermissionSettings?:
|
|
1491
|
+
| 'PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED'
|
|
1492
|
+
| 'COLLABORATION_SPACE'
|
|
1493
|
+
| 'ANNOUNCEMENT_SPACE';
|
|
1234
1494
|
/** Optional. Whether the space is a DM between a Chat app and a single human. */
|
|
1235
1495
|
singleUserBotDm?: boolean;
|
|
1236
1496
|
/** Optional. Details about the space including description and rules. */
|
|
1237
1497
|
spaceDetails?: SpaceDetails;
|
|
1238
1498
|
/** Optional. The message history state for messages and threads in this space. */
|
|
1239
|
-
spaceHistoryState?:
|
|
1499
|
+
spaceHistoryState?:
|
|
1500
|
+
| 'HISTORY_STATE_UNSPECIFIED'
|
|
1501
|
+
| 'HISTORY_OFF'
|
|
1502
|
+
| 'HISTORY_ON';
|
|
1240
1503
|
/** Output only. The threading state in the Chat space. */
|
|
1241
|
-
spaceThreadingState?:
|
|
1504
|
+
spaceThreadingState?:
|
|
1505
|
+
| 'SPACE_THREADING_STATE_UNSPECIFIED'
|
|
1506
|
+
| 'THREADED_MESSAGES'
|
|
1507
|
+
| 'GROUPED_MESSAGES'
|
|
1508
|
+
| 'UNTHREADED_MESSAGES';
|
|
1242
1509
|
/** Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage. */
|
|
1243
|
-
spaceType?:
|
|
1510
|
+
spaceType?:
|
|
1511
|
+
| 'SPACE_TYPE_UNSPECIFIED'
|
|
1512
|
+
| 'SPACE'
|
|
1513
|
+
| 'GROUP_CHAT'
|
|
1514
|
+
| 'DIRECT_MESSAGE';
|
|
1244
1515
|
/** Output only. The URI for a user to access the space. */
|
|
1245
1516
|
spaceUri?: string;
|
|
1246
1517
|
/** Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space. */
|
|
1247
1518
|
threaded?: boolean;
|
|
1248
1519
|
/** Output only. Deprecated: Use `space_type` instead. The type of a space. */
|
|
1249
|
-
type?:
|
|
1520
|
+
type?: 'TYPE_UNSPECIFIED' | 'ROOM' | 'DM';
|
|
1250
1521
|
}
|
|
1251
1522
|
interface SpaceBatchUpdatedEventData {
|
|
1252
1523
|
/** A list of updated spaces. */
|
|
@@ -1308,11 +1579,16 @@ declare namespace gapi.client {
|
|
|
1308
1579
|
}
|
|
1309
1580
|
interface SpaceNotificationSetting {
|
|
1310
1581
|
/** The space notification mute setting. */
|
|
1311
|
-
muteSetting?:
|
|
1582
|
+
muteSetting?: 'MUTE_SETTING_UNSPECIFIED' | 'UNMUTED' | 'MUTED';
|
|
1312
1583
|
/** Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`. */
|
|
1313
1584
|
name?: string;
|
|
1314
1585
|
/** The notification setting. */
|
|
1315
|
-
notificationSetting?:
|
|
1586
|
+
notificationSetting?:
|
|
1587
|
+
| 'NOTIFICATION_SETTING_UNSPECIFIED'
|
|
1588
|
+
| 'ALL'
|
|
1589
|
+
| 'MAIN_CONVERSATIONS'
|
|
1590
|
+
| 'FOR_YOU'
|
|
1591
|
+
| 'OFF';
|
|
1316
1592
|
}
|
|
1317
1593
|
interface SpaceReadState {
|
|
1318
1594
|
/** Optional. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space. */
|
|
@@ -1328,7 +1604,7 @@ declare namespace gapi.client {
|
|
|
1328
1604
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1329
1605
|
code?: number;
|
|
1330
1606
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1331
|
-
details?:
|
|
1607
|
+
details?: {[P in string]: any}[];
|
|
1332
1608
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
1333
1609
|
message?: string;
|
|
1334
1610
|
}
|
|
@@ -1393,11 +1669,11 @@ declare namespace gapi.client {
|
|
|
1393
1669
|
/** Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API. */
|
|
1394
1670
|
name?: string;
|
|
1395
1671
|
/** User type. */
|
|
1396
|
-
type?:
|
|
1672
|
+
type?: 'TYPE_UNSPECIFIED' | 'HUMAN' | 'BOT';
|
|
1397
1673
|
}
|
|
1398
1674
|
interface UserMentionMetadata {
|
|
1399
1675
|
/** The type of user mention. */
|
|
1400
|
-
type?:
|
|
1676
|
+
type?: 'TYPE_UNSPECIFIED' | 'ADD' | 'MENTION';
|
|
1401
1677
|
/** The user mentioned. */
|
|
1402
1678
|
user?: User;
|
|
1403
1679
|
}
|
|
@@ -1415,17 +1691,17 @@ declare namespace gapi.client {
|
|
|
1415
1691
|
/** Whether to include variables from the previous step in the data source. */
|
|
1416
1692
|
includeVariables?: boolean;
|
|
1417
1693
|
/** The type of data source. */
|
|
1418
|
-
type?:
|
|
1694
|
+
type?: 'UNKNOWN' | 'USER' | 'SPACE' | 'USER_WITH_FREE_FORM';
|
|
1419
1695
|
}
|
|
1420
1696
|
interface CustomEmojisResource {
|
|
1421
1697
|
/** Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis` */
|
|
1422
1698
|
create(request: {
|
|
1423
1699
|
/** V1 error format. */
|
|
1424
|
-
'$.xgafv'?:
|
|
1700
|
+
'$.xgafv'?: '1' | '2';
|
|
1425
1701
|
/** OAuth access token. */
|
|
1426
1702
|
access_token?: string;
|
|
1427
1703
|
/** Data format for response. */
|
|
1428
|
-
alt?:
|
|
1704
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1429
1705
|
/** JSONP */
|
|
1430
1706
|
callback?: string;
|
|
1431
1707
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1448,11 +1724,11 @@ declare namespace gapi.client {
|
|
|
1448
1724
|
create(
|
|
1449
1725
|
request: {
|
|
1450
1726
|
/** V1 error format. */
|
|
1451
|
-
'$.xgafv'?:
|
|
1727
|
+
'$.xgafv'?: '1' | '2';
|
|
1452
1728
|
/** OAuth access token. */
|
|
1453
1729
|
access_token?: string;
|
|
1454
1730
|
/** Data format for response. */
|
|
1455
|
-
alt?:
|
|
1731
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1456
1732
|
/** JSONP */
|
|
1457
1733
|
callback?: string;
|
|
1458
1734
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1475,11 +1751,11 @@ declare namespace gapi.client {
|
|
|
1475
1751
|
/** Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis` */
|
|
1476
1752
|
delete(request?: {
|
|
1477
1753
|
/** V1 error format. */
|
|
1478
|
-
'$.xgafv'?:
|
|
1754
|
+
'$.xgafv'?: '1' | '2';
|
|
1479
1755
|
/** OAuth access token. */
|
|
1480
1756
|
access_token?: string;
|
|
1481
1757
|
/** Data format for response. */
|
|
1482
|
-
alt?:
|
|
1758
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1483
1759
|
/** JSONP */
|
|
1484
1760
|
callback?: string;
|
|
1485
1761
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1502,11 +1778,11 @@ declare namespace gapi.client {
|
|
|
1502
1778
|
/** Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis` */
|
|
1503
1779
|
get(request?: {
|
|
1504
1780
|
/** V1 error format. */
|
|
1505
|
-
'$.xgafv'?:
|
|
1781
|
+
'$.xgafv'?: '1' | '2';
|
|
1506
1782
|
/** OAuth access token. */
|
|
1507
1783
|
access_token?: string;
|
|
1508
1784
|
/** Data format for response. */
|
|
1509
|
-
alt?:
|
|
1785
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1510
1786
|
/** JSONP */
|
|
1511
1787
|
callback?: string;
|
|
1512
1788
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1529,11 +1805,11 @@ declare namespace gapi.client {
|
|
|
1529
1805
|
/** Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis` */
|
|
1530
1806
|
list(request?: {
|
|
1531
1807
|
/** V1 error format. */
|
|
1532
|
-
'$.xgafv'?:
|
|
1808
|
+
'$.xgafv'?: '1' | '2';
|
|
1533
1809
|
/** OAuth access token. */
|
|
1534
1810
|
access_token?: string;
|
|
1535
1811
|
/** Data format for response. */
|
|
1536
|
-
alt?:
|
|
1812
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1537
1813
|
/** JSONP */
|
|
1538
1814
|
callback?: string;
|
|
1539
1815
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1562,11 +1838,11 @@ declare namespace gapi.client {
|
|
|
1562
1838
|
/** Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`. */
|
|
1563
1839
|
download(request?: {
|
|
1564
1840
|
/** V1 error format. */
|
|
1565
|
-
'$.xgafv'?:
|
|
1841
|
+
'$.xgafv'?: '1' | '2';
|
|
1566
1842
|
/** OAuth access token. */
|
|
1567
1843
|
access_token?: string;
|
|
1568
1844
|
/** Data format for response. */
|
|
1569
|
-
alt?:
|
|
1845
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1570
1846
|
/** JSONP */
|
|
1571
1847
|
callback?: string;
|
|
1572
1848
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1589,11 +1865,11 @@ declare namespace gapi.client {
|
|
|
1589
1865
|
/** 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) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) 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). */
|
|
1590
1866
|
upload(request: {
|
|
1591
1867
|
/** V1 error format. */
|
|
1592
|
-
'$.xgafv'?:
|
|
1868
|
+
'$.xgafv'?: '1' | '2';
|
|
1593
1869
|
/** OAuth access token. */
|
|
1594
1870
|
access_token?: string;
|
|
1595
1871
|
/** Data format for response. */
|
|
1596
|
-
alt?:
|
|
1872
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1597
1873
|
/** JSONP */
|
|
1598
1874
|
callback?: string;
|
|
1599
1875
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1618,11 +1894,11 @@ declare namespace gapi.client {
|
|
|
1618
1894
|
upload(
|
|
1619
1895
|
request: {
|
|
1620
1896
|
/** V1 error format. */
|
|
1621
|
-
'$.xgafv'?:
|
|
1897
|
+
'$.xgafv'?: '1' | '2';
|
|
1622
1898
|
/** OAuth access token. */
|
|
1623
1899
|
access_token?: string;
|
|
1624
1900
|
/** Data format for response. */
|
|
1625
|
-
alt?:
|
|
1901
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1626
1902
|
/** JSONP */
|
|
1627
1903
|
callback?: string;
|
|
1628
1904
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1649,11 +1925,11 @@ declare namespace gapi.client {
|
|
|
1649
1925
|
/** Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. 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. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to add the calling app to the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Inviting users external to the Workspace organization that owns the space. - Adding a Google Group to a space. - Adding a Chat app to a space. For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api). */
|
|
1650
1926
|
create(request: {
|
|
1651
1927
|
/** V1 error format. */
|
|
1652
|
-
'$.xgafv'?:
|
|
1928
|
+
'$.xgafv'?: '1' | '2';
|
|
1653
1929
|
/** OAuth access token. */
|
|
1654
1930
|
access_token?: string;
|
|
1655
1931
|
/** Data format for response. */
|
|
1656
|
-
alt?:
|
|
1932
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1657
1933
|
/** JSONP */
|
|
1658
1934
|
callback?: string;
|
|
1659
1935
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1680,11 +1956,11 @@ declare namespace gapi.client {
|
|
|
1680
1956
|
create(
|
|
1681
1957
|
request: {
|
|
1682
1958
|
/** V1 error format. */
|
|
1683
|
-
'$.xgafv'?:
|
|
1959
|
+
'$.xgafv'?: '1' | '2';
|
|
1684
1960
|
/** OAuth access token. */
|
|
1685
1961
|
access_token?: string;
|
|
1686
1962
|
/** Data format for response. */
|
|
1687
|
-
alt?:
|
|
1963
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1688
1964
|
/** JSONP */
|
|
1689
1965
|
callback?: string;
|
|
1690
1966
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1711,11 +1987,11 @@ declare namespace gapi.client {
|
|
|
1711
1987
|
/** 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). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to remove the calling app from the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Removing a Google Group from a space. - Removing a Chat app from a space. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the Chat app must be the space creator. */
|
|
1712
1988
|
delete(request?: {
|
|
1713
1989
|
/** V1 error format. */
|
|
1714
|
-
'$.xgafv'?:
|
|
1990
|
+
'$.xgafv'?: '1' | '2';
|
|
1715
1991
|
/** OAuth access token. */
|
|
1716
1992
|
access_token?: string;
|
|
1717
1993
|
/** Data format for response. */
|
|
1718
|
-
alt?:
|
|
1994
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1719
1995
|
/** JSONP */
|
|
1720
1996
|
callback?: string;
|
|
1721
1997
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1740,11 +2016,11 @@ declare namespace gapi.client {
|
|
|
1740
2016
|
/** 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). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships` */
|
|
1741
2017
|
get(request?: {
|
|
1742
2018
|
/** V1 error format. */
|
|
1743
|
-
'$.xgafv'?:
|
|
2019
|
+
'$.xgafv'?: '1' | '2';
|
|
1744
2020
|
/** OAuth access token. */
|
|
1745
2021
|
access_token?: string;
|
|
1746
2022
|
/** Data format for response. */
|
|
1747
|
-
alt?:
|
|
2023
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1748
2024
|
/** JSONP */
|
|
1749
2025
|
callback?: string;
|
|
1750
2026
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1769,11 +2045,11 @@ declare namespace gapi.client {
|
|
|
1769
2045
|
/** 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. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships` */
|
|
1770
2046
|
list(request?: {
|
|
1771
2047
|
/** V1 error format. */
|
|
1772
|
-
'$.xgafv'?:
|
|
2048
|
+
'$.xgafv'?: '1' | '2';
|
|
1773
2049
|
/** OAuth access token. */
|
|
1774
2050
|
access_token?: string;
|
|
1775
2051
|
/** Data format for response. */
|
|
1776
|
-
alt?:
|
|
2052
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1777
2053
|
/** JSONP */
|
|
1778
2054
|
callback?: string;
|
|
1779
2055
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1808,11 +2084,11 @@ declare namespace gapi.client {
|
|
|
1808
2084
|
/** Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` */
|
|
1809
2085
|
patch(request: {
|
|
1810
2086
|
/** V1 error format. */
|
|
1811
|
-
'$.xgafv'?:
|
|
2087
|
+
'$.xgafv'?: '1' | '2';
|
|
1812
2088
|
/** OAuth access token. */
|
|
1813
2089
|
access_token?: string;
|
|
1814
2090
|
/** Data format for response. */
|
|
1815
|
-
alt?:
|
|
2091
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1816
2092
|
/** JSONP */
|
|
1817
2093
|
callback?: string;
|
|
1818
2094
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1841,11 +2117,11 @@ declare namespace gapi.client {
|
|
|
1841
2117
|
patch(
|
|
1842
2118
|
request: {
|
|
1843
2119
|
/** V1 error format. */
|
|
1844
|
-
'$.xgafv'?:
|
|
2120
|
+
'$.xgafv'?: '1' | '2';
|
|
1845
2121
|
/** OAuth access token. */
|
|
1846
2122
|
access_token?: string;
|
|
1847
2123
|
/** Data format for response. */
|
|
1848
|
-
alt?:
|
|
2124
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1849
2125
|
/** JSONP */
|
|
1850
2126
|
callback?: string;
|
|
1851
2127
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1876,11 +2152,11 @@ declare namespace gapi.client {
|
|
|
1876
2152
|
/** 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) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.bot` */
|
|
1877
2153
|
get(request?: {
|
|
1878
2154
|
/** V1 error format. */
|
|
1879
|
-
'$.xgafv'?:
|
|
2155
|
+
'$.xgafv'?: '1' | '2';
|
|
1880
2156
|
/** OAuth access token. */
|
|
1881
2157
|
access_token?: string;
|
|
1882
2158
|
/** Data format for response. */
|
|
1883
|
-
alt?:
|
|
2159
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1884
2160
|
/** JSONP */
|
|
1885
2161
|
callback?: string;
|
|
1886
2162
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1905,11 +2181,11 @@ declare namespace gapi.client {
|
|
|
1905
2181
|
/** Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.create` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) */
|
|
1906
2182
|
create(request: {
|
|
1907
2183
|
/** V1 error format. */
|
|
1908
|
-
'$.xgafv'?:
|
|
2184
|
+
'$.xgafv'?: '1' | '2';
|
|
1909
2185
|
/** OAuth access token. */
|
|
1910
2186
|
access_token?: string;
|
|
1911
2187
|
/** Data format for response. */
|
|
1912
|
-
alt?:
|
|
2188
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1913
2189
|
/** JSONP */
|
|
1914
2190
|
callback?: string;
|
|
1915
2191
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1934,11 +2210,11 @@ declare namespace gapi.client {
|
|
|
1934
2210
|
create(
|
|
1935
2211
|
request: {
|
|
1936
2212
|
/** V1 error format. */
|
|
1937
|
-
'$.xgafv'?:
|
|
2213
|
+
'$.xgafv'?: '1' | '2';
|
|
1938
2214
|
/** OAuth access token. */
|
|
1939
2215
|
access_token?: string;
|
|
1940
2216
|
/** Data format for response. */
|
|
1941
|
-
alt?:
|
|
2217
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1942
2218
|
/** JSONP */
|
|
1943
2219
|
callback?: string;
|
|
1944
2220
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1963,11 +2239,11 @@ declare namespace gapi.client {
|
|
|
1963
2239
|
/** Deletes a reaction to a message. 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) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) */
|
|
1964
2240
|
delete(request?: {
|
|
1965
2241
|
/** V1 error format. */
|
|
1966
|
-
'$.xgafv'?:
|
|
2242
|
+
'$.xgafv'?: '1' | '2';
|
|
1967
2243
|
/** OAuth access token. */
|
|
1968
2244
|
access_token?: string;
|
|
1969
2245
|
/** Data format for response. */
|
|
1970
|
-
alt?:
|
|
2246
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1971
2247
|
/** JSONP */
|
|
1972
2248
|
callback?: string;
|
|
1973
2249
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1990,11 +2266,11 @@ declare namespace gapi.client {
|
|
|
1990
2266
|
/** 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) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` */
|
|
1991
2267
|
list(request?: {
|
|
1992
2268
|
/** V1 error format. */
|
|
1993
|
-
'$.xgafv'?:
|
|
2269
|
+
'$.xgafv'?: '1' | '2';
|
|
1994
2270
|
/** OAuth access token. */
|
|
1995
2271
|
access_token?: string;
|
|
1996
2272
|
/** Data format for response. */
|
|
1997
|
-
alt?:
|
|
2273
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1998
2274
|
/** JSONP */
|
|
1999
2275
|
callback?: string;
|
|
2000
2276
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2025,13 +2301,18 @@ declare namespace gapi.client {
|
|
|
2025
2301
|
/** Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`).  The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`).  The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request. */
|
|
2026
2302
|
create(request: {
|
|
2027
2303
|
/** V1 error format. */
|
|
2028
|
-
'$.xgafv'?:
|
|
2304
|
+
'$.xgafv'?: '1' | '2';
|
|
2029
2305
|
/** OAuth access token. */
|
|
2030
2306
|
access_token?: string;
|
|
2031
2307
|
/** Data format for response. */
|
|
2032
|
-
alt?:
|
|
2308
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2033
2309
|
/** JSONP */
|
|
2034
2310
|
callback?: string;
|
|
2311
|
+
/** The notification type for the message. */
|
|
2312
|
+
'createMessageNotificationOptions.notificationType'?:
|
|
2313
|
+
| 'NOTIFICATION_TYPE_NONE'
|
|
2314
|
+
| 'NOTIFICATION_TYPE_FORCE_NOTIFY'
|
|
2315
|
+
| 'NOTIFICATION_TYPE_SILENT';
|
|
2035
2316
|
/** Selector specifying which fields to include in a partial response. */
|
|
2036
2317
|
fields?: string;
|
|
2037
2318
|
/** 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. */
|
|
@@ -2039,7 +2320,10 @@ declare namespace gapi.client {
|
|
|
2039
2320
|
/** 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). */
|
|
2040
2321
|
messageId?: string;
|
|
2041
2322
|
/** Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread. */
|
|
2042
|
-
messageReplyOption?:
|
|
2323
|
+
messageReplyOption?:
|
|
2324
|
+
| 'MESSAGE_REPLY_OPTION_UNSPECIFIED'
|
|
2325
|
+
| 'REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD'
|
|
2326
|
+
| 'REPLY_MESSAGE_OR_FAIL';
|
|
2043
2327
|
/** OAuth 2.0 token for the current user. */
|
|
2044
2328
|
oauth_token?: string;
|
|
2045
2329
|
/** Required. The resource name of the space in which to create a message. Format: `spaces/{space}` */
|
|
@@ -2062,13 +2346,18 @@ declare namespace gapi.client {
|
|
|
2062
2346
|
create(
|
|
2063
2347
|
request: {
|
|
2064
2348
|
/** V1 error format. */
|
|
2065
|
-
'$.xgafv'?:
|
|
2349
|
+
'$.xgafv'?: '1' | '2';
|
|
2066
2350
|
/** OAuth access token. */
|
|
2067
2351
|
access_token?: string;
|
|
2068
2352
|
/** Data format for response. */
|
|
2069
|
-
alt?:
|
|
2353
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2070
2354
|
/** JSONP */
|
|
2071
2355
|
callback?: string;
|
|
2356
|
+
/** The notification type for the message. */
|
|
2357
|
+
'createMessageNotificationOptions.notificationType'?:
|
|
2358
|
+
| 'NOTIFICATION_TYPE_NONE'
|
|
2359
|
+
| 'NOTIFICATION_TYPE_FORCE_NOTIFY'
|
|
2360
|
+
| 'NOTIFICATION_TYPE_SILENT';
|
|
2072
2361
|
/** Selector specifying which fields to include in a partial response. */
|
|
2073
2362
|
fields?: string;
|
|
2074
2363
|
/** 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. */
|
|
@@ -2076,7 +2365,10 @@ declare namespace gapi.client {
|
|
|
2076
2365
|
/** 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). */
|
|
2077
2366
|
messageId?: string;
|
|
2078
2367
|
/** Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread. */
|
|
2079
|
-
messageReplyOption?:
|
|
2368
|
+
messageReplyOption?:
|
|
2369
|
+
| 'MESSAGE_REPLY_OPTION_UNSPECIFIED'
|
|
2370
|
+
| 'REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD'
|
|
2371
|
+
| 'REPLY_MESSAGE_OR_FAIL';
|
|
2080
2372
|
/** OAuth 2.0 token for the current user. */
|
|
2081
2373
|
oauth_token?: string;
|
|
2082
2374
|
/** Required. The resource name of the space in which to create a message. Format: `spaces/{space}` */
|
|
@@ -2099,11 +2391,11 @@ declare namespace gapi.client {
|
|
|
2099
2391
|
/** Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app. */
|
|
2100
2392
|
delete(request?: {
|
|
2101
2393
|
/** V1 error format. */
|
|
2102
|
-
'$.xgafv'?:
|
|
2394
|
+
'$.xgafv'?: '1' | '2';
|
|
2103
2395
|
/** OAuth access token. */
|
|
2104
2396
|
access_token?: string;
|
|
2105
2397
|
/** Data format for response. */
|
|
2106
|
-
alt?:
|
|
2398
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2107
2399
|
/** JSONP */
|
|
2108
2400
|
callback?: string;
|
|
2109
2401
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2125,14 +2417,14 @@ declare namespace gapi.client {
|
|
|
2125
2417
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2126
2418
|
uploadType?: string;
|
|
2127
2419
|
}): Request<{}>;
|
|
2128
|
-
/** Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
2420
|
+
/** Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space. */
|
|
2129
2421
|
get(request?: {
|
|
2130
2422
|
/** V1 error format. */
|
|
2131
|
-
'$.xgafv'?:
|
|
2423
|
+
'$.xgafv'?: '1' | '2';
|
|
2132
2424
|
/** OAuth access token. */
|
|
2133
2425
|
access_token?: string;
|
|
2134
2426
|
/** Data format for response. */
|
|
2135
|
-
alt?:
|
|
2427
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2136
2428
|
/** JSONP */
|
|
2137
2429
|
callback?: string;
|
|
2138
2430
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2152,14 +2444,14 @@ declare namespace gapi.client {
|
|
|
2152
2444
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2153
2445
|
uploadType?: string;
|
|
2154
2446
|
}): Request<Message>;
|
|
2155
|
-
/** Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
2447
|
+
/** Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) */
|
|
2156
2448
|
list(request?: {
|
|
2157
2449
|
/** V1 error format. */
|
|
2158
|
-
'$.xgafv'?:
|
|
2450
|
+
'$.xgafv'?: '1' | '2';
|
|
2159
2451
|
/** OAuth access token. */
|
|
2160
2452
|
access_token?: string;
|
|
2161
2453
|
/** Data format for response. */
|
|
2162
|
-
alt?:
|
|
2454
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2163
2455
|
/** JSONP */
|
|
2164
2456
|
callback?: string;
|
|
2165
2457
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2192,13 +2484,13 @@ declare namespace gapi.client {
|
|
|
2192
2484
|
/** 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). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app. */
|
|
2193
2485
|
patch(request: {
|
|
2194
2486
|
/** V1 error format. */
|
|
2195
|
-
'$.xgafv'?:
|
|
2487
|
+
'$.xgafv'?: '1' | '2';
|
|
2196
2488
|
/** OAuth access token. */
|
|
2197
2489
|
access_token?: string;
|
|
2198
2490
|
/** 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. */
|
|
2199
2491
|
allowMissing?: boolean;
|
|
2200
2492
|
/** Data format for response. */
|
|
2201
|
-
alt?:
|
|
2493
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2202
2494
|
/** JSONP */
|
|
2203
2495
|
callback?: string;
|
|
2204
2496
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2225,13 +2517,13 @@ declare namespace gapi.client {
|
|
|
2225
2517
|
patch(
|
|
2226
2518
|
request: {
|
|
2227
2519
|
/** V1 error format. */
|
|
2228
|
-
'$.xgafv'?:
|
|
2520
|
+
'$.xgafv'?: '1' | '2';
|
|
2229
2521
|
/** OAuth access token. */
|
|
2230
2522
|
access_token?: string;
|
|
2231
2523
|
/** 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. */
|
|
2232
2524
|
allowMissing?: boolean;
|
|
2233
2525
|
/** Data format for response. */
|
|
2234
|
-
alt?:
|
|
2526
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2235
2527
|
/** JSONP */
|
|
2236
2528
|
callback?: string;
|
|
2237
2529
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2258,13 +2550,13 @@ declare namespace gapi.client {
|
|
|
2258
2550
|
/** 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). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app. */
|
|
2259
2551
|
update(request: {
|
|
2260
2552
|
/** V1 error format. */
|
|
2261
|
-
'$.xgafv'?:
|
|
2553
|
+
'$.xgafv'?: '1' | '2';
|
|
2262
2554
|
/** OAuth access token. */
|
|
2263
2555
|
access_token?: string;
|
|
2264
2556
|
/** 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. */
|
|
2265
2557
|
allowMissing?: boolean;
|
|
2266
2558
|
/** Data format for response. */
|
|
2267
|
-
alt?:
|
|
2559
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2268
2560
|
/** JSONP */
|
|
2269
2561
|
callback?: string;
|
|
2270
2562
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2291,13 +2583,13 @@ declare namespace gapi.client {
|
|
|
2291
2583
|
update(
|
|
2292
2584
|
request: {
|
|
2293
2585
|
/** V1 error format. */
|
|
2294
|
-
'$.xgafv'?:
|
|
2586
|
+
'$.xgafv'?: '1' | '2';
|
|
2295
2587
|
/** OAuth access token. */
|
|
2296
2588
|
access_token?: string;
|
|
2297
2589
|
/** 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. */
|
|
2298
2590
|
allowMissing?: boolean;
|
|
2299
2591
|
/** Data format for response. */
|
|
2300
|
-
alt?:
|
|
2592
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2301
2593
|
/** JSONP */
|
|
2302
2594
|
callback?: string;
|
|
2303
2595
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2325,14 +2617,14 @@ declare namespace gapi.client {
|
|
|
2325
2617
|
reactions: ReactionsResource;
|
|
2326
2618
|
}
|
|
2327
2619
|
interface SpaceEventsResource {
|
|
2328
|
-
/** 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. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
2620
|
+
/** 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. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller 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). */
|
|
2329
2621
|
get(request?: {
|
|
2330
2622
|
/** V1 error format. */
|
|
2331
|
-
'$.xgafv'?:
|
|
2623
|
+
'$.xgafv'?: '1' | '2';
|
|
2332
2624
|
/** OAuth access token. */
|
|
2333
2625
|
access_token?: string;
|
|
2334
2626
|
/** Data format for response. */
|
|
2335
|
-
alt?:
|
|
2627
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2336
2628
|
/** JSONP */
|
|
2337
2629
|
callback?: string;
|
|
2338
2630
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2352,14 +2644,14 @@ declare namespace gapi.client {
|
|
|
2352
2644
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2353
2645
|
uploadType?: string;
|
|
2354
2646
|
}): Request<SpaceEvent>;
|
|
2355
|
-
/** 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. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth)
|
|
2647
|
+
/** 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. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller 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). */
|
|
2356
2648
|
list(request?: {
|
|
2357
2649
|
/** V1 error format. */
|
|
2358
|
-
'$.xgafv'?:
|
|
2650
|
+
'$.xgafv'?: '1' | '2';
|
|
2359
2651
|
/** OAuth access token. */
|
|
2360
2652
|
access_token?: string;
|
|
2361
2653
|
/** Data format for response. */
|
|
2362
|
-
alt?:
|
|
2654
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2363
2655
|
/** JSONP */
|
|
2364
2656
|
callback?: string;
|
|
2365
2657
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2390,11 +2682,11 @@ declare namespace gapi.client {
|
|
|
2390
2682
|
/** Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) and domain-wide delegation with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.import` For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import). */
|
|
2391
2683
|
completeImport(request: {
|
|
2392
2684
|
/** V1 error format. */
|
|
2393
|
-
'$.xgafv'?:
|
|
2685
|
+
'$.xgafv'?: '1' | '2';
|
|
2394
2686
|
/** OAuth access token. */
|
|
2395
2687
|
access_token?: string;
|
|
2396
2688
|
/** Data format for response. */
|
|
2397
|
-
alt?:
|
|
2689
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2398
2690
|
/** JSONP */
|
|
2399
2691
|
callback?: string;
|
|
2400
2692
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2419,11 +2711,11 @@ declare namespace gapi.client {
|
|
|
2419
2711
|
completeImport(
|
|
2420
2712
|
request: {
|
|
2421
2713
|
/** V1 error format. */
|
|
2422
|
-
'$.xgafv'?:
|
|
2714
|
+
'$.xgafv'?: '1' | '2';
|
|
2423
2715
|
/** OAuth access token. */
|
|
2424
2716
|
access_token?: string;
|
|
2425
2717
|
/** Data format for response. */
|
|
2426
|
-
alt?:
|
|
2718
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2427
2719
|
/** JSONP */
|
|
2428
2720
|
callback?: string;
|
|
2429
2721
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2448,11 +2740,11 @@ declare namespace gapi.client {
|
|
|
2448
2740
|
/** Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces.create` - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When authenticating as an app, the `space.customer` field must be set in the request. When authenticating as an app, the Chat app is added as a member of the space. However, unlike human authentication, the Chat app is not added as a space manager. By default, the Chat app can be removed from the space by all space members. To allow only space managers to remove the app from a space, set `space.permission_settings.manage_apps` to `managers_allowed`. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. 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. */
|
|
2449
2741
|
create(request: {
|
|
2450
2742
|
/** V1 error format. */
|
|
2451
|
-
'$.xgafv'?:
|
|
2743
|
+
'$.xgafv'?: '1' | '2';
|
|
2452
2744
|
/** OAuth access token. */
|
|
2453
2745
|
access_token?: string;
|
|
2454
2746
|
/** Data format for response. */
|
|
2455
|
-
alt?:
|
|
2747
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2456
2748
|
/** JSONP */
|
|
2457
2749
|
callback?: string;
|
|
2458
2750
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2477,11 +2769,11 @@ declare namespace gapi.client {
|
|
|
2477
2769
|
create(
|
|
2478
2770
|
request: {
|
|
2479
2771
|
/** V1 error format. */
|
|
2480
|
-
'$.xgafv'?:
|
|
2772
|
+
'$.xgafv'?: '1' | '2';
|
|
2481
2773
|
/** OAuth access token. */
|
|
2482
2774
|
access_token?: string;
|
|
2483
2775
|
/** Data format for response. */
|
|
2484
|
-
alt?:
|
|
2776
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2485
2777
|
/** JSONP */
|
|
2486
2778
|
callback?: string;
|
|
2487
2779
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2506,11 +2798,11 @@ declare namespace gapi.client {
|
|
|
2506
2798
|
/** 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). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.delete` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.delete` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.delete` */
|
|
2507
2799
|
delete(request?: {
|
|
2508
2800
|
/** V1 error format. */
|
|
2509
|
-
'$.xgafv'?:
|
|
2801
|
+
'$.xgafv'?: '1' | '2';
|
|
2510
2802
|
/** OAuth access token. */
|
|
2511
2803
|
access_token?: string;
|
|
2512
2804
|
/** Data format for response. */
|
|
2513
|
-
alt?:
|
|
2805
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2514
2806
|
/** JSONP */
|
|
2515
2807
|
callback?: string;
|
|
2516
2808
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2535,11 +2827,11 @@ declare namespace gapi.client {
|
|
|
2535
2827
|
/** 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 [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. 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. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` */
|
|
2536
2828
|
findDirectMessage(request?: {
|
|
2537
2829
|
/** V1 error format. */
|
|
2538
|
-
'$.xgafv'?:
|
|
2830
|
+
'$.xgafv'?: '1' | '2';
|
|
2539
2831
|
/** OAuth access token. */
|
|
2540
2832
|
access_token?: string;
|
|
2541
2833
|
/** Data format for response. */
|
|
2542
|
-
alt?:
|
|
2834
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2543
2835
|
/** JSONP */
|
|
2544
2836
|
callback?: string;
|
|
2545
2837
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2559,14 +2851,50 @@ declare namespace gapi.client {
|
|
|
2559
2851
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2560
2852
|
uploadType?: string;
|
|
2561
2853
|
}): Request<Space>;
|
|
2854
|
+
/** Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/workspace/chat/find-group-chats). If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` */
|
|
2855
|
+
findGroupChats(request?: {
|
|
2856
|
+
/** V1 error format. */
|
|
2857
|
+
'$.xgafv'?: '1' | '2';
|
|
2858
|
+
/** OAuth access token. */
|
|
2859
|
+
access_token?: string;
|
|
2860
|
+
/** Data format for response. */
|
|
2861
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2862
|
+
/** JSONP */
|
|
2863
|
+
callback?: string;
|
|
2864
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2865
|
+
fields?: string;
|
|
2866
|
+
/** 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. */
|
|
2867
|
+
key?: string;
|
|
2868
|
+
/** OAuth 2.0 token for the current user. */
|
|
2869
|
+
oauth_token?: string;
|
|
2870
|
+
/** Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error. */
|
|
2871
|
+
pageSize?: number;
|
|
2872
|
+
/** Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results. */
|
|
2873
|
+
pageToken?: string;
|
|
2874
|
+
/** Returns response with indentations and line breaks. */
|
|
2875
|
+
prettyPrint?: boolean;
|
|
2876
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2877
|
+
quotaUser?: string;
|
|
2878
|
+
/** Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly. */
|
|
2879
|
+
spaceView?:
|
|
2880
|
+
| 'SPACE_VIEW_UNSPECIFIED'
|
|
2881
|
+
| 'SPACE_VIEW_RESOURCE_NAME_ONLY'
|
|
2882
|
+
| 'SPACE_VIEW_EXPANDED';
|
|
2883
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2884
|
+
upload_protocol?: string;
|
|
2885
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2886
|
+
uploadType?: string;
|
|
2887
|
+
/** Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. 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, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also 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. */
|
|
2888
|
+
users?: string | string[];
|
|
2889
|
+
}): Request<FindGroupChatsResponse>;
|
|
2562
2890
|
/** Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - `space.access_settings` is only populated when using the `chat.app.spaces` scope. - `space.predefind_permission_settings` and `space.permission_settings` are only populated when using the `chat.app.spaces` scope, and only for spaces the app created. */
|
|
2563
2891
|
get(request?: {
|
|
2564
2892
|
/** V1 error format. */
|
|
2565
|
-
'$.xgafv'?:
|
|
2893
|
+
'$.xgafv'?: '1' | '2';
|
|
2566
2894
|
/** OAuth access token. */
|
|
2567
2895
|
access_token?: string;
|
|
2568
2896
|
/** Data format for response. */
|
|
2569
|
-
alt?:
|
|
2897
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2570
2898
|
/** JSONP */
|
|
2571
2899
|
callback?: string;
|
|
2572
2900
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2591,11 +2919,11 @@ declare namespace gapi.client {
|
|
|
2591
2919
|
/** 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). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead. */
|
|
2592
2920
|
list(request?: {
|
|
2593
2921
|
/** V1 error format. */
|
|
2594
|
-
'$.xgafv'?:
|
|
2922
|
+
'$.xgafv'?: '1' | '2';
|
|
2595
2923
|
/** OAuth access token. */
|
|
2596
2924
|
access_token?: string;
|
|
2597
2925
|
/** Data format for response. */
|
|
2598
|
-
alt?:
|
|
2926
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2599
2927
|
/** JSONP */
|
|
2600
2928
|
callback?: string;
|
|
2601
2929
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2622,11 +2950,11 @@ declare namespace gapi.client {
|
|
|
2622
2950
|
/** 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. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - To update either `space.predefined_permission_settings` or `space.permission_settings`, the app must be the space creator. - Updating the `space.access_settings.audience` is not supported for app authentication. */
|
|
2623
2951
|
patch(request: {
|
|
2624
2952
|
/** V1 error format. */
|
|
2625
|
-
'$.xgafv'?:
|
|
2953
|
+
'$.xgafv'?: '1' | '2';
|
|
2626
2954
|
/** OAuth access token. */
|
|
2627
2955
|
access_token?: string;
|
|
2628
2956
|
/** Data format for response. */
|
|
2629
|
-
alt?:
|
|
2957
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2630
2958
|
/** JSONP */
|
|
2631
2959
|
callback?: string;
|
|
2632
2960
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2655,11 +2983,11 @@ declare namespace gapi.client {
|
|
|
2655
2983
|
patch(
|
|
2656
2984
|
request: {
|
|
2657
2985
|
/** V1 error format. */
|
|
2658
|
-
'$.xgafv'?:
|
|
2986
|
+
'$.xgafv'?: '1' | '2';
|
|
2659
2987
|
/** OAuth access token. */
|
|
2660
2988
|
access_token?: string;
|
|
2661
2989
|
/** Data format for response. */
|
|
2662
|
-
alt?:
|
|
2990
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2663
2991
|
/** JSONP */
|
|
2664
2992
|
callback?: string;
|
|
2665
2993
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2688,11 +3016,11 @@ declare namespace gapi.client {
|
|
|
2688
3016
|
/** Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, set `use_admin_access` to `true`. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` */
|
|
2689
3017
|
search(request?: {
|
|
2690
3018
|
/** V1 error format. */
|
|
2691
|
-
'$.xgafv'?:
|
|
3019
|
+
'$.xgafv'?: '1' | '2';
|
|
2692
3020
|
/** OAuth access token. */
|
|
2693
3021
|
access_token?: string;
|
|
2694
3022
|
/** Data format for response. */
|
|
2695
|
-
alt?:
|
|
3023
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2696
3024
|
/** JSONP */
|
|
2697
3025
|
callback?: string;
|
|
2698
3026
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2709,7 +3037,7 @@ declare namespace gapi.client {
|
|
|
2709
3037
|
pageToken?: string;
|
|
2710
3038
|
/** Returns response with indentations and line breaks. */
|
|
2711
3039
|
prettyPrint?: boolean;
|
|
2712
|
-
/** Required. A search query. You can search by using the following parameters: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` */
|
|
3040
|
+
/** Required. A search query. You can search by using the following parameters : - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` */
|
|
2713
3041
|
query?: string;
|
|
2714
3042
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2715
3043
|
quotaUser?: string;
|
|
@@ -2723,11 +3051,11 @@ declare namespace gapi.client {
|
|
|
2723
3051
|
/** 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 `membership.member.name`. 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`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add 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) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` */
|
|
2724
3052
|
setup(request: {
|
|
2725
3053
|
/** V1 error format. */
|
|
2726
|
-
'$.xgafv'?:
|
|
3054
|
+
'$.xgafv'?: '1' | '2';
|
|
2727
3055
|
/** OAuth access token. */
|
|
2728
3056
|
access_token?: string;
|
|
2729
3057
|
/** Data format for response. */
|
|
2730
|
-
alt?:
|
|
3058
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2731
3059
|
/** JSONP */
|
|
2732
3060
|
callback?: string;
|
|
2733
3061
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2750,11 +3078,11 @@ declare namespace gapi.client {
|
|
|
2750
3078
|
setup(
|
|
2751
3079
|
request: {
|
|
2752
3080
|
/** V1 error format. */
|
|
2753
|
-
'$.xgafv'?:
|
|
3081
|
+
'$.xgafv'?: '1' | '2';
|
|
2754
3082
|
/** OAuth access token. */
|
|
2755
3083
|
access_token?: string;
|
|
2756
3084
|
/** Data format for response. */
|
|
2757
|
-
alt?:
|
|
3085
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2758
3086
|
/** JSONP */
|
|
2759
3087
|
callback?: string;
|
|
2760
3088
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2778,15 +3106,347 @@ declare namespace gapi.client {
|
|
|
2778
3106
|
messages: MessagesResource;
|
|
2779
3107
|
spaceEvents: SpaceEventsResource;
|
|
2780
3108
|
}
|
|
3109
|
+
interface ItemsResource {
|
|
3110
|
+
/** Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly` */
|
|
3111
|
+
list(request?: {
|
|
3112
|
+
/** V1 error format. */
|
|
3113
|
+
'$.xgafv'?: '1' | '2';
|
|
3114
|
+
/** OAuth access token. */
|
|
3115
|
+
access_token?: string;
|
|
3116
|
+
/** Data format for response. */
|
|
3117
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3118
|
+
/** JSONP */
|
|
3119
|
+
callback?: string;
|
|
3120
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3121
|
+
fields?: string;
|
|
3122
|
+
/** Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error. */
|
|
3123
|
+
filter?: string;
|
|
3124
|
+
/** 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. */
|
|
3125
|
+
key?: string;
|
|
3126
|
+
/** OAuth 2.0 token for the current user. */
|
|
3127
|
+
oauth_token?: string;
|
|
3128
|
+
/** Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error. */
|
|
3129
|
+
pageSize?: number;
|
|
3130
|
+
/** Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. */
|
|
3131
|
+
pageToken?: string;
|
|
3132
|
+
/** Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}` */
|
|
3133
|
+
parent: string;
|
|
3134
|
+
/** Returns response with indentations and line breaks. */
|
|
3135
|
+
prettyPrint?: boolean;
|
|
3136
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3137
|
+
quotaUser?: string;
|
|
3138
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3139
|
+
upload_protocol?: string;
|
|
3140
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3141
|
+
uploadType?: string;
|
|
3142
|
+
}): Request<ListSectionItemsResponse>;
|
|
3143
|
+
/** Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` */
|
|
3144
|
+
move(request: {
|
|
3145
|
+
/** V1 error format. */
|
|
3146
|
+
'$.xgafv'?: '1' | '2';
|
|
3147
|
+
/** OAuth access token. */
|
|
3148
|
+
access_token?: string;
|
|
3149
|
+
/** Data format for response. */
|
|
3150
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3151
|
+
/** JSONP */
|
|
3152
|
+
callback?: string;
|
|
3153
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3154
|
+
fields?: string;
|
|
3155
|
+
/** 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. */
|
|
3156
|
+
key?: string;
|
|
3157
|
+
/** Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}` */
|
|
3158
|
+
name: string;
|
|
3159
|
+
/** OAuth 2.0 token for the current user. */
|
|
3160
|
+
oauth_token?: string;
|
|
3161
|
+
/** Returns response with indentations and line breaks. */
|
|
3162
|
+
prettyPrint?: boolean;
|
|
3163
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3164
|
+
quotaUser?: string;
|
|
3165
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3166
|
+
upload_protocol?: string;
|
|
3167
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3168
|
+
uploadType?: string;
|
|
3169
|
+
/** Request body */
|
|
3170
|
+
resource: MoveSectionItemRequest;
|
|
3171
|
+
}): Request<MoveSectionItemResponse>;
|
|
3172
|
+
move(
|
|
3173
|
+
request: {
|
|
3174
|
+
/** V1 error format. */
|
|
3175
|
+
'$.xgafv'?: '1' | '2';
|
|
3176
|
+
/** OAuth access token. */
|
|
3177
|
+
access_token?: string;
|
|
3178
|
+
/** Data format for response. */
|
|
3179
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3180
|
+
/** JSONP */
|
|
3181
|
+
callback?: string;
|
|
3182
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3183
|
+
fields?: string;
|
|
3184
|
+
/** 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. */
|
|
3185
|
+
key?: string;
|
|
3186
|
+
/** Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}` */
|
|
3187
|
+
name: string;
|
|
3188
|
+
/** OAuth 2.0 token for the current user. */
|
|
3189
|
+
oauth_token?: string;
|
|
3190
|
+
/** Returns response with indentations and line breaks. */
|
|
3191
|
+
prettyPrint?: boolean;
|
|
3192
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3193
|
+
quotaUser?: string;
|
|
3194
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3195
|
+
upload_protocol?: string;
|
|
3196
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3197
|
+
uploadType?: string;
|
|
3198
|
+
},
|
|
3199
|
+
body: MoveSectionItemRequest,
|
|
3200
|
+
): Request<MoveSectionItemResponse>;
|
|
3201
|
+
}
|
|
3202
|
+
interface SectionsResource {
|
|
3203
|
+
/** Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` */
|
|
3204
|
+
create(request: {
|
|
3205
|
+
/** V1 error format. */
|
|
3206
|
+
'$.xgafv'?: '1' | '2';
|
|
3207
|
+
/** OAuth access token. */
|
|
3208
|
+
access_token?: string;
|
|
3209
|
+
/** Data format for response. */
|
|
3210
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3211
|
+
/** JSONP */
|
|
3212
|
+
callback?: string;
|
|
3213
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3214
|
+
fields?: string;
|
|
3215
|
+
/** 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. */
|
|
3216
|
+
key?: string;
|
|
3217
|
+
/** OAuth 2.0 token for the current user. */
|
|
3218
|
+
oauth_token?: string;
|
|
3219
|
+
/** Required. The parent resource name where the section is created. Format: `users/{user}` */
|
|
3220
|
+
parent: string;
|
|
3221
|
+
/** Returns response with indentations and line breaks. */
|
|
3222
|
+
prettyPrint?: boolean;
|
|
3223
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3224
|
+
quotaUser?: string;
|
|
3225
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3226
|
+
upload_protocol?: string;
|
|
3227
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3228
|
+
uploadType?: string;
|
|
3229
|
+
/** Request body */
|
|
3230
|
+
resource: GoogleChatV1Section;
|
|
3231
|
+
}): Request<GoogleChatV1Section>;
|
|
3232
|
+
create(
|
|
3233
|
+
request: {
|
|
3234
|
+
/** V1 error format. */
|
|
3235
|
+
'$.xgafv'?: '1' | '2';
|
|
3236
|
+
/** OAuth access token. */
|
|
3237
|
+
access_token?: string;
|
|
3238
|
+
/** Data format for response. */
|
|
3239
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3240
|
+
/** JSONP */
|
|
3241
|
+
callback?: string;
|
|
3242
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3243
|
+
fields?: string;
|
|
3244
|
+
/** 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. */
|
|
3245
|
+
key?: string;
|
|
3246
|
+
/** OAuth 2.0 token for the current user. */
|
|
3247
|
+
oauth_token?: string;
|
|
3248
|
+
/** Required. The parent resource name where the section is created. Format: `users/{user}` */
|
|
3249
|
+
parent: string;
|
|
3250
|
+
/** Returns response with indentations and line breaks. */
|
|
3251
|
+
prettyPrint?: boolean;
|
|
3252
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3253
|
+
quotaUser?: string;
|
|
3254
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3255
|
+
upload_protocol?: string;
|
|
3256
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3257
|
+
uploadType?: string;
|
|
3258
|
+
},
|
|
3259
|
+
body: GoogleChatV1Section,
|
|
3260
|
+
): Request<GoogleChatV1Section>;
|
|
3261
|
+
/** Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` */
|
|
3262
|
+
delete(request?: {
|
|
3263
|
+
/** V1 error format. */
|
|
3264
|
+
'$.xgafv'?: '1' | '2';
|
|
3265
|
+
/** OAuth access token. */
|
|
3266
|
+
access_token?: string;
|
|
3267
|
+
/** Data format for response. */
|
|
3268
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3269
|
+
/** JSONP */
|
|
3270
|
+
callback?: string;
|
|
3271
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3272
|
+
fields?: string;
|
|
3273
|
+
/** 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. */
|
|
3274
|
+
key?: string;
|
|
3275
|
+
/** Required. The name of the section to delete. Format: `users/{user}/sections/{section}` */
|
|
3276
|
+
name: string;
|
|
3277
|
+
/** OAuth 2.0 token for the current user. */
|
|
3278
|
+
oauth_token?: string;
|
|
3279
|
+
/** Returns response with indentations and line breaks. */
|
|
3280
|
+
prettyPrint?: boolean;
|
|
3281
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3282
|
+
quotaUser?: string;
|
|
3283
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3284
|
+
upload_protocol?: string;
|
|
3285
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3286
|
+
uploadType?: string;
|
|
3287
|
+
}): Request<{}>;
|
|
3288
|
+
/** Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly` */
|
|
3289
|
+
list(request?: {
|
|
3290
|
+
/** V1 error format. */
|
|
3291
|
+
'$.xgafv'?: '1' | '2';
|
|
3292
|
+
/** OAuth access token. */
|
|
3293
|
+
access_token?: string;
|
|
3294
|
+
/** Data format for response. */
|
|
3295
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3296
|
+
/** JSONP */
|
|
3297
|
+
callback?: string;
|
|
3298
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3299
|
+
fields?: string;
|
|
3300
|
+
/** 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. */
|
|
3301
|
+
key?: string;
|
|
3302
|
+
/** OAuth 2.0 token for the current user. */
|
|
3303
|
+
oauth_token?: string;
|
|
3304
|
+
/** Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error. */
|
|
3305
|
+
pageSize?: number;
|
|
3306
|
+
/** Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. */
|
|
3307
|
+
pageToken?: string;
|
|
3308
|
+
/** Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}` */
|
|
3309
|
+
parent: string;
|
|
3310
|
+
/** Returns response with indentations and line breaks. */
|
|
3311
|
+
prettyPrint?: boolean;
|
|
3312
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3313
|
+
quotaUser?: string;
|
|
3314
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3315
|
+
upload_protocol?: string;
|
|
3316
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3317
|
+
uploadType?: string;
|
|
3318
|
+
}): Request<ListSectionsResponse>;
|
|
3319
|
+
/** Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` */
|
|
3320
|
+
patch(request: {
|
|
3321
|
+
/** V1 error format. */
|
|
3322
|
+
'$.xgafv'?: '1' | '2';
|
|
3323
|
+
/** OAuth access token. */
|
|
3324
|
+
access_token?: string;
|
|
3325
|
+
/** Data format for response. */
|
|
3326
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3327
|
+
/** JSONP */
|
|
3328
|
+
callback?: string;
|
|
3329
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3330
|
+
fields?: string;
|
|
3331
|
+
/** 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. */
|
|
3332
|
+
key?: string;
|
|
3333
|
+
/** Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` */
|
|
3334
|
+
name: string;
|
|
3335
|
+
/** OAuth 2.0 token for the current user. */
|
|
3336
|
+
oauth_token?: string;
|
|
3337
|
+
/** Returns response with indentations and line breaks. */
|
|
3338
|
+
prettyPrint?: boolean;
|
|
3339
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3340
|
+
quotaUser?: string;
|
|
3341
|
+
/** Required. The mask to specify which fields to update. Currently supported field paths: - `display_name` */
|
|
3342
|
+
updateMask?: string;
|
|
3343
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3344
|
+
upload_protocol?: string;
|
|
3345
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3346
|
+
uploadType?: string;
|
|
3347
|
+
/** Request body */
|
|
3348
|
+
resource: GoogleChatV1Section;
|
|
3349
|
+
}): Request<GoogleChatV1Section>;
|
|
3350
|
+
patch(
|
|
3351
|
+
request: {
|
|
3352
|
+
/** V1 error format. */
|
|
3353
|
+
'$.xgafv'?: '1' | '2';
|
|
3354
|
+
/** OAuth access token. */
|
|
3355
|
+
access_token?: string;
|
|
3356
|
+
/** Data format for response. */
|
|
3357
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3358
|
+
/** JSONP */
|
|
3359
|
+
callback?: string;
|
|
3360
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3361
|
+
fields?: string;
|
|
3362
|
+
/** 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. */
|
|
3363
|
+
key?: string;
|
|
3364
|
+
/** Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` */
|
|
3365
|
+
name: string;
|
|
3366
|
+
/** OAuth 2.0 token for the current user. */
|
|
3367
|
+
oauth_token?: string;
|
|
3368
|
+
/** Returns response with indentations and line breaks. */
|
|
3369
|
+
prettyPrint?: boolean;
|
|
3370
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3371
|
+
quotaUser?: string;
|
|
3372
|
+
/** Required. The mask to specify which fields to update. Currently supported field paths: - `display_name` */
|
|
3373
|
+
updateMask?: string;
|
|
3374
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3375
|
+
upload_protocol?: string;
|
|
3376
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3377
|
+
uploadType?: string;
|
|
3378
|
+
},
|
|
3379
|
+
body: GoogleChatV1Section,
|
|
3380
|
+
): Request<GoogleChatV1Section>;
|
|
3381
|
+
/** Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` */
|
|
3382
|
+
position(request: {
|
|
3383
|
+
/** V1 error format. */
|
|
3384
|
+
'$.xgafv'?: '1' | '2';
|
|
3385
|
+
/** OAuth access token. */
|
|
3386
|
+
access_token?: string;
|
|
3387
|
+
/** Data format for response. */
|
|
3388
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3389
|
+
/** JSONP */
|
|
3390
|
+
callback?: string;
|
|
3391
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3392
|
+
fields?: string;
|
|
3393
|
+
/** 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. */
|
|
3394
|
+
key?: string;
|
|
3395
|
+
/** Required. The resource name of the section to position. Format: `users/{user}/sections/{section}` */
|
|
3396
|
+
name: string;
|
|
3397
|
+
/** OAuth 2.0 token for the current user. */
|
|
3398
|
+
oauth_token?: string;
|
|
3399
|
+
/** Returns response with indentations and line breaks. */
|
|
3400
|
+
prettyPrint?: boolean;
|
|
3401
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3402
|
+
quotaUser?: string;
|
|
3403
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3404
|
+
upload_protocol?: string;
|
|
3405
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3406
|
+
uploadType?: string;
|
|
3407
|
+
/** Request body */
|
|
3408
|
+
resource: PositionSectionRequest;
|
|
3409
|
+
}): Request<PositionSectionResponse>;
|
|
3410
|
+
position(
|
|
3411
|
+
request: {
|
|
3412
|
+
/** V1 error format. */
|
|
3413
|
+
'$.xgafv'?: '1' | '2';
|
|
3414
|
+
/** OAuth access token. */
|
|
3415
|
+
access_token?: string;
|
|
3416
|
+
/** Data format for response. */
|
|
3417
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3418
|
+
/** JSONP */
|
|
3419
|
+
callback?: string;
|
|
3420
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3421
|
+
fields?: string;
|
|
3422
|
+
/** 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. */
|
|
3423
|
+
key?: string;
|
|
3424
|
+
/** Required. The resource name of the section to position. Format: `users/{user}/sections/{section}` */
|
|
3425
|
+
name: string;
|
|
3426
|
+
/** OAuth 2.0 token for the current user. */
|
|
3427
|
+
oauth_token?: string;
|
|
3428
|
+
/** Returns response with indentations and line breaks. */
|
|
3429
|
+
prettyPrint?: boolean;
|
|
3430
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3431
|
+
quotaUser?: string;
|
|
3432
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3433
|
+
upload_protocol?: string;
|
|
3434
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3435
|
+
uploadType?: string;
|
|
3436
|
+
},
|
|
3437
|
+
body: PositionSectionRequest,
|
|
3438
|
+
): Request<PositionSectionResponse>;
|
|
3439
|
+
items: ItemsResource;
|
|
3440
|
+
}
|
|
2781
3441
|
interface SpaceNotificationSettingResource {
|
|
2782
3442
|
/** Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings` */
|
|
2783
3443
|
get(request?: {
|
|
2784
3444
|
/** V1 error format. */
|
|
2785
|
-
'$.xgafv'?:
|
|
3445
|
+
'$.xgafv'?: '1' | '2';
|
|
2786
3446
|
/** OAuth access token. */
|
|
2787
3447
|
access_token?: string;
|
|
2788
3448
|
/** Data format for response. */
|
|
2789
|
-
alt?:
|
|
3449
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2790
3450
|
/** JSONP */
|
|
2791
3451
|
callback?: string;
|
|
2792
3452
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2809,11 +3469,11 @@ declare namespace gapi.client {
|
|
|
2809
3469
|
/** Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings` */
|
|
2810
3470
|
patch(request: {
|
|
2811
3471
|
/** V1 error format. */
|
|
2812
|
-
'$.xgafv'?:
|
|
3472
|
+
'$.xgafv'?: '1' | '2';
|
|
2813
3473
|
/** OAuth access token. */
|
|
2814
3474
|
access_token?: string;
|
|
2815
3475
|
/** Data format for response. */
|
|
2816
|
-
alt?:
|
|
3476
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2817
3477
|
/** JSONP */
|
|
2818
3478
|
callback?: string;
|
|
2819
3479
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2840,11 +3500,11 @@ declare namespace gapi.client {
|
|
|
2840
3500
|
patch(
|
|
2841
3501
|
request: {
|
|
2842
3502
|
/** V1 error format. */
|
|
2843
|
-
'$.xgafv'?:
|
|
3503
|
+
'$.xgafv'?: '1' | '2';
|
|
2844
3504
|
/** OAuth access token. */
|
|
2845
3505
|
access_token?: string;
|
|
2846
3506
|
/** Data format for response. */
|
|
2847
|
-
alt?:
|
|
3507
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2848
3508
|
/** JSONP */
|
|
2849
3509
|
callback?: string;
|
|
2850
3510
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2873,11 +3533,11 @@ declare namespace gapi.client {
|
|
|
2873
3533
|
/** Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` */
|
|
2874
3534
|
getThreadReadState(request?: {
|
|
2875
3535
|
/** V1 error format. */
|
|
2876
|
-
'$.xgafv'?:
|
|
3536
|
+
'$.xgafv'?: '1' | '2';
|
|
2877
3537
|
/** OAuth access token. */
|
|
2878
3538
|
access_token?: string;
|
|
2879
3539
|
/** Data format for response. */
|
|
2880
|
-
alt?:
|
|
3540
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2881
3541
|
/** JSONP */
|
|
2882
3542
|
callback?: string;
|
|
2883
3543
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2902,11 +3562,11 @@ declare namespace gapi.client {
|
|
|
2902
3562
|
/** Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` */
|
|
2903
3563
|
getSpaceReadState(request?: {
|
|
2904
3564
|
/** V1 error format. */
|
|
2905
|
-
'$.xgafv'?:
|
|
3565
|
+
'$.xgafv'?: '1' | '2';
|
|
2906
3566
|
/** OAuth access token. */
|
|
2907
3567
|
access_token?: string;
|
|
2908
3568
|
/** Data format for response. */
|
|
2909
|
-
alt?:
|
|
3569
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2910
3570
|
/** JSONP */
|
|
2911
3571
|
callback?: string;
|
|
2912
3572
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2929,11 +3589,11 @@ declare namespace gapi.client {
|
|
|
2929
3589
|
/** Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate` */
|
|
2930
3590
|
updateSpaceReadState(request: {
|
|
2931
3591
|
/** V1 error format. */
|
|
2932
|
-
'$.xgafv'?:
|
|
3592
|
+
'$.xgafv'?: '1' | '2';
|
|
2933
3593
|
/** OAuth access token. */
|
|
2934
3594
|
access_token?: string;
|
|
2935
3595
|
/** Data format for response. */
|
|
2936
|
-
alt?:
|
|
3596
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2937
3597
|
/** JSONP */
|
|
2938
3598
|
callback?: string;
|
|
2939
3599
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2960,11 +3620,11 @@ declare namespace gapi.client {
|
|
|
2960
3620
|
updateSpaceReadState(
|
|
2961
3621
|
request: {
|
|
2962
3622
|
/** V1 error format. */
|
|
2963
|
-
'$.xgafv'?:
|
|
3623
|
+
'$.xgafv'?: '1' | '2';
|
|
2964
3624
|
/** OAuth access token. */
|
|
2965
3625
|
access_token?: string;
|
|
2966
3626
|
/** Data format for response. */
|
|
2967
|
-
alt?:
|
|
3627
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2968
3628
|
/** JSONP */
|
|
2969
3629
|
callback?: string;
|
|
2970
3630
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -2992,6 +3652,7 @@ declare namespace gapi.client {
|
|
|
2992
3652
|
threads: ThreadsResource;
|
|
2993
3653
|
}
|
|
2994
3654
|
interface UsersResource {
|
|
3655
|
+
sections: SectionsResource;
|
|
2995
3656
|
spaces: SpacesResource;
|
|
2996
3657
|
}
|
|
2997
3658
|
|