@maxim_mazurok/gapi.client.chat-v1 0.0.20231017 → 0.0.20231024
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 +24 -38
- package/package.json +1 -1
- package/tests.ts +11 -13
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: 20231024
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -172,7 +172,7 @@ declare namespace gapi.client {
|
|
|
172
172
|
Status;
|
|
173
173
|
}
|
|
174
174
|
interface ChatClientDataSourceMarkup {
|
|
175
|
-
/**
|
|
175
|
+
/** Google Chat spaces that the user is a member of. */
|
|
176
176
|
spaceDataSource?:
|
|
177
177
|
SpaceDataSource;
|
|
178
178
|
}
|
|
@@ -745,16 +745,10 @@ declare namespace gapi.client {
|
|
|
745
745
|
string;
|
|
746
746
|
}
|
|
747
747
|
interface GoogleAppsCardV1PlatformDataSource {
|
|
748
|
-
/**
|
|
749
|
-
* For a `SelectionInput` widget that uses a multi-select menu, a data source shared by all Google Workspace host applications, such as users in a Google Workspace organization.
|
|
750
|
-
* [Developer Preview](https://developers.google.com/workspace/preview).
|
|
751
|
-
*/
|
|
748
|
+
/** A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. */
|
|
752
749
|
commonDataSource?:
|
|
753
750
|
string;
|
|
754
|
-
/**
|
|
755
|
-
* A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. [Developer
|
|
756
|
-
* Preview](https://developers.google.com/workspace/preview).
|
|
757
|
-
*/
|
|
751
|
+
/** A data source that's unique to a Google Workspace host application, such spaces in Google Chat. */
|
|
758
752
|
hostAppDataSource?:
|
|
759
753
|
HostAppDataSourceMarkup;
|
|
760
754
|
}
|
|
@@ -784,7 +778,7 @@ declare namespace gapi.client {
|
|
|
784
778
|
GoogleAppsCardV1Widget[];
|
|
785
779
|
}
|
|
786
780
|
interface GoogleAppsCardV1SelectionInput {
|
|
787
|
-
/** An external data source, such as a relational data base.
|
|
781
|
+
/** An external data source, such as a relational data base. */
|
|
788
782
|
externalDataSource?:
|
|
789
783
|
GoogleAppsCardV1Action;
|
|
790
784
|
/** An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items. */
|
|
@@ -796,15 +790,12 @@ declare namespace gapi.client {
|
|
|
796
790
|
*/
|
|
797
791
|
label?:
|
|
798
792
|
string;
|
|
799
|
-
/**
|
|
800
|
-
* For multi-select menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, set to 3 items. [Developer
|
|
801
|
-
* Preview](https://developers.google.com/workspace/preview).
|
|
802
|
-
*/
|
|
793
|
+
/** For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items. */
|
|
803
794
|
multiSelectMaxSelectedItems?:
|
|
804
795
|
number;
|
|
805
796
|
/**
|
|
806
|
-
* For
|
|
807
|
-
* characters for static data sources and 3 characters for external data sources.
|
|
797
|
+
* For multiselect menus, the number of text characters that a user inputs before the Chat app queries autocomplete and displays suggested items in the menu. If unspecified, defaults
|
|
798
|
+
* to 0 characters for static data sources and 3 characters for external data sources.
|
|
808
799
|
*/
|
|
809
800
|
multiSelectMinQueryLength?:
|
|
810
801
|
number;
|
|
@@ -820,10 +811,7 @@ declare namespace gapi.client {
|
|
|
820
811
|
*/
|
|
821
812
|
onChangeAction?:
|
|
822
813
|
GoogleAppsCardV1Action;
|
|
823
|
-
/**
|
|
824
|
-
* A data source from a [Google Workspace host application](https://developers.google.com/chat/api/reference/rest/v1/HostApp). [Developer
|
|
825
|
-
* Preview](https://developers.google.com/workspace/preview).
|
|
826
|
-
*/
|
|
814
|
+
/** A data source from Google Workspace. */
|
|
827
815
|
platformDataSource?:
|
|
828
816
|
GoogleAppsCardV1PlatformDataSource;
|
|
829
817
|
/**
|
|
@@ -834,15 +822,15 @@ declare namespace gapi.client {
|
|
|
834
822
|
string;
|
|
835
823
|
}
|
|
836
824
|
interface GoogleAppsCardV1SelectionItem {
|
|
837
|
-
/** For
|
|
825
|
+
/** For multiselect menus, a text description or label that's displayed below the item's `text` field. */
|
|
838
826
|
bottomText?:
|
|
839
827
|
string;
|
|
840
828
|
/** Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item. */
|
|
841
829
|
selected?:
|
|
842
830
|
boolean;
|
|
843
831
|
/**
|
|
844
|
-
* For
|
|
845
|
-
* `https://developers.google.com/chat/images/quickstart-app-avatar.png`.
|
|
832
|
+
* For multiselect menus, the URL for the icon displayed next to the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example,
|
|
833
|
+
* `https://developers.google.com/chat/images/quickstart-app-avatar.png`.
|
|
846
834
|
*/
|
|
847
835
|
startIconUri?:
|
|
848
836
|
string;
|
|
@@ -1050,7 +1038,7 @@ declare namespace gapi.client {
|
|
|
1050
1038
|
GoogleAppsCardV1TextParagraph;
|
|
1051
1039
|
}
|
|
1052
1040
|
interface HostAppDataSourceMarkup {
|
|
1053
|
-
/**
|
|
1041
|
+
/** A data source from Google Chat. */
|
|
1054
1042
|
chatDataSource?:
|
|
1055
1043
|
ChatClientDataSourceMarkup;
|
|
1056
1044
|
}
|
|
@@ -1459,7 +1447,7 @@ declare namespace gapi.client {
|
|
|
1459
1447
|
string;
|
|
1460
1448
|
}
|
|
1461
1449
|
interface SpaceDataSource {
|
|
1462
|
-
/**
|
|
1450
|
+
/** If set to `true`, the multiselect menu selects the current Google Chat space as an item by default. */
|
|
1463
1451
|
defaultToCurrentSpace?:
|
|
1464
1452
|
boolean;
|
|
1465
1453
|
}
|
|
@@ -1853,8 +1841,7 @@ declare namespace gapi.client {
|
|
|
1853
1841
|
/**
|
|
1854
1842
|
* Returns details about a membership. For an example, see [Get a membership](https://developers.google.com/chat/api/guides/v1/members/get). Requires
|
|
1855
1843
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
1856
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
1857
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
1844
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
1858
1845
|
*/
|
|
1859
1846
|
get(request?: {
|
|
1860
1847
|
/** V1 error format. */
|
|
@@ -1903,8 +1890,7 @@ declare namespace gapi.client {
|
|
|
1903
1890
|
* 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,
|
|
1904
1891
|
* 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
|
|
1905
1892
|
* has access to. Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
1906
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
1907
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
1893
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
1908
1894
|
*/
|
|
1909
1895
|
list(request?: {
|
|
1910
1896
|
/** V1 error format. */
|
|
@@ -2345,8 +2331,8 @@ declare namespace gapi.client {
|
|
|
2345
2331
|
/**
|
|
2346
2332
|
* Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
|
|
2347
2333
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2348
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
2349
|
-
*
|
|
2334
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Requests
|
|
2335
|
+
* authenticated with service accounts can only delete messages created by the calling Chat app.
|
|
2350
2336
|
*/
|
|
2351
2337
|
delete(request?: {
|
|
2352
2338
|
/** V1 error format. */
|
|
@@ -2396,8 +2382,8 @@ declare namespace gapi.client {
|
|
|
2396
2382
|
/**
|
|
2397
2383
|
* Returns details about a message. For an example, see [Read a message](https://developers.google.com/chat/api/guides/v1/messages/get). Requires
|
|
2398
2384
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2399
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
2400
|
-
*
|
|
2385
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Note: Might
|
|
2386
|
+
* return a message from a blocked member or space.
|
|
2401
2387
|
*/
|
|
2402
2388
|
get(request?: {
|
|
2403
2389
|
/** V1 error format. */
|
|
@@ -2520,8 +2506,8 @@ declare namespace gapi.client {
|
|
|
2520
2506
|
* 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
|
|
2521
2507
|
* recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
2522
2508
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2523
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
2524
|
-
*
|
|
2509
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Requests
|
|
2510
|
+
* authenticated with service accounts can only update messages created by the calling Chat app.
|
|
2525
2511
|
*/
|
|
2526
2512
|
patch(request: {
|
|
2527
2513
|
/** V1 error format. */
|
|
@@ -2631,8 +2617,8 @@ declare namespace gapi.client {
|
|
|
2631
2617
|
* 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
|
|
2632
2618
|
* recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
2633
2619
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2634
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
2635
|
-
*
|
|
2620
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Requests
|
|
2621
|
+
* authenticated with service accounts can only update messages created by the calling Chat app.
|
|
2636
2622
|
*/
|
|
2637
2623
|
update(request: {
|
|
2638
2624
|
/** V1 error format. */
|
package/package.json
CHANGED
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: 20231024
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -239,8 +239,7 @@ gapi.load('client', async () => {
|
|
|
239
239
|
/**
|
|
240
240
|
* Returns details about a membership. For an example, see [Get a membership](https://developers.google.com/chat/api/guides/v1/members/get). Requires
|
|
241
241
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
242
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
243
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
242
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
244
243
|
*/
|
|
245
244
|
await gapi.client.chat.spaces.members.get({
|
|
246
245
|
name: "Test string",
|
|
@@ -250,8 +249,7 @@ gapi.load('client', async () => {
|
|
|
250
249
|
* 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,
|
|
251
250
|
* 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
|
|
252
251
|
* access to. Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
253
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
254
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
252
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
255
253
|
*/
|
|
256
254
|
await gapi.client.chat.spaces.members.list({
|
|
257
255
|
filter: "Test string",
|
|
@@ -2368,8 +2366,8 @@ gapi.load('client', async () => {
|
|
|
2368
2366
|
/**
|
|
2369
2367
|
* Deletes a message. For an example, see [Delete a message](https://developers.google.com/chat/api/guides/v1/messages/delete). Requires
|
|
2370
2368
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2371
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
2372
|
-
*
|
|
2369
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Requests
|
|
2370
|
+
* authenticated with service accounts can only delete messages created by the calling Chat app.
|
|
2373
2371
|
*/
|
|
2374
2372
|
await gapi.client.chat.spaces.messages.delete({
|
|
2375
2373
|
force: true,
|
|
@@ -2378,8 +2376,8 @@ gapi.load('client', async () => {
|
|
|
2378
2376
|
/**
|
|
2379
2377
|
* Returns details about a message. For an example, see [Read a message](https://developers.google.com/chat/api/guides/v1/messages/get). Requires
|
|
2380
2378
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2381
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
2382
|
-
*
|
|
2379
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Note: Might
|
|
2380
|
+
* return a message from a blocked member or space.
|
|
2383
2381
|
*/
|
|
2384
2382
|
await gapi.client.chat.spaces.messages.get({
|
|
2385
2383
|
name: "Test string",
|
|
@@ -2400,8 +2398,8 @@ gapi.load('client', async () => {
|
|
|
2400
2398
|
* 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
|
|
2401
2399
|
* using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
2402
2400
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
2403
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
2404
|
-
*
|
|
2401
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Requests
|
|
2402
|
+
* authenticated with service accounts can only update messages created by the calling Chat app.
|
|
2405
2403
|
*/
|
|
2406
2404
|
await gapi.client.chat.spaces.messages.patch({
|
|
2407
2405
|
allowMissing: true,
|
|
@@ -4505,8 +4503,8 @@ gapi.load('client', async () => {
|
|
|
4505
4503
|
* 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
|
|
4506
4504
|
* using the `patch` method. For an example, see [Update a message](https://developers.google.com/chat/api/guides/v1/messages/update). Requires
|
|
4507
4505
|
* [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account
|
|
4508
|
-
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).
|
|
4509
|
-
*
|
|
4506
|
+
* authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Requests
|
|
4507
|
+
* authenticated with service accounts can only update messages created by the calling Chat app.
|
|
4510
4508
|
*/
|
|
4511
4509
|
await gapi.client.chat.spaces.messages.update({
|
|
4512
4510
|
allowMissing: true,
|