Skip to content

Commit

Permalink
feat(chat)!: update the API
Browse files Browse the repository at this point in the history
BREAKING CHANGE: This release has breaking changes.

#### chat:v1

The following keys were deleted:
- schemas.Space.properties.singleUserBotDm.readOnly

The following keys were changed:
- resources.spaces.resources.messages.methods.update.parameters.updateMask.description
- schemas.ActionStatus.properties.statusCode.enumDescriptions
- schemas.CommonEventObject.properties.hostApp.enum
- schemas.CommonEventObject.properties.hostApp.enumDescriptions
- schemas.GoogleAppsCardV1Action.properties.persistValues.description
- schemas.GoogleAppsCardV1TextParagraph.description
- schemas.Space.properties.singleUserBotDm.description
  • Loading branch information
yoshi-automation authored and sofisl committed Sep 21, 2022
1 parent 2644a4c commit 21b00d5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
15 changes: 8 additions & 7 deletions discovery/chat-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@
"type": "string"
},
"updateMask": {
"description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) ",
"description": "Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2 ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
Expand Down Expand Up @@ -642,7 +642,7 @@
}
}
},
"revision": "20220816",
"revision": "20220917",
"rootUrl": "https://chat.googleapis.com/",
"schemas": {
"ActionParameter": {
Expand Down Expand Up @@ -721,7 +721,7 @@
"DATA_LOSS"
],
"enumDescriptions": [
"Not an error; returned on success HTTP Mapping: 200 OK",
"Not an error; returned on success. HTTP Mapping: 200 OK",
"The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request",
"Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error",
"The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request",
Expand Down Expand Up @@ -1021,6 +1021,7 @@
"DRIVE",
"DEMO",
"DOCS",
"MEET",
"SHEETS",
"SLIDES",
"DRAWINGS",
Expand All @@ -1033,6 +1034,7 @@
"The add-on launches from Google Drive.",
"Not used.",
"The add-on launches from Google Docs.",
"The add-on launches from Google Meet.",
"The add-on launches from Google Sheets.",
"The add-on launches from Google Slides.",
"The add-on launches from Google Drawings.",
Expand Down Expand Up @@ -1281,7 +1283,7 @@
"type": "array"
},
"persistValues": {
"description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. When using [LoadIndicator.NONE](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use [LoadIndicator.SPINNER](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed. Not supported by Google Chat apps.",
"description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. When using [LoadIndicator.NONE](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use [LoadIndicator.SPINNER](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed. Not supported by Google Chat apps.",
"type": "boolean"
}
},
Expand Down Expand Up @@ -2031,7 +2033,7 @@
"type": "object"
},
"GoogleAppsCardV1TextParagraph": {
"description": "A paragraph of text that supports formatting. See [Text formatting](workspace/add-ons/concepts/widgets#text_formatting) for details.",
"description": "A paragraph of text that supports formatting. See [Text formatting](https://developers.google.com/workspace/add-ons/concepts/widgets#text_formatting) for details.",
"id": "GoogleAppsCardV1TextParagraph",
"properties": {
"text": {
Expand Down Expand Up @@ -2645,8 +2647,7 @@
"type": "string"
},
"singleUserBotDm": {
"description": "Output only. Whether the space is a DM between a Chat app and a single human.",
"readOnly": true,
"description": "Optional. Whether the space is a DM between a Chat app and a single human.",
"type": "boolean"
},
"spaceDetails": {
Expand Down
2 changes: 1 addition & 1 deletion src/apis/chat/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"webpack": "webpack"
},
"dependencies": {
"googleapis-common": "^5.0.1"
"googleapis-common": "^6.0.3"
},
"devDependencies": {
"@microsoft/api-documenter": "^7.8.10",
Expand Down
10 changes: 5 additions & 5 deletions src/apis/chat/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ export namespace chat_v1 {
*/
parameters?: Schema$GoogleAppsCardV1ActionParameter[];
/**
* Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. When using [LoadIndicator.NONE](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use [LoadIndicator.SPINNER](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed. Not supported by Google Chat apps.
* Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. When using [LoadIndicator.NONE](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use [LoadIndicator.SPINNER](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed. Not supported by Google Chat apps.
*/
persistValues?: boolean | null;
}
Expand Down Expand Up @@ -1076,7 +1076,7 @@ export namespace chat_v1 {
value?: string | null;
}
/**
* A paragraph of text that supports formatting. See [Text formatting](workspace/add-ons/concepts/widgets#text_formatting) for details.
* A paragraph of text that supports formatting. See [Text formatting](https://developers.google.com/workspace/add-ons/concepts/widgets#text_formatting) for details.
*/
export interface Schema$GoogleAppsCardV1TextParagraph {
/**
Expand Down Expand Up @@ -1439,7 +1439,7 @@ export namespace chat_v1 {
*/
name?: string | null;
/**
* Output only. Whether the space is a DM between a Chat app and a single human.
* Optional. Whether the space is a DM between a Chat app and a single human.
*/
singleUserBotDm?: boolean | null;
/**
Expand Down Expand Up @@ -4174,7 +4174,7 @@ export namespace chat_v1 {
* const res = await chat.spaces.messages.update({
* // Resource name in the form `spaces/x/messages/x`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`
* name: 'spaces/my-space/messages/my-message',
* // Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).)
* // Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
* updateMask: 'placeholder-value',
*
* // Request body metadata
Expand Down Expand Up @@ -4353,7 +4353,7 @@ export namespace chat_v1 {
*/
name?: string;
/**
* Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).)
* Required. The field paths to update. Separate multiple values with commas. Currently supported field paths: - text - cards (Requires [service account authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
*/
updateMask?: string;

Expand Down

0 comments on commit 21b00d5

Please sign in to comment.