crisp-api 10.8.0 → 10.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/EXAMPLES.md +3 -0
- package/README.md +7 -4
- package/dist/crisp.js +1 -1
- package/dist/resources/WebsiteHelpdesk.d.ts +12 -4
- package/dist/resources/WebsiteSettings.d.ts +7 -0
- package/lib/resources/WebsiteHelpdesk.ts +12 -4
- package/lib/resources/WebsiteSettings.ts +7 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
Changelog
|
|
2
2
|
=========
|
|
3
3
|
|
|
4
|
+
## v10.8.2
|
|
5
|
+
|
|
6
|
+
### Changes
|
|
7
|
+
|
|
8
|
+
* Added `mode_initial` and `home` properties on `chatbox` options in website settings.
|
|
9
|
+
|
|
10
|
+
## v10.8.1
|
|
11
|
+
|
|
12
|
+
### Changes
|
|
13
|
+
|
|
14
|
+
* Added `conversations` property on `chatbox` options in website settings.
|
|
15
|
+
|
|
4
16
|
## v10.8.0
|
|
5
17
|
|
|
6
18
|
### New Features
|
package/EXAMPLES.md
CHANGED
|
@@ -1697,6 +1697,7 @@ var settings = {
|
|
|
1697
1697
|
},
|
|
1698
1698
|
"chatbox": {
|
|
1699
1699
|
"tile": "default",
|
|
1700
|
+
"conversations": true,
|
|
1700
1701
|
"wait_game": false,
|
|
1701
1702
|
"website_logo": true,
|
|
1702
1703
|
"last_operator_face": false,
|
|
@@ -1716,6 +1717,8 @@ var settings = {
|
|
|
1716
1717
|
"visitor_compose": false,
|
|
1717
1718
|
"file_transfer": true,
|
|
1718
1719
|
"audio_record": true,
|
|
1720
|
+
"mode_initial": "chat",
|
|
1721
|
+
"home": true,
|
|
1719
1722
|
"overlay_search": true,
|
|
1720
1723
|
"overlay_mode": false,
|
|
1721
1724
|
"helpdesk_link": true,
|
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
|
|
|
6
6
|
|
|
7
7
|
Copyright 2026 Crisp IM SAS. See LICENSE for copying information.
|
|
8
8
|
|
|
9
|
-
* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision:
|
|
9
|
+
* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 29/01/2026
|
|
10
10
|
* **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
@@ -22,7 +22,7 @@ To authenticate against the API, obtain your authentication token keypair by fol
|
|
|
22
22
|
Then, add authentication parameters to your `client` instance right after you create it:
|
|
23
23
|
|
|
24
24
|
```javascript
|
|
25
|
-
var Crisp = require("crisp-api");
|
|
25
|
+
var { Crisp } = require("crisp-api");
|
|
26
26
|
var CrispClient = new Crisp();
|
|
27
27
|
|
|
28
28
|
// Authenticate to API with your plugin token (identifier, key)
|
|
@@ -37,7 +37,7 @@ CrispClient.authenticateTier("plugin", identifier, key);
|
|
|
37
37
|
You may follow the [REST API Quickstart](https://docs.crisp.chat/guides/rest-api/quickstart/) guide, which will get you running with the REST API in minutes.
|
|
38
38
|
|
|
39
39
|
```javascript
|
|
40
|
-
var Crisp = require("crisp-api");
|
|
40
|
+
var { Crisp } = require("crisp-api");
|
|
41
41
|
var CrispClient = new Crisp();
|
|
42
42
|
|
|
43
43
|
CrispClient.authenticateTier("plugin", identifier, key);
|
|
@@ -56,7 +56,7 @@ CrispClient.website.listConversations(websiteID, 1)
|
|
|
56
56
|
### Create your own bot!
|
|
57
57
|
|
|
58
58
|
```javascript
|
|
59
|
-
var Crisp = require("crisp-api");
|
|
59
|
+
var { Crisp } = require("crisp-api");
|
|
60
60
|
var CrispClient = new Crisp();
|
|
61
61
|
|
|
62
62
|
CrispClient.authenticateTier("plugin", identifier, key);
|
|
@@ -2472,6 +2472,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2472
2472
|
},
|
|
2473
2473
|
"chatbox": {
|
|
2474
2474
|
"tile": "default",
|
|
2475
|
+
"conversations": true,
|
|
2475
2476
|
"wait_game": false,
|
|
2476
2477
|
"website_logo": true,
|
|
2477
2478
|
"last_operator_face": false,
|
|
@@ -2491,6 +2492,8 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
|
|
|
2491
2492
|
"visitor_compose": false,
|
|
2492
2493
|
"file_transfer": true,
|
|
2493
2494
|
"audio_record": true,
|
|
2495
|
+
"mode_initial": "chat",
|
|
2496
|
+
"home": true,
|
|
2494
2497
|
"overlay_search": true,
|
|
2495
2498
|
"overlay_mode": false,
|
|
2496
2499
|
"helpdesk_link": true,
|
package/dist/crisp.js
CHANGED
|
@@ -21,11 +21,19 @@ export interface HelpdeskLocale {
|
|
|
21
21
|
categories?: number;
|
|
22
22
|
}
|
|
23
23
|
export interface HelpdeskLocaleArticle {
|
|
24
|
-
|
|
25
|
-
|
|
24
|
+
article_id?: string;
|
|
25
|
+
title?: string;
|
|
26
|
+
description?: string | null;
|
|
27
|
+
content?: string;
|
|
28
|
+
status?: "published" | "draft";
|
|
29
|
+
visibility?: "visible" | "hidden";
|
|
30
|
+
featured?: boolean;
|
|
31
|
+
visits?: number;
|
|
32
|
+
order?: number;
|
|
26
33
|
url?: string;
|
|
27
|
-
|
|
28
|
-
|
|
34
|
+
created_at?: number;
|
|
35
|
+
updated_at?: number;
|
|
36
|
+
published_at?: number;
|
|
29
37
|
}
|
|
30
38
|
export interface HelpdeskLocaleArticleCategory {
|
|
31
39
|
category_id?: string;
|
|
@@ -41,6 +41,7 @@ export interface WebsiteSettingsEmails {
|
|
|
41
41
|
}
|
|
42
42
|
export interface WebsiteSettingsChatbox {
|
|
43
43
|
tile?: string;
|
|
44
|
+
conversations?: boolean;
|
|
44
45
|
wait_game?: boolean;
|
|
45
46
|
website_logo?: boolean;
|
|
46
47
|
last_operator_face?: boolean;
|
|
@@ -60,6 +61,8 @@ export interface WebsiteSettingsChatbox {
|
|
|
60
61
|
visitor_compose?: boolean;
|
|
61
62
|
file_transfer?: boolean;
|
|
62
63
|
audio_record?: boolean;
|
|
64
|
+
mode_initial?: string;
|
|
65
|
+
home?: boolean;
|
|
63
66
|
overlay_search?: boolean;
|
|
64
67
|
overlay_mode?: boolean;
|
|
65
68
|
helpdesk_link?: boolean;
|
|
@@ -77,6 +80,7 @@ export interface WebsiteSettingsChatbox {
|
|
|
77
80
|
blocked_pages?: string[];
|
|
78
81
|
blocked_countries?: string[];
|
|
79
82
|
blocked_locales?: string[];
|
|
83
|
+
blocked_ips?: string[];
|
|
80
84
|
}
|
|
81
85
|
export interface WebsiteSettingsUpdate {
|
|
82
86
|
websiteID?: string;
|
|
@@ -114,6 +118,7 @@ export interface WebsiteSettingsUpdateEmails {
|
|
|
114
118
|
}
|
|
115
119
|
export interface WebsiteSettingsUpdateChatbox {
|
|
116
120
|
tile?: string;
|
|
121
|
+
conversations?: boolean;
|
|
117
122
|
wait_game?: boolean;
|
|
118
123
|
website_logo?: boolean;
|
|
119
124
|
last_operator_face?: boolean;
|
|
@@ -133,6 +138,8 @@ export interface WebsiteSettingsUpdateChatbox {
|
|
|
133
138
|
visitor_compose?: boolean;
|
|
134
139
|
file_transfer?: boolean;
|
|
135
140
|
audio_record?: boolean;
|
|
141
|
+
mode_initial?: string;
|
|
142
|
+
home?: boolean;
|
|
136
143
|
overlay_search?: boolean;
|
|
137
144
|
overlay_mode?: boolean;
|
|
138
145
|
helpdesk_link?: boolean;
|
|
@@ -35,11 +35,19 @@ export interface HelpdeskLocale {
|
|
|
35
35
|
}
|
|
36
36
|
|
|
37
37
|
export interface HelpdeskLocaleArticle {
|
|
38
|
-
|
|
39
|
-
|
|
38
|
+
article_id?: string;
|
|
39
|
+
title?: string;
|
|
40
|
+
description?: string | null;
|
|
41
|
+
content?: string;
|
|
42
|
+
status?: "published" | "draft";
|
|
43
|
+
visibility?: "visible" | "hidden";
|
|
44
|
+
featured?: boolean;
|
|
45
|
+
visits?: number;
|
|
46
|
+
order?: number;
|
|
40
47
|
url?: string;
|
|
41
|
-
|
|
42
|
-
|
|
48
|
+
created_at?: number;
|
|
49
|
+
updated_at?: number;
|
|
50
|
+
published_at?: number;
|
|
43
51
|
}
|
|
44
52
|
|
|
45
53
|
export interface HelpdeskLocaleArticleCategory {
|
|
@@ -57,6 +57,7 @@ export interface WebsiteSettingsEmails {
|
|
|
57
57
|
|
|
58
58
|
export interface WebsiteSettingsChatbox {
|
|
59
59
|
tile?: string;
|
|
60
|
+
conversations?: boolean;
|
|
60
61
|
wait_game?: boolean;
|
|
61
62
|
website_logo?: boolean;
|
|
62
63
|
last_operator_face?: boolean;
|
|
@@ -76,6 +77,8 @@ export interface WebsiteSettingsChatbox {
|
|
|
76
77
|
visitor_compose?: boolean;
|
|
77
78
|
file_transfer?: boolean;
|
|
78
79
|
audio_record?: boolean;
|
|
80
|
+
mode_initial?: string;
|
|
81
|
+
home?: boolean;
|
|
79
82
|
overlay_search?: boolean;
|
|
80
83
|
overlay_mode?: boolean;
|
|
81
84
|
helpdesk_link?: boolean;
|
|
@@ -93,6 +96,7 @@ export interface WebsiteSettingsChatbox {
|
|
|
93
96
|
blocked_pages?: string[];
|
|
94
97
|
blocked_countries?: string[];
|
|
95
98
|
blocked_locales?: string[];
|
|
99
|
+
blocked_ips?: string[];
|
|
96
100
|
}
|
|
97
101
|
|
|
98
102
|
export interface WebsiteSettingsUpdate {
|
|
@@ -136,6 +140,7 @@ export interface WebsiteSettingsUpdateEmails {
|
|
|
136
140
|
|
|
137
141
|
export interface WebsiteSettingsUpdateChatbox {
|
|
138
142
|
tile?: string;
|
|
143
|
+
conversations?: boolean;
|
|
139
144
|
wait_game?: boolean;
|
|
140
145
|
website_logo?: boolean;
|
|
141
146
|
last_operator_face?: boolean;
|
|
@@ -155,6 +160,8 @@ export interface WebsiteSettingsUpdateChatbox {
|
|
|
155
160
|
visitor_compose?: boolean;
|
|
156
161
|
file_transfer?: boolean;
|
|
157
162
|
audio_record?: boolean;
|
|
163
|
+
mode_initial?: string;
|
|
164
|
+
home?: boolean;
|
|
158
165
|
overlay_search?: boolean;
|
|
159
166
|
overlay_mode?: boolean;
|
|
160
167
|
helpdesk_link?: boolean;
|
package/package.json
CHANGED