Skip to content

Commit fc5760c

Browse files
oliwiapolecoliwiapolec
authored
feat(docs): add Customer Chat API guide
1 parent 2847cf4 commit fc5760c

File tree

51 files changed

+817
-193
lines changed

Some content is hidden

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

51 files changed

+817
-193
lines changed

‎_redirects‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@
6363
/extending-chat-widget/visitor-sdk/* /docs/extending-chat-widget/customer-sdk/:splat 301
6464
/messaging/chat-sdk/* /docs/messaging/node-sdk/:splat 301
6565
/monetization/partner-program-api/* /docs/partner-program/partner-api/:splat 301
66+
/getting-started/app-guides/* /docs/guides/console-guides/:splat 301
67+
/app-guides/* /docs/guides/console-guides/:splat 301
68+
/monetization/app-webhooks/* /docs/guides/console-guides/app-webhooks/:splat 301
6669

6770
# Redirect images so can work on netlify and /docs domain
6871
/docs/images/* /images/:splat 200

‎src/assets/icons/Videos.js‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
export const VideosIcon = ({ fill = "#1B1B20", ...rest }) => (
2+
<svg
3+
width="24"
4+
height="24"
5+
viewBox="0 0 24 24"
6+
fill="none"
7+
xmlns="http://www.w3.org/2000/svg"
8+
{...rest}
9+
>
10+
<g clipPath="url(#clip0_2_4746)">
11+
<path
12+
d="M18 4H6C4.89543 4 4 4.89543 4 6V18C4 19.1046 4.89543 20 6 20H18C19.1046 20 20 19.1046 20 18V6C20 4.89543 19.1046 4 18 4Z"
13+
stroke={fill}
14+
strokeWidth="2"
15+
strokeLinecap="round"
16+
strokeLinejoin="round"
17+
/>
18+
<path
19+
d="M8 4V20"
20+
stroke={fill}
21+
strokeWidth="2"
22+
strokeLinecap="round"
23+
strokeLinejoin="round"
24+
/>
25+
<path
26+
d="M16 4V20"
27+
stroke={fill}
28+
strokeWidth="2"
29+
strokeLinecap="round"
30+
strokeLinejoin="round"
31+
/>
32+
<path
33+
d="M4 8H8"
34+
stroke={fill}
35+
strokeWidth="2"
36+
strokeLinecap="round"
37+
strokeLinejoin="round"
38+
/>
39+
<path
40+
d="M4 16H8"
41+
stroke={fill}
42+
strokeWidth="2"
43+
strokeLinecap="round"
44+
strokeLinejoin="round"
45+
/>
46+
<path
47+
d="M4 12H20"
48+
stroke={fill}
49+
strokeWidth="2"
50+
strokeLinecap="round"
51+
strokeLinejoin="round"
52+
/>
53+
<path
54+
d="M16 8H20"
55+
stroke={fill}
56+
strokeWidth="2"
57+
strokeLinecap="round"
58+
strokeLinejoin="round"
59+
/>
60+
<path
61+
d="M16 16H20"
62+
stroke={fill}
63+
strokeWidth="2"
64+
strokeLinecap="round"
65+
strokeLinejoin="round"
66+
/>
67+
</g>
68+
<defs>
69+
<clipPath id="clip0_2_4746">
70+
<rect width="24" height="24" fill="white" />
71+
</clipPath>
72+
</defs>
73+
</svg>
74+
);

‎src/assets/icons/cards/Guides.js‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
export const GuidesIcon = ({ fill, background, ...rest }) => (
2+
<svg
3+
width="30"
4+
height="30"
5+
viewBox="0 0 30 30"
6+
fill="none"
7+
xmlns="http://www.w3.org/2000/svg"
8+
{...rest}
9+
>
10+
<rect width="30" height="30" rx="4" fill={background || "#328DFF"} />
11+
<g clipPath="url(#clip0_4028_587)">
12+
<path
13+
d="M25 12L15 8L5 12L15 16L25 12ZM25 12V18"
14+
stroke={fill || "white"}
15+
strokeWidth="2"
16+
strokeLinecap="round"
17+
strokeLinejoin="round"
18+
/>
19+
<path
20+
d="M9 13.6V19C9 19.7957 9.63214 20.5587 10.7574 21.1213C11.8826 21.6839 13.4087 22 15 22C16.5913 22 18.1174 21.6839 19.2426 21.1213C20.3679 20.5587 21 19.7957 21 19V13.6"
21+
stroke={fill || "white"}
22+
strokeWidth="2"
23+
strokeLinecap="round"
24+
strokeLinejoin="round"
25+
/>
26+
</g>
27+
<defs>
28+
<clipPath id="clip0_4028_587">
29+
<rect width="24" height="24" fill="white" transform="translate(3 3)" />
30+
</clipPath>
31+
</defs>
32+
</svg>
33+
);

‎src/components/core/Navbar/Resources.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import Connect from "./Connect";
1111

1212
const Wrapper = styled.div`
1313
display: flex;
14-
height: 400px;
14+
height: 450px;
1515
> div {
1616
margin: 8px 0px;
1717
}

‎src/configs/containers.json‎

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,18 @@
66
"slug": "/getting-started/",
77
"title": "Platform Overview"
88
},
9-
{
10-
"slug": "/getting-started/installing-livechat",
11-
"title": "Installing LiveChat"
12-
},
13-
{
14-
"slug": "/getting-started/livechat-apps",
15-
"title": "LiveChat Apps"
16-
},
17-
{
18-
"slug": "/getting-started/helpdesk-apps",
19-
"title": "HelpDesk Apps"
20-
},
21-
{
22-
"slug": "/getting-started/app-guides",
23-
"title": "App Guides"
24-
},
259
{
2610
"slug": "/getting-started/api-pricing",
2711
"title": "API Pricing"
2812
},
2913
{
30-
"slug": "/getting-started/developer-sdk",
31-
"title": "Developer SDK"
14+
"slug": "/getting-started/developer-sdk",
15+
"title": "Developer SDK"
3216
},
3317
{
3418
"slug": "/getting-started/developer-cli",
3519
"title": "Developer CLI"
36-
}
20+
}
3721
]
3822
},
3923
{
@@ -75,7 +59,6 @@
7559
"slug": "/messaging/references",
7660
"title": "References"
7761
}
78-
7962
]
8063
},
8164
{
@@ -164,5 +147,38 @@
164147
{
165148
"category": "partner-program",
166149
"items": []
150+
},
151+
{
152+
"category": "helpdesk",
153+
"items": []
154+
},
155+
{
156+
"category": "guides",
157+
"items": [
158+
{
159+
"slug": "/guides/",
160+
"title": "Guides and tutorials"
161+
},
162+
{
163+
"slug": "/guides/installing-livechat",
164+
"title": "Installing LiveChat"
165+
},
166+
{
167+
"slug": "/guides/livechat-apps",
168+
"title": "LiveChat Apps"
169+
},
170+
{
171+
"slug": "/guides/helpdesk-apps",
172+
"title": "HelpDesk Apps"
173+
},
174+
{
175+
"slug": "/guides/api-guides",
176+
"title": "API Guides"
177+
},
178+
{
179+
"slug": "/guides/console-guides",
180+
"title": "Console Guides"
181+
}
182+
]
167183
}
168184
]

‎src/constants/cards.js‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,15 @@ import { TextApiIcon } from "assets/icons/cards/TextAPI";
1111
import { BeginnerPathIcon } from "assets/icons/cards/BeginnerPath";
1212
import { AdvancedPathIcon } from "assets/icons/cards/AdvancedPath";
1313
import { PartnerApiIcon } from "assets/icons/cards/PartnerAPI";
14+
import { GuidesIcon } from "assets/icons/cards/Guides";
1415

1516
export const cards = [
17+
{
18+
title: "Guides and tutorials",
19+
link: "/guides",
20+
copy: "Step-by-step explainers for using APIs and the Text Platform.",
21+
image: <GuidesIcon />,
22+
},
1623
{
1724
title: "Messaging",
1825
link: "/messaging",
@@ -26,7 +33,7 @@ export const cards = [
2633
image: <ManagementIcon />,
2734
},
2835
{
29-
title: "Data & Reporting",
36+
title: "Data and Reporting",
3037
link: "/data-reporting",
3138
copy: "Extract data to build custom reports and dashboards.",
3239
image: <DataReportingIcon />,
@@ -45,7 +52,7 @@ export const cards = [
4552
},
4653
{
4754
title: "HelpDesk API",
48-
link: "/getting-started/helpdesk-apps/helpdesk-api",
55+
link: "/helpdesk",
4956
copy: "Build integration for our ticketing system, HelpDesk.",
5057
image: <HelpDeskApiIcon />,
5158
},
@@ -63,7 +70,7 @@ export const cards = [
6370
},
6471
{
6572
title: "Developer Console Guides",
66-
link: "/getting-started/app-guides",
73+
link: "/guides/console-guides",
6774
copy: "Learn how to configure your app with Developer Console tools.",
6875
image: <DevConsoleToolsIcon />,
6976
},
@@ -92,15 +99,15 @@ export const devPaths = [
9299
name: "Platform Overview",
93100
},
94101
{
95-
link: "/getting-started/app-guides",
96-
name: "App Guides",
102+
link: "/guides/console-guides",
103+
name: "Console Guides",
97104
},
98105
{
99-
link: "/getting-started/livechat-apps",
106+
link: "/guides/livechat-apps",
100107
name: "Building LiveChat apps",
101108
},
102109
{
103-
link: "/getting-started/helpdesk-apps",
110+
link: "/guides/helpdesk-apps",
104111
name: "Building HelpDesk apps",
105112
},
106113
{

‎src/constants/header.js‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import { AuthorizationIcon } from "assets/icons/cards/Authorization";
1414
import { MonetizationIcon } from "assets/icons/cards/Monetization";
1515
import { GettingStartedIcon } from "assets/icons/cards/GettingStarted";
1616
import { TextApiIcon } from "assets/icons/cards/TextAPI";
17+
import { VideosIcon } from "assets/icons/Videos";
1718

1819
export const apis = [
1920
{
@@ -134,7 +135,7 @@ export const platform = {
134135
{
135136
title: "HelpDesk API",
136137
description: "Integrate with HelpDesk",
137-
link: "/getting-started/helpdesk-apps/helpdesk-api",
138+
link: "/helpdesk",
138139
primaryIcon: <HelpDeskApiIcon fill="#2FC774" />,
139140
secondaryIcon: <HelpDeskApiIcon fill="#ffffff" background="#4a4a55" />,
140141
},
@@ -154,17 +155,16 @@ export const resources = [
154155
description: "Ready-to-use components",
155156
link: "https://design.livechat.com/",
156157
},
158+
{
159+
title: "Guides and tutorials",
160+
description: "Step-by-step explainers",
161+
link: "https://platform.text.com/docs/guides",
162+
},
157163
{
158164
title: "Figma templates",
159165
description: "Visual assets for the Marketplace",
160166
link: "https://www.figma.com/community/file/1192489623743762740",
161167
},
162-
{
163-
title: "Video tutorials",
164-
description: "Tutorials, courses, webinars",
165-
link:
166-
"https://www.youtube.com/watch?v=NVBthQxCZqY&list=PL7llGGeQNj4z8Up8tmq8JKThsVoq1XL-u&ab_channel=LiveChatInsider",
167-
},
168168
{
169169
title: "Developer CLI",
170170
description: "Build apps from the command line",
@@ -185,6 +185,13 @@ export const connects = [
185185
primaryIcon: <UpdatesIcon />,
186186
secondaryIcon: <UpdatesIcon fill="#ffffff" />,
187187
},
188+
{
189+
title: "Video tutorials",
190+
link:
191+
"https://www.youtube.com/watch?v=NVBthQxCZqY&list=PL7llGGeQNj4z8Up8tmq8JKThsVoq1XL-u&ab_channel=LiveChatInsider",
192+
primaryIcon: <VideosIcon />,
193+
secondaryIcon: <VideosIcon fill="#ffffff" />,
194+
},
188195
{
189196
title: "Discord",
190197
link: process.env.NEXT_PUBLIC_DISCORD_FOOTER_URL,

‎src/pages/authorization/agent-authorization/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ const get_customers = () => {
238238

239239
</CodeSample>
240240

241-
To make it work, run this app on localhost or [deploy it to Firebase](/getting-started/livechat-apps/#creating-livechat-apps) to host it. Update `index.html` with your own `redirectUri` (link to your app) and `clientId`.
241+
To make it work, run this app on localhost or [deploy it to Firebase](/guides/livechat-apps/#creating-livechat-apps) to host it. Update `index.html` with your own `redirectUri` (link to your app) and `clientId`.
242242
Make sure to use the exact same Redirect URI in Developer Console. Also, to use the **Get Customers** method, your app needs the `customers:ro` scope, which you should select in Developer Console.
243243
When everything is ready, install the app privately for your license.
244244

‎src/pages/authorization/authorization-in-practice/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Together, we'll go through the following steps:
2626
Make sure you have:
2727

2828
- a LiveChat Owner or Admin account. <a href="https://accounts.livechat.com" target="_blank">Sign up</a> for free if you don't have it.
29-
- a **server-side application** in Developer Console. [Find out how to create one.](/getting-started/livechat-apps/#creating-livechat-apps)
29+
- a **server-side application** in Developer Console. [Find out how to create one.](/guides/livechat-apps/#creating-livechat-apps)
3030
- correct **scopes** for the selected method. [See documentation.](/messaging/agent-chat-api#list-chats)
3131
- any tool that will allow you to send requests (Postman, terminal, etc.)
3232

‎src/pages/authorization/authorizing-api-calls/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Decide which authorization flow to choose based on your use case.
3434
| **Building public server-side apps** | [Sign in with LiveChat](/authorization/sign-in-with-livechat), [Authorization code grant](/authorization/agent-authorization#authorization-code-grant) |
3535
| **Building private server-side apps** | [Personal Access Tokens](/authorization/agent-authorization#personal-access-tokens) for the personal use of the app, [Sign in with LiveChat](/authorization/sign-in-with-livechat) or [Authorization code grant](/authorization/agent-authorization#authorization-code-grant) for all agents within a license |
3636

37-
Read more about [creating LiveChat apps](/getting-started/livechat-apps/#creating-livechat-apps) or go straight to <a href="https://platform.text.com/console/" target="_blank" rel="noopener noreferrer">Developer Console</a> and start building.
37+
Read more about [creating LiveChat apps](/guides/livechat-apps/#creating-livechat-apps) or go straight to <a href="https://platform.text.com/console/" target="_blank" rel="noopener noreferrer">Developer Console</a> and start building.
3838

3939
## Postman collection
4040

0 commit comments

Comments
 (0)