@maxim_mazurok/gapi.client.chat-v1 0.0.20231102 → 0.0.20231114
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 +22 -24
- package/package.json +1 -1
- package/readme.md +1 -1
- package/tests.ts +11 -11
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: 20231114
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1123,7 +1123,7 @@ declare namespace gapi.client {
|
|
|
1123
1123
|
string;
|
|
1124
1124
|
}
|
|
1125
1125
|
interface ListMembershipsResponse {
|
|
1126
|
-
/** List of memberships in the requested (or first) page. */
|
|
1126
|
+
/** Unordered list. List of memberships in the requested (or first) page. */
|
|
1127
1127
|
memberships?:
|
|
1128
1128
|
Membership[];
|
|
1129
1129
|
/** A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. */
|
|
@@ -1540,11 +1540,10 @@ declare namespace gapi.client {
|
|
|
1540
1540
|
boolean;
|
|
1541
1541
|
/**
|
|
1542
1542
|
* 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
|
|
1543
|
-
* as: - the `
|
|
1544
|
-
*
|
|
1545
|
-
*
|
|
1546
|
-
*
|
|
1547
|
-
* `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.
|
|
1543
|
+
* 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
|
|
1544
|
+
* 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. -
|
|
1545
|
+
* 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
|
|
1546
|
+
* `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.
|
|
1548
1547
|
*/
|
|
1549
1548
|
name?:
|
|
1550
1549
|
string;
|
|
@@ -1707,9 +1706,9 @@ declare namespace gapi.client {
|
|
|
1707
1706
|
* 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
|
|
1708
1707
|
* authentication](https://developers.google.com/chat/api/guides/auth/users). To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add
|
|
1709
1708
|
* the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where
|
|
1710
|
-
* `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `
|
|
1711
|
-
*
|
|
1712
|
-
*
|
|
1709
|
+
* `{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
|
|
1710
|
+
* 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
|
|
1711
|
+
* `membership.member.name` to `users/user@example.com` or `users/123456789`.
|
|
1713
1712
|
*/
|
|
1714
1713
|
create(request: {
|
|
1715
1714
|
/** V1 error format. */
|
|
@@ -2891,12 +2890,11 @@ declare namespace gapi.client {
|
|
|
2891
2890
|
key?:
|
|
2892
2891
|
string;
|
|
2893
2892
|
/**
|
|
2894
|
-
* Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `
|
|
2893
|
+
* Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the
|
|
2895
2894
|
* [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the
|
|
2896
|
-
* [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API `
|
|
2897
|
-
*
|
|
2898
|
-
*
|
|
2899
|
-
* is the email of the Google Chat user.
|
|
2895
|
+
* [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a
|
|
2896
|
+
* direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/chat/api/guides/auth/users), you can use
|
|
2897
|
+
* 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.
|
|
2900
2898
|
*/
|
|
2901
2899
|
name?:
|
|
2902
2900
|
string;
|
|
@@ -3137,15 +3135,15 @@ declare namespace gapi.client {
|
|
|
3137
3135
|
* 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
|
|
3138
3136
|
* [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
|
|
3139
3137
|
* `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
|
|
3140
|
-
* the `
|
|
3141
|
-
*
|
|
3142
|
-
*
|
|
3143
|
-
*
|
|
3144
|
-
*
|
|
3145
|
-
*
|
|
3146
|
-
*
|
|
3147
|
-
*
|
|
3148
|
-
*
|
|
3138
|
+
* 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`,
|
|
3139
|
+
* 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
|
|
3140
|
+
* 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
|
|
3141
|
+
* 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
|
|
3142
|
+
* `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
|
|
3143
|
+
* 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
|
|
3144
|
+
* 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
|
|
3145
|
+
* `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
|
|
3146
|
+
* [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
3149
3147
|
*/
|
|
3150
3148
|
setup(request: {
|
|
3151
3149
|
/** 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}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `
|
|
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 `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. For a space or group chat, if the caller blocks or is blocked by some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [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 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/chat/api/guides/auth/users).
|
|
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: 20231114
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -159,13 +159,13 @@ gapi.load('client', async () => {
|
|
|
159
159
|
* 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
|
|
160
160
|
* 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
|
|
161
161
|
* `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
|
|
162
|
-
* `
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
162
|
+
* `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
|
|
163
|
+
* 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
|
|
164
|
+
* 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
|
|
165
|
+
* 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
|
|
166
|
+
* `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
|
|
167
|
+
* 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
|
|
168
|
+
* 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
|
|
169
169
|
* `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
|
|
170
170
|
* authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
171
171
|
*/
|
|
@@ -210,9 +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). To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the
|
|
212
212
|
* calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can
|
|
213
|
-
* be the email address for the user. For users in the same Workspace organization `{user}` can also be the `
|
|
214
|
-
*
|
|
215
|
-
* `
|
|
213
|
+
* 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
|
|
214
|
+
* 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
|
|
215
|
+
* `users/user@example.com` or `users/123456789`.
|
|
216
216
|
*/
|
|
217
217
|
await gapi.client.chat.spaces.members.create({
|
|
218
218
|
parent: "Test string",
|