Skip to content

Commit 2d007cf

Browse files
oliwiapolecoliwiapolec
authored
feat(docs): add new 'limit' param description
1 parent 1dd1812 commit 2d007cf

File tree

12 files changed

+211
-211
lines changed

12 files changed

+211
-211
lines changed

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

Lines changed: 28 additions & 28 deletions
Large diffs are not rendered by default.

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

Lines changed: 27 additions & 27 deletions
Large diffs are not rendered by default.

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

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

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

Lines changed: 44 additions & 44 deletions
Large diffs are not rendered by default.

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

Lines changed: 28 additions & 28 deletions
Large diffs are not rendered by default.

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

Lines changed: 27 additions & 27 deletions
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.6/data-structures/#chat-s
130130

131131
| Parameter | Required | Type | Notes |
132132
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ |
133-
| `limit` | No | `number` | Default: 10, maximum: 25 |
133+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. |
134134
| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat summaries are sorted by the creation date of its last thread. |
135135
| `page_id` | No | `string` | |
136136

@@ -232,7 +232,7 @@ It returns threads that the current Customer has access to in a given chat.
232232
| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
233233
| `chat_id` | Yes | `string` | |
234234
| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). |
235-
| `limit` | No | `number` | Default: 3, maximum: 100 |
235+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. |
236236
| `page_id` | No | `string` | |
237237
| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. |
238238

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.6/data-structures/#chat-s
168168

169169
| Parameter | Required | Type | Notes |
170170
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ |
171-
| `limit` | No | `number` | Default: 10, maximum: 25 |
171+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. |
172172
| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat summaries are sorted by the creation date of its last thread. |
173173
| `page_id` | No | `string` | |
174174

@@ -275,7 +275,7 @@ It returns threads that the current Customer has access to in a given chat.
275275
| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
276276
| `chat_id` | Yes | `string` | |
277277
| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). |
278-
| `limit` | No | `number` | Default: 3, maximum: 100 |
278+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. |
279279
| `page_id` | No | `string` | |
280280
| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. |
281281

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.5/data-structures/#chat-s
135135

136136
| Parameter | Required | Type | Notes |
137137
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ |
138-
| `limit` | No | `number` | Default: 10, maximum: 25 |
138+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. |
139139
| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat summaries are sorted by the creation date of its last thread. |
140140
| `page_id` | No | `string` | |
141141

@@ -237,7 +237,7 @@ It returns threads that the current Customer has access to in a given chat.
237237
| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
238238
| `chat_id` | Yes | `string` | |
239239
| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). |
240-
| `limit` | No | `number` | Default: 3, maximum: 100 |
240+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. |
241241
| `page_id` | No | `string` | |
242242
| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. |
243243

‎src/pages/messaging/customer-chat-api/v3.5/rtm-reference/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ It returns [summaries](/messaging/customer-chat-api/v3.5/data-structures/#chat-s
167167

168168
| Parameter | Required | Type | Notes |
169169
| ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------ |
170-
| `limit` | No | `number` | Default: 10, maximum: 25 |
170+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 10, maximum: 25. |
171171
| `sort_order` | No | `string` | Possible values: `asc`, `desc` (default). Chat summaries are sorted by the creation date of its last thread. |
172172
| `page_id` | No | `string` | |
173173

@@ -274,7 +274,7 @@ It returns threads that the current Customer has access to in a given chat.
274274
| ------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
275275
| `chat_id` | Yes | `string` | |
276276
| `sort_order` | No | `string` | Possible values: `asc` - oldest threads first and `desc` - newest threads first (default). |
277-
| `limit` | No | `number` | Default: 3, maximum: 100 |
277+
| `limit` | No | `number` | Maximum number of records returned on each [page](#pagination). Default: 3, maximum: 100. |
278278
| `page_id` | No | `string` | |
279279
| `min_events_count` | No | `number` | Range: 1-100; Specifies the minimum number of events to be returned in the response. It's the **total** number of events, so they can come from more than one thread. You'll get as many latest threads as needed to meet the `min_events_count` condition. |
280280

0 commit comments

Comments
 (0)