Skip to content

Commit 4a17660

Browse files
Slimak-TextSlimak-Text
authored
feat(docs): update docs for fixing collision in summary naming (#1623)
1 parent 8d4552c commit 4a17660

File tree

12 files changed

+51
-42
lines changed

12 files changed

+51
-42
lines changed

‎payloads/messaging/v3.7/agent-chat-api/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export { default as customer } from "./users/customer.json";
1414

1515
export { default as access } from "./other-structures/access.json";
1616
export { default as chat } from "./other-structures/chat.json";
17-
export { default as chatSummary } from "./other-structures/chatSummary.json";
17+
export { default as chatInfo } from "./other-structures/chatInfo.json";
1818
export { default as formFields } from "./other-structures/formFields.json";
1919
export { default as filledFormFields } from "./other-structures/filledFormFields.json";
2020
export { default as properties } from "./other-structures/properties.json";

payloads/messaging/v3.7/agent-chat-api/other-structures/chatSummary.json renamed to payloads/messaging/v3.7/agent-chat-api/other-structures/chatInfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"id": "PJ0MRSHTDG",
3-
"last_thread_summary": {
3+
"last_thread_info": {
44
"id": "QA37PVJ75B",
55
"created_at": "2020-05-12T11:42:47.383000Z",
66
"user_ids": [

‎payloads/messaging/v3.7/customer-chat-api/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export { default as customer } from "./users/customer.json"
1111

1212
export { default as access } from "./other-structures/access.json"
1313
export { default as chat } from "./other-structures/chat.json"
14-
export { default as chatSummary } from "./other-structures/chatSummary.json"
14+
export { default as chatInfo } from "./other-structures/chatInfo.json"
1515
export { default as form } from "./other-structures/form.json"
1616
export { default as formFields } from "./other-structures/formFields.json"
1717
export { default as filledFormFields } from "./other-structures/filledFormFields.json"

payloads/messaging/v3.7/customer-chat-api/other-structures/chatSummary.json renamed to payloads/messaging/v3.7/customer-chat-api/other-structures/chatInfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@
6464
]
6565
},
6666
"active": false
67-
}
67+
}

‎src/pages/messaging/agent-chat-api/changelog/index.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ The developer preview version provides a preview of the upcoming changes to the
3131
### Chats
3232

