Skip to content

Commit b427ac3

Browse files
oliwiapolecoliwiapolec
authored
feat(docs): clean table formatting (#1626)
1 parent c92cab5 commit b427ac3

File tree

45 files changed

+3176
-3177
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+3176
-3177
lines changed

‎src/pages/data-reporting/reports-api/index.mdx‎

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

‎src/pages/data-reporting/reports-api/v3.7/index.mdx‎

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

‎src/pages/extending-chat-widget/customer-sdk/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ Parameters:
451451
| parameters | type | description |
452452
| ---------- | ------ | --------------------------------------------------- |
453453
| id | string | ID of the chat whose properties you want to delete. |
454-
| properties | object | Chat properties to delete |
454+
| properties | object | The chat properties to delete. |
455455

456456
Returned value:
457457

@@ -1154,7 +1154,7 @@ Parameters:
11541154
| parameters | type | description |
11551155
| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------- |
11561156
| active | boolean | Optional, defaults to `true` but can be used to create threads that are immediately inactive |
1157-
| continuous | boolean | Optional, starts chat as continuous (online group is not required); default: false. |
1157+
| continuous | boolean | Optional, starts the chat as continuous (online group is not required); default: false. |
11581158
| chat.access | access | Optional; chat access to set, default: all agents. |
11591159
| chat.properties | object | Optional, [default properties docs](https://platform.text.com/docs/messaging/references/default-properties) |
11601160
| chat.thread.events | event[] | Optional; initial events that will immediately become a part of the created thread. |

‎src/pages/extending-chat-widget/customer-sdk/v2.0/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ Parameters:
458458
| parameters | type | description |
459459
| ---------- | ------ | --------------------------------------------------- |
460460
| chatId | string | ID of the chat whose properties you want to delete. |
461-
| properties | object | Chat properties to delete |
461+
| properties | object | The chat properties to delete. |
462462

463463
Returned value:
464464

‎src/pages/extending-chat-widget/customer-sdk/v3.0/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ Parameters:
445445
| parameters | type | description |
446446
| ---------- | ------ | --------------------------------------------------- |
447447
| id | string | ID of the chat whose properties you want to delete. |
448-
| properties | object | Chat properties to delete |
448+
| properties | object | The chat properties to delete. |
449449

450450
Returned value:
451451

‎src/pages/management/configuration-api/index.mdx‎

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

‎src/pages/management/configuration-api/v3.7/index.mdx‎

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

‎src/pages/management/webhooks/index.mdx‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ Indicates about a chat coming with a new thread. The webhook payload contains th
5252

5353
#### Webhook payload
5454

55-
| Field | Notes |
56-
| ------ | ----------------------------------------------------------------------- |
57-
| `chat` | [Chat data structure](/messaging/agent-chat-api/data-structures/#chats) |
55+
| Field | Notes |
56+
| ------ | ---------------------------------------------------------------------------- |
57+
| `chat` | The [chat data structure](/messaging/agent-chat-api/data-structures/#chats). |
5858

5959
</Text>
6060

@@ -173,10 +173,10 @@ Indicates about the update of a user's access to a particular chat. It contains
173173

174174
#### Webhook payload
175175

176-
| Field | Notes |
177-
| -------- | -------------------------------------------------------------------------------------------------- |
178-
| `id` | Chat ID |
179-
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.6/data-structures/#access-1) data structure |
176+
| Field | Notes |
177+
| -------- | --------------------------------------------------------------------------------------------------- |
178+
| `id` | The chat ID. |
179+
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.6/data-structures/#access-1) data structure. |
180180

181181
</Text>
182182

@@ -230,12 +230,12 @@ Indicates that a chat was transferred to a different group or to an agent.
230230

231231
#### Webhook payload
232232

233-
| Field | Notes |
234-
| ---------------- | ------------------------------------------------------------------------ |
235-
| `thread_id` | Present if the chat is active. |
236-
| `transferred_to` | IDs of the groups and agents the chat is assigned to after the transfer. |
237-
| `reason` **\*** | Indicates why the chat was transferred. |
238-
| `queue` | Present if the chat is queued after the transfer. |
233+
| Field | Notes |
234+
| ---------------- | ---------------------------------------------------------------------------- |
235+
| `thread_id` | Present if the chat is active. |
236+
| `transferred_to` | The IDs of the groups and agents the chat is assigned to after the transfer. |
237+
| `reason` **\*** | Indicates why the chat was transferred. |
238+
| `queue` | Present if the chat is queued after the transfer. |
239239

240240
**\*)**
241241
Possible reasons: `manual`, `inactive`, `assigned`, `unassigned`, `other`.
@@ -295,9 +295,9 @@ Indicates that a user (customer or agent) was added to a chat.
295295

296296
#### Webhook payload
297297

298-
| Field | Notes |
299-
| ----------- | ------------------------------------ |
300-
| `user_type` | Possible values: `agent`, `customer` |
298+
| Field | Notes |
299+
| ----------- | ------------------------------------- |
300+
| `user_type` | Possible values: `agent`, `customer`. |
301301

302302
</Text>
303303

@@ -354,9 +354,9 @@ Indicates that a user (customer or agent) was removed from a chat.
354354

355355
#### Webhook payload
356356

357-
| Field | Notes |
358-
| ----------- | ------------------------------------ |
359-
| `user_type` | Possible values: `agent`, `customer` |
357+
| Field | Notes |
358+
| ----------- | ------------------------------------- |
359+
| `user_type` | Possible values: `agent`, `customer`. |
360360

361361
</Text>
362362

@@ -855,9 +855,9 @@ Indicates about those event properties that were updated.
855855

856856
#### Webhook payload
857857

858-
| Field | Notes |
859-
| ------------ | --------------------------------------------------------------------------------------------------------------- |
860-
| `properties` | This is not a full `properties` object. This webhook shows only the properties that have been recently updated. |
858+
| Field | Notes |
859+
| ------------ | ------------------------------------------------------------------------------------------------------- |
860+
| `properties` | Not a full `properties` object. This webhook shows only the properties that have been recently updated. |
861861

862862
</Text>
863863

@@ -915,9 +915,9 @@ Indicates about those event properties that were deleted.
915915

916916
#### Webhook payload
917917

918-
| Field | Notes |
919-
| ------------ | --------------------------------------------------------------------------------------------------------------- |
920-
| `properties` | This is not a full `properties` object. This webhook shows only the properties that have been recently updated. |
918+
| Field | Notes |
919+
| ------------ | ------------------------------------------------------------------------------------------------------- |
920+
| `properties` | Not a full `properties` object. This webhook shows only the properties that have been recently updated. |
921921

922922
</Text>
923923

@@ -1077,9 +1077,9 @@ Indicates that an agent's or bot's status has changed.
10771077

10781078
#### Webhook payload
10791079

1080-
| Field | Notes |
1081-
| -------- | ------------------------------------------------------------------------------------ |
1082-
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for Bots only) |
1080+
| Field | Notes |
1081+
| -------- | ------------------------------------------------------------------------------------- |
1082+
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for bots only). |
10831083

10841084
</Text>
10851085

‎src/pages/management/webhooks/v3.7/index.mdx‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ Indicates about a chat coming with a new thread. The webhook payload contains th
5252

5353
#### Webhook payload
5454

55-
| Field | Notes |
56-
| ------ | ----------------------------------------------------------------------- |
57-
| `chat` | [Chat data structure](/messaging/agent-chat-api/data-structures/#chats) |
55+
| Field | Notes |
56+
| ------ | ---------------------------------------------------------------------------- |
57+
| `chat` | The [chat data structure](/messaging/agent-chat-api/data-structures/#chats). |
5858

5959
</Text>
6060

@@ -173,10 +173,10 @@ Indicates about the update of a user's access to a particular chat. It contains
173173

174174
#### Webhook payload
175175

176-
| Field | Notes |
177-
| -------- | -------------------------------------------------------------------------------------------------- |
178-
| `id` | Chat ID |
179-
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.7/data-structures/#access-1) data structure |
176+
| Field | Notes |
177+
| -------- | --------------------------------------------------------------------------------------------------- |
178+
| `id` | The chat ID. |
179+
| `access` | The updated chat [access](/messaging/agent-chat-api/v3.7/data-structures/#access-1) data structure. |
180180

181181
</Text>
182182

@@ -230,12 +230,12 @@ Indicates that a chat was transferred to a different group or to an agent.
230230

231231
#### Webhook payload
232232

233-
| Field | Notes |
234-
| ---------------- | ------------------------------------------------------------------------ |
235-
| `thread_id` | Present if the chat is active. |
236-
| `transferred_to` | IDs of the groups and agents the chat is assigned to after the transfer. |
237-
| `reason` **\*** | Indicates why the chat was transferred. |
238-
| `queue` | Present if the chat is queued after the transfer. |
233+
| Field | Notes |
234+
| ---------------- | ---------------------------------------------------------------------------- |
235+
| `thread_id` | Present if the chat is active. |
236+
| `transferred_to` | The IDs of the groups and agents the chat is assigned to after the transfer. |
237+
| `reason` **\*** | Indicates why the chat was transferred. |
238+
| `queue` | Present if the chat is queued after the transfer. |
239239

240240
**\*)**
241241
Possible reasons: `manual`, `inactive`, `assigned`, `unassigned`, `other`.
@@ -295,9 +295,9 @@ Indicates that a user (customer or agent) was added to a chat.
295295

296296
#### Webhook payload
297297

298-
| Field | Notes |
299-
| ----------- | ------------------------------------ |
300-
| `user_type` | Possible values: `agent`, `customer` |
298+
| Field | Notes |
299+
| ----------- | ------------------------------------- |
300+
| `user_type` | Possible values: `agent`, `customer`. |
301301

302302
</Text>
303303

@@ -354,9 +354,9 @@ Indicates that a user (customer or agent) was removed from a chat.
354354

355355
#### Webhook payload
356356

357-
| Field | Notes |
358-
| ----------- | ------------------------------------ |
359-
| `user_type` | Possible values: `agent`, `customer` |
357+
| Field | Notes |
358+
| ----------- | ------------------------------------- |
359+
| `user_type` | Possible values: `agent`, `customer`. |
360360

361361
</Text>
362362

@@ -1077,9 +1077,9 @@ Indicates that an agent's or bot's status has changed.
10771077

10781078
#### Webhook payload
10791079

1080-
| Field | Notes |
1081-
| -------- | ------------------------------------------------------------------------------------ |
1082-
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for Bots only) |
1080+
| Field | Notes |
1081+
| -------- | ------------------------------------------------------------------------------------- |
1082+
| `status` | Possible values: `accepting chats`, `not accepting chats`, `offline` (for bots only). |
10831083

10841084
</Text>
10851085

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ It is not possible to send a System event in API version 3.6.
410410
| `created_at` | optional | |
411411
| `email` | optional | |
412412
| `email_verified` | optional | Specifies if the customer confirmed their email address. See [Request Email Verification](/messaging/customer-chat-api/v3.6/#request-email-verification). |
413-
| `session_fields` | optional | An array of custom object-enclosed `key:value` pairs. Expires along with the session. |
413+
| `session_fields` | optional | An array of custom object-enclosed key-value pairs. Expires along with the session. |
414414
| `name` | optional | |
415415
| `phone_number` | optional | |
416416
| `events_seen_up_to` | optional | RFC 3339 datetime string |

0 commit comments

Comments
 (0)