@maxim_mazurok/gapi.client.chat-v1 0.0.20230729 → 0.0.20230803

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 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: 20230729
12
+ // Revision: 20230803
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -75,22 +75,22 @@ declare namespace gapi.client {
75
75
  /** A reference to the attachment data. This field is used with the media API to download the attachment data. */
76
76
  attachmentDataRef?:
77
77
  AttachmentDataRef;
78
- /** The original file name for the content, not the full path. */
78
+ /** Output only. The original file name for the content, not the full path. */
79
79
  contentName?:
80
80
  string;
81
- /** The content type (MIME type) of the file. */
81
+ /** Output only. The content type (MIME type) of the file. */
82
82
  contentType?:
83
83
  string;
84
84
  /** Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content. */
85
85
  downloadUri?:
86
86
  string;
87
- /** A reference to the drive attachment. This field is used with the Drive API. */
87
+ /** Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API. */
88
88
  driveDataRef?:
89
89
  DriveDataRef;
90
90
  /** Resource name of the attachment, in the form `spaces/*‍/messages/*‍/attachments/*`. */
91
91
  name?:
92
92
  string;
93
- /** The source of the attachment. */
93
+ /** Output only. The source of the attachment. */
94
94
  source?:
95
95
  string;
96
96
  /** Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content. */
@@ -728,7 +728,7 @@ declare namespace gapi.client {
728
728
  GoogleAppsCardV1Card;
729
729
  /**
730
730
  * An add-on triggers this action when the action needs to open a link. This differs from the `open_link` above in that this needs to talk to server to get the link. Thus some
731
- * preparation work is required for web client to do before the open link action response comes back.
731
+ * preparation work is required for web client to do before the open link action response comes back. Supported by Google Workspace Add-ons, but not Google Chat apps.
732
732
  */
733
733
  openDynamicLinkAction?:
734
734
  GoogleAppsCardV1Action;
@@ -1404,7 +1404,10 @@ declare namespace gapi.client {
1404
1404
  */
1405
1405
  displayName?:
1406
1406
  string;
1407
- /** Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space. For existing spaces, this field is output only. */
1407
+ /**
1408
+ * Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. For Google Chat users that use a Google
1409
+ * Account, omit this field when creating a space (By default, the space permits any Google Chat user). For existing spaces, this field is output only.
1410
+ */
1408
1411
  externalUserAllowed?:
1409
1412
  boolean;
1410
1413
  /** Resource name of the space. Format: `spaces/{space}` */
@@ -1480,10 +1483,7 @@ declare namespace gapi.client {
1480
1483
  /** Resource name of the thread. Example: `spaces/{space}/threads/{thread}` */
1481
1484
  name?:
1482
1485
  string;
1483
- /**
1484
- * Optional. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message
1485
- * thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread). For other requests, this is an output only field.
1486
- */
1486
+ /** Optional. ID for the thread. Supports up to 4000 characters. Input for creating or updating a thread. Otherwise, output only. */
1487
1487
  threadKey?:
1488
1488
  string;
1489
1489
  }
@@ -2245,8 +2245,8 @@ declare namespace gapi.client {
2245
2245
  requestId?:
2246
2246
  string;
2247
2247
  /**
2248
- * Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For
2249
- * example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).
2248
+ * Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey`
2249
+ * or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).
2250
2250
  */
2251
2251
  threadKey?:
2252
2252
  string;
@@ -2308,8 +2308,8 @@ declare namespace gapi.client {
2308
2308
  requestId?:
2309
2309
  string;
2310
2310
  /**
2311
- * Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For
2312
- * example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).
2311
+ * Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey`
2312
+ * or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).
2313
2313
  */
2314
2314
  threadKey?:
2315
2315
  string;
@@ -2728,9 +2728,8 @@ declare namespace gapi.client {
2728
2728
  }
2729
2729
  interface SpacesResource {
2730
2730
  /**
2731
- * Creates a named space. Spaces grouped by topics or that have guest access aren't supported. For an example, see [Create a
2732
- * 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
2733
- * `chat.spaces.create` or `chat.spaces` scope.
2731
+ * Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/chat/api/guides/v1/spaces/create). Requires
2732
+ * [user authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
2734
2733
  */
2735
2734
  create(request: {
2736
2735
  /** V1 error format. */
@@ -3137,8 +3136,8 @@ declare namespace gapi.client {
3137
3136
  * 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
3137
  * 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
3138
  * 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.
3139
+ * 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. Requires [user
3140
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
3142
3141
  */
3143
3142
  setup(request: {
3144
3143
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.chat-v1",
3
- "version": "0.0.20230729",
3
+ "version": "0.0.20230803",
4
4
  "description": "TypeScript typings for Google Chat API v1",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -15,6 +15,6 @@
15
15
  "types": "index.d.ts",
16
16
  "dependencies": {
17
17
  "@types/gapi.client": "*",
18
- "@types/gapi.client.discovery": "*"
18
+ "@types/gapi.client.discovery-v1": "*"
19
19
  }
20
20
  }
package/readme.md CHANGED
@@ -119,7 +119,7 @@ Uploads an attachment. For an example, see [Upload media as a file attachment](h
119
119
  await gapi.client.chat.media.upload({ parent: "parent", });
120
120
 
121
121
  /*
122
- 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.
122
+ Creates a named space. Spaces grouped by topics 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.
123
123
  */
124
124
  await gapi.client.chat.spaces.create({ });
125
125
 
@@ -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 `{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.
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 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: 20230729
6
+ // Revision: 20230803
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -73,9 +73,8 @@ gapi.load('client', async () => {
73
73
  filename: "Test string",
74
74
  });
75
75
  /**
76
- * Creates a named space. Spaces grouped by topics or that have guest access aren't supported. For an example, see [Create a
77
- * 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
78
- * `chat.spaces.create` or `chat.spaces` scope.
76
+ * Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/chat/api/guides/v1/spaces/create). Requires [user
77
+ * authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
79
78
  */
80
79
  await gapi.client.chat.spaces.create({
81
80
  requestId: "Test string",
@@ -166,7 +165,7 @@ gapi.load('client', async () => {
166
165
  * 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
166
  * 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
167
  * 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
168
+ * 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. Requires [user
170
169
  * authentication](https://developers.google.com/chat/api/guides/auth/users) and the `chat.spaces.create` or `chat.spaces` scope.
171
170
  */
172
171
  await gapi.client.chat.spaces.setup({