3333
- 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`.
34+
- 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`.
35+
- The **Login** ([RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#login)) method's response body field `chats_summary` was renamed to `chats_info`.
36+
- 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`.
3437

3538
## [v3.6] - 2025-08-07
3639

‎src/pages/messaging/agent-chat-api/v3.7/data-structures/index.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ Apart from [Events](#events) and [Users](#users), there are also other common da
423423

424424
- [Access](#access)
425425
- [Chats](#chats)
426-
- [Chat summaries](#chat-summaries)
426+
- [Chat info](#chat-info)
427427
- [Form fields](#form-fields)
428428
- [Filled form fields](#filled-form-fields)
429429
- [Properties](#properties)
@@ -447,11 +447,11 @@ Apart from [Events](#events) and [Users](#users), there are also other common da
447447
| `properties` | optional | |
448448
| `access` | optional | |
449449

450-
## Chat summaries
450+
## Chat info
451451

452-
**Chat summary** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat summary** includes `last_thread_summary` and `last_event_per_type`.
452+
**Chat info** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat info** includes `last_thread_info` and `last_event_per_type`.
453453

454-
<CodeResponse version="v3.7" type="agent" title={'Sample Chat summary data structure'} json="chatSummary"/>
454+
<CodeResponse version="v3.7" type="agent" title={'Sample Chat info data structure'} json="chatInfo"/>
455455

456456
## Form fields
457457

‎src/pages/messaging/agent-chat-api/v3.7/index.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ curl -X POST \
121121

122122
### List Chats
123123

124-
It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) of the chats an agent has access to.
124+
It returns the [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) about the chats an agent has access to.
125125

126126
#### Specifics
127127

@@ -140,7 +140,7 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ
140140
| ----------------------------------------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
141141
| `filters` | No | `object` | When paginating, `filters` provided in the first request are remembered and automatically used for the subsequent requests. Providing a new `filters` object will result in a `validation` error. To reset the filters, start paginating with a new set of filters. |
142142
| `filters.active` | No | `bool` | Possible values: `true` - active chats only, `false` - inactive chats only, `null` or not provided - both active and inactive chats. |
143-
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat summary includes chats without any threads; default: `true`. |
143+
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat info includes chats without any threads; default: `true`. |
144144
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
145145
| `filters.properties.<namespace>.<name>.<filter_type>` | No | `any` | |
146146
| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first (default) |
@@ -159,7 +159,7 @@ There's only one value allowed for a single property.
159159

160160
| Field | Data type | Notes |
161161
| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ |
162-
| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) data structures |
162+
| `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures. |
163163
| `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's a next page. |
164164
| `previous_page_id` | `string` | In relation to `page_id` specified in the request Appears in the response only when there's a previous page. |
165165
| `found_chats` | `number` | An estimated number. The real number of found chats can slightly differ. |
@@ -182,7 +182,7 @@ curl -X POST \
182182
```json
183183
{
184184
"next_page_id": "MTUxNzM5ODEzMTQ5Ng==", // optional
185-
"chats_summary": [{
185+
"chats_info": [{
186186
"id": "PJ0MRSHTDG",
187187
"last_event_per_type": {
188188
"message": {
@@ -210,7 +210,7 @@ curl -X POST \
210210
}, {
211211
// "Agent" user object
212212
}],
213-
"last_thread_summary": {
213+
"last_thread_info": {
214214
"id": "K600PKZON8",
215215
"created_at": "2020-05-07T07:11:28.288340Z",
216216
"user_ids": [
@@ -486,7 +486,7 @@ curl -X POST \
486486

487487
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.
488488

489-
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**.
489+
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**.
490490

491491
#### Specifics
492492

‎src/pages/messaging/agent-chat-api/v3.7/rtm-reference/index.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ When connecting to the Agent Chat RTM API, clients have to send over the require
161161

162162
### List Chats
163163

164-
It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) of the chats an agent has access to.
164+
It returns [info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) of the chats an agent has access to.
165165

166166
#### Specifics
167167

@@ -182,7 +182,7 @@ It returns [summaries](/messaging/agent-chat-api/v3.7/data-structures/#chat-summ
182182
| ----------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
183183
| `filters` | No | `object` | When paginating, `filters` provided in the first request are remembered and automatically used for the subsequent requests. Providing a new `filters` object will result in a `validation` error. To reset the filters, start paginating with a new set of filters. |
184184
| `filters.active` | No | `bool` | Possible values: `true` - active chats only, `false` - inactive chats only, `null` or not provided - both active and inactive chats. |
185-
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat summary includes chats without any threads; default: `true`. |
185+
| `filters.include_chats_without_threads` | No | `bool` | Defines if the returned chat info includes chats without any threads; default: `true`. |
186186
| `filters.group_ids` | No | `array` | Array of group IDs. Max array size: 200 |
187187
| `filters.properties.<namespace>.<name>.<filter_type>` | No | `any` | |
188188
| `sort_order` | No | `string` | Possible values: `asc` - oldest chats first, `desc` - newest chats first (default) |
@@ -201,7 +201,7 @@ There's only one value allowed for a single property.
201201

202202
| Field | Data type | Notes |
203203
| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------ |
204-
| `chats_summary` | `array` | An array of [Chat summary](/messaging/agent-chat-api/v3.7/data-structures/#chat-summaries) data structures |
204+
| `chats_info` | `array` | An array of [Chat info](/messaging/agent-chat-api/v3.7/data-structures/#chat-info) data structures. |
205205
| `next_page_id` | `string` | In relation to `page_id` specified in the request. Appears in the response only when there's a next page. |
206206
| `previous_page_id` | `string` | In relation to `page_id` specified in the request Appears in the response only when there's a previous page. |
207207
| `found_chats` | `number` | An estimated number. The real number of found chats can slightly differ. |
@@ -229,7 +229,7 @@ There's only one value allowed for a single property.
229229
"success": true,
230230
"payload": {
231231
"next_page_id": "MTUxNzM5ODEzMTQ5Ng==", // optional
232-
"chats_summary": [{
232+
"chats_info": [{
233233
"id": "PJ0MRSHTDG",
234234
"last_event_per_type": {
235235
"message": {
@@ -257,7 +257,7 @@ There's only one value allowed for a single property.
257257
}, {
258258
// "Agent" user object
259259
}],
260-
"last_thread_summary": {
260+
"last_thread_info": {
261261
"id": "K600PKZON8",
262262
"created_at": "2020-05-07T07:11:28.288340Z",
263263
"user_ids": [
@@ -543,7 +543,7 @@ It returns a thread that the current agent has access to in a given chat.
543543

544544
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.
545545

546-
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**.
546+
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**.
547547

548548
#### Specifics
549549

@@ -2650,7 +2650,7 @@ __**__ These values mean:
26502650
"my_profile": {
26512651
// "User > My profile" object
26522652
},
2653-
"chats_summary": [{
2653+
"chats_info": [{
26542654
"id": "PJ0MRSHTDG",
26552655
"users": [
26562656
// array of "User" objects
@@ -2677,7 +2677,7 @@ __**__ These values mean:
26772677
}
26782678
// ...
26792679
},
2680-
"last_thread_summary": {
2680+
"last_thread_info": {
26812681
"id": "K600PKZON8",
26822682
"user_ids": ["smith@example.com"],
26832683
"properties": {

‎src/pages/messaging/customer-chat-api/changelog/index.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ The developer preview version provides a preview of the upcoming changes to the
1919

2020
</Warning>
2121

22+
## [v3.7] - Developer preview
23+
24+
### Chats
25+
26+
- The **List Chats** ([Web](/messaging/customer-chat-api/v3.7/#list-chats) & [RTM](/messaging/customer-chat-api/v3.7/rtm-reference/#list-chats)) method's response body field `chats_summary` was renamed to `chats_info`.
27+
2228
## [v3.6] - 2025-08-07
2329

2430
### Config

‎src/pages/messaging/customer-chat-api/v3.7/data-structures/index.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ Apart from [Events](#events) and [Users](#users), there are also other common da
394394

395395
- [Access](#access)
396396
- [Chats](#chats)
397-
- [Chat summaries](#chat-summaries)
397+
- [Chat info](#chat-info)
398398
- [Forms](#forms)
399399
- [Form fields](#form-fields)
400400
- [Filled form fields](#filled-form-fields)
@@ -418,11 +418,11 @@ Apart from [Events](#events) and [Users](#users), there are also other common da
418418
| `properties` | optional | |
419419
| `access` | optional | |
420420

421-
## Chat summaries
421+
## Chat info
422422

423-
**Chat summary** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat summary** includes `last_event_per_type`.
423+
**Chat info** is similar to the **Chat** data structure. The difference is that **Chat** contains a `thread` object, while **Chat info** includes `last_event_per_type`.
424424

425-
<CodeResponse version="v3.7" type="customer" title={'Sample Chat summary data structure'} json="chatSummary"/>
425+
<CodeResponse version="v3.7" type="customer" title={'Sample Chat info data structure'} json="chatInfo"/>
426426

427427
## Forms
428428

0 commit comments

Comments
 (0)