feat(docs): update docs for fixing collision in summary naming #1623
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oliwiapolec
reviewed
Dec 2, 2025
| ### Chats | ||
|
|
||
| - The **List Archives** ([Web](/messaging/agent-chat-api/v3.7/#list-archives) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-archives)) method has a new filter, `chat_ids`. | ||
| - The **List Chats** ([Web](/messaging/agent-chat-api/v3.7/#list-chats) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` is renamed to `chats_info` |
Collaborator
There was a problem hiding this comment.
Suggested change
| - The **List Chats** ([Web](/messaging/agent-chat-api/v3.7/#list-chats) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` is renamed to `chats_info` | |
| - The **List Chats** ([Web](/messaging/agent-chat-api/v3.7/#list-chats) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` was renamed to `chats_info`. |
|
|
||
| - The **List Archives** ([Web](/messaging/agent-chat-api/v3.7/#list-archives) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-archives)) method has a new filter, `chat_ids`. | ||
| - The **List Chats** ([Web](/messaging/agent-chat-api/v3.7/#list-chats) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` is renamed to `chats_info` | ||
| - The **Login** ([RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#login)) method's response body field `chats_summary` is renamed to `chats_info` |
Collaborator
There was a problem hiding this comment.
Suggested change
| - The **Login** ([RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#login)) method's response body field `chats_summary` is renamed to `chats_info` | |
| - The **Login** ([RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#login)) method's response body field `chats_summary` was renamed to `chats_info`. |
| - The **List Archives** ([Web](/messaging/agent-chat-api/v3.7/#list-archives) & [RTM](/messaging/agent-chat-api/rtm-reference/#list-archives)) method has a new filter, `chat_ids`. | ||
| - The **List Chats** ([Web](/messaging/agent-chat-api/v3.7/#list-chats) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` is renamed to `chats_info` | ||
| - The **Login** ([RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#login)) method's response body field `chats_summary` is renamed to `chats_info` | ||
| - The **Chat summary** data structure renamed to [**Chat info**](/messaging/agent-chat-api/v3.7/data-structures#chat-info) and its field `last_thread_summary` renamed to `last_thread_info` |
Collaborator
There was a problem hiding this comment.
Suggested change
| - The **Chat summary** data structure renamed to [**Chat info**](/messaging/agent-chat-api/v3.7/data-structures#chat-info) and its field `last_thread_summary` renamed to `last_thread_info` | |
| - The **Chat summary** data structure is renamed to [**Chat info**](/messaging/agent-chat-api/v3.7/data-structures#chat-info), and its field `last_thread_summary` is renamed to `last_thread_info`. |
| | Field | Data type | Notes | | ||
| | ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ | | ||
| | `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) data structures | | ||
| | `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures | | |
| | `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures. | |
| ### List Chats | ||
|
|
||
| It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) of the chats an agent has access to. | ||
| It returns [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) about the chats an agent has access to. |
Collaborator
There was a problem hiding this comment.
Suggested change
| It returns [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) about the chats an agent has access to. | |
| It returns the [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) about the chats an agent has access to. |
| It returns a list of the chats an agent has access to. Together with a **chat**, the **events** of **one thread** from this chat are returned. | ||
|
|
||
| The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat summary**. | ||
| The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat info**. |
Collaborator
There was a problem hiding this comment.
Suggested change
| The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only a **chat info**. | |
| The list classification is based on threads; 1 chat per 1 thread. Thus, the same **chat** object may appear on the list several times, but each time with a different **thread**. The returned **chat** is a complete object, not only the **chat info**. |
| | Parameter | Required | Type | Notes | | ||
| | ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------- | | ||
| | `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | | ||
| | `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat entries info are sorted by the creation date of its last thread. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat entries info are sorted by the creation date of its last thread. | | |
| | `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). The chat info entries are sorted by the creation date of their last thread. | |
| | Parameter | Required | Type | Notes | | ||
| | ------------ | -------- | -------- | --------------------------------------------------------------------------------------------------------------- | | ||
| | `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. | | ||
| | `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat info entries are sorted by the creation date of its last thread. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat info entries are sorted by the creation date of its last thread. | | |
| | `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). The chat info entries are sorted by the creation date of their last thread. | |
oliwiapolec
reviewed
Dec 3, 2025
| 0 | ||
| ] | ||
| }, | ||
| "active": false |
Collaborator
There was a problem hiding this comment.
When renaming the files, you also have to rename exports :D Otherwise, the build will fail. Exports are under:
/livechat-public-docs/payloads/messaging/v3.7/agent-chat-api/index.js for agent
/livechat-public-docs/payloads/messaging/v3.7/customer-chat-api/index.js for customer
oliwiapolec
approved these changes
Dec 3, 2025
Collaborator
oliwiapolec
left a comment
oliwiapolec
left a comment
There was a problem hiding this comment.
DM me if this can be merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Release requirements
PR information
What does this PR do? (optional)
This PR's goal is to fix collision in naming of our structs so that only data structures related to AI thread summary feature would use summary in their names. Data structures meant as shorter versions of chats and threads are renamed to chat info and thread info
Type of change
Deploy preview
The deploy preview link will appear in the checks section below once the build is complete.
Versioning
Pull request titles should comply with the Conventional Commits specification. This is required to update the project's version.