@maxim_mazurok/gapi.client.chat-v1 0.0.20230727 → 0.0.20230729
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 +28 -22
- package/package.json +1 -1
- package/readme.md +1 -1
- package/tests.ts +13 -14
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: 20230729
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1343,11 +1343,13 @@ declare namespace gapi.client {
|
|
|
1343
1343
|
}
|
|
1344
1344
|
interface SetUpSpaceRequest {
|
|
1345
1345
|
/**
|
|
1346
|
-
* Optional. The
|
|
1347
|
-
*
|
|
1348
|
-
*
|
|
1346
|
+
* Optional. The Google Chat users to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 20 memberships (in addition to
|
|
1347
|
+
* the caller). The `Membership.member` field must contain a `user` with `name` populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You can only add human users
|
|
1348
|
+
* when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}.
|
|
1349
|
+
* For example, the `user.name` can be `users/example@gmail.com`." To invite Gmail users or users from external Google Workspace domains, user's email must be used for `{user}`.
|
|
1350
|
+
* Optional when setting `Space.spaceType` to `SPACE`. Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships. Required when setting
|
|
1349
1351
|
* `Space.spaceType` to `DIRECT_MESSAGE` with a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app
|
|
1350
|
-
* (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).
|
|
1352
|
+
* (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).
|
|
1351
1353
|
*/
|
|
1352
1354
|
memberships?:
|
|
1353
1355
|
Membership[];
|
|
@@ -1689,10 +1691,10 @@ declare namespace gapi.client {
|
|
|
1689
1691
|
* 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
|
|
1690
1692
|
* 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
|
|
1691
1693
|
* 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
|
|
1692
|
-
* `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}`
|
|
1693
|
-
*
|
|
1694
|
-
*
|
|
1695
|
-
*
|
|
1694
|
+
* `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace
|
|
1695
|
+
* organization `{user}` can also be the `{person_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
|
|
1696
|
+
* `resourceName` for `user@example.com` is `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or
|
|
1697
|
+
* `users/123456789`.
|
|
1696
1698
|
*/
|
|
1697
1699
|
create(request: {
|
|
1698
1700
|
/** V1 error format. */
|
|
@@ -1799,8 +1801,9 @@ declare namespace gapi.client {
|
|
|
1799
1801
|
string;
|
|
1800
1802
|
/**
|
|
1801
1803
|
* Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a
|
|
1802
|
-
* human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format.
|
|
1803
|
-
*
|
|
1804
|
+
* human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example,
|
|
1805
|
+
* `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app`
|
|
1806
|
+
* scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
|
|
1804
1807
|
*/
|
|
1805
1808
|
name:
|
|
1806
1809
|
string;
|
|
@@ -1847,7 +1850,8 @@ declare namespace gapi.client {
|
|
|
1847
1850
|
string;
|
|
1848
1851
|
/**
|
|
1849
1852
|
* Required. Resource name of the membership to retrieve. To get the app's own membership, you can optionally use `spaces/{space}/members/app`. Format:
|
|
1850
|
-
* `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
|
|
1853
|
+
* `spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a user](https://developers.google.com/chat/api/guides/auth/users), you can use the
|
|
1854
|
+
* user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.
|
|
1851
1855
|
*/
|
|
1852
1856
|
name:
|
|
1853
1857
|
string;
|
|
@@ -2887,7 +2891,9 @@ declare namespace gapi.client {
|
|
|
2887
2891
|
* Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `{person_id}` for the
|
|
2888
2892
|
* [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the
|
|
2889
2893
|
* [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
|
|
2890
|
-
* `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`.
|
|
2894
|
+
* `people/123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a
|
|
2895
|
+
* user](https://developers.google.com/chat/api/guides/auth/users), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com`
|
|
2896
|
+
* is the email of the Google Chat user.
|
|
2891
2897
|
*/
|
|
2892
2898
|
name?:
|
|
2893
2899
|
string;
|
|
@@ -3124,15 +3130,15 @@ declare namespace gapi.client {
|
|
|
3124
3130
|
/**
|
|
3125
3131
|
* 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
|
|
3126
3132
|
* [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
|
|
3127
|
-
* `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}`
|
|
3128
|
-
* from the People API, or the `id` for the
|
|
3129
|
-
*
|
|
3130
|
-
*
|
|
3131
|
-
*
|
|
3132
|
-
*
|
|
3133
|
-
*
|
|
3134
|
-
*
|
|
3135
|
-
*
|
|
3133
|
+
* `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be
|
|
3134
|
+
* the `{person_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 `resourceName` for `user@example.com` is
|
|
3135
|
+
* `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the
|
|
3136
|
+
* 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,
|
|
3137
|
+
* 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
|
|
3138
|
+
* 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
|
|
3139
|
+
* 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
|
|
3140
|
+
* 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
|
|
3141
|
+
* supported. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
3136
3142
|
*/
|
|
3137
3143
|
setup(request: {
|
|
3138
3144
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -149,7 +149,7 @@ Updates a space. For an example, see [Update a space](https://developers.google.
|
|
|
149
149
|
await gapi.client.chat.spaces.patch({ name: "name", });
|
|
150
150
|
|
|
151
151
|
/*
|
|
152
|
-
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}`
|
|
152
|
+
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}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `{person_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 `resourceName` for `user@example.com` is `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [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.
|
|
153
153
|
*/
|
|
154
154
|
await gapi.client.chat.spaces.setup({ });
|
|
155
155
|
```
|
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: 20230729
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -159,15 +159,15 @@ gapi.load('client', async () => {
|
|
|
159
159
|
/**
|
|
160
160
|
* Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set
|
|
161
161
|
* 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
|
|
162
|
-
* `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}`
|
|
163
|
-
* the People API, or the `id` for the
|
|
164
|
-
* `
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
162
|
+
* `SetUpSpaceRequest`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the
|
|
163
|
+
* `{person_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 `resourceName` for `user@example.com` is
|
|
164
|
+
* `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the caller
|
|
165
|
+
* 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
|
|
166
|
+
* 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
|
|
167
|
+
* 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
|
|
168
|
+
* 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,
|
|
169
|
+
* 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
|
|
170
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
|
|
171
171
|
*/
|
|
172
172
|
await gapi.client.chat.spaces.setup({
|
|
173
173
|
}, {
|
|
@@ -210,10 +210,9 @@ gapi.load('client', async () => {
|
|
|
210
210
|
* invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user
|
|
211
211
|
* 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
|
|
212
212
|
* 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
|
|
213
|
-
* `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}`
|
|
214
|
-
*
|
|
215
|
-
*
|
|
216
|
-
* can add the user to the space by setting the `membership.member.name` to `users/123456789`.
|
|
213
|
+
* `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace
|
|
214
|
+
* organization `{user}` can also be the `{person_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
|
|
215
|
+
* `resourceName` for `user@example.com` is `people/123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`.
|
|
217
216
|
*/
|
|
218
217
|
await gapi.client.chat.spaces.members.create({
|
|
219
218
|
parent: "Test string",
|