@maxim_mazurok/gapi.client.chat-v1 0.0.20250121 → 0.0.20250126

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.
Files changed (3) hide show
  1. package/index.d.ts +23 -17
  2. package/package.json +1 -1
  3. package/readme.md +2 -2
package/index.d.ts CHANGED
@@ -9,14 +9,14 @@
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: 20250121
12
+ // Revision: 20250126
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
17
  /** Load Google Chat API v1 */
18
18
  function load(
19
- urlOrObject: 'https://chat.googleapis.com/$discovery/rest?version=v1'
19
+ urlOrObject: 'https://chat.googleapis.com/$discovery/rest?version=v1',
20
20
  ): Promise<void>;
21
21
  /** @deprecated Please load APIs with discovery documents. */
22
22
  function load(name: 'chat', version: 'v1'): Promise<void>;
@@ -57,6 +57,8 @@ declare namespace gapi.client {
57
57
  userFacingMessage?: string;
58
58
  }
59
59
  interface Annotation {
60
+ /** The metadata for a custom emoji. */
61
+ customEmojiMetadata?: CustomEmojiMetadata;
60
62
  /** Length of the substring in the plain-text message body this annotation corresponds to. */
61
63
  length?: number;
62
64
  /** The metadata for a rich link. */
@@ -191,6 +193,10 @@ declare namespace gapi.client {
191
193
  /** Output only. Unique key for the custom emoji resource. */
192
194
  uid?: string;
193
195
  }
196
+ interface CustomEmojiMetadata {
197
+ /** The custom emoji. */
198
+ customEmoji?: CustomEmoji;
199
+ }
194
200
  interface DateInput {
195
201
  /** Time since epoch time, in milliseconds. */
196
202
  msSinceEpoch?: string;
@@ -254,7 +260,7 @@ declare namespace gapi.client {
254
260
  mimeType?: string;
255
261
  }
256
262
  interface Emoji {
257
- /** Output only. A custom emoji. */
263
+ /** A custom emoji. */
258
264
  customEmoji?: CustomEmoji;
259
265
  /** Optional. A basic emoji represented by a unicode string. */
260
266
  unicode?: string;
@@ -1328,7 +1334,7 @@ declare namespace gapi.client {
1328
1334
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1329
1335
  uploadType?: string;
1330
1336
  },
1331
- body: UploadAttachmentRequest
1337
+ body: UploadAttachmentRequest,
1332
1338
  ): Request<UploadAttachmentResponse>;
1333
1339
  }
1334
1340
  interface MembersResource {
@@ -1392,7 +1398,7 @@ declare namespace gapi.client {
1392
1398
  /** Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access. */
1393
1399
  useAdminAccess?: boolean;
1394
1400
  },
1395
- body: Membership
1401
+ body: Membership,
1396
1402
  ): Request<Membership>;
1397
1403
  /** Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. */
1398
1404
  delete(request?: {
@@ -1555,7 +1561,7 @@ declare namespace gapi.client {
1555
1561
  /** Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). */
1556
1562
  useAdminAccess?: boolean;
1557
1563
  },
1558
- body: Membership
1564
+ body: Membership,
1559
1565
  ): Request<Membership>;
1560
1566
  }
1561
1567
  interface AttachmentsResource {
@@ -1588,7 +1594,7 @@ declare namespace gapi.client {
1588
1594
  }): Request<Attachment>;
1589
1595
  }
1590
1596
  interface ReactionsResource {
1591
- /** Creates a reaction and adds it to a message. Only unicode emojis are supported. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
1597
+ /** Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
1592
1598
  create(request: {
1593
1599
  /** V1 error format. */
1594
1600
  '$.xgafv'?: string;
@@ -1644,9 +1650,9 @@ declare namespace gapi.client {
1644
1650
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1645
1651
  uploadType?: string;
1646
1652
  },
1647
- body: Reaction
1653
+ body: Reaction,
1648
1654
  ): Request<Reaction>;
1649
- /** Deletes a reaction to a message. Only unicode emojis are supported. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
1655
+ /** Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */
1650
1656
  delete(request?: {
1651
1657
  /** V1 error format. */
1652
1658
  '$.xgafv'?: string;
@@ -1780,7 +1786,7 @@ declare namespace gapi.client {
1780
1786
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1781
1787
  uploadType?: string;
1782
1788
  },
1783
- body: Message
1789
+ body: Message,
1784
1790
  ): Request<Message>;
1785
1791
  /** Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only delete messages created by the calling Chat app. */
1786
1792
  delete(request?: {
@@ -1939,7 +1945,7 @@ declare namespace gapi.client {
1939
1945
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1940
1946
  uploadType?: string;
1941
1947
  },
1942
- body: Message
1948
+ body: Message,
1943
1949
  ): Request<Message>;
1944
1950
  /** Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app. */
1945
1951
  update(request: {
@@ -2005,7 +2011,7 @@ declare namespace gapi.client {
2005
2011
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2006
2012
  uploadType?: string;
2007
2013
  },
2008
- body: Message
2014
+ body: Message,
2009
2015
  ): Request<Message>;
2010
2016
  attachments: AttachmentsResource;
2011
2017
  reactions: ReactionsResource;
@@ -2129,7 +2135,7 @@ declare namespace gapi.client {
2129
2135
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2130
2136
  uploadType?: string;
2131
2137
  },
2132
- body: CompleteImportSpaceRequest
2138
+ body: CompleteImportSpaceRequest,
2133
2139
  ): Request<CompleteImportSpaceResponse>;
2134
2140
  /** Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When authenticating as an app, the `space.customer` field must be set in the request. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. */
2135
2141
  create(request: {
@@ -2187,7 +2193,7 @@ declare namespace gapi.client {
2187
2193
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2188
2194
  uploadType?: string;
2189
2195
  },
2190
- body: Space
2196
+ body: Space,
2191
2197
  ): Request<Space>;
2192
2198
  /** Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. */
2193
2199
  delete(request?: {
@@ -2369,7 +2375,7 @@ declare namespace gapi.client {
2369
2375
  /** Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`. */
2370
2376
  useAdminAccess?: boolean;
2371
2377
  },
2372
- body: Space
2378
+ body: Space,
2373
2379
  ): Request<Space>;
2374
2380
  /** Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges). In the request, set `use_admin_access` to `true`. */
2375
2381
  search(request?: {
@@ -2458,7 +2464,7 @@ declare namespace gapi.client {
2458
2464
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2459
2465
  uploadType?: string;
2460
2466
  },
2461
- body: SetUpSpaceRequest
2467
+ body: SetUpSpaceRequest,
2462
2468
  ): Request<Space>;
2463
2469
  members: MembersResource;
2464
2470
  messages: MessagesResource;
@@ -2581,7 +2587,7 @@ declare namespace gapi.client {
2581
2587
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2582
2588
  uploadType?: string;
2583
2589
  },
2584
- body: SpaceReadState
2590
+ body: SpaceReadState,
2585
2591
  ): Request<SpaceReadState>;
2586
2592
  threads: ThreadsResource;
2587
2593
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.chat-v1",
3
- "version": "0.0.20250121",
3
+ "version": "0.0.20250126",
4
4
  "description": "TypeScript typings for Google Chat API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -30,7 +30,7 @@ gapi.client.load(
30
30
  () => {
31
31
  // now we can use:
32
32
  // gapi.client.chat
33
- }
33
+ },
34
34
  );
35
35
  ```
36
36
 
@@ -137,7 +137,7 @@ gapi.auth.authorize(
137
137
  } else {
138
138
  /* handle authorization error */
139
139
  }
140
- }
140
+ },
141
141
  );
142
142
  ```
143
143