intercom-client 2.11.0 → 3.0.0
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/README.md +873 -396
- package/dist/admin/admin.types.d.ts +13 -0
- package/dist/admin/admin.types.d.ts.map +1 -0
- package/dist/admin/admin.types.js +3 -0
- package/dist/admin/admin.types.js.map +1 -0
- package/dist/admin.d.ts +48 -0
- package/dist/admin.d.ts.map +1 -0
- package/dist/admin.js +40 -41
- package/dist/admin.js.map +1 -0
- package/dist/client.d.ts +67 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +230 -239
- package/dist/client.js.map +1 -0
- package/dist/common/common.types.d.ts +91 -0
- package/dist/common/common.types.d.ts.map +1 -0
- package/dist/common/common.types.js +29 -0
- package/dist/common/common.types.js.map +1 -0
- package/dist/company/company.types.d.ts +37 -0
- package/dist/company/company.types.d.ts.map +1 -0
- package/dist/company/company.types.js +3 -0
- package/dist/company/company.types.js.map +1 -0
- package/dist/company.d.ts +67 -0
- package/dist/company.d.ts.map +1 -0
- package/dist/company.js +110 -83
- package/dist/company.js.map +1 -0
- package/dist/contact/contact.types.d.ts +80 -0
- package/dist/contact/contact.types.d.ts.map +1 -0
- package/dist/contact/contact.types.js +3 -0
- package/dist/contact/contact.types.js.map +1 -0
- package/dist/contact.d.ts +130 -0
- package/dist/contact.d.ts.map +1 -0
- package/dist/contact.js +155 -81
- package/dist/contact.js.map +1 -0
- package/dist/conversation/conversation.types.d.ts +144 -0
- package/dist/conversation/conversation.types.d.ts.map +1 -0
- package/dist/conversation/conversation.types.js +50 -0
- package/dist/conversation/conversation.types.js.map +1 -0
- package/dist/conversation.d.ts +176 -0
- package/dist/conversation.d.ts.map +1 -0
- package/dist/conversation.js +287 -48
- package/dist/conversation.js.map +1 -0
- package/dist/dataAttribute/dataAttribute.types.d.ts +32 -0
- package/dist/dataAttribute/dataAttribute.types.d.ts.map +1 -0
- package/dist/dataAttribute/dataAttribute.types.js +18 -0
- package/dist/dataAttribute/dataAttribute.types.js.map +1 -0
- package/dist/dataAttribute.d.ts +33 -0
- package/dist/dataAttribute.d.ts.map +1 -0
- package/dist/dataAttribute.js +49 -0
- package/dist/dataAttribute.js.map +1 -0
- package/dist/errors/badResponse.error.d.ts +9 -0
- package/dist/errors/badResponse.error.d.ts.map +1 -0
- package/dist/errors/badResponse.error.js +21 -0
- package/dist/errors/badResponse.error.js.map +1 -0
- package/dist/event/event.types.d.ts +29 -0
- package/dist/event/event.types.d.ts.map +1 -0
- package/dist/event/event.types.js +3 -0
- package/dist/event/event.types.js.map +1 -0
- package/dist/event.d.ts +41 -0
- package/dist/event.d.ts.map +1 -0
- package/dist/event.js +42 -45
- package/dist/event.js.map +1 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +25 -76
- package/dist/index.js.map +1 -0
- package/dist/message/message.types.d.ts +17 -0
- package/dist/message/message.types.d.ts.map +1 -0
- package/dist/message/message.types.js +11 -0
- package/dist/message/message.types.js.map +1 -0
- package/dist/message.d.ts +30 -0
- package/dist/message.d.ts.map +1 -0
- package/dist/message.js +32 -31
- package/dist/message.js.map +1 -0
- package/dist/scroll.d.ts +24 -0
- package/dist/scroll.d.ts.map +1 -0
- package/dist/scroll.js +67 -79
- package/dist/scroll.js.map +1 -0
- package/dist/segment/segment.types.d.ts +11 -0
- package/dist/segment/segment.types.d.ts.map +1 -0
- package/dist/segment/segment.types.js +3 -0
- package/dist/segment/segment.types.js.map +1 -0
- package/dist/segment.d.ts +22 -0
- package/dist/segment.d.ts.map +1 -0
- package/dist/segment.js +26 -36
- package/dist/segment.js.map +1 -0
- package/dist/subscription/subscription.types.d.ts +19 -0
- package/dist/subscription/subscription.types.d.ts.map +1 -0
- package/dist/subscription/subscription.types.js +10 -0
- package/dist/subscription/subscription.types.js.map +1 -0
- package/dist/tag/tag.types.d.ts +6 -0
- package/dist/tag/tag.types.d.ts.map +1 -0
- package/dist/tag/tag.types.js +3 -0
- package/dist/tag/tag.types.js.map +1 -0
- package/dist/tag.d.ts +52 -0
- package/dist/tag.d.ts.map +1 -0
- package/dist/tag.js +93 -57
- package/dist/tag.js.map +1 -0
- package/dist/team/team.types.d.ts +7 -0
- package/dist/team/team.types.d.ts.map +1 -0
- package/dist/team/team.types.js +3 -0
- package/dist/team/team.types.js.map +1 -0
- package/dist/team.d.ts +18 -0
- package/dist/team.d.ts.map +1 -0
- package/dist/team.js +23 -0
- package/dist/team.js.map +1 -0
- package/dist/util/time.d.ts +3 -0
- package/dist/util/time.d.ts.map +1 -0
- package/dist/util/time.js +6 -0
- package/dist/util/time.js.map +1 -0
- package/dist/util/url.d.ts +3 -0
- package/dist/util/url.d.ts.map +1 -0
- package/dist/util/url.js +9 -0
- package/dist/util/url.js.map +1 -0
- package/package.json +57 -48
- package/dist/bulk.js +0 -55
- package/dist/counts.js +0 -88
- package/dist/customer.js +0 -33
- package/dist/note.js +0 -43
- package/dist/snippet.js +0 -121
- package/dist/user-data.js +0 -105
- package/dist/user.js +0 -120
- package/dist/visitor.js +0 -54
package/dist/contact.js
CHANGED
|
@@ -1,83 +1,157 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
|
|
11
|
-
|
|
12
|
-
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
|
|
13
|
-
|
|
14
|
-
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
|
|
15
|
-
|
|
16
|
-
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
|
|
17
|
-
|
|
18
|
-
var Contact =
|
|
19
|
-
/*#__PURE__*/
|
|
20
|
-
function () {
|
|
21
|
-
function Contact(client) {
|
|
22
|
-
_classCallCheck(this, Contact);
|
|
23
|
-
|
|
24
|
-
this.client = client;
|
|
25
|
-
this.scroll = new _scroll["default"](this.client, 'contact');
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
_createClass(Contact, [{
|
|
29
|
-
key: "create",
|
|
30
|
-
value: function create() {
|
|
31
|
-
var parameters_or_function = arguments[0];
|
|
32
|
-
var params = {};
|
|
33
|
-
var callback = parameters_or_function;
|
|
34
|
-
|
|
35
|
-
if (typeof parameters_or_function !== 'function') {
|
|
36
|
-
params = parameters_or_function;
|
|
37
|
-
callback = arguments[1];
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
return this.client.post('/contacts', params, callback);
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SearchContactOrderBy = void 0;
|
|
4
|
+
var common_types_1 = require("./common/common.types");
|
|
5
|
+
var Contact = /** @class */ (function () {
|
|
6
|
+
function Contact(client) {
|
|
7
|
+
this.client = client;
|
|
8
|
+
this.baseUrl = 'contacts';
|
|
9
|
+
this.client = client;
|
|
41
10
|
}
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
11
|
+
Contact.prototype.createUser = function (_a) {
|
|
12
|
+
var externalId = _a.externalId, phone = _a.phone, name = _a.name, avatar = _a.avatar, signedUpAt = _a.signedUpAt, lastSeenAt = _a.lastSeenAt, ownerId = _a.ownerId, isUnsubscribedFromEmails = _a.isUnsubscribedFromEmails, customAttributes = _a.customAttributes;
|
|
13
|
+
var requestData = {
|
|
14
|
+
role: common_types_1.Role.USER,
|
|
15
|
+
external_id: externalId,
|
|
16
|
+
phone: phone,
|
|
17
|
+
name: name,
|
|
18
|
+
avatar: avatar,
|
|
19
|
+
signed_up_at: signedUpAt,
|
|
20
|
+
last_seen_at: lastSeenAt,
|
|
21
|
+
owner_id: ownerId,
|
|
22
|
+
unsubscribed_from_emails: isUnsubscribedFromEmails,
|
|
23
|
+
custom_attributes: customAttributes,
|
|
24
|
+
};
|
|
25
|
+
return this.client.post({
|
|
26
|
+
url: "/".concat(this.baseUrl),
|
|
27
|
+
data: requestData,
|
|
28
|
+
});
|
|
29
|
+
};
|
|
30
|
+
Contact.prototype.createLead = function (data) {
|
|
31
|
+
var requestData = {
|
|
32
|
+
role: common_types_1.Role.LEAD,
|
|
33
|
+
phone: data === null || data === void 0 ? void 0 : data.phone,
|
|
34
|
+
name: data === null || data === void 0 ? void 0 : data.name,
|
|
35
|
+
avatar: data === null || data === void 0 ? void 0 : data.avatar,
|
|
36
|
+
signed_up_at: data === null || data === void 0 ? void 0 : data.signedUpAt,
|
|
37
|
+
last_seen_at: data === null || data === void 0 ? void 0 : data.lastSeenAt,
|
|
38
|
+
owner_id: data === null || data === void 0 ? void 0 : data.ownerId,
|
|
39
|
+
unsubscribed_from_emails: data === null || data === void 0 ? void 0 : data.isUnsubscribedFromMails,
|
|
40
|
+
custom_attributes: data === null || data === void 0 ? void 0 : data.customAttributes,
|
|
41
|
+
};
|
|
42
|
+
return this.client.post({
|
|
43
|
+
url: "/".concat(this.baseUrl),
|
|
44
|
+
data: requestData,
|
|
45
|
+
});
|
|
46
|
+
};
|
|
47
|
+
Contact.prototype.find = function (_a) {
|
|
48
|
+
var id = _a.id;
|
|
49
|
+
return this.client.get({
|
|
50
|
+
url: "/".concat(this.baseUrl, "/").concat(id),
|
|
51
|
+
});
|
|
52
|
+
};
|
|
53
|
+
Contact.prototype.update = function (_a) {
|
|
54
|
+
var id = _a.id, role = _a.role, externalId = _a.externalId, phone = _a.phone, name = _a.name, avatar = _a.avatar, signedUpAt = _a.signedUpAt, lastSeenAt = _a.lastSeenAt, ownerId = _a.ownerId, isUnsubscribedFromMails = _a.isUnsubscribedFromMails, customAttributes = _a.customAttributes;
|
|
55
|
+
var data = {
|
|
56
|
+
role: role,
|
|
57
|
+
external_id: externalId,
|
|
58
|
+
phone: phone,
|
|
59
|
+
name: name,
|
|
60
|
+
avatar: avatar,
|
|
61
|
+
signed_up_at: signedUpAt,
|
|
62
|
+
last_seen_at: lastSeenAt,
|
|
63
|
+
owner_id: ownerId,
|
|
64
|
+
unsubscribed_from_emails: isUnsubscribedFromMails,
|
|
65
|
+
custom_attributes: customAttributes,
|
|
66
|
+
};
|
|
67
|
+
return this.client.put({
|
|
68
|
+
url: "/".concat(this.baseUrl, "/").concat(id),
|
|
69
|
+
data: data,
|
|
70
|
+
});
|
|
71
|
+
};
|
|
72
|
+
Contact.prototype.mergeLeadInUser = function (_a) {
|
|
73
|
+
var leadId = _a.leadId, userId = _a.userId;
|
|
74
|
+
var data = {
|
|
75
|
+
from: leadId,
|
|
76
|
+
into: userId,
|
|
77
|
+
};
|
|
78
|
+
return this.client.post({
|
|
79
|
+
url: "/".concat(this.baseUrl, "/merge"),
|
|
80
|
+
data: data,
|
|
81
|
+
});
|
|
82
|
+
};
|
|
83
|
+
Contact.prototype.search = function (_a) {
|
|
84
|
+
var data = _a.data;
|
|
85
|
+
return this.client.post({
|
|
86
|
+
url: "/".concat(this.baseUrl, "/search"),
|
|
87
|
+
data: data,
|
|
88
|
+
});
|
|
89
|
+
};
|
|
90
|
+
Contact.prototype.list = function (_a) {
|
|
91
|
+
var perPage = _a.perPage, startingAfter = _a.startingAfter;
|
|
92
|
+
var params = {
|
|
93
|
+
per_page: perPage,
|
|
94
|
+
starting_after: startingAfter,
|
|
95
|
+
};
|
|
96
|
+
return this.client.get({
|
|
97
|
+
url: "/".concat(this.baseUrl),
|
|
98
|
+
params: params,
|
|
99
|
+
});
|
|
100
|
+
};
|
|
101
|
+
Contact.prototype.delete = function (_a) {
|
|
102
|
+
var id = _a.id;
|
|
103
|
+
return this.client.delete({
|
|
104
|
+
url: "/".concat(this.baseUrl, "/").concat(id),
|
|
105
|
+
});
|
|
106
|
+
};
|
|
107
|
+
Contact.prototype.archive = function (_a) {
|
|
108
|
+
var id = _a.id;
|
|
109
|
+
return this.client.post({
|
|
110
|
+
url: "/".concat(this.baseUrl, "/").concat(id, "/archive"),
|
|
111
|
+
});
|
|
112
|
+
};
|
|
113
|
+
Contact.prototype.unarchive = function (_a) {
|
|
114
|
+
var id = _a.id;
|
|
115
|
+
return this.client.post({
|
|
116
|
+
url: "/".concat(this.baseUrl, "/").concat(id, "/unarchive"),
|
|
117
|
+
});
|
|
118
|
+
};
|
|
119
|
+
Contact.prototype.listAttachedCompanies = function (_a) {
|
|
120
|
+
var id = _a.id, perPage = _a.perPage, page = _a.page;
|
|
121
|
+
var params = {
|
|
122
|
+
per_page: perPage,
|
|
123
|
+
page: page,
|
|
124
|
+
};
|
|
125
|
+
return this.client.get({
|
|
126
|
+
url: "/".concat(this.baseUrl, "/").concat(id, "/companies"),
|
|
127
|
+
params: params,
|
|
128
|
+
});
|
|
129
|
+
};
|
|
130
|
+
Contact.prototype.listAttachedTags = function (_a) {
|
|
131
|
+
var id = _a.id;
|
|
132
|
+
return this.client.get({
|
|
133
|
+
url: "/".concat(this.baseUrl, "/").concat(id, "/tags"),
|
|
134
|
+
});
|
|
135
|
+
};
|
|
136
|
+
Contact.prototype.listAttachedSegments = function (_a) {
|
|
137
|
+
var id = _a.id;
|
|
138
|
+
return this.client.get({
|
|
139
|
+
url: "/".concat(this.baseUrl, "/").concat(id, "/segments"),
|
|
140
|
+
});
|
|
141
|
+
};
|
|
142
|
+
Contact.prototype.listAttachedEmailSubscriptions = function (_a) {
|
|
143
|
+
var id = _a.id;
|
|
144
|
+
return this.client.get({
|
|
145
|
+
url: "/".concat(this.baseUrl, "/").concat(id, "/subscriptions"),
|
|
146
|
+
});
|
|
147
|
+
};
|
|
148
|
+
return Contact;
|
|
149
|
+
}());
|
|
150
|
+
exports.default = Contact;
|
|
151
|
+
//
|
|
152
|
+
var SearchContactOrderBy;
|
|
153
|
+
(function (SearchContactOrderBy) {
|
|
154
|
+
SearchContactOrderBy["ASC"] = "ascending";
|
|
155
|
+
SearchContactOrderBy["DESC"] = "descending";
|
|
156
|
+
})(SearchContactOrderBy = exports.SearchContactOrderBy || (exports.SearchContactOrderBy = {}));
|
|
157
|
+
//# sourceMappingURL=contact.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contact.js","sourceRoot":"","sources":["../lib/contact.ts"],"names":[],"mappings":";;;AAEA,sDAK+B;AAM/B;IAGI,iBAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF3B,YAAO,GAAG,UAAU,CAAC;QAGjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IACD,4BAAU,GAAV,UAAW,EAUM;YATb,UAAU,gBAAA,EACV,KAAK,WAAA,EACL,IAAI,UAAA,EACJ,MAAM,YAAA,EACN,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,OAAO,aAAA,EACP,wBAAwB,8BAAA,EACxB,gBAAgB,sBAAA;QAEhB,IAAM,WAAW,GAAyB;YACtC,IAAI,EAAE,mBAAI,CAAC,IAAI;YACf,WAAW,EAAE,UAAU;YACvB,KAAK,OAAA;YACL,IAAI,MAAA;YACJ,MAAM,QAAA;YACN,YAAY,EAAE,UAAU;YACxB,YAAY,EAAE,UAAU;YACxB,QAAQ,EAAE,OAAO;YACjB,wBAAwB,EAAE,wBAAwB;YAClD,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,EAAE,WAAW;SACpB,CAAC,CAAC;IACP,CAAC;IACD,4BAAU,GAAV,UAAW,IAAqB;QAC5B,IAAM,WAAW,GAAyB;YACtC,IAAI,EAAE,mBAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,IAAI,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI;YAChB,MAAM,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM;YACpB,YAAY,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU;YAC9B,YAAY,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU;YAC9B,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO;YACvB,wBAAwB,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,uBAAuB;YACvD,iBAAiB,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB;SAC5C,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,EAAE,WAAW;SACpB,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAA2B;YAAzB,EAAE,QAAA;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAYa;YAXhB,EAAE,QAAA,EACF,IAAI,UAAA,EACJ,UAAU,gBAAA,EACV,KAAK,WAAA,EACL,IAAI,UAAA,EACJ,MAAM,YAAA,EACN,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,OAAO,aAAA,EACP,uBAAuB,6BAAA,EACvB,gBAAgB,sBAAA;QAEhB,IAAM,IAAI,GAAyB;YAC/B,IAAI,MAAA;YACJ,WAAW,EAAE,UAAU;YACvB,KAAK,OAAA;YACL,IAAI,MAAA;YACJ,MAAM,QAAA;YACN,YAAY,EAAE,UAAU;YACxB,YAAY,EAAE,UAAU;YACxB,QAAQ,EAAE,OAAO;YACjB,wBAAwB,EAAE,uBAAuB;YACjD,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;YAC7B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,iCAAe,GAAf,UAAgB,EAA8C;YAA5C,MAAM,YAAA,EAAE,MAAM,YAAA;QAC5B,IAAM,IAAI,GAAkC;YACxC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;SACf,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,WAAQ;YAC7B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAA8B;YAA5B,IAAI,UAAA;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAwB;YAC3C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,YAAS;YAC9B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAA+C;YAA7C,OAAO,aAAA,EAAE,aAAa,mBAAA;QACzB,IAAM,MAAM,GAA2B;YACnC,QAAQ,EAAE,OAAO;YACjB,cAAc,EAAE,aAAa;SAChC,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAuB;YACzC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAAyB;YAAvB,EAAE,QAAA;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAwB;YAC7C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,yBAAO,GAAP,UAAQ,EAA0B;YAAxB,EAAE,QAAA;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAyB;YAC5C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,aAAU;SACxC,CAAC,CAAC;IACP,CAAC;IACD,2BAAS,GAAT,UAAU,EAA4B;YAA1B,EAAE,QAAA;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAA2B;YAC9C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,eAAY;SAC1C,CAAC,CAAC;IACP,CAAC;IACD,uCAAqB,GAArB,UAAsB,EAAgD;YAA9C,EAAE,QAAA,EAAE,OAAO,aAAA,EAAE,IAAI,UAAA;QACrC,IAAM,MAAM,GAAG;YACX,QAAQ,EAAE,OAAO;YACjB,IAAI,MAAA;SACP,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAwB;YAC1C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,eAAY;YACvC,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,kCAAgB,GAAhB,UAAiB,EAA2B;YAAzB,EAAE,QAAA;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA2B;YAC7C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,UAAO;SACrC,CAAC,CAAC;IACP,CAAC;IACD,sCAAoB,GAApB,UAAqB,EAA2B;YAAzB,EAAE,QAAA;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA+B;YACjD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,cAAW;SACzC,CAAC,CAAC;IACP,CAAC;IACD,gDAA8B,GAA9B,UAA+B,EAA2B;YAAzB,EAAE,QAAA;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAyC;YAC3D,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,mBAAgB;SAC9C,CAAC,CAAC;IACP,CAAC;IACL,cAAC;AAAD,CAAC,AA3JD,IA2JC;;AA8GD,EAAE;AACF,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC5B,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;AACvB,CAAC,EAHW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAG/B"}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { AdminObject } from '../admin/admin.types';
|
|
2
|
+
import { JavascriptObject, Seconds, Timestamp } from '../common/common.types';
|
|
3
|
+
export interface ConversationObject {
|
|
4
|
+
type: 'conversation';
|
|
5
|
+
id: string;
|
|
6
|
+
created_at: Timestamp;
|
|
7
|
+
updated_at: Timestamp;
|
|
8
|
+
source: SourceObject;
|
|
9
|
+
contacts: Array<ContactObject>;
|
|
10
|
+
teammates: Array<TeammateObject>;
|
|
11
|
+
title: string;
|
|
12
|
+
admin_assignee_id: number;
|
|
13
|
+
team_assignee_id: number;
|
|
14
|
+
custom_attributes: JavascriptObject;
|
|
15
|
+
topics: JavascriptObject;
|
|
16
|
+
open: boolean;
|
|
17
|
+
state: ConversationState;
|
|
18
|
+
read: boolean;
|
|
19
|
+
waiting_since: Timestamp;
|
|
20
|
+
snoozed_until: Timestamp;
|
|
21
|
+
tags: JavascriptObject[];
|
|
22
|
+
first_contact_reply: FirstContactReplyObject;
|
|
23
|
+
priority: ConversationPriority;
|
|
24
|
+
sla_applied: SLAObject;
|
|
25
|
+
conversation_rating: ConversationRatingObject;
|
|
26
|
+
statistics: StatisticsObject;
|
|
27
|
+
conversation_parts: ConversationPartObject;
|
|
28
|
+
}
|
|
29
|
+
export declare type ConversationObjectWithoutParts = Exclude<ConversationObject, 'conversation_parts'>;
|
|
30
|
+
interface SourceObject {
|
|
31
|
+
type: ConversationSourceType;
|
|
32
|
+
id: string;
|
|
33
|
+
delivered_as: string;
|
|
34
|
+
subject?: string;
|
|
35
|
+
body: string;
|
|
36
|
+
author: Author;
|
|
37
|
+
attachments: JavascriptObject[];
|
|
38
|
+
url: string;
|
|
39
|
+
redacted: boolean;
|
|
40
|
+
}
|
|
41
|
+
interface ContactObject {
|
|
42
|
+
type: ContactType;
|
|
43
|
+
id: string;
|
|
44
|
+
}
|
|
45
|
+
interface TeammateObject {
|
|
46
|
+
type: 'admin';
|
|
47
|
+
id: string;
|
|
48
|
+
}
|
|
49
|
+
interface FirstContactReplyObject {
|
|
50
|
+
type: ConversationSourceType;
|
|
51
|
+
url: string;
|
|
52
|
+
created_at: Timestamp;
|
|
53
|
+
}
|
|
54
|
+
interface ConversationRatingObject {
|
|
55
|
+
rating: FromOneToFiveRating;
|
|
56
|
+
remark?: string;
|
|
57
|
+
created_at: Timestamp;
|
|
58
|
+
contact: ContactObject;
|
|
59
|
+
teammate: TeammateObject;
|
|
60
|
+
}
|
|
61
|
+
interface SLAObject {
|
|
62
|
+
sla_name: string;
|
|
63
|
+
sla_status: SLAStatus;
|
|
64
|
+
}
|
|
65
|
+
interface StatisticsObject {
|
|
66
|
+
time_to_assignment: Seconds;
|
|
67
|
+
time_to_admin_reply: Seconds;
|
|
68
|
+
time_to_first_close: Seconds;
|
|
69
|
+
time_to_last_close: Seconds;
|
|
70
|
+
median_time_to_reply: Seconds;
|
|
71
|
+
first_contact_reply_at: Seconds;
|
|
72
|
+
first_assignment_at: Seconds;
|
|
73
|
+
first_admin_reply_at: Seconds;
|
|
74
|
+
first_close_at: Seconds;
|
|
75
|
+
last_assignment_at: Seconds;
|
|
76
|
+
last_assignment_admin_reply_at: Seconds;
|
|
77
|
+
last_contact_reply_at: Seconds;
|
|
78
|
+
last_admin_reply_at: Seconds;
|
|
79
|
+
last_close_at: Seconds;
|
|
80
|
+
last_closed_by: AdminObject;
|
|
81
|
+
count_reopens: number;
|
|
82
|
+
count_assignments: number;
|
|
83
|
+
count_conversations_parts: number;
|
|
84
|
+
}
|
|
85
|
+
interface ConversationPartObject {
|
|
86
|
+
type: 'conversation_part.list';
|
|
87
|
+
conversation_parts: {
|
|
88
|
+
id: string;
|
|
89
|
+
part_type: string;
|
|
90
|
+
body: string;
|
|
91
|
+
created_at: Timestamp;
|
|
92
|
+
updated_at: Timestamp;
|
|
93
|
+
notified_at: Timestamp;
|
|
94
|
+
assigned_to: string | null;
|
|
95
|
+
author: Author;
|
|
96
|
+
attachments: JavascriptObject[];
|
|
97
|
+
redacted: boolean;
|
|
98
|
+
}[];
|
|
99
|
+
}
|
|
100
|
+
declare enum ConversationState {
|
|
101
|
+
OPEN = "open",
|
|
102
|
+
CLOSED = "closed",
|
|
103
|
+
SNOOZED = "snoozed"
|
|
104
|
+
}
|
|
105
|
+
declare enum ConversationPriority {
|
|
106
|
+
PRIORITY = "priority",
|
|
107
|
+
NOT_PRIORITY = "not_priority"
|
|
108
|
+
}
|
|
109
|
+
declare enum ConversationSourceType {
|
|
110
|
+
CONVERASTION = "conversation",
|
|
111
|
+
PUSH = "push",
|
|
112
|
+
FACEBOOK = "facebook",
|
|
113
|
+
TWITTER = "twitter",
|
|
114
|
+
EMAIL = "email"
|
|
115
|
+
}
|
|
116
|
+
export declare enum ContactType {
|
|
117
|
+
USER = "user",
|
|
118
|
+
LEAD = "lead"
|
|
119
|
+
}
|
|
120
|
+
declare enum FromOneToFiveRating {
|
|
121
|
+
ONE = 1,
|
|
122
|
+
TWO = 2,
|
|
123
|
+
THREE = 3,
|
|
124
|
+
FOUR = 4,
|
|
125
|
+
FIVE = 5
|
|
126
|
+
}
|
|
127
|
+
declare enum SLAStatus {
|
|
128
|
+
HIT = "hit",
|
|
129
|
+
MISSED = "missed",
|
|
130
|
+
CANCELLED = "cancelled",
|
|
131
|
+
ACTIVE = "active"
|
|
132
|
+
}
|
|
133
|
+
interface Author {
|
|
134
|
+
id: string;
|
|
135
|
+
type: AuthorType;
|
|
136
|
+
}
|
|
137
|
+
declare enum AuthorType {
|
|
138
|
+
USER = "user",
|
|
139
|
+
ADMIN = "admin",
|
|
140
|
+
BOT = "bot",
|
|
141
|
+
TEAM = "team"
|
|
142
|
+
}
|
|
143
|
+
export {};
|
|
144
|
+
//# sourceMappingURL=conversation.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversation.types.d.ts","sourceRoot":"","sources":["../../lib/conversation/conversation.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,CAAC;IACtB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC/B,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,gBAAgB,CAAC;IACpC,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,iBAAiB,CAAC;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,aAAa,EAAE,SAAS,CAAC;IACzB,aAAa,EAAE,SAAS,CAAC;IACzB,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,WAAW,EAAE,SAAS,CAAC;IACvB,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,kBAAkB,EAAE,sBAAsB,CAAC;CAC9C;AAED,oBAAY,8BAA8B,GAAG,OAAO,CAChD,kBAAkB,EAClB,oBAAoB,CACvB,CAAC;AAEF,UAAU,YAAY;IAClB,IAAI,EAAE,sBAAsB,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,UAAU,aAAa;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,cAAc;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,uBAAuB;IAC7B,IAAI,EAAE,sBAAsB,CAAC;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,SAAS,CAAC;CACzB;AAED,UAAU,wBAAwB;IAC9B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;CAC5B;AAED,UAAU,SAAS;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,SAAS,CAAC;CACzB;AAED,UAAU,gBAAgB;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,sBAAsB,EAAE,OAAO,CAAC;IAChC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,8BAA8B,EAAE,OAAO,CAAC;IACxC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,cAAc,EAAE,WAAW,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yBAAyB,EAAE,MAAM,CAAC;CACrC;AAED,UAAU,sBAAsB;IAC5B,IAAI,EAAE,wBAAwB,CAAC;IAC/B,kBAAkB,EAAE;QAChB,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,SAAS,CAAC;QACtB,UAAU,EAAE,SAAS,CAAC;QACtB,WAAW,EAAE,SAAS,CAAC;QACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,gBAAgB,EAAE,CAAC;QAChC,QAAQ,EAAE,OAAO,CAAC;KACrB,EAAE,CAAC;CACP;AAED,aAAK,iBAAiB;IAClB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,OAAO,YAAY;CACtB;AAED,aAAK,oBAAoB;IACrB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,aAAK,sBAAsB;IACvB,YAAY,iBAAiB;IAC7B,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED,oBAAY,WAAW;IACnB,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED,aAAK,mBAAmB;IACpB,GAAG,IAAI;IACP,GAAG,IAAI;IACP,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;CACX;AAED,aAAK,SAAS;IACV,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,MAAM,WAAW;CACpB;AAED,UAAU,MAAM;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,UAAU,CAAC;CACpB;AAED,aAAK,UAAU;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,IAAI,SAAS;CAChB"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ContactType = void 0;
|
|
4
|
+
var ConversationState;
|
|
5
|
+
(function (ConversationState) {
|
|
6
|
+
ConversationState["OPEN"] = "open";
|
|
7
|
+
ConversationState["CLOSED"] = "closed";
|
|
8
|
+
ConversationState["SNOOZED"] = "snoozed";
|
|
9
|
+
})(ConversationState || (ConversationState = {}));
|
|
10
|
+
var ConversationPriority;
|
|
11
|
+
(function (ConversationPriority) {
|
|
12
|
+
ConversationPriority["PRIORITY"] = "priority";
|
|
13
|
+
ConversationPriority["NOT_PRIORITY"] = "not_priority";
|
|
14
|
+
})(ConversationPriority || (ConversationPriority = {}));
|
|
15
|
+
var ConversationSourceType;
|
|
16
|
+
(function (ConversationSourceType) {
|
|
17
|
+
ConversationSourceType["CONVERASTION"] = "conversation";
|
|
18
|
+
ConversationSourceType["PUSH"] = "push";
|
|
19
|
+
ConversationSourceType["FACEBOOK"] = "facebook";
|
|
20
|
+
ConversationSourceType["TWITTER"] = "twitter";
|
|
21
|
+
ConversationSourceType["EMAIL"] = "email";
|
|
22
|
+
})(ConversationSourceType || (ConversationSourceType = {}));
|
|
23
|
+
var ContactType;
|
|
24
|
+
(function (ContactType) {
|
|
25
|
+
ContactType["USER"] = "user";
|
|
26
|
+
ContactType["LEAD"] = "lead";
|
|
27
|
+
})(ContactType = exports.ContactType || (exports.ContactType = {}));
|
|
28
|
+
var FromOneToFiveRating;
|
|
29
|
+
(function (FromOneToFiveRating) {
|
|
30
|
+
FromOneToFiveRating[FromOneToFiveRating["ONE"] = 1] = "ONE";
|
|
31
|
+
FromOneToFiveRating[FromOneToFiveRating["TWO"] = 2] = "TWO";
|
|
32
|
+
FromOneToFiveRating[FromOneToFiveRating["THREE"] = 3] = "THREE";
|
|
33
|
+
FromOneToFiveRating[FromOneToFiveRating["FOUR"] = 4] = "FOUR";
|
|
34
|
+
FromOneToFiveRating[FromOneToFiveRating["FIVE"] = 5] = "FIVE";
|
|
35
|
+
})(FromOneToFiveRating || (FromOneToFiveRating = {}));
|
|
36
|
+
var SLAStatus;
|
|
37
|
+
(function (SLAStatus) {
|
|
38
|
+
SLAStatus["HIT"] = "hit";
|
|
39
|
+
SLAStatus["MISSED"] = "missed";
|
|
40
|
+
SLAStatus["CANCELLED"] = "cancelled";
|
|
41
|
+
SLAStatus["ACTIVE"] = "active";
|
|
42
|
+
})(SLAStatus || (SLAStatus = {}));
|
|
43
|
+
var AuthorType;
|
|
44
|
+
(function (AuthorType) {
|
|
45
|
+
AuthorType["USER"] = "user";
|
|
46
|
+
AuthorType["ADMIN"] = "admin";
|
|
47
|
+
AuthorType["BOT"] = "bot";
|
|
48
|
+
AuthorType["TEAM"] = "team";
|
|
49
|
+
})(AuthorType || (AuthorType = {}));
|
|
50
|
+
//# sourceMappingURL=conversation.types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversation.types.js","sourceRoot":"","sources":["../../lib/conversation/conversation.types.ts"],"names":[],"mappings":";;;AAiHA,IAAK,iBAIJ;AAJD,WAAK,iBAAiB;IAClB,kCAAa,CAAA;IACb,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;AACvB,CAAC,EAJI,iBAAiB,KAAjB,iBAAiB,QAIrB;AAED,IAAK,oBAGJ;AAHD,WAAK,oBAAoB;IACrB,6CAAqB,CAAA;IACrB,qDAA6B,CAAA;AACjC,CAAC,EAHI,oBAAoB,KAApB,oBAAoB,QAGxB;AAED,IAAK,sBAMJ;AAND,WAAK,sBAAsB;IACvB,uDAA6B,CAAA;IAC7B,uCAAa,CAAA;IACb,+CAAqB,CAAA;IACrB,6CAAmB,CAAA;IACnB,yCAAe,CAAA;AACnB,CAAC,EANI,sBAAsB,KAAtB,sBAAsB,QAM1B;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACnB,4BAAa,CAAA;IACb,4BAAa,CAAA;AACjB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED,IAAK,mBAMJ;AAND,WAAK,mBAAmB;IACpB,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,+DAAS,CAAA;IACT,6DAAQ,CAAA;IACR,6DAAQ,CAAA;AACZ,CAAC,EANI,mBAAmB,KAAnB,mBAAmB,QAMvB;AAED,IAAK,SAKJ;AALD,WAAK,SAAS;IACV,wBAAW,CAAA;IACX,8BAAiB,CAAA;IACjB,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;AACrB,CAAC,EALI,SAAS,KAAT,SAAS,QAKb;AAOD,IAAK,UAKJ;AALD,WAAK,UAAU;IACX,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,yBAAW,CAAA;IACX,2BAAa,CAAA;AACjB,CAAC,EALI,UAAU,KAAV,UAAU,QAKd"}
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
import Client from './client';
|
|
2
|
+
import { Paginated, StringifiedTimestamp, GenericSearchFilters, Leaves, Order } from './common/common.types';
|
|
3
|
+
import { ContactType, ConversationObject, ConversationObjectWithoutParts } from './conversation/conversation.types';
|
|
4
|
+
import { MessageObject } from './message/message.types';
|
|
5
|
+
export default class Conversation {
|
|
6
|
+
private readonly client;
|
|
7
|
+
readonly baseUrl = "conversations";
|
|
8
|
+
constructor(client: Client);
|
|
9
|
+
create({ userId, body }: CreateConversationData): Promise<MessageObject>;
|
|
10
|
+
find({ id, inPlainText }: RetrieveConversationData): Promise<ConversationObject>;
|
|
11
|
+
update({ id, markRead, customAttributes }: UpdateConversationData): Promise<ConversationObject>;
|
|
12
|
+
replyByIdAsUser({ id, body, intercomUserId, userId, email, attachmentUrls, }: ReplyByIdAsUserData): Promise<ConversationObject>;
|
|
13
|
+
replyByIdAsAdmin({ id, adminId, messageType, body, attachmentUrls, }: ReplyByIdAsAdminData): Promise<ConversationObject>;
|
|
14
|
+
replyByLastAsUser({ body, intercomUserId, userId, email, attachmentUrls, }: ReplyByLastAsUserData): Promise<ConversationObject>;
|
|
15
|
+
replyByLastAsAdmin({ adminId, messageType, body, attachmentUrls, }: ReplyByLastAsAdminData): Promise<ConversationObject>;
|
|
16
|
+
assign({ id, type, adminId, assigneeId, body, withRunningAssignmentRules, }: AssignConversationData): Promise<ConversationObject>;
|
|
17
|
+
snooze({ id, adminId, snoozedUntil }: SnoozeConversationData): Promise<ConversationObject>;
|
|
18
|
+
close({ id, adminId, body }: CloseConversationData): Promise<ConversationObject>;
|
|
19
|
+
open({ id, adminId }: OpenConversationData): Promise<ConversationObject>;
|
|
20
|
+
attachContactAsAdmin({ id, adminId, customer, }: AttachContactToConversationAsAdminData): Promise<AttachContactToConversationResponse>;
|
|
21
|
+
attachContactAsContact({ id, userId, intercomUserId, email, customer, }: AttachContactToConversationAsContactData): Promise<AttachContactToConversationResponse>;
|
|
22
|
+
detachContactAsAdmin({ conversationId, contactId, adminId, }: DetachContactFromConversationData): Promise<ConversationObject>;
|
|
23
|
+
search({ data }: SearchConversationRequest): Promise<SearchConversationResponse>;
|
|
24
|
+
list({ query: { order, sort, page, perPage: per_page }, }: ListConversationData): Promise<ListConversationResponse>;
|
|
25
|
+
redactConversationPart({ conversationId, conversationPartId, sourceId, type, }: RedactConversationPartData): Promise<Conversation>;
|
|
26
|
+
}
|
|
27
|
+
interface CreateConversationData {
|
|
28
|
+
userId: string;
|
|
29
|
+
body: string;
|
|
30
|
+
}
|
|
31
|
+
interface RetrieveConversationData {
|
|
32
|
+
id: string;
|
|
33
|
+
inPlainText?: boolean;
|
|
34
|
+
}
|
|
35
|
+
interface UpdateConversationData {
|
|
36
|
+
id: string;
|
|
37
|
+
markRead?: boolean;
|
|
38
|
+
customAttributes?: object;
|
|
39
|
+
}
|
|
40
|
+
export declare enum ReplyToConversationMessageType {
|
|
41
|
+
COMMENT = "comment",
|
|
42
|
+
NOTE = "note"
|
|
43
|
+
}
|
|
44
|
+
export declare enum ReplyToConversationUserType {
|
|
45
|
+
ADMIN = "admin",
|
|
46
|
+
USER = "user"
|
|
47
|
+
}
|
|
48
|
+
interface ReplyByIdAsUserData {
|
|
49
|
+
id: string;
|
|
50
|
+
body: string;
|
|
51
|
+
intercomUserId?: string;
|
|
52
|
+
userId?: string;
|
|
53
|
+
email?: string;
|
|
54
|
+
attachmentUrls?: Array<string>;
|
|
55
|
+
}
|
|
56
|
+
interface ReplyByIdAsAdminData {
|
|
57
|
+
id: string;
|
|
58
|
+
adminId: string;
|
|
59
|
+
messageType: ReplyToConversationMessageType;
|
|
60
|
+
body: string;
|
|
61
|
+
attachmentUrls?: Array<string>;
|
|
62
|
+
}
|
|
63
|
+
declare type ReplyByLastAsUserData = Omit<ReplyByIdAsUserData, 'id'>;
|
|
64
|
+
declare type ReplyByLastAsAdminData = Omit<ReplyByIdAsAdminData, 'id'>;
|
|
65
|
+
export declare enum AssignToConversationMessageType {
|
|
66
|
+
ASSIGNMENT = "assignment"
|
|
67
|
+
}
|
|
68
|
+
export declare enum AssignToConversationUserType {
|
|
69
|
+
ADMIN = "admin",
|
|
70
|
+
TEAM = "team"
|
|
71
|
+
}
|
|
72
|
+
interface AssignConversationData {
|
|
73
|
+
id: string;
|
|
74
|
+
type?: AssignToConversationUserType;
|
|
75
|
+
adminId?: string;
|
|
76
|
+
assigneeId?: string | 0;
|
|
77
|
+
body?: string;
|
|
78
|
+
withRunningAssignmentRules?: boolean;
|
|
79
|
+
}
|
|
80
|
+
export declare enum SnoozeConversationMessageType {
|
|
81
|
+
SNOOZED = "snoozed"
|
|
82
|
+
}
|
|
83
|
+
interface SnoozeConversationData {
|
|
84
|
+
id: string;
|
|
85
|
+
adminId: string;
|
|
86
|
+
snoozedUntil: StringifiedTimestamp;
|
|
87
|
+
}
|
|
88
|
+
export declare enum CloseConversationMessageType {
|
|
89
|
+
CLOSED = "closed"
|
|
90
|
+
}
|
|
91
|
+
export declare enum CloseConversationType {
|
|
92
|
+
ADMIN = "admin"
|
|
93
|
+
}
|
|
94
|
+
interface CloseConversationData {
|
|
95
|
+
id: string;
|
|
96
|
+
adminId: string;
|
|
97
|
+
body?: string;
|
|
98
|
+
}
|
|
99
|
+
export declare enum OpenConversationMessageType {
|
|
100
|
+
OPEN = "open"
|
|
101
|
+
}
|
|
102
|
+
interface OpenConversationData {
|
|
103
|
+
id: string;
|
|
104
|
+
adminId: string;
|
|
105
|
+
}
|
|
106
|
+
interface NormalizedCustomerObject {
|
|
107
|
+
intercomUserId?: string;
|
|
108
|
+
userId?: string;
|
|
109
|
+
email?: string;
|
|
110
|
+
}
|
|
111
|
+
interface AttachContactToConversationAsAdminData {
|
|
112
|
+
id: string;
|
|
113
|
+
adminId: string;
|
|
114
|
+
customer: NormalizedCustomerObject;
|
|
115
|
+
}
|
|
116
|
+
interface AttachContactToConversationAsContactData extends NormalizedCustomerObject {
|
|
117
|
+
id: string;
|
|
118
|
+
customer: NormalizedCustomerObject;
|
|
119
|
+
}
|
|
120
|
+
interface AttachContactToConversationResponse {
|
|
121
|
+
customers: Array<{
|
|
122
|
+
id: string;
|
|
123
|
+
type: ContactType;
|
|
124
|
+
}>;
|
|
125
|
+
}
|
|
126
|
+
interface DetachContactFromConversationData {
|
|
127
|
+
conversationId: string;
|
|
128
|
+
contactId: string;
|
|
129
|
+
adminId: string;
|
|
130
|
+
}
|
|
131
|
+
export declare enum SearchConversationOrderBy {
|
|
132
|
+
ASC = "ascending",
|
|
133
|
+
DESC = "descending"
|
|
134
|
+
}
|
|
135
|
+
interface SearchConversationPagination {
|
|
136
|
+
pagination: {
|
|
137
|
+
per_page: number;
|
|
138
|
+
starting_after?: string;
|
|
139
|
+
};
|
|
140
|
+
}
|
|
141
|
+
interface SearchConversationOrder {
|
|
142
|
+
sort: {
|
|
143
|
+
field: Leaves<ConversationObject>;
|
|
144
|
+
order: SearchConversationOrderBy;
|
|
145
|
+
};
|
|
146
|
+
}
|
|
147
|
+
interface SearchConversationRequest {
|
|
148
|
+
data: GenericSearchFilters<ConversationObject> & Partial<SearchConversationPagination> & Partial<SearchConversationOrder>;
|
|
149
|
+
}
|
|
150
|
+
declare type SearchConversationResponse = Paginated<ConversationObject>;
|
|
151
|
+
export declare enum SortBy {
|
|
152
|
+
CreatedAt = "created_at",
|
|
153
|
+
UpdatedAt = "updated_at",
|
|
154
|
+
WaitingSince = "waiting_since"
|
|
155
|
+
}
|
|
156
|
+
interface ListConversationData {
|
|
157
|
+
query: {
|
|
158
|
+
order: Order;
|
|
159
|
+
sort: SortBy;
|
|
160
|
+
page?: number;
|
|
161
|
+
perPage?: number;
|
|
162
|
+
};
|
|
163
|
+
}
|
|
164
|
+
declare type ListConversationResponse = Paginated<ConversationObjectWithoutParts>;
|
|
165
|
+
export declare enum RedactConversationPartType {
|
|
166
|
+
CONVERSATION_PART = "conversation_part",
|
|
167
|
+
SOURCE = "source"
|
|
168
|
+
}
|
|
169
|
+
interface RedactConversationPartData {
|
|
170
|
+
type: RedactConversationPartType;
|
|
171
|
+
conversationId: string;
|
|
172
|
+
conversationPartId?: string;
|
|
173
|
+
sourceId?: string;
|
|
174
|
+
}
|
|
175
|
+
export {};
|
|
176
|
+
//# sourceMappingURL=conversation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["../lib/conversation.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,EACH,SAAS,EACT,oBAAoB,EACpB,oBAAoB,EACpB,MAAM,EACN,KAAK,EACR,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,WAAW,EACX,kBAAkB,EAClB,8BAA8B,EACjC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,MAAM,CAAC,OAAO,OAAO,YAAY;IAGjB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,SAAgB,OAAO,mBAAmB;gBAEb,MAAM,EAAE,MAAM;IAG3C,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,sBAAsB;IAa/C,IAAI,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,wBAAwB;IAYlD,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,gBAAgB,EAAE,EAAE,sBAAsB;IAWjE,eAAe,CAAC,EACZ,EAAE,EACF,IAAI,EACJ,cAAc,EACd,MAAM,EACN,KAAK,EACL,cAAc,GACjB,EAAE,mBAAmB;IAetB,gBAAgB,CAAC,EACb,EAAE,EACF,OAAO,EACP,WAAW,EACX,IAAI,EACJ,cAAc,GACjB,EAAE,oBAAoB;IAavB,iBAAiB,CAAC,EACd,IAAI,EACJ,cAAc,EACd,MAAM,EACN,KAAK,EACL,cAAc,GACjB,EAAE,qBAAqB;IAexB,kBAAkB,CAAC,EACf,OAAO,EACP,WAAW,EACX,IAAI,EACJ,cAAc,GACjB,EAAE,sBAAsB;IAazB,MAAM,CAAC,EACH,EAAE,EACF,IAAI,EACJ,OAAO,EACP,UAAU,EACV,IAAI,EACJ,0BAAkC,GACrC,EAAE,sBAAsB;IAiBzB,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,sBAAsB;IAY5D,KAAK,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,qBAAqB;IAalD,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,oBAAoB;IAW1C,oBAAoB,CAAC,EACjB,EAAE,EACF,OAAO,EACP,QAAQ,GACX,EAAE,sCAAsC;IAezC,sBAAsB,CAAC,EACnB,EAAE,EACF,MAAM,EACN,cAAc,EACd,KAAK,EACL,QAAQ,GACX,EAAE,wCAAwC;IAiB3C,oBAAoB,CAAC,EACjB,cAAc,EACd,SAAS,EACT,OAAO,GACV,EAAE,iCAAiC;IAUpC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,yBAAyB;IAM1C,IAAI,CAAC,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,GAClD,EAAE,oBAAoB;IAQvB,sBAAsB,CAAC,EACnB,cAAc,EACd,kBAAkB,EAClB,QAAQ,EACR,IAAI,GACP,EAAE,0BAA0B;CAahC;AAUD,UAAU,sBAAsB;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,wBAAwB;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAMD,UAAU,sBAAsB;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,oBAAY,8BAA8B;IACtC,OAAO,YAAY;IACnB,IAAI,SAAS;CAChB;AACD,oBAAY,2BAA2B;IACnC,KAAK,UAAU;IACf,IAAI,SAAS;CAChB;AAqBD,UAAU,mBAAmB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAClC;AAED,UAAU,oBAAoB;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,8BAA8B,CAAC;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAClC;AAED,aAAK,qBAAqB,GAAG,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;AAE7D,aAAK,sBAAsB,GAAG,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC;AAE/D,oBAAY,+BAA+B;IACvC,UAAU,eAAe;CAC5B;AACD,oBAAY,4BAA4B;IACpC,KAAK,UAAU;IACf,IAAI,SAAS;CAChB;AAUD,UAAU,sBAAsB;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,4BAA4B,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACxC;AAED,oBAAY,6BAA6B;IACrC,OAAO,YAAY;CACtB;AAQD,UAAU,sBAAsB;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,oBAAoB,CAAC;CACtC;AAED,oBAAY,4BAA4B;IACpC,MAAM,WAAW;CACpB;AACD,oBAAY,qBAAqB;IAC7B,KAAK,UAAU;CAClB;AASD,UAAU,qBAAqB;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,2BAA2B;IACnC,IAAI,SAAS;CAChB;AAOD,UAAU,oBAAoB;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CACnB;AAQD,UAAU,wBAAwB;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAWD,UAAU,sCAAsC;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,wBAAwB,CAAC;CACtC;AAED,UAAU,wCACN,SAAQ,wBAAwB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,wBAAwB,CAAC;CACtC;AAED,UAAU,mCAAmC;IACzC,SAAS,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;CACvD;AAMD,UAAU,iCAAiC;IACvC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,yBAAyB;IACjC,GAAG,cAAc;IACjB,IAAI,eAAe;CACtB;AACD,UAAU,4BAA4B;IAClC,UAAU,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;CACL;AAED,UAAU,uBAAuB;IAC7B,IAAI,EAAE;QACF,KAAK,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAClC,KAAK,EAAE,yBAAyB,CAAC;KACpC,CAAC;CACL;AAED,UAAU,yBAAyB;IAC/B,IAAI,EAAE,oBAAoB,CAAC,kBAAkB,CAAC,GAC1C,OAAO,CAAC,4BAA4B,CAAC,GACrC,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACxC;AAED,aAAK,0BAA0B,GAAG,SAAS,CAAC,kBAAkB,CAAC,CAAC;AAEhE,oBAAY,MAAM;IACd,SAAS,eAAe;IACxB,SAAS,eAAe;IACxB,YAAY,kBAAkB;CACjC;AAED,UAAU,oBAAoB;IAC1B,KAAK,EAAE;QACH,KAAK,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACL;AAED,aAAK,wBAAwB,GAAG,SAAS,CAAC,8BAA8B,CAAC,CAAC;AAE1E,oBAAY,0BAA0B;IAClC,iBAAiB,sBAAsB;IACvC,MAAM,WAAW;CACpB;AASD,UAAU,0BAA0B;IAChC,IAAI,EAAE,0BAA0B,CAAC;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB"}
|