@maxim_mazurok/gapi.client.chat-v1 0.0.20230521 → 0.0.20230530
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 +107 -101
- package/package.json +1 -1
- package/readme.md +8 -8
- package/tests.ts +80 -77
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: 20230530
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -93,10 +93,7 @@ declare namespace gapi.client {
|
|
|
93
93
|
string;
|
|
94
94
|
}
|
|
95
95
|
interface AttachmentDataRef {
|
|
96
|
-
/**
|
|
97
|
-
* Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments. [Developer
|
|
98
|
-
* Preview](https://developers.google.com/workspace/preview).
|
|
99
|
-
*/
|
|
96
|
+
/** Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments. */
|
|
100
97
|
attachmentUploadToken?:
|
|
101
98
|
string;
|
|
102
99
|
/** The resource name of the attachment data. This field is used with the media API to download the attachment data. */
|
|
@@ -570,7 +567,7 @@ declare namespace gapi.client {
|
|
|
570
567
|
string;
|
|
571
568
|
}
|
|
572
569
|
interface GoogleAppsCardV1DecoratedText {
|
|
573
|
-
/** The text that appears below `text`. Always
|
|
570
|
+
/** The text that appears below `text`. Always wraps. */
|
|
574
571
|
bottomLabel?:
|
|
575
572
|
string;
|
|
576
573
|
/** A button that a user can click to trigger an action. */
|
|
@@ -1183,24 +1180,23 @@ declare namespace gapi.client {
|
|
|
1183
1180
|
CardWithId[];
|
|
1184
1181
|
/**
|
|
1185
1182
|
* A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this
|
|
1186
|
-
* field to get, update, or delete the message with the specified value.
|
|
1187
|
-
*
|
|
1183
|
+
* field to get, update, or delete the message with the specified value. Assigning a custom name lets a Chat app recall the message without saving the message `name` from the [response
|
|
1184
|
+
* body](/chat/api/reference/rest/v1/spaces.messages/get#response-body) returned when creating the message. Assigning a custom name doesn't replace the generated `name` field, the
|
|
1185
|
+
* message's resource name. Instead, it sets the custom name as the `clientAssignedMessageId` field, which you can reference while processing later operations, like updating or
|
|
1186
|
+
* deleting the message. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
|
|
1188
1187
|
*/
|
|
1189
1188
|
clientAssignedMessageId?:
|
|
1190
1189
|
string;
|
|
1191
1190
|
/** Output only. The time at which the message was created in Google Chat. */
|
|
1192
1191
|
createTime?:
|
|
1193
1192
|
string;
|
|
1194
|
-
/**
|
|
1195
|
-
* Output only. The time at which the message was deleted in Google Chat server. If the message is never deleted, this field is empty. [Developer
|
|
1196
|
-
* Preview](https://developers.google.com/workspace/preview).
|
|
1197
|
-
*/
|
|
1193
|
+
/** Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty. */
|
|
1198
1194
|
deleteTime?:
|
|
1199
1195
|
string;
|
|
1200
|
-
/** Output only. Information about a deleted message. A message is deleted when `delete_time` is set.
|
|
1196
|
+
/** Output only. Information about a deleted message. A message is deleted when `delete_time` is set. */
|
|
1201
1197
|
deletionMetadata?:
|
|
1202
1198
|
DeletionMetadata;
|
|
1203
|
-
/** Output only. The list of emoji reaction summaries on the message.
|
|
1199
|
+
/** Output only. The list of emoji reaction summaries on the message. */
|
|
1204
1200
|
emojiReactionSummaries?:
|
|
1205
1201
|
EmojiReactionSummary[];
|
|
1206
1202
|
/** A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. */
|
|
@@ -1355,19 +1351,19 @@ declare namespace gapi.client {
|
|
|
1355
1351
|
/** Details about the space including description and rules. */
|
|
1356
1352
|
spaceDetails?:
|
|
1357
1353
|
SpaceDetails;
|
|
1358
|
-
/** The message history state for messages and threads in this space.
|
|
1354
|
+
/** The message history state for messages and threads in this space. */
|
|
1359
1355
|
spaceHistoryState?:
|
|
1360
1356
|
string;
|
|
1361
1357
|
/** Output only. The threading state in the Chat space. */
|
|
1362
1358
|
spaceThreadingState?:
|
|
1363
1359
|
string;
|
|
1364
|
-
/** The type of space. Required when creating or updating a space. Output only for other usage.
|
|
1360
|
+
/** The type of space. Required when creating a space or updating the space type of a space. Output only for other usage. */
|
|
1365
1361
|
spaceType?:
|
|
1366
1362
|
string;
|
|
1367
1363
|
/** Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space. */
|
|
1368
1364
|
threaded?:
|
|
1369
1365
|
boolean;
|
|
1370
|
-
/** Output only. Deprecated: Use `
|
|
1366
|
+
/** Output only. Deprecated: Use `space_type` instead. The type of a space. */
|
|
1371
1367
|
type?:
|
|
1372
1368
|
string;
|
|
1373
1369
|
}
|
|
@@ -1532,9 +1528,10 @@ declare namespace gapi.client {
|
|
|
1532
1528
|
string;
|
|
1533
1529
|
}): Request<Media>;
|
|
1534
1530
|
/**
|
|
1535
|
-
* [
|
|
1536
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth/users)
|
|
1537
|
-
* types blocked by Google
|
|
1531
|
+
* Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/chat/api/guides/v1/media-and-attachments/upload). Requires user
|
|
1532
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.create` authorization scope. You can upload attachments up to
|
|
1533
|
+
* 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google
|
|
1534
|
+
* Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).
|
|
1538
1535
|
*/
|
|
1539
1536
|
upload(request: {
|
|
1540
1537
|
/** V1 error format. */
|
|
@@ -1619,12 +1616,15 @@ declare namespace gapi.client {
|
|
|
1619
1616
|
}
|
|
1620
1617
|
interface MembersResource {
|
|
1621
1618
|
/**
|
|
1622
|
-
*
|
|
1623
|
-
*
|
|
1624
|
-
*
|
|
1625
|
-
*
|
|
1626
|
-
* the
|
|
1627
|
-
* `
|
|
1619
|
+
* Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [ Create a
|
|
1620
|
+
* membership](https://developers.google.com/chat/api/guides/v1/members/create). When creating a membership, if the specified member has their auto-accept policy turned off, then
|
|
1621
|
+
* they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user
|
|
1622
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app membership) scope. To
|
|
1623
|
+
* specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to a space or a direct message between two human users, use
|
|
1624
|
+
* `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the
|
|
1625
|
+
* [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the
|
|
1626
|
+
* [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`,
|
|
1627
|
+
* you can add the user to the space by setting the `membership.member.name` to `users/123456789`.
|
|
1628
1628
|
*/
|
|
1629
1629
|
create(request: {
|
|
1630
1630
|
/** V1 error format. */
|
|
@@ -1707,8 +1707,8 @@ declare namespace gapi.client {
|
|
|
1707
1707
|
},
|
|
1708
1708
|
body: Membership): Request<Membership>;
|
|
1709
1709
|
/**
|
|
1710
|
-
*
|
|
1711
|
-
* and the `chat.memberships` or `chat.memberships.app` authorization scope.
|
|
1710
|
+
* Deletes a membership. For an example, see [Delete a membership](https://developers.google.com/chat/api/guides/v1/members/delete). Requires [user
|
|
1711
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` or `chat.memberships.app` authorization scope.
|
|
1712
1712
|
*/
|
|
1713
1713
|
delete(request?: {
|
|
1714
1714
|
/** V1 error format. */
|
|
@@ -1753,9 +1753,9 @@ declare namespace gapi.client {
|
|
|
1753
1753
|
string;
|
|
1754
1754
|
}): Request<Membership>;
|
|
1755
1755
|
/**
|
|
1756
|
-
* Returns a membership.
|
|
1757
|
-
* authentication](https://developers.google.com/chat/api/guides/auth
|
|
1758
|
-
*
|
|
1756
|
+
* Returns details about a membership. For an example, see [Get a membership](https://developers.google.com/chat/api/guides/v1/members/get). Requires
|
|
1757
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
1758
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
1759
1759
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.memberships` or `chat.memberships.readonly` authorization scope.
|
|
1760
1760
|
*/
|
|
1761
1761
|
get(request?: {
|
|
@@ -1797,9 +1797,11 @@ declare namespace gapi.client {
|
|
|
1797
1797
|
string;
|
|
1798
1798
|
}): Request<Membership>;
|
|
1799
1799
|
/**
|
|
1800
|
-
* Lists memberships in a space.
|
|
1801
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
1802
|
-
*
|
|
1800
|
+
* Lists memberships in a space. For an example, see [List memberships](https://developers.google.com/chat/api/guides/v1/members/list). Listing memberships with [app
|
|
1801
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships,
|
|
1802
|
+
* including its own. Listing memberships with [User authentication](https://developers.google.com/chat/api/guides/auth/users) lists memberships in spaces that the authenticated user
|
|
1803
|
+
* has access to. Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
1804
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
1803
1805
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.memberships` or `chat.memberships.readonly` authorization scope.
|
|
1804
1806
|
*/
|
|
1805
1807
|
list(request?: {
|
|
@@ -1870,8 +1872,9 @@ declare namespace gapi.client {
|
|
|
1870
1872
|
}
|
|
1871
1873
|
interface AttachmentsResource {
|
|
1872
1874
|
/**
|
|
1873
|
-
* Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/chat/api/reference/rest/v1/media/download).
|
|
1874
|
-
* [
|
|
1875
|
+
* Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/chat/api/reference/rest/v1/media/download). For an
|
|
1876
|
+
* example, see [Get a message attachment](https://developers.google.com/chat/api/guides/v1/media-and-attachments/get). Requires [service account
|
|
1877
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
|
|
1875
1878
|
*/
|
|
1876
1879
|
get(request?: {
|
|
1877
1880
|
/** V1 error format. */
|
|
@@ -1914,7 +1917,7 @@ declare namespace gapi.client {
|
|
|
1914
1917
|
}
|
|
1915
1918
|
interface ReactionsResource {
|
|
1916
1919
|
/**
|
|
1917
|
-
*
|
|
1920
|
+
* Creates a reaction and adds it to a message. For an example, see [Create a reaction](https://developers.google.com/chat/api/guides/v1/reactions/create). Requires [user
|
|
1918
1921
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages`, `chat.messages.reactions`, or `chat.messages.reactions.create` scope. Only unicode
|
|
1919
1922
|
* emoji are supported.
|
|
1920
1923
|
*/
|
|
@@ -1999,7 +2002,7 @@ declare namespace gapi.client {
|
|
|
1999
2002
|
},
|
|
2000
2003
|
body: Reaction): Request<Reaction>;
|
|
2001
2004
|
/**
|
|
2002
|
-
* [
|
|
2005
|
+
* Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/chat/api/guides/v1/reactions/delete). Requires [user
|
|
2003
2006
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.reactions` scope.
|
|
2004
2007
|
*/
|
|
2005
2008
|
delete(request?: {
|
|
@@ -2041,7 +2044,7 @@ declare namespace gapi.client {
|
|
|
2041
2044
|
string;
|
|
2042
2045
|
}): Request<{}>;
|
|
2043
2046
|
/**
|
|
2044
|
-
* [
|
|
2047
|
+
* Lists reactions to a message. For an example, see [List reactions](https://developers.google.com/chat/api/guides/v1/reactions/list). Requires [user
|
|
2045
2048
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) and `chat.messages`, `chat.messages.readonly`, `chat.messages.reactions`, or
|
|
2046
2049
|
* `chat.messages.reactions.readonly` scope.
|
|
2047
2050
|
*/
|
|
@@ -2111,13 +2114,13 @@ declare namespace gapi.client {
|
|
|
2111
2114
|
}
|
|
2112
2115
|
interface MessagesResource {
|
|
2113
2116
|
/**
|
|
2114
|
-
* Creates a message. For example
|
|
2115
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth).
|
|
2116
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/
|
|
2117
|
-
*
|
|
2118
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/
|
|
2119
|
-
*
|
|
2120
|
-
*
|
|
2117
|
+
* Creates a message. For an example, see [Create a message](https://developers.google.com/chat/api/guides/crudl/messages#create_a_message). Requires
|
|
2118
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Creating a text message supports both [user
|
|
2119
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). [User
|
|
2120
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.create` authorization scope. Creating a card message
|
|
2121
|
+
* requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts) Because Chat provides authentication for
|
|
2122
|
+
* [webhooks](https://developers.google.com/chat/how-tos/webhooks) as part of the URL that's generated when a webhook is registered, webhooks can create messages without a service
|
|
2123
|
+
* account or user authentication.
|
|
2121
2124
|
*/
|
|
2122
2125
|
create(request: {
|
|
2123
2126
|
/** V1 error format. */
|
|
@@ -2140,7 +2143,10 @@ declare namespace gapi.client {
|
|
|
2140
2143
|
string;
|
|
2141
2144
|
/**
|
|
2142
2145
|
* Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in
|
|
2143
|
-
* length. Specify this field to get, update, or delete the message with the specified value.
|
|
2146
|
+
* length. Specify this field to get, update, or delete the message with the specified value. Assigning a custom name lets a a Chat app recall the message without saving the
|
|
2147
|
+
* message `name` from the [response body](/chat/api/reference/rest/v1/spaces.messages/get#response-body) returned when creating the message. Assigning a custom name doesn't
|
|
2148
|
+
* replace the generated `name` field, the message's resource name. Instead, it sets the custom name as the `clientAssignedMessageId` field, which you can reference while
|
|
2149
|
+
* processing later operations, like updating or deleting the message. For example usage, see [Name a created
|
|
2144
2150
|
* message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
|
|
2145
2151
|
*/
|
|
2146
2152
|
messageId?:
|
|
@@ -2200,7 +2206,10 @@ declare namespace gapi.client {
|
|
|
2200
2206
|
string;
|
|
2201
2207
|
/**
|
|
2202
2208
|
* Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in
|
|
2203
|
-
* length. Specify this field to get, update, or delete the message with the specified value.
|
|
2209
|
+
* length. Specify this field to get, update, or delete the message with the specified value. Assigning a custom name lets a a Chat app recall the message without saving the
|
|
2210
|
+
* message `name` from the [response body](/chat/api/reference/rest/v1/spaces.messages/get#response-body) returned when creating the message. Assigning a custom name doesn't
|
|
2211
|
+
* replace the generated `name` field, the message's resource name. Instead, it sets the custom name as the `clientAssignedMessageId` field, which you can reference while
|
|
2212
|
+
* processing later operations, like updating or deleting the message. For example usage, see [Name a created
|
|
2204
2213
|
* message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
|
|
2205
2214
|
*/
|
|
2206
2215
|
messageId?:
|
|
@@ -2238,10 +2247,9 @@ declare namespace gapi.client {
|
|
|
2238
2247
|
},
|
|
2239
2248
|
body: Message): Request<Message>;
|
|
2240
2249
|
/**
|
|
2241
|
-
* Deletes a message. For example
|
|
2250
|
+
* Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
|
|
2242
2251
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2243
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
2244
|
-
* part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
2252
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2245
2253
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
|
|
2246
2254
|
*/
|
|
2247
2255
|
delete(request?: {
|
|
@@ -2290,10 +2298,9 @@ declare namespace gapi.client {
|
|
|
2290
2298
|
string;
|
|
2291
2299
|
}): Request<{}>;
|
|
2292
2300
|
/**
|
|
2293
|
-
* Returns a message. For example
|
|
2294
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [
|
|
2295
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
2296
|
-
* part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
2301
|
+
* Returns details about a message. For an example, see [Read a message](https://developers.google.com/chat/api/guides/v1/messages/get). Requires
|
|
2302
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2303
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2297
2304
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.readonly` authorization scope. Note: Might return a message
|
|
2298
2305
|
* from a blocked member or space.
|
|
2299
2306
|
*/
|
|
@@ -2340,7 +2347,7 @@ declare namespace gapi.client {
|
|
|
2340
2347
|
string;
|
|
2341
2348
|
}): Request<Message>;
|
|
2342
2349
|
/**
|
|
2343
|
-
*
|
|
2350
|
+
* Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list).
|
|
2344
2351
|
* Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.readonly` authorization scope. This method is only
|
|
2345
2352
|
* supported in spaces that don't allow users from outside the Workspace organization to join.
|
|
2346
2353
|
*/
|
|
@@ -2416,11 +2423,10 @@ declare namespace gapi.client {
|
|
|
2416
2423
|
string;
|
|
2417
2424
|
}): Request<ListMessagesResponse>;
|
|
2418
2425
|
/**
|
|
2419
|
-
* Updates a message. There's a difference between `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We
|
|
2420
|
-
* using the `patch` method. For example
|
|
2421
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth
|
|
2422
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
2423
|
-
* part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
2426
|
+
* 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
|
|
2427
|
+
* recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
2428
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2429
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2424
2430
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
|
|
2425
2431
|
*/
|
|
2426
2432
|
patch(request: {
|
|
@@ -2462,7 +2468,7 @@ declare namespace gapi.client {
|
|
|
2462
2468
|
string;
|
|
2463
2469
|
/**
|
|
2464
2470
|
* Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
|
|
2465
|
-
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
|
|
2471
|
+
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).)
|
|
2466
2472
|
*/
|
|
2467
2473
|
updateMask?:
|
|
2468
2474
|
string;
|
|
@@ -2515,7 +2521,7 @@ declare namespace gapi.client {
|
|
|
2515
2521
|
string;
|
|
2516
2522
|
/**
|
|
2517
2523
|
* Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
|
|
2518
|
-
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
|
|
2524
|
+
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).)
|
|
2519
2525
|
*/
|
|
2520
2526
|
updateMask?:
|
|
2521
2527
|
string;
|
|
@@ -2528,11 +2534,10 @@ declare namespace gapi.client {
|
|
|
2528
2534
|
},
|
|
2529
2535
|
body: Message): Request<Message>;
|
|
2530
2536
|
/**
|
|
2531
|
-
* Updates a message. There's a difference between `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We
|
|
2532
|
-
* using the `patch` method. For example
|
|
2533
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth
|
|
2534
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
2535
|
-
* part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
2537
|
+
* 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
|
|
2538
|
+
* recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
2539
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2540
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2536
2541
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
|
|
2537
2542
|
*/
|
|
2538
2543
|
update(request: {
|
|
@@ -2574,7 +2579,7 @@ declare namespace gapi.client {
|
|
|
2574
2579
|
string;
|
|
2575
2580
|
/**
|
|
2576
2581
|
* Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
|
|
2577
|
-
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
|
|
2582
|
+
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).)
|
|
2578
2583
|
*/
|
|
2579
2584
|
updateMask?:
|
|
2580
2585
|
string;
|
|
@@ -2627,7 +2632,7 @@ declare namespace gapi.client {
|
|
|
2627
2632
|
string;
|
|
2628
2633
|
/**
|
|
2629
2634
|
* Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - `text` - `cards` (Requires [service account
|
|
2630
|
-
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
|
|
2635
|
+
* authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [service account authentication](/chat/api/guides/auth/service-accounts).)
|
|
2631
2636
|
*/
|
|
2632
2637
|
updateMask?:
|
|
2633
2638
|
string;
|
|
@@ -2646,8 +2651,9 @@ declare namespace gapi.client {
|
|
|
2646
2651
|
}
|
|
2647
2652
|
interface SpacesResource {
|
|
2648
2653
|
/**
|
|
2649
|
-
*
|
|
2650
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the
|
|
2654
|
+
* Creates a named space. Spaces grouped by topics or that have guest access aren't supported. For an example, see [Create a
|
|
2655
|
+
* space](https://developers.google.com/chat/api/guides/v1/spaces/create). Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the
|
|
2656
|
+
* `chat.spaces.create` or `chat.spaces` scope.
|
|
2651
2657
|
*/
|
|
2652
2658
|
create(request: {
|
|
2653
2659
|
/** V1 error format. */
|
|
@@ -2736,9 +2742,9 @@ declare namespace gapi.client {
|
|
|
2736
2742
|
},
|
|
2737
2743
|
body: Space): Request<Space>;
|
|
2738
2744
|
/**
|
|
2739
|
-
*
|
|
2740
|
-
*
|
|
2741
|
-
* has permission to delete the space, and the `chat.delete` scope.
|
|
2745
|
+
* 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
|
|
2746
|
+
* deleted. For an example, see [Delete a space](https://developers.google.com/chat/api/guides/v1/spaces/delete). Requires [user
|
|
2747
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.
|
|
2742
2748
|
*/
|
|
2743
2749
|
delete(request?: {
|
|
2744
2750
|
/** V1 error format. */
|
|
@@ -2779,10 +2785,10 @@ declare namespace gapi.client {
|
|
|
2779
2785
|
string;
|
|
2780
2786
|
}): Request<{}>;
|
|
2781
2787
|
/**
|
|
2782
|
-
*
|
|
2783
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users), returns the direct message space
|
|
2784
|
-
* account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), returns the direct
|
|
2785
|
-
*
|
|
2788
|
+
* 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
|
|
2789
|
+
* message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/chat/api/guides/auth/users), returns the direct message space
|
|
2790
|
+
* between the specified user and the authenticated user. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), returns the direct
|
|
2791
|
+
* message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) or [service account
|
|
2786
2792
|
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
|
|
2787
2793
|
*/
|
|
2788
2794
|
findDirectMessage(request?: {
|
|
@@ -2829,9 +2835,9 @@ declare namespace gapi.client {
|
|
|
2829
2835
|
string;
|
|
2830
2836
|
}): Request<Space>;
|
|
2831
2837
|
/**
|
|
2832
|
-
* Returns a space.
|
|
2833
|
-
* authentication](https://developers.google.com/chat/api/guides/auth
|
|
2834
|
-
*
|
|
2838
|
+
* Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires
|
|
2839
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2840
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2835
2841
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.spaces` or `chat.spaces.readonly` authorization scope.
|
|
2836
2842
|
*/
|
|
2837
2843
|
get(request?: {
|
|
@@ -2873,11 +2879,11 @@ declare namespace gapi.client {
|
|
|
2873
2879
|
string;
|
|
2874
2880
|
}): Request<Space>;
|
|
2875
2881
|
/**
|
|
2876
|
-
* Lists spaces the caller is a member of.
|
|
2877
|
-
*
|
|
2878
|
-
*
|
|
2879
|
-
*
|
|
2880
|
-
*
|
|
2882
|
+
* 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
|
|
2883
|
+
* spaces](https://developers.google.com/chat/api/guides/v1/spaces/list). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2884
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users) requires the
|
|
2885
|
+
* `chat.spaces` or `chat.spaces.readonly` authorization scope. Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is
|
|
2886
|
+
* sent.
|
|
2881
2887
|
*/
|
|
2882
2888
|
list(request?: {
|
|
2883
2889
|
/** V1 error format. */
|
|
@@ -2901,7 +2907,7 @@ declare namespace gapi.client {
|
|
|
2901
2907
|
* `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ```
|
|
2902
2908
|
* space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. With [service
|
|
2903
2909
|
* account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), this field is ignored and the query always returns all spaces. But the Chat API
|
|
2904
|
-
* still validates the query syntax with service accounts, so invalid queries are still rejected.
|
|
2910
|
+
* still validates the query syntax with service accounts, so invalid queries are still rejected.
|
|
2905
2911
|
*/
|
|
2906
2912
|
filter?:
|
|
2907
2913
|
string;
|
|
@@ -2937,8 +2943,8 @@ declare namespace gapi.client {
|
|
|
2937
2943
|
string;
|
|
2938
2944
|
}): Request<ListSpacesResponse>;
|
|
2939
2945
|
/**
|
|
2940
|
-
*
|
|
2941
|
-
* the `chat.spaces` scope.
|
|
2946
|
+
* Updates a space. For an example, see [Update a space](https://developers.google.com/chat/api/guides/v1/spaces/update). Requires [user
|
|
2947
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces` scope.
|
|
2942
2948
|
*/
|
|
2943
2949
|
patch(request: {
|
|
2944
2950
|
/** V1 error format. */
|
|
@@ -3043,17 +3049,17 @@ declare namespace gapi.client {
|
|
|
3043
3049
|
},
|
|
3044
3050
|
body: Space): Request<Space>;
|
|
3045
3051
|
/**
|
|
3046
|
-
*
|
|
3047
|
-
*
|
|
3048
|
-
* human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people)
|
|
3049
|
-
* for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People
|
|
3050
|
-
* `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group
|
|
3051
|
-
* blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another
|
|
3052
|
-
* 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
|
|
3053
|
-
* `Space.singleUserBotDm` to true and don't specify any memberships. You can only use this method to
|
|
3054
|
-
*
|
|
3055
|
-
* the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access
|
|
3056
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
3052
|
+
* 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
|
|
3053
|
+
* [Set up a space](https://developers.google.com/chat/api/guides/v1/spaces/set-up). To specify the human members to add, add memberships with the appropriate `member.name` in the
|
|
3054
|
+
* `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people)
|
|
3055
|
+
* from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People
|
|
3056
|
+
* API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group
|
|
3057
|
+
* chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another
|
|
3058
|
+
* 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
|
|
3059
|
+
* 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
|
|
3060
|
+
* calling app as a member of a space or an existing DM between two human users, see [create a membership](https://developers.google.com/chat/api/guides/v1/members/create). If a DM
|
|
3061
|
+
* 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 or guest access
|
|
3062
|
+
* aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
3057
3063
|
*/
|
|
3058
3064
|
setup(request: {
|
|
3059
3065
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -111,42 +111,42 @@ Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.
|
|
|
111
111
|
await gapi.client.chat.media.download({ resourceName: "resourceName", });
|
|
112
112
|
|
|
113
113
|
/*
|
|
114
|
-
[
|
|
114
|
+
Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/chat/api/guides/v1/media-and-attachments/upload). Requires user [authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.create` authorization scope. 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).
|
|
115
115
|
*/
|
|
116
116
|
await gapi.client.chat.media.upload({ parent: "parent", });
|
|
117
117
|
|
|
118
118
|
/*
|
|
119
|
-
|
|
119
|
+
Creates a named space. Spaces grouped by topics or that have guest access aren't supported. For an example, see [Create a space](https://developers.google.com/chat/api/guides/v1/spaces/create). Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
120
120
|
*/
|
|
121
121
|
await gapi.client.chat.spaces.create({ });
|
|
122
122
|
|
|
123
123
|
/*
|
|
124
|
-
|
|
124
|
+
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/chat/api/guides/v1/spaces/delete). Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.
|
|
125
125
|
*/
|
|
126
126
|
await gapi.client.chat.spaces.delete({ name: "name", });
|
|
127
127
|
|
|
128
128
|
/*
|
|
129
|
-
|
|
129
|
+
Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/chat/api/guides/auth/users), returns the direct message space between the specified user and the authenticated user. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), returns the direct message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) or [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
|
|
130
130
|
*/
|
|
131
131
|
await gapi.client.chat.spaces.findDirectMessage({ });
|
|
132
132
|
|
|
133
133
|
/*
|
|
134
|
-
Returns a space.
|
|
134
|
+
Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.spaces` or `chat.spaces.readonly` authorization scope.
|
|
135
135
|
*/
|
|
136
136
|
await gapi.client.chat.spaces.get({ name: "name", });
|
|
137
137
|
|
|
138
138
|
/*
|
|
139
|
-
Lists spaces the caller is a member of.
|
|
139
|
+
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/chat/api/guides/v1/spaces/list). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.spaces` or `chat.spaces.readonly` authorization scope. Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent.
|
|
140
140
|
*/
|
|
141
141
|
await gapi.client.chat.spaces.list({ });
|
|
142
142
|
|
|
143
143
|
/*
|
|
144
|
-
[
|
|
144
|
+
Updates a space. For an example, see [Update a space](https://developers.google.com/chat/api/guides/v1/spaces/update). Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces` scope.
|
|
145
145
|
*/
|
|
146
146
|
await gapi.client.chat.spaces.patch({ name: "name", });
|
|
147
147
|
|
|
148
148
|
/*
|
|
149
|
-
|
|
149
|
+
Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space](https://developers.google.com/chat/api/guides/v1/spaces/set-up). To specify the human members to add, add memberships with the appropriate `member.name` in the `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_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 Admin SDK Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [create a membership](https://developers.google.com/chat/api/guides/v1/members/create). 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 or guest access aren't supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
150
150
|
*/
|
|
151
151
|
await gapi.client.chat.spaces.setup({ });
|
|
152
152
|
```
|
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20230530
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -60,8 +60,9 @@ gapi.load('client', async () => {
|
|
|
60
60
|
resourceName: "Test string",
|
|
61
61
|
});
|
|
62
62
|
/**
|
|
63
|
-
*
|
|
64
|
-
*
|
|
63
|
+
* Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/chat/api/guides/v1/media-and-attachments/upload). Requires user
|
|
64
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.create` authorization scope. You can upload attachments up to 200
|
|
65
|
+
* MB. Certain file types aren't supported. For details, see [File types blocked by Google
|
|
65
66
|
* Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).
|
|
66
67
|
*/
|
|
67
68
|
await gapi.client.chat.media.upload({
|
|
@@ -70,8 +71,9 @@ gapi.load('client', async () => {
|
|
|
70
71
|
filename: "Test string",
|
|
71
72
|
});
|
|
72
73
|
/**
|
|
73
|
-
*
|
|
74
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the
|
|
74
|
+
* Creates a named space. Spaces grouped by topics or that have guest access aren't supported. For an example, see [Create a
|
|
75
|
+
* space](https://developers.google.com/chat/api/guides/v1/spaces/create). Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the
|
|
76
|
+
* `chat.spaces.create` or `chat.spaces` scope.
|
|
75
77
|
*/
|
|
76
78
|
await gapi.client.chat.spaces.create({
|
|
77
79
|
requestId: "Test string",
|
|
@@ -91,38 +93,37 @@ gapi.load('client', async () => {
|
|
|
91
93
|
type: "Test string",
|
|
92
94
|
});
|
|
93
95
|
/**
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
* permission to delete the space, and the `chat.delete` scope.
|
|
96
|
+
* 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.
|
|
97
|
+
* For an example, see [Delete a space](https://developers.google.com/chat/api/guides/v1/spaces/delete). Requires [user
|
|
98
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) from a user who has permission to delete the space, and the `chat.delete` scope.
|
|
97
99
|
*/
|
|
98
100
|
await gapi.client.chat.spaces.delete({
|
|
99
101
|
name: "Test string",
|
|
100
102
|
});
|
|
101
103
|
/**
|
|
102
|
-
*
|
|
103
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users), returns the direct message space between
|
|
104
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), returns the direct message
|
|
105
|
-
*
|
|
104
|
+
* 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
|
|
105
|
+
* message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/chat/api/guides/auth/users), returns the direct message space between
|
|
106
|
+
* the specified user and the authenticated user. With [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts), returns the direct message
|
|
107
|
+
* space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) or [service account
|
|
106
108
|
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
|
|
107
109
|
*/
|
|
108
110
|
await gapi.client.chat.spaces.findDirectMessage({
|
|
109
111
|
name: "Test string",
|
|
110
112
|
});
|
|
111
113
|
/**
|
|
112
|
-
* Returns a space.
|
|
113
|
-
* authentication](https://developers.google.com/chat/api/guides/auth
|
|
114
|
-
*
|
|
114
|
+
* Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires
|
|
115
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
116
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
115
117
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.spaces` or `chat.spaces.readonly` authorization scope.
|
|
116
118
|
*/
|
|
117
119
|
await gapi.client.chat.spaces.get({
|
|
118
120
|
name: "Test string",
|
|
119
121
|
});
|
|
120
122
|
/**
|
|
121
|
-
* Lists spaces the caller is a member of.
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* authenticated user. Group chats and DMs aren't listed until the first message is sent.
|
|
123
|
+
* 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
|
|
124
|
+
* spaces](https://developers.google.com/chat/api/guides/v1/spaces/list). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
125
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users) requires the
|
|
126
|
+
* `chat.spaces` or `chat.spaces.readonly` authorization scope. Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent.
|
|
126
127
|
*/
|
|
127
128
|
await gapi.client.chat.spaces.list({
|
|
128
129
|
filter: "Test string",
|
|
@@ -130,8 +131,8 @@ gapi.load('client', async () => {
|
|
|
130
131
|
pageToken: "Test string",
|
|
131
132
|
});
|
|
132
133
|
/**
|
|
133
|
-
*
|
|
134
|
-
* `chat.spaces` scope.
|
|
134
|
+
* Updates a space. For an example, see [Update a space](https://developers.google.com/chat/api/guides/v1/spaces/update). Requires [user
|
|
135
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces` scope.
|
|
135
136
|
*/
|
|
136
137
|
await gapi.client.chat.spaces.patch({
|
|
137
138
|
name: "Test string",
|
|
@@ -152,17 +153,17 @@ gapi.load('client', async () => {
|
|
|
152
153
|
type: "Test string",
|
|
153
154
|
});
|
|
154
155
|
/**
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
* `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from
|
|
158
|
-
* [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API
|
|
159
|
-
* `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the
|
|
160
|
-
* blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user,
|
|
161
|
-
* 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
|
|
162
|
-
* `Space.singleUserBotDm` to true and don't specify any memberships. You can only use this method to
|
|
163
|
-
*
|
|
164
|
-
* the time a request is made, then the existing DM is returned. Spaces with threaded replies or guest access aren't supported. Requires
|
|
165
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
156
|
+
* 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
|
|
157
|
+
* up a space](https://developers.google.com/chat/api/guides/v1/spaces/set-up). To specify the human members to add, add memberships with the appropriate `member.name` in the
|
|
158
|
+
* `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the [person](https://developers.google.com/people/api/rest/v1/people) from
|
|
159
|
+
* the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. For example, if the People API
|
|
160
|
+
* `Person` `resourceName` is `people/123456789`, you can add the user to the space by including a membership with `users/123456789` as the `member.name`. For a space or group chat, if the
|
|
161
|
+
* caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user,
|
|
162
|
+
* 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
|
|
163
|
+
* 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
|
|
164
|
+
* member of a space or an existing DM between two human users, see [create a membership](https://developers.google.com/chat/api/guides/v1/members/create). If a DM already exists between
|
|
165
|
+
* 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 or guest access aren't supported. Requires
|
|
166
|
+
* [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
166
167
|
*/
|
|
167
168
|
await gapi.client.chat.spaces.setup({
|
|
168
169
|
}, {
|
|
@@ -199,12 +200,15 @@ gapi.load('client', async () => {
|
|
|
199
200
|
},
|
|
200
201
|
});
|
|
201
202
|
/**
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
* the
|
|
207
|
-
*
|
|
203
|
+
* Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [ Create a
|
|
204
|
+
* membership](https://developers.google.com/chat/api/guides/v1/members/create). When creating a membership, if the specified member has their auto-accept policy turned off, then they're
|
|
205
|
+
* invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user
|
|
206
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` (for human membership) or `chat.memberships.app` (for app membership) scope. To
|
|
207
|
+
* specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to a space or a direct message between two human users, use
|
|
208
|
+
* `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` is either the `{person_id}` for the
|
|
209
|
+
* [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the
|
|
210
|
+
* [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `Person` `resourceName` is `people/123456789`, you
|
|
211
|
+
* can add the user to the space by setting the `membership.member.name` to `users/123456789`.
|
|
208
212
|
*/
|
|
209
213
|
await gapi.client.chat.spaces.members.create({
|
|
210
214
|
parent: "Test string",
|
|
@@ -222,25 +226,27 @@ gapi.load('client', async () => {
|
|
|
222
226
|
state: "Test string",
|
|
223
227
|
});
|
|
224
228
|
/**
|
|
225
|
-
*
|
|
226
|
-
* the `chat.memberships` or `chat.memberships.app` authorization scope.
|
|
229
|
+
* Deletes a membership. For an example, see [Delete a membership](https://developers.google.com/chat/api/guides/v1/members/delete). Requires [user
|
|
230
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.memberships` or `chat.memberships.app` authorization scope.
|
|
227
231
|
*/
|
|
228
232
|
await gapi.client.chat.spaces.members.delete({
|
|
229
233
|
name: "Test string",
|
|
230
234
|
});
|
|
231
235
|
/**
|
|
232
|
-
* Returns a membership.
|
|
233
|
-
* authentication](https://developers.google.com/chat/api/guides/auth
|
|
234
|
-
*
|
|
236
|
+
* Returns details about a membership. For an example, see [Get a membership](https://developers.google.com/chat/api/guides/v1/members/get). Requires
|
|
237
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
238
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
235
239
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.memberships` or `chat.memberships.readonly` authorization scope.
|
|
236
240
|
*/
|
|
237
241
|
await gapi.client.chat.spaces.members.get({
|
|
238
242
|
name: "Test string",
|
|
239
243
|
});
|
|
240
244
|
/**
|
|
241
|
-
* Lists memberships in a space.
|
|
242
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
243
|
-
*
|
|
245
|
+
* Lists memberships in a space. For an example, see [List memberships](https://developers.google.com/chat/api/guides/v1/members/list). Listing memberships with [app
|
|
246
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships,
|
|
247
|
+
* including its own. Listing memberships with [User authentication](https://developers.google.com/chat/api/guides/auth/users) lists memberships in spaces that the authenticated user has
|
|
248
|
+
* access to. Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
249
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
244
250
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.memberships` or `chat.memberships.readonly` authorization scope.
|
|
245
251
|
*/
|
|
246
252
|
await gapi.client.chat.spaces.members.list({
|
|
@@ -251,13 +257,13 @@ gapi.load('client', async () => {
|
|
|
251
257
|
showInvited: true,
|
|
252
258
|
});
|
|
253
259
|
/**
|
|
254
|
-
* Creates a message. For example
|
|
255
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth).
|
|
256
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/
|
|
257
|
-
*
|
|
258
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/
|
|
259
|
-
*
|
|
260
|
-
*
|
|
260
|
+
* Creates a message. For an example, see [Create a message](https://developers.google.com/chat/api/guides/crudl/messages#create_a_message). Requires
|
|
261
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Creating a text message supports both [user
|
|
262
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). [User
|
|
263
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.create` authorization scope. Creating a card message requires
|
|
264
|
+
* [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts) Because Chat provides authentication for
|
|
265
|
+
* [webhooks](https://developers.google.com/chat/how-tos/webhooks) as part of the URL that's generated when a webhook is registered, webhooks can create messages without a service account
|
|
266
|
+
* or user authentication.
|
|
261
267
|
*/
|
|
262
268
|
await gapi.client.chat.spaces.messages.create({
|
|
263
269
|
messageId: "Test string",
|
|
@@ -2719,10 +2725,9 @@ gapi.load('client', async () => {
|
|
|
2719
2725
|
threadReply: true,
|
|
2720
2726
|
});
|
|
2721
2727
|
/**
|
|
2722
|
-
* Deletes a message. For example
|
|
2728
|
+
* Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
|
|
2723
2729
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2724
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
2725
|
-
* the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
2730
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2726
2731
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
|
|
2727
2732
|
*/
|
|
2728
2733
|
await gapi.client.chat.spaces.messages.delete({
|
|
@@ -2730,10 +2735,9 @@ gapi.load('client', async () => {
|
|
|
2730
2735
|
name: "Test string",
|
|
2731
2736
|
});
|
|
2732
2737
|
/**
|
|
2733
|
-
* Returns a message. For example
|
|
2734
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [
|
|
2735
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
2736
|
-
* the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
2738
|
+
* Returns details about a message. For an example, see [Read a message](https://developers.google.com/chat/api/guides/v1/messages/get). Requires
|
|
2739
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2740
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2737
2741
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.readonly` authorization scope. Note: Might return a message from
|
|
2738
2742
|
* a blocked member or space.
|
|
2739
2743
|
*/
|
|
@@ -2741,7 +2745,7 @@ gapi.load('client', async () => {
|
|
|
2741
2745
|
name: "Test string",
|
|
2742
2746
|
});
|
|
2743
2747
|
/**
|
|
2744
|
-
*
|
|
2748
|
+
* Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list).
|
|
2745
2749
|
* Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.readonly` authorization scope. This method is only
|
|
2746
2750
|
* supported in spaces that don't allow users from outside the Workspace organization to join.
|
|
2747
2751
|
*/
|
|
@@ -2754,11 +2758,10 @@ gapi.load('client', async () => {
|
|
|
2754
2758
|
showDeleted: true,
|
|
2755
2759
|
});
|
|
2756
2760
|
/**
|
|
2757
|
-
* Updates a message. There's a difference between `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend
|
|
2758
|
-
* using the `patch` method. For example
|
|
2759
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth
|
|
2760
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
2761
|
-
* the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
2761
|
+
* 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
|
|
2762
|
+
* using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
2763
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2764
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
2762
2765
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
|
|
2763
2766
|
*/
|
|
2764
2767
|
await gapi.client.chat.spaces.messages.patch({
|
|
@@ -5219,11 +5222,10 @@ gapi.load('client', async () => {
|
|
|
5219
5222
|
threadReply: true,
|
|
5220
5223
|
});
|
|
5221
5224
|
/**
|
|
5222
|
-
* Updates a message. There's a difference between `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend
|
|
5223
|
-
* using the `patch` method. For example
|
|
5224
|
-
* [authentication](https://developers.google.com/chat/api/guides/auth
|
|
5225
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts)
|
|
5226
|
-
* the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User
|
|
5225
|
+
* 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
|
|
5226
|
+
* using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
5227
|
+
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
5228
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User
|
|
5227
5229
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
|
|
5228
5230
|
*/
|
|
5229
5231
|
await gapi.client.chat.spaces.messages.update({
|
|
@@ -7684,14 +7686,15 @@ gapi.load('client', async () => {
|
|
|
7684
7686
|
threadReply: true,
|
|
7685
7687
|
});
|
|
7686
7688
|
/**
|
|
7687
|
-
* Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/chat/api/reference/rest/v1/media/download).
|
|
7688
|
-
* [
|
|
7689
|
+
* Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/chat/api/reference/rest/v1/media/download). For an example,
|
|
7690
|
+
* see [Get a message attachment](https://developers.google.com/chat/api/guides/v1/media-and-attachments/get). Requires [service account
|
|
7691
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
|
|
7689
7692
|
*/
|
|
7690
7693
|
await gapi.client.chat.spaces.messages.attachments.get({
|
|
7691
7694
|
name: "Test string",
|
|
7692
7695
|
});
|
|
7693
7696
|
/**
|
|
7694
|
-
*
|
|
7697
|
+
* Creates a reaction and adds it to a message. For an example, see [Create a reaction](https://developers.google.com/chat/api/guides/v1/reactions/create). Requires [user
|
|
7695
7698
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages`, `chat.messages.reactions`, or `chat.messages.reactions.create` scope. Only unicode
|
|
7696
7699
|
* emoji are supported.
|
|
7697
7700
|
*/
|
|
@@ -7714,14 +7717,14 @@ gapi.load('client', async () => {
|
|
|
7714
7717
|
},
|
|
7715
7718
|
});
|
|
7716
7719
|
/**
|
|
7717
|
-
* [
|
|
7720
|
+
* Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/chat/api/guides/v1/reactions/delete). Requires [user
|
|
7718
7721
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.messages` or `chat.messages.reactions` scope.
|
|
7719
7722
|
*/
|
|
7720
7723
|
await gapi.client.chat.spaces.messages.reactions.delete({
|
|
7721
7724
|
name: "Test string",
|
|
7722
7725
|
});
|
|
7723
7726
|
/**
|
|
7724
|
-
* [
|
|
7727
|
+
* Lists reactions to a message. For an example, see [List reactions](https://developers.google.com/chat/api/guides/v1/reactions/list). Requires [user
|
|
7725
7728
|
* authentication](https://developers.google.com/chat/api/guides/auth/users) and `chat.messages`, `chat.messages.readonly`, `chat.messages.reactions`, or `chat.messages.reactions.readonly`
|
|
7726
7729
|
* scope.
|
|
7727
7730
|
*/
|