intercom-client 3.2.0 → 4.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.
Files changed (175) hide show
  1. package/README.md +18 -20
  2. package/dist/admin/admin.types.d.ts +15 -0
  3. package/dist/admin/admin.types.d.ts.map +1 -0
  4. package/dist/admin/admin.types.js +3 -0
  5. package/dist/admin/admin.types.js.map +1 -0
  6. package/dist/admin.d.ts +48 -0
  7. package/dist/admin.d.ts.map +1 -0
  8. package/dist/admin.js +42 -0
  9. package/dist/admin.js.map +1 -0
  10. package/dist/article/article.types.d.ts +87 -0
  11. package/dist/article/article.types.d.ts.map +1 -0
  12. package/dist/article/article.types.js +45 -0
  13. package/dist/article/article.types.js.map +1 -0
  14. package/dist/article.d.ts +34 -0
  15. package/dist/article.d.ts.map +1 -0
  16. package/dist/article.js +69 -0
  17. package/dist/article.js.map +1 -0
  18. package/dist/client.d.ts +82 -0
  19. package/dist/client.d.ts.map +1 -0
  20. package/dist/client.js +325 -0
  21. package/dist/client.js.map +1 -0
  22. package/dist/common/common.types.d.ts +69 -0
  23. package/dist/common/common.types.d.ts.map +1 -0
  24. package/dist/common/common.types.js +29 -0
  25. package/dist/common/common.types.js.map +1 -0
  26. package/dist/company/company.types.d.ts +37 -0
  27. package/dist/company/company.types.d.ts.map +1 -0
  28. package/dist/company/company.types.js +3 -0
  29. package/dist/company/company.types.js.map +1 -0
  30. package/dist/company.d.ts +63 -0
  31. package/dist/company.d.ts.map +1 -0
  32. package/dist/company.js +114 -0
  33. package/dist/company.js.map +1 -0
  34. package/dist/contact/contact.types.d.ts +82 -0
  35. package/dist/contact/contact.types.d.ts.map +1 -0
  36. package/dist/contact/contact.types.js +3 -0
  37. package/dist/contact/contact.types.js.map +1 -0
  38. package/dist/contact.d.ts +121 -0
  39. package/dist/contact.d.ts.map +1 -0
  40. package/dist/contact.js +160 -0
  41. package/dist/contact.js.map +1 -0
  42. package/dist/conversation/conversation.types.d.ts +144 -0
  43. package/dist/conversation/conversation.types.d.ts.map +1 -0
  44. package/dist/conversation/conversation.types.js +50 -0
  45. package/dist/conversation/conversation.types.js.map +1 -0
  46. package/dist/conversation.d.ts +176 -0
  47. package/dist/conversation.d.ts.map +1 -0
  48. package/dist/conversation.js +289 -0
  49. package/dist/conversation.js.map +1 -0
  50. package/dist/count/count.types.d.ts +89 -0
  51. package/dist/count/count.types.d.ts.map +1 -0
  52. package/dist/count/count.types.js +17 -0
  53. package/dist/count/count.types.js.map +1 -0
  54. package/dist/count.d.ts +18 -0
  55. package/dist/count.d.ts.map +1 -0
  56. package/dist/count.js +72 -0
  57. package/dist/count.js.map +1 -0
  58. package/dist/dataAttribute/dataAttribute.types.d.ts +32 -0
  59. package/dist/dataAttribute/dataAttribute.types.d.ts.map +1 -0
  60. package/dist/dataAttribute/dataAttribute.types.js +18 -0
  61. package/dist/dataAttribute/dataAttribute.types.js.map +1 -0
  62. package/dist/dataAttribute.d.ts +33 -0
  63. package/dist/dataAttribute.d.ts.map +1 -0
  64. package/dist/dataAttribute.js +49 -0
  65. package/dist/dataAttribute.js.map +1 -0
  66. package/dist/dataExport/dataExport.types.d.ts +7 -0
  67. package/dist/dataExport/dataExport.types.d.ts.map +1 -0
  68. package/dist/dataExport/dataExport.types.js +3 -0
  69. package/dist/dataExport/dataExport.types.js.map +1 -0
  70. package/dist/dataExport.d.ts +18 -0
  71. package/dist/dataExport.d.ts.map +1 -0
  72. package/dist/dataExport.js +36 -0
  73. package/dist/dataExport.js.map +1 -0
  74. package/dist/errors/badResponse.error.d.ts +9 -0
  75. package/dist/errors/badResponse.error.d.ts.map +1 -0
  76. package/dist/errors/badResponse.error.js +35 -0
  77. package/dist/errors/badResponse.error.js.map +1 -0
  78. package/dist/event/event.types.d.ts +29 -0
  79. package/dist/event/event.types.d.ts.map +1 -0
  80. package/dist/event/event.types.js +3 -0
  81. package/dist/event/event.types.js.map +1 -0
  82. package/dist/event.d.ts +41 -0
  83. package/dist/event.d.ts.map +1 -0
  84. package/dist/event.js +44 -0
  85. package/dist/event.js.map +1 -0
  86. package/dist/helpCenter/helpCenter.types.d.ts +23 -0
  87. package/dist/helpCenter/helpCenter.types.d.ts.map +1 -0
  88. package/dist/helpCenter/helpCenter.types.js +3 -0
  89. package/dist/helpCenter/helpCenter.types.js.map +1 -0
  90. package/dist/helpCenter.d.ts +58 -0
  91. package/dist/helpCenter.d.ts.map +1 -0
  92. package/dist/helpCenter.js +121 -0
  93. package/dist/helpCenter.js.map +1 -0
  94. package/dist/index.d.ts +29 -0
  95. package/dist/index.d.ts.map +1 -0
  96. package/dist/index.js +74 -0
  97. package/dist/index.js.map +1 -0
  98. package/dist/message/message.types.d.ts +17 -0
  99. package/dist/message/message.types.d.ts.map +1 -0
  100. package/dist/message/message.types.js +11 -0
  101. package/dist/message/message.types.js.map +1 -0
  102. package/dist/message.d.ts +32 -0
  103. package/dist/message.d.ts.map +1 -0
  104. package/dist/message.js +35 -0
  105. package/dist/message.js.map +1 -0
  106. package/dist/note/note.types.d.ts +13 -0
  107. package/dist/note/note.types.d.ts.map +1 -0
  108. package/dist/note/note.types.js +3 -0
  109. package/dist/note/note.types.js.map +1 -0
  110. package/dist/note.d.ts +24 -0
  111. package/dist/note.d.ts.map +1 -0
  112. package/dist/note.js +40 -0
  113. package/dist/note.js.map +1 -0
  114. package/dist/package.json +1 -1
  115. package/dist/phoneCallRedirect/phoneCallRedirect.types.d.ts +5 -0
  116. package/dist/phoneCallRedirect/phoneCallRedirect.types.d.ts.map +1 -0
  117. package/dist/phoneCallRedirect/phoneCallRedirect.types.js +3 -0
  118. package/dist/phoneCallRedirect/phoneCallRedirect.types.js.map +1 -0
  119. package/dist/phoneCallRedirect.d.ts +15 -0
  120. package/dist/phoneCallRedirect.d.ts.map +1 -0
  121. package/dist/phoneCallRedirect.js +23 -0
  122. package/dist/phoneCallRedirect.js.map +1 -0
  123. package/dist/scroll.d.ts +24 -0
  124. package/dist/scroll.d.ts.map +1 -0
  125. package/dist/scroll.js +131 -0
  126. package/dist/scroll.js.map +1 -0
  127. package/dist/segment/segment.types.d.ts +11 -0
  128. package/dist/segment/segment.types.d.ts.map +1 -0
  129. package/dist/segment/segment.types.js +3 -0
  130. package/dist/segment/segment.types.js.map +1 -0
  131. package/dist/segment.d.ts +22 -0
  132. package/dist/segment.d.ts.map +1 -0
  133. package/dist/segment.js +28 -0
  134. package/dist/segment.js.map +1 -0
  135. package/dist/subscription/subscription.types.d.ts +19 -0
  136. package/dist/subscription/subscription.types.d.ts.map +1 -0
  137. package/dist/subscription/subscription.types.js +10 -0
  138. package/dist/subscription/subscription.types.js.map +1 -0
  139. package/dist/subscription.d.ts +14 -0
  140. package/dist/subscription.d.ts.map +1 -0
  141. package/dist/subscription.js +17 -0
  142. package/dist/subscription.js.map +1 -0
  143. package/dist/tag/tag.types.d.ts +6 -0
  144. package/dist/tag/tag.types.d.ts.map +1 -0
  145. package/dist/tag/tag.types.js +3 -0
  146. package/dist/tag/tag.types.js.map +1 -0
  147. package/dist/tag.d.ts +52 -0
  148. package/dist/tag.d.ts.map +1 -0
  149. package/dist/tag.js +95 -0
  150. package/dist/tag.js.map +1 -0
  151. package/dist/team/team.types.d.ts +7 -0
  152. package/dist/team/team.types.d.ts.map +1 -0
  153. package/dist/team/team.types.js +3 -0
  154. package/dist/team/team.types.js.map +1 -0
  155. package/dist/team.d.ts +18 -0
  156. package/dist/team.d.ts.map +1 -0
  157. package/dist/team.js +23 -0
  158. package/dist/team.js.map +1 -0
  159. package/dist/util/time.d.ts +3 -0
  160. package/dist/util/time.d.ts.map +1 -0
  161. package/dist/util/time.js +6 -0
  162. package/dist/util/time.js.map +1 -0
  163. package/dist/util/url.d.ts +3 -0
  164. package/dist/util/url.d.ts.map +1 -0
  165. package/dist/util/url.js +9 -0
  166. package/dist/util/url.js.map +1 -0
  167. package/dist/visitor/visitor.types.d.ts +20 -0
  168. package/dist/visitor/visitor.types.d.ts.map +1 -0
  169. package/dist/visitor/visitor.types.js +3 -0
  170. package/dist/visitor/visitor.types.js.map +1 -0
  171. package/dist/visitor.d.ts +50 -0
  172. package/dist/visitor.d.ts.map +1 -0
  173. package/dist/visitor.js +60 -0
  174. package/dist/visitor.js.map +1 -0
  175. package/package.json +1 -1
@@ -0,0 +1,50 @@
1
+ import { Client, ContactObject } from '.';
2
+ import { Role } from './common/common.types';
3
+ import { VisitorObject } from './visitor/visitor.types';
4
+ export default class Visitor {
5
+ private readonly client;
6
+ readonly baseUrl = "visitors";
7
+ constructor(client: Client);
8
+ find({ id, userId }: FindVisitorByIdData): Promise<VisitorObject>;
9
+ update({ id, userId, name, customAttributes }: UpdateVisitorData): Promise<VisitorObject>;
10
+ delete({ id }: DeleteVisitorByIdData): Promise<VisitorObject>;
11
+ mergeToContact({ visitor, user, type }: MergeVisitorToContactData): Promise<ContactObject>;
12
+ }
13
+ export declare type IdentificationForVisitor = {
14
+ id: string;
15
+ userId?: never;
16
+ } | {
17
+ id?: never;
18
+ userId: string;
19
+ };
20
+ declare type FindVisitorByIdData = IdentificationForVisitor;
21
+ declare type UpdateVisitorData = IdentificationForVisitor & {
22
+ name?: string;
23
+ customAttributes?: VisitorObject['custom_attributes'];
24
+ };
25
+ declare type DeleteVisitorByIdData = {
26
+ id: string;
27
+ };
28
+ export declare type MergeVisitorToContactData = {
29
+ visitor: VisitorObjectForMerge;
30
+ user: ContactObjectForMerge;
31
+ type: Role;
32
+ };
33
+ export declare type VisitorObjectForMerge = {
34
+ id: string;
35
+ userId?: never;
36
+ email?: never;
37
+ } | {
38
+ id?: never;
39
+ userId: string;
40
+ email?: never;
41
+ } | {
42
+ id?: never;
43
+ userId?: never;
44
+ email: string;
45
+ };
46
+ export declare type ContactObjectForMerge = IdentificationForVisitor & {
47
+ email?: string;
48
+ };
49
+ export {};
50
+ //# sourceMappingURL=visitor.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visitor.d.ts","sourceRoot":"","sources":["../../lib/visitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,MAAM,CAAC,OAAO,OAAO,OAAO;IAGZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,SAAgB,OAAO,cAAc;gBAER,MAAM,EAAE,MAAM;IAI3C,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,mBAAmB;IASxC,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,EAAE,iBAAiB;IAahE,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,qBAAqB;IAKpC,cAAc,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,yBAAyB;CAoBpE;AAED,oBAAY,wBAAwB,GAC9B;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAA;CAAE,GAC9B;IAAE,EAAE,CAAC,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAErC,aAAK,mBAAmB,GAAG,wBAAwB,CAAC;AAEpD,aAAK,iBAAiB,GAAG,wBAAwB,GAAG;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CACzD,CAAC;AAEF,aAAK,qBAAqB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5C,oBAAY,yBAAyB,GAAG;IACpC,OAAO,EAAE,qBAAqB,CAAC;IAC/B,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,IAAI,CAAC;CACd,CAAC;AAEF,oBAAY,qBAAqB,GAC3B;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAC7C;IAAE,EAAE,CAAC,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAC7C;IAAE,EAAE,CAAC,EAAE,KAAK,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD,oBAAY,qBAAqB,GAAG,wBAAwB,GAAG;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var Visitor = /** @class */ (function () {
4
+ function Visitor(client) {
5
+ this.client = client;
6
+ this.baseUrl = 'visitors';
7
+ this.client = client;
8
+ }
9
+ Visitor.prototype.find = function (_a) {
10
+ var id = _a.id, userId = _a.userId;
11
+ var query = userId ? { user_id: userId } : {};
12
+ var url = "/".concat(this.baseUrl).concat(id ? "/".concat(id) : '');
13
+ return this.client.get({
14
+ url: url,
15
+ params: query,
16
+ });
17
+ };
18
+ Visitor.prototype.update = function (_a) {
19
+ var id = _a.id, userId = _a.userId, name = _a.name, customAttributes = _a.customAttributes;
20
+ var data = {
21
+ id: id,
22
+ user_id: userId,
23
+ name: name,
24
+ custom_attributes: customAttributes,
25
+ };
26
+ return this.client.put({
27
+ url: "/".concat(this.baseUrl),
28
+ data: data,
29
+ });
30
+ };
31
+ Visitor.prototype.delete = function (_a) {
32
+ var id = _a.id;
33
+ return this.client.delete({
34
+ url: "/".concat(this.baseUrl, "/").concat(id),
35
+ });
36
+ };
37
+ Visitor.prototype.mergeToContact = function (_a) {
38
+ var visitor = _a.visitor, user = _a.user, type = _a.type;
39
+ var data = {
40
+ visitor: {
41
+ id: visitor.id,
42
+ user_id: visitor.userId,
43
+ email: visitor.email,
44
+ },
45
+ user: {
46
+ id: user.id,
47
+ user_id: user.userId,
48
+ email: user.email,
49
+ },
50
+ type: type,
51
+ };
52
+ return this.client.post({
53
+ url: "/".concat(this.baseUrl, "/convert"),
54
+ data: data,
55
+ });
56
+ };
57
+ return Visitor;
58
+ }());
59
+ exports.default = Visitor;
60
+ //# sourceMappingURL=visitor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visitor.js","sourceRoot":"","sources":["../../lib/visitor.ts"],"names":[],"mappings":";;AAIA;IAGI,iBAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF3B,YAAO,GAAG,UAAU,CAAC;QAGjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,sBAAI,GAAJ,UAAK,EAAmC;YAAjC,EAAE,QAAA,EAAE,MAAM,YAAA;QACb,IAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,IAAM,GAAG,GAAG,WAAI,IAAI,CAAC,OAAO,SAAG,EAAE,CAAC,CAAC,CAAC,WAAI,EAAE,CAAE,CAAC,CAAC,CAAC,EAAE,CAAE,CAAC;QAEpD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,KAAA;YACH,MAAM,EAAE,KAAK;SAChB,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAAyD;YAAvD,EAAE,QAAA,EAAE,MAAM,YAAA,EAAE,IAAI,UAAA,EAAE,gBAAgB,sBAAA;QACvC,IAAM,IAAI,GAAG;YACT,EAAE,IAAA;YACF,OAAO,EAAE,MAAM;YACf,IAAI,MAAA;YACJ,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAA6B;YAA3B,EAAE,QAAA;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAgB;YACrC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,gCAAc,GAAd,UAAe,EAAkD;YAAhD,OAAO,aAAA,EAAE,IAAI,UAAA,EAAE,IAAI,UAAA;QAChC,IAAM,IAAI,GAAG;YACT,OAAO,EAAE;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,OAAO,EAAE,OAAO,CAAC,MAAM;gBACvB,KAAK,EAAE,OAAO,CAAC,KAAK;aACvB;YACD,IAAI,EAAE;gBACF,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,OAAO,EAAE,IAAI,CAAC,MAAM;gBACpB,KAAK,EAAE,IAAI,CAAC,KAAK;aACpB;YACD,IAAI,MAAA;SACP,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,aAAU;YAC/B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACL,cAAC;AAAD,CAAC,AAtDD,IAsDC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "intercom-client",
3
- "version": "3.2.0",
3
+ "version": "4.0.0",
4
4
  "description": "Official Node bindings to the Intercom API",
5
5
  "homepage": "https://github.com/intercom/intercom-node",
6
6
  "bugs:": "https://github.com/intercom/intercom-node/issues",