intercom-client 3.0.0-0 → 3.1.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 (155) hide show
  1. package/README.md +317 -3
  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 +77 -0
  19. package/dist/client.d.ts.map +1 -0
  20. package/dist/client.js +249 -0
  21. package/dist/client.js.map +1 -0
  22. package/dist/common/common.types.d.ts +67 -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 +112 -0
  33. package/dist/company.js.map +1 -0
  34. package/dist/contact/contact.types.d.ts +80 -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 +126 -0
  39. package/dist/contact.d.ts.map +1 -0
  40. package/dist/contact.js +157 -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/errors/badResponse.error.d.ts +9 -0
  67. package/dist/errors/badResponse.error.d.ts.map +1 -0
  68. package/dist/errors/badResponse.error.js +21 -0
  69. package/dist/errors/badResponse.error.js.map +1 -0
  70. package/dist/event/event.types.d.ts +29 -0
  71. package/dist/event/event.types.d.ts.map +1 -0
  72. package/dist/event/event.types.js +3 -0
  73. package/dist/event/event.types.js.map +1 -0
  74. package/dist/event.d.ts +41 -0
  75. package/dist/event.d.ts.map +1 -0
  76. package/dist/event.js +44 -0
  77. package/dist/event.js.map +1 -0
  78. package/dist/helpCenter/helpCenter.types.d.ts +23 -0
  79. package/dist/helpCenter/helpCenter.types.d.ts.map +1 -0
  80. package/dist/helpCenter/helpCenter.types.js +3 -0
  81. package/dist/helpCenter/helpCenter.types.js.map +1 -0
  82. package/dist/helpCenter.d.ts +58 -0
  83. package/dist/helpCenter.d.ts.map +1 -0
  84. package/dist/helpCenter.js +121 -0
  85. package/dist/helpCenter.js.map +1 -0
  86. package/dist/index.d.ts +29 -0
  87. package/dist/index.d.ts.map +1 -0
  88. package/dist/index.js +62 -0
  89. package/dist/index.js.map +1 -0
  90. package/dist/message/message.types.d.ts +17 -0
  91. package/dist/message/message.types.d.ts.map +1 -0
  92. package/dist/message/message.types.js +11 -0
  93. package/dist/message/message.types.js.map +1 -0
  94. package/dist/message.d.ts +30 -0
  95. package/dist/message.d.ts.map +1 -0
  96. package/dist/message.js +34 -0
  97. package/dist/message.js.map +1 -0
  98. package/dist/note/note.types.d.ts +13 -0
  99. package/dist/note/note.types.d.ts.map +1 -0
  100. package/dist/note/note.types.js +3 -0
  101. package/dist/note/note.types.js.map +1 -0
  102. package/dist/note.d.ts +24 -0
  103. package/dist/note.d.ts.map +1 -0
  104. package/dist/note.js +40 -0
  105. package/dist/note.js.map +1 -0
  106. package/dist/package.json +59 -0
  107. package/dist/scroll.d.ts +24 -0
  108. package/dist/scroll.d.ts.map +1 -0
  109. package/dist/scroll.js +70 -0
  110. package/dist/scroll.js.map +1 -0
  111. package/dist/segment/segment.types.d.ts +11 -0
  112. package/dist/segment/segment.types.d.ts.map +1 -0
  113. package/dist/segment/segment.types.js +3 -0
  114. package/dist/segment/segment.types.js.map +1 -0
  115. package/dist/segment.d.ts +22 -0
  116. package/dist/segment.d.ts.map +1 -0
  117. package/dist/segment.js +28 -0
  118. package/dist/segment.js.map +1 -0
  119. package/dist/subscription/subscription.types.d.ts +19 -0
  120. package/dist/subscription/subscription.types.d.ts.map +1 -0
  121. package/dist/subscription/subscription.types.js +10 -0
  122. package/dist/subscription/subscription.types.js.map +1 -0
  123. package/dist/tag/tag.types.d.ts +6 -0
  124. package/dist/tag/tag.types.d.ts.map +1 -0
  125. package/dist/tag/tag.types.js +3 -0
  126. package/dist/tag/tag.types.js.map +1 -0
  127. package/dist/tag.d.ts +52 -0
  128. package/dist/tag.d.ts.map +1 -0
  129. package/dist/tag.js +95 -0
  130. package/dist/tag.js.map +1 -0
  131. package/dist/team/team.types.d.ts +7 -0
  132. package/dist/team/team.types.d.ts.map +1 -0
  133. package/dist/team/team.types.js +3 -0
  134. package/dist/team/team.types.js.map +1 -0
  135. package/dist/team.d.ts +18 -0
  136. package/dist/team.d.ts.map +1 -0
  137. package/dist/team.js +23 -0
  138. package/dist/team.js.map +1 -0
  139. package/dist/util/time.d.ts +3 -0
  140. package/dist/util/time.d.ts.map +1 -0
  141. package/dist/util/time.js +6 -0
  142. package/dist/util/time.js.map +1 -0
  143. package/dist/util/url.d.ts +3 -0
  144. package/dist/util/url.d.ts.map +1 -0
  145. package/dist/util/url.js +9 -0
  146. package/dist/util/url.js.map +1 -0
  147. package/dist/visitor/visitor.types.d.ts +20 -0
  148. package/dist/visitor/visitor.types.d.ts.map +1 -0
  149. package/dist/visitor/visitor.types.js +3 -0
  150. package/dist/visitor/visitor.types.js.map +1 -0
  151. package/dist/visitor.d.ts +50 -0
  152. package/dist/visitor.d.ts.map +1 -0
  153. package/dist/visitor.js +60 -0
  154. package/dist/visitor.js.map +1 -0
  155. package/package.json +15 -23
@@ -0,0 +1,69 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var Article = /** @class */ (function () {
4
+ function Article(client) {
5
+ this.client = client;
6
+ this.baseUrl = 'articles';
7
+ this.client = client;
8
+ }
9
+ Article.prototype.create = function (_a) {
10
+ var title = _a.title, description = _a.description, body = _a.body, authorId = _a.authorId, state = _a.state, parentId = _a.parentId, parentType = _a.parentType, translatedContent = _a.translatedContent;
11
+ var data = {
12
+ title: title,
13
+ description: description,
14
+ body: body,
15
+ author_id: authorId,
16
+ state: state,
17
+ parent_id: parentId,
18
+ parent_type: parentType,
19
+ translated_content: translatedContent,
20
+ };
21
+ return this.client.post({
22
+ url: "/".concat(this.baseUrl),
23
+ data: data,
24
+ });
25
+ };
26
+ Article.prototype.find = function (_a) {
27
+ var id = _a.id;
28
+ return this.client.get({
29
+ url: "/".concat(this.baseUrl, "/").concat(id),
30
+ });
31
+ };
32
+ Article.prototype.update = function (_a) {
33
+ var id = _a.id, title = _a.title, description = _a.description, body = _a.body, authorId = _a.authorId, state = _a.state, parentId = _a.parentId, parentType = _a.parentType, translatedContent = _a.translatedContent;
34
+ var data = {
35
+ title: title,
36
+ description: description,
37
+ body: body,
38
+ author_id: authorId,
39
+ state: state,
40
+ parent_id: parentId,
41
+ parent_type: parentType,
42
+ translated_content: translatedContent,
43
+ };
44
+ return this.client.put({
45
+ url: "/".concat(this.baseUrl, "/").concat(id),
46
+ data: data,
47
+ });
48
+ };
49
+ Article.prototype.delete = function (_a) {
50
+ var id = _a.id;
51
+ return this.client.delete({
52
+ url: "/".concat(this.baseUrl, "/").concat(id),
53
+ });
54
+ };
55
+ Article.prototype.list = function (_a) {
56
+ var page = _a.page, per_page = _a.perPage;
57
+ var params = {
58
+ page: page,
59
+ per_page: per_page,
60
+ };
61
+ return this.client.get({
62
+ url: "/".concat(this.baseUrl),
63
+ params: params,
64
+ });
65
+ };
66
+ return Article;
67
+ }());
68
+ exports.default = Article;
69
+ //# sourceMappingURL=article.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"article.js","sourceRoot":"","sources":["../../lib/article.ts"],"names":[],"mappings":";;AAWA;IAGI,iBAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF3B,YAAO,GAAG,UAAU,CAAC;QAGjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,wBAAM,GAAN,UAAO,EASa;YARhB,KAAK,WAAA,EACL,WAAW,iBAAA,EACX,IAAI,UAAA,EACJ,QAAQ,cAAA,EACR,KAAK,WAAA,EACL,QAAQ,cAAA,EACR,UAAU,gBAAA,EACV,iBAAiB,uBAAA;QAEjB,IAAM,IAAI,GAAG;YACT,KAAK,OAAA;YACL,WAAW,aAAA;YACX,IAAI,MAAA;YACJ,SAAS,EAAE,QAAQ;YACnB,KAAK,OAAA;YACL,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,UAAU;YACvB,kBAAkB,EAAE,iBAAiB;SACxC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,MAAA;SACP,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,EAUa;YAThB,EAAE,QAAA,EACF,KAAK,WAAA,EACL,WAAW,iBAAA,EACX,IAAI,UAAA,EACJ,QAAQ,cAAA,EACR,KAAK,WAAA,EACL,QAAQ,cAAA,EACR,UAAU,gBAAA,EACV,iBAAiB,uBAAA;QAEjB,IAAM,IAAI,GAAG;YACT,KAAK,OAAA;YACL,WAAW,aAAA;YACX,IAAI,MAAA;YACJ,SAAS,EAAE,QAAQ;YACnB,KAAK,OAAA;YACL,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,UAAU;YACvB,kBAAkB,EAAE,iBAAiB;SACxC,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,wBAAM,GAAN,UAAO,EAA6B;YAA3B,EAAE,QAAA;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAA4B;YACjD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAA4C;YAA1C,IAAI,UAAA,EAAW,QAAQ,aAAA;QAC1B,IAAM,MAAM,GAAG;YACX,IAAI,MAAA;YACJ,QAAQ,UAAA;SACX,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAsB;YACxC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACL,cAAC;AAAD,CAAC,AAjFD,IAiFC"}
@@ -0,0 +1,77 @@
1
+ import { Axios, AxiosDefaults } from 'axios';
2
+ import Article from './article';
3
+ import Admin from './admin';
4
+ import Company from './company';
5
+ import Contact from './contact';
6
+ import Conversation from './conversation';
7
+ import Count from './count';
8
+ import DataAttribute from './dataAttribute';
9
+ import Event from './event';
10
+ import HelpCenter from './helpCenter';
11
+ import Message from './message';
12
+ import Note from './note';
13
+ import Segment from './segment';
14
+ import Team from './team';
15
+ import Tag from './tag';
16
+ import Visitor from './visitor';
17
+ interface RequestOptions {
18
+ url: string;
19
+ data?: any;
20
+ params?: any;
21
+ }
22
+ declare type Constructor = {
23
+ usernameAuth?: UsernameAuth;
24
+ tokenAuth?: TokenAuth;
25
+ apiKeyAuth?: ApiKeyAuth;
26
+ };
27
+ declare type UsernameAuth = {
28
+ username: string;
29
+ password: string;
30
+ };
31
+ declare type TokenAuth = {
32
+ token: string;
33
+ };
34
+ declare type ApiKeyAuth = {
35
+ appId: string;
36
+ appApiKey: string;
37
+ };
38
+ export default class Client {
39
+ articles: Article;
40
+ admins: Admin;
41
+ axiosInstance: Axios;
42
+ companies: Company;
43
+ contacts: Contact;
44
+ conversations: Conversation;
45
+ counts: Count;
46
+ dataAttributes: DataAttribute;
47
+ events: Event;
48
+ helpCenter: HelpCenter;
49
+ messages: Message;
50
+ notes: Note;
51
+ segments: Segment;
52
+ passwordPart?: string;
53
+ propertiesToOmitInRequestOpts: string[];
54
+ requestOpts: Partial<AxiosDefaults>;
55
+ tags: Tag;
56
+ teams: Team;
57
+ usebaseURL: (baseURL: string) => this;
58
+ usernamePart?: string;
59
+ visitors: Visitor;
60
+ constructor(args: Constructor);
61
+ initiateAxiosInstance(): Axios;
62
+ useRequestOpts(opts: Partial<AxiosDefaults>): this;
63
+ updateAxiosInstanceDefaults(): void;
64
+ filterUnwantedProperties(opts: Partial<AxiosDefaults>): Partial<AxiosDefaults>;
65
+ ping<T>(): Promise<T>;
66
+ put<T>({ url, data }: RequestOptions): Promise<T>;
67
+ post<T>({ url, data }: RequestOptions): Promise<T>;
68
+ get<T>({ url, data, params }: RequestOptions): Promise<T>;
69
+ nextPage<T>(paginationObject: {
70
+ next: string;
71
+ }): Promise<T>;
72
+ delete<T>({ url, data, params }: RequestOptions): Promise<T>;
73
+ private checkOnErrorInResponse;
74
+ private static getAuthDetails;
75
+ }
76
+ export {};
77
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../lib/client.ts"],"names":[],"mappings":"AACA,OAAc,EAAE,KAAK,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAGnE,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,OAAO,MAAM,WAAW,CAAC;AAMhC,UAAU,cAAc;IACpB,GAAG,EAAE,MAAM,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX,MAAM,CAAC,EAAE,GAAG,CAAC;CAChB;AAED,aAAK,WAAW,GAAG;IACf,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B,CAAC;AAEF,aAAK,YAAY,GAAG;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,SAAS,GAAG;IACb,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,aAAK,UAAU,GAAG;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,MAAM;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC;IACd,aAAa,EAAE,KAAK,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,aAAa,EAAE,YAAY,CAAC;IAC5B,MAAM,EAAE,KAAK,CAAC;IACd,cAAc,EAAE,aAAa,CAAC;IAC9B,MAAM,EAAE,KAAK,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,IAAI,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6BAA6B,EAAE,MAAM,EAAE,CAAC;IACxC,WAAW,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACpC,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,EAAE,IAAI,CAAC;IACZ,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;gBAEN,IAAI,EAAE,WAAW;IAuC7B,qBAAqB,IAAI,KAAK;IAsB9B,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC;IAS3C,2BAA2B,IAAI,IAAI;IAOnC,wBAAwB,CACpB,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,GAC7B,OAAO,CAAC,aAAa,CAAC;IAInB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC;IAcrB,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAcjD,IAAI,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAclD,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBzD,QAAQ,CAAC,CAAC,EAAE,gBAAgB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAiB3D,MAAM,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBlE,OAAO,CAAC,sBAAsB;IAqB9B,OAAO,CAAC,MAAM,CAAC,cAAc;CAehC"}
package/dist/client.js ADDED
@@ -0,0 +1,249 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var tslib_1 = require("tslib");
4
+ var util_1 = require("util");
5
+ var axios_1 = (0, tslib_1.__importDefault)(require("axios"));
6
+ var lodash_1 = require("lodash");
7
+ var article_1 = (0, tslib_1.__importDefault)(require("./article"));
8
+ var admin_1 = (0, tslib_1.__importDefault)(require("./admin"));
9
+ var company_1 = (0, tslib_1.__importDefault)(require("./company"));
10
+ var contact_1 = (0, tslib_1.__importDefault)(require("./contact"));
11
+ var conversation_1 = (0, tslib_1.__importDefault)(require("./conversation"));
12
+ var count_1 = (0, tslib_1.__importDefault)(require("./count"));
13
+ var dataAttribute_1 = (0, tslib_1.__importDefault)(require("./dataAttribute"));
14
+ var event_1 = (0, tslib_1.__importDefault)(require("./event"));
15
+ var helpCenter_1 = (0, tslib_1.__importDefault)(require("./helpCenter"));
16
+ var message_1 = (0, tslib_1.__importDefault)(require("./message"));
17
+ var note_1 = (0, tslib_1.__importDefault)(require("./note"));
18
+ var segment_1 = (0, tslib_1.__importDefault)(require("./segment"));
19
+ var team_1 = (0, tslib_1.__importDefault)(require("./team"));
20
+ var tag_1 = (0, tslib_1.__importDefault)(require("./tag"));
21
+ var visitor_1 = (0, tslib_1.__importDefault)(require("./visitor"));
22
+ var packageJson = (0, tslib_1.__importStar)(require("../package.json"));
23
+ var badResponse_error_1 = require("./errors/badResponse.error");
24
+ var Client = /** @class */ (function () {
25
+ function Client(args) {
26
+ var _this = this;
27
+ var _a = (0, tslib_1.__read)(Client.getAuthDetails(args), 2), usernamePart = _a[0], passwordPart = _a[1];
28
+ this.usernamePart = usernamePart;
29
+ this.passwordPart = passwordPart;
30
+ if (!this.usernamePart || this.passwordPart === undefined) {
31
+ throw new Error('Could not construct a client with those parameters');
32
+ }
33
+ this.admins = new admin_1.default(this);
34
+ this.articles = new article_1.default(this);
35
+ this.companies = new company_1.default(this);
36
+ this.contacts = new contact_1.default(this);
37
+ this.conversations = new conversation_1.default(this);
38
+ this.counts = new count_1.default(this);
39
+ this.dataAttributes = new dataAttribute_1.default(this);
40
+ this.events = new event_1.default(this);
41
+ this.helpCenter = new helpCenter_1.default(this);
42
+ this.messages = new message_1.default(this);
43
+ this.notes = new note_1.default(this);
44
+ this.segments = new segment_1.default(this);
45
+ this.tags = new tag_1.default(this);
46
+ this.teams = new team_1.default(this);
47
+ this.visitors = new visitor_1.default(this);
48
+ this.requestOpts = {
49
+ baseURL: 'https://api.intercom.io',
50
+ };
51
+ this.propertiesToOmitInRequestOpts = ['headers.common.Accept'];
52
+ this.usebaseURL = (0, util_1.deprecate)(function (baseURL) { return _this.useRequestOpts({ baseURL: baseURL }); }, 'intercom-client - client.usebaseURL(url): Use client.useRequestOpts({ baseURL: url }) instead');
53
+ this.axiosInstance = this.initiateAxiosInstance();
54
+ }
55
+ Client.prototype.initiateAxiosInstance = function () {
56
+ var defaultHeaders = {
57
+ 'User-Agent': "intercom-node-client/".concat(packageJson.version),
58
+ Accept: 'application/json',
59
+ };
60
+ var axiosInstance = axios_1.default.create({
61
+ auth: {
62
+ username: this.usernamePart,
63
+ password: this.passwordPart,
64
+ },
65
+ baseURL: this.requestOpts.baseURL,
66
+ });
67
+ axiosInstance.defaults.headers.common = (0, lodash_1.merge)(axiosInstance.defaults.headers.common, defaultHeaders);
68
+ return axiosInstance;
69
+ };
70
+ Client.prototype.useRequestOpts = function (opts) {
71
+ var filteredOpts = this.filterUnwantedProperties(opts);
72
+ this.requestOpts = (0, lodash_1.merge)(this.requestOpts, filteredOpts);
73
+ this.updateAxiosInstanceDefaults();
74
+ return this;
75
+ };
76
+ Client.prototype.updateAxiosInstanceDefaults = function () {
77
+ this.axiosInstance.defaults = (0, lodash_1.merge)(this.axiosInstance.defaults, this.requestOpts);
78
+ };
79
+ Client.prototype.filterUnwantedProperties = function (opts) {
80
+ return (0, lodash_1.omit)(opts, this.propertiesToOmitInRequestOpts);
81
+ };
82
+ Client.prototype.ping = function () {
83
+ return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
84
+ var response, err_1, error;
85
+ return (0, tslib_1.__generator)(this, function (_a) {
86
+ switch (_a.label) {
87
+ case 0:
88
+ _a.trys.push([0, 2, , 3]);
89
+ return [4 /*yield*/, this.axiosInstance.get('/admins')];
90
+ case 1:
91
+ response = _a.sent();
92
+ return [2 /*return*/, response.data];
93
+ case 2:
94
+ err_1 = _a.sent();
95
+ error = err_1.response
96
+ ? this.checkOnErrorInResponse(err_1.response)
97
+ : err_1;
98
+ throw error;
99
+ case 3: return [2 /*return*/];
100
+ }
101
+ });
102
+ });
103
+ };
104
+ Client.prototype.put = function (_a) {
105
+ var url = _a.url, data = _a.data;
106
+ return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
107
+ var response, err_2, error;
108
+ return (0, tslib_1.__generator)(this, function (_b) {
109
+ switch (_b.label) {
110
+ case 0:
111
+ _b.trys.push([0, 2, , 3]);
112
+ return [4 /*yield*/, this.axiosInstance.put(url, data)];
113
+ case 1:
114
+ response = _b.sent();
115
+ return [2 /*return*/, response.data];
116
+ case 2:
117
+ err_2 = _b.sent();
118
+ error = err_2.response
119
+ ? this.checkOnErrorInResponse(err_2.response)
120
+ : err_2;
121
+ throw error;
122
+ case 3: return [2 /*return*/];
123
+ }
124
+ });
125
+ });
126
+ };
127
+ Client.prototype.post = function (_a) {
128
+ var url = _a.url, data = _a.data;
129
+ return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
130
+ var response, err_3, error;
131
+ return (0, tslib_1.__generator)(this, function (_b) {
132
+ switch (_b.label) {
133
+ case 0:
134
+ _b.trys.push([0, 2, , 3]);
135
+ return [4 /*yield*/, this.axiosInstance.post(url, data)];
136
+ case 1:
137
+ response = _b.sent();
138
+ return [2 /*return*/, response.data];
139
+ case 2:
140
+ err_3 = _b.sent();
141
+ error = err_3.response
142
+ ? this.checkOnErrorInResponse(err_3.response)
143
+ : err_3;
144
+ throw error;
145
+ case 3: return [2 /*return*/];
146
+ }
147
+ });
148
+ });
149
+ };
150
+ Client.prototype.get = function (_a) {
151
+ var url = _a.url, data = _a.data, params = _a.params;
152
+ return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
153
+ var response, err_4, error;
154
+ return (0, tslib_1.__generator)(this, function (_b) {
155
+ switch (_b.label) {
156
+ case 0:
157
+ _b.trys.push([0, 2, , 3]);
158
+ return [4 /*yield*/, this.axiosInstance.get(url, {
159
+ params: params,
160
+ data: data,
161
+ })];
162
+ case 1:
163
+ response = _b.sent();
164
+ return [2 /*return*/, response.data];
165
+ case 2:
166
+ err_4 = _b.sent();
167
+ error = err_4.response
168
+ ? this.checkOnErrorInResponse(err_4.response)
169
+ : err_4;
170
+ throw error;
171
+ case 3: return [2 /*return*/];
172
+ }
173
+ });
174
+ });
175
+ };
176
+ Client.prototype.nextPage = function (paginationObject) {
177
+ return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
178
+ var response, err_5, error;
179
+ return (0, tslib_1.__generator)(this, function (_a) {
180
+ switch (_a.label) {
181
+ case 0:
182
+ _a.trys.push([0, 2, , 3]);
183
+ return [4 /*yield*/, this.axiosInstance.get(paginationObject.next, { baseURL: undefined })];
184
+ case 1:
185
+ response = _a.sent();
186
+ return [2 /*return*/, response.data];
187
+ case 2:
188
+ err_5 = _a.sent();
189
+ error = err_5.response
190
+ ? this.checkOnErrorInResponse(err_5.response)
191
+ : err_5;
192
+ throw error;
193
+ case 3: return [2 /*return*/];
194
+ }
195
+ });
196
+ });
197
+ };
198
+ Client.prototype.delete = function (_a) {
199
+ var url = _a.url, data = _a.data, params = _a.params;
200
+ return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
201
+ var response, err_6, error;
202
+ return (0, tslib_1.__generator)(this, function (_b) {
203
+ switch (_b.label) {
204
+ case 0:
205
+ _b.trys.push([0, 2, , 3]);
206
+ return [4 /*yield*/, this.axiosInstance.delete(url, {
207
+ data: data,
208
+ params: params,
209
+ })];
210
+ case 1:
211
+ response = _b.sent();
212
+ return [2 /*return*/, response.data];
213
+ case 2:
214
+ err_6 = _b.sent();
215
+ error = err_6.response
216
+ ? this.checkOnErrorInResponse(err_6.response)
217
+ : err_6;
218
+ throw error;
219
+ case 3: return [2 /*return*/];
220
+ }
221
+ });
222
+ });
223
+ };
224
+ Client.prototype.checkOnErrorInResponse = function (_a) {
225
+ var data = _a.data, headers = _a.headers, status = _a.status;
226
+ if (data.type !== 'error.list') {
227
+ return undefined;
228
+ }
229
+ var message = Array.isArray(data.errors) && data.errors[0].message
230
+ ? data.errors[0].message
231
+ : null;
232
+ return new badResponse_error_1.BadResponseError(message || 'Response error', data, headers, status);
233
+ };
234
+ Client.getAuthDetails = function (args) {
235
+ if (args.apiKeyAuth) {
236
+ return [args.apiKeyAuth.appId, args.apiKeyAuth.appApiKey];
237
+ }
238
+ if (args.tokenAuth) {
239
+ return [args.tokenAuth.token, ''];
240
+ }
241
+ if (args.usernameAuth) {
242
+ return [args.usernameAuth.username, args.usernameAuth.password];
243
+ }
244
+ return [undefined, undefined];
245
+ };
246
+ return Client;
247
+ }());
248
+ exports.default = Client;
249
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../../lib/client.ts"],"names":[],"mappings":";;;AAAA,6BAAiC;AACjC,6DAAmE;AACnE,iCAAqC;AAErC,mEAAgC;AAChC,+DAA4B;AAC5B,mEAAgC;AAChC,mEAAgC;AAChC,6EAA0C;AAC1C,+DAA4B;AAC5B,+EAA4C;AAC5C,+DAA4B;AAC5B,yEAAsC;AACtC,mEAAgC;AAChC,6DAA0B;AAC1B,mEAAgC;AAChC,6DAA0B;AAC1B,2DAAwB;AACxB,mEAAgC;AAEhC,wEAA+C;AAE/C,gEAA8D;AA8B9D;IAuBI,gBAAY,IAAiB;QAA7B,iBAsCC;QArCS,IAAA,KAAA,oBAA+B,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAA,EAAzD,YAAY,QAAA,EAAE,YAAY,QAA+B,CAAC;QAEjE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QAEjC,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACvD,MAAM,IAAI,KAAK,CACX,oDAAoD,CACvD,CAAC;SACL;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,WAAW,GAAG;YACf,OAAO,EAAE,yBAAyB;SACrC,CAAC;QACF,IAAI,CAAC,6BAA6B,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAE/D,IAAI,CAAC,UAAU,GAAG,IAAA,gBAAS,EACvB,UAAC,OAAO,IAAK,OAAA,KAAI,CAAC,cAAc,CAAC,EAAE,OAAO,SAAA,EAAE,CAAC,EAAhC,CAAgC,EAC7C,+FAA+F,CAClG,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtD,CAAC;IACD,sCAAqB,GAArB;QACI,IAAM,cAAc,GAAG;YACnB,YAAY,EAAE,+BAAwB,WAAW,CAAC,OAAO,CAAE;YAC3D,MAAM,EAAE,kBAAkB;SAC7B,CAAC;QAEF,IAAM,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAC/B,IAAI,EAAE;gBACF,QAAQ,EAAE,IAAI,CAAC,YAAsB;gBACrC,QAAQ,EAAE,IAAI,CAAC,YAAsB;aACxC;YACD,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;SACpC,CAAC,CAAC;QAEH,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,IAAA,cAAK,EACzC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EACrC,cAAc,CACjB,CAAC;QAEF,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,+BAAc,GAAd,UAAe,IAA4B;QACvC,IAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAEzD,IAAI,CAAC,WAAW,GAAG,IAAA,cAAK,EAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,2BAA2B,EAAE,CAAC;QAEnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,4CAA2B,GAA3B;QACI,IAAI,CAAC,aAAa,CAAC,QAAQ,GAAG,IAAA,cAAK,EAC/B,IAAI,CAAC,aAAa,CAAC,QAAQ,EAC3B,IAAI,CAAC,WAAW,CACnB,CAAC;IACN,CAAC;IAED,yCAAwB,GAAxB,UACI,IAA4B;QAE5B,OAAO,IAAA,aAAI,EAAC,IAAI,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1D,CAAC;IAEK,qBAAI,GAAV;;;;;;;wBAEyB,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAA;;wBAAlD,QAAQ,GAAG,SAAuC;wBAExD,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,oBAAG,GAAT,UAAa,EAA6B;YAA3B,GAAG,SAAA,EAAE,IAAI,UAAA;;;;;;;wBAEC,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,EAAA;;wBAAlD,QAAQ,GAAG,SAAuC;wBAExD,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,qBAAI,GAAV,UAAc,EAA6B;YAA3B,GAAG,SAAA,EAAE,IAAI,UAAA;;;;;;;wBAEA,qBAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAA;;wBAAnD,QAAQ,GAAG,SAAwC;wBAEzD,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,oBAAG,GAAT,UAAa,EAAqC;YAAnC,GAAG,SAAA,EAAE,IAAI,UAAA,EAAE,MAAM,YAAA;;;;;;;wBAEP,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE;gCAC/C,MAAM,QAAA;gCACN,IAAI,MAAA;6BACP,CAAC,EAAA;;wBAHI,QAAQ,GAAG,SAGf;wBAEF,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,yBAAQ,GAAd,UAAkB,gBAAkC;;;;;;;wBAE3B,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CACzC,gBAAgB,CAAC,IAAI,EACrB,EAAE,OAAO,EAAE,SAAS,EAAE,CACzB,EAAA;;wBAHK,QAAQ,GAAG,SAGhB;wBAED,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,uBAAM,GAAZ,UAAgB,EAAqC;YAAnC,GAAG,SAAA,EAAE,IAAI,UAAA,EAAE,MAAM,YAAA;;;;;;;wBAEV,qBAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE;gCAClD,IAAI,MAAA;gCACJ,MAAM,QAAA;6BACT,CAAC,EAAA;;wBAHI,QAAQ,GAAG,SAGf;wBAEF,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEO,uCAAsB,GAA9B,UAA+B,EAIf;YAHZ,IAAI,UAAA,EACJ,OAAO,aAAA,EACP,MAAM,YAAA;QAEN,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE;YAC5B,OAAO,SAAS,CAAC;SACpB;QAED,IAAM,OAAO,GACT,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;YAChD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;YACxB,CAAC,CAAC,IAAI,CAAC;QACf,OAAO,IAAI,oCAAgB,CACvB,OAAO,IAAI,gBAAgB,EAC3B,IAAI,EACJ,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAEc,qBAAc,GAA7B,UACI,IAAiB;QAEjB,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;SAC7D;QACD,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;SACrC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACnB,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;SACnE;QAED,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAClC,CAAC;IACL,aAAC;AAAD,CAAC,AA3OD,IA2OC"}
@@ -0,0 +1,67 @@
1
+ export declare type StringifiedTimestamp = string;
2
+ export declare type Timestamp = number;
3
+ export declare type Seconds = number;
4
+ export declare type JavascriptObject = Record<string | number, unknown>;
5
+ export declare enum Role {
6
+ USER = "user",
7
+ LEAD = "lead"
8
+ }
9
+ export declare type Paginated<T> = {
10
+ type: string;
11
+ data: T[];
12
+ pages: {
13
+ type: 'pages';
14
+ next?: {
15
+ page: number;
16
+ starting_after?: string;
17
+ };
18
+ page: number;
19
+ per_page: number;
20
+ total_pages: number;
21
+ };
22
+ total_count: number;
23
+ };
24
+ export declare enum Operators {
25
+ AND = "AND",
26
+ OR = "OR",
27
+ EQUALS = "=",
28
+ NOT_EQUALS = "!=",
29
+ IN = "IN",
30
+ NIN = "NIN",
31
+ GREATER_THAN = ">",
32
+ LESS_THAN = "<",
33
+ CONTAINS = "~",
34
+ NOT_CONTAINS = "!~",
35
+ STARTS_WITH = "^",
36
+ ENDS_WITH = "$"
37
+ }
38
+ interface FlatQuery {
39
+ field: string;
40
+ operator: Operators;
41
+ value: string | number | null;
42
+ }
43
+ interface NestedQueries {
44
+ operator: Operators;
45
+ value: Array<FlatQuery | NestedQueries> | string | number | null;
46
+ }
47
+ export interface GenericSearchFilters {
48
+ query: FlatQuery | NestedQueries;
49
+ }
50
+ export declare enum Order {
51
+ DESC = "desc",
52
+ ASC = "asc"
53
+ }
54
+ export interface PaginationParams {
55
+ page?: number;
56
+ perPage?: number;
57
+ }
58
+ export interface GenericDeletedResponse<ObjectType extends string> {
59
+ id: string;
60
+ object: ObjectType;
61
+ deleted: boolean;
62
+ }
63
+ export interface OperationById {
64
+ id: string;
65
+ }
66
+ export {};
67
+ //# sourceMappingURL=common.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"common.types.d.ts","sourceRoot":"","sources":["../../../lib/common/common.types.ts"],"names":[],"mappings":"AAAA,oBAAY,oBAAoB,GAAG,MAAM,CAAC;AAC1C,oBAAY,SAAS,GAAG,MAAM,CAAC;AAC/B,oBAAY,OAAO,GAAG,MAAM,CAAC;AAC7B,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhE,oBAAY,IAAI;IACZ,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED,oBAAY,SAAS,CAAC,CAAC,IAAI;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,KAAK,EAAE;QACH,IAAI,EAAE,OAAO,CAAC;QACd,IAAI,CAAC,EAAE;YACH,IAAI,EAAE,MAAM,CAAC;YACb,cAAc,CAAC,EAAE,MAAM,CAAC;SAC3B,CAAC;QACF,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,oBAAY,SAAS;IACjB,GAAG,QAAQ;IACX,EAAE,OAAO;IACT,MAAM,MAAM;IACZ,UAAU,OAAO;IACjB,EAAE,OAAO;IACT,GAAG,QAAQ;IACX,YAAY,MAAM;IAClB,SAAS,MAAM;IACf,QAAQ,MAAM;IACd,YAAY,OAAO;IACnB,WAAW,MAAM;IACjB,SAAS,MAAM;CAClB;AAED,UAAU,SAAS;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,UAAU,aAAa;IACnB,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC,SAAS,GAAG,aAAa,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,oBAAoB;IACjC,KAAK,EAAE,SAAS,GAAG,aAAa,CAAC;CACpC;AAED,oBAAY,KAAK;IACb,IAAI,SAAS;IACb,GAAG,QAAQ;CACd;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB,CAAC,UAAU,SAAS,MAAM;IAC7D,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;CACd"}
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Order = exports.Operators = exports.Role = void 0;
4
+ var Role;
5
+ (function (Role) {
6
+ Role["USER"] = "user";
7
+ Role["LEAD"] = "lead";
8
+ })(Role = exports.Role || (exports.Role = {}));
9
+ var Operators;
10
+ (function (Operators) {
11
+ Operators["AND"] = "AND";
12
+ Operators["OR"] = "OR";
13
+ Operators["EQUALS"] = "=";
14
+ Operators["NOT_EQUALS"] = "!=";
15
+ Operators["IN"] = "IN";
16
+ Operators["NIN"] = "NIN";
17
+ Operators["GREATER_THAN"] = ">";
18
+ Operators["LESS_THAN"] = "<";
19
+ Operators["CONTAINS"] = "~";
20
+ Operators["NOT_CONTAINS"] = "!~";
21
+ Operators["STARTS_WITH"] = "^";
22
+ Operators["ENDS_WITH"] = "$";
23
+ })(Operators = exports.Operators || (exports.Operators = {}));
24
+ var Order;
25
+ (function (Order) {
26
+ Order["DESC"] = "desc";
27
+ Order["ASC"] = "asc";
28
+ })(Order = exports.Order || (exports.Order = {}));
29
+ //# sourceMappingURL=common.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../../lib/common/common.types.ts"],"names":[],"mappings":";;;AAKA,IAAY,IAGX;AAHD,WAAY,IAAI;IACZ,qBAAa,CAAA;IACb,qBAAa,CAAA;AACjB,CAAC,EAHW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAGf;AAkBD,IAAY,SAaX;AAbD,WAAY,SAAS;IACjB,wBAAW,CAAA;IACX,sBAAS,CAAA;IACT,yBAAY,CAAA;IACZ,8BAAiB,CAAA;IACjB,sBAAS,CAAA;IACT,wBAAW,CAAA;IACX,+BAAkB,CAAA;IAClB,4BAAe,CAAA;IACf,2BAAc,CAAA;IACd,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;AACnB,CAAC,EAbW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAapB;AAiBD,IAAY,KAGX;AAHD,WAAY,KAAK;IACb,sBAAa,CAAA;IACb,oBAAW,CAAA;AACf,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB"}
@@ -0,0 +1,37 @@
1
+ import { JavascriptObject, Paginated, Timestamp } from '../common/common.types';
2
+ import { SegmentObject } from '../segment/segment.types';
3
+ import { TagObject } from '../tag/tag.types';
4
+ export interface CompanyObject {
5
+ type: 'company';
6
+ company_id: string;
7
+ id: string;
8
+ app_id: string;
9
+ name: string;
10
+ remote_created_at: Timestamp;
11
+ created_at: Timestamp;
12
+ updated_at: Timestamp;
13
+ last_request_at: Timestamp;
14
+ monthly_spend: number;
15
+ session_count: number;
16
+ user_count: number;
17
+ size: number;
18
+ website: string;
19
+ industry: string;
20
+ tags: {
21
+ type: 'tag.list';
22
+ tags: TagObject;
23
+ };
24
+ segments: {
25
+ type: 'segment.list';
26
+ segments: SegmentObject;
27
+ };
28
+ plan: PlanObject;
29
+ custom_attributes: JavascriptObject;
30
+ }
31
+ export interface PlanObject {
32
+ type: 'plan';
33
+ id: string;
34
+ name: string;
35
+ }
36
+ export declare type ListCompaniesResponse = Paginated<CompanyObject>;
37
+ //# sourceMappingURL=company.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"company.types.d.ts","sourceRoot":"","sources":["../../../lib/company/company.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,SAAS,CAAC;IAC7B,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,CAAC;IACtB,eAAe,EAAE,SAAS,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,QAAQ,EAAE;QACN,IAAI,EAAE,cAAc,CAAC;QACrB,QAAQ,EAAE,aAAa,CAAC;KAC3B,CAAC;IACF,IAAI,EAAE,UAAU,CAAC;IACjB,iBAAiB,EAAE,gBAAgB,CAAC;CACvC;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,qBAAqB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=company.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"company.types.js","sourceRoot":"","sources":["../../../lib/company/company.types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,63 @@
1
+ import { Client } from '.';
2
+ import { PaginationParams, JavascriptObject, Order, Paginated, Timestamp, GenericDeletedResponse } from './common/common.types';
3
+ import { CompanyObject, ListCompaniesResponse } from './company/company.types';
4
+ import { ContactObject } from './contact/contact.types';
5
+ import Scroll from './scroll';
6
+ import { SegmentObject } from './segment/segment.types';
7
+ export default class Company {
8
+ private readonly client;
9
+ readonly baseUrl = "companies";
10
+ readonly scroll: Scroll<Company>;
11
+ constructor(client: Client);
12
+ create({ createdAt, companyId, name, monthlySpend, plan, size, website, industry, customAttributes, }: CreateCompanyData): Promise<CompanyObject>;
13
+ update({ createdAt, companyId, name, monthlySpend, plan, size, website, industry, customAttributes, }: UpdateCompanyData): Promise<CompanyObject>;
14
+ find({ companyId, name }: FindCompanyData): Promise<CompanyObject>;
15
+ delete({ id }: DeleteCompanyData): Promise<DeleteCompanyResponse>;
16
+ list({ page, perPage: per_page, order, tagId: tag_id, segmentId: segment_id, }: ListCompaniesData): Promise<ListCompaniesResponse>;
17
+ attachContact({ contactId, companyId }: AttachContactData): Promise<CompanyObject>;
18
+ detachContact({ contactId, companyId }: DetachContactData): Promise<CompanyObject>;
19
+ listAttachedContacts({ companyId, page, perPage, }: ListAttachedContactsData): Promise<Paginated<ContactObject>>;
20
+ listAttachedSegments({ companyId }: ListAttachedSegmentsData): Promise<ListAttachedSegmentsResponse>;
21
+ }
22
+ interface CreateCompanyData {
23
+ createdAt: Timestamp;
24
+ companyId: string;
25
+ name: string;
26
+ monthlySpend: number;
27
+ plan: string;
28
+ size: number;
29
+ website: string;
30
+ industry: string;
31
+ customAttributes: JavascriptObject;
32
+ }
33
+ declare type UpdateCompanyData = CreateCompanyData;
34
+ interface FindCompanyData {
35
+ companyId?: string;
36
+ name?: string;
37
+ }
38
+ interface DeleteCompanyData {
39
+ id: string;
40
+ }
41
+ declare type DeleteCompanyResponse = GenericDeletedResponse<'company'>;
42
+ interface ListCompaniesData extends PaginationParams {
43
+ order?: Order;
44
+ tagId?: string;
45
+ segmentId?: string;
46
+ }
47
+ interface AttachContactData {
48
+ contactId: string;
49
+ companyId: string;
50
+ }
51
+ declare type DetachContactData = AttachContactData;
52
+ interface ListAttachedContactsData extends PaginationParams {
53
+ companyId: string;
54
+ }
55
+ interface ListAttachedSegmentsData {
56
+ companyId: string;
57
+ }
58
+ interface ListAttachedSegmentsResponse {
59
+ type: 'list';
60
+ data: SegmentObject[];
61
+ }
62
+ export {};
63
+ //# sourceMappingURL=company.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"company.d.ts","sourceRoot":"","sources":["../../lib/company.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,SAAS,EACT,SAAS,EACT,sBAAsB,EACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,MAAM,CAAC,OAAO,OAAO,OAAO;IAIZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAHnC,SAAgB,OAAO,eAAe;IACtC,SAAgB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBAEX,MAAM,EAAE,MAAM;IAI3C,MAAM,CAAC,EACH,SAAS,EACT,SAAS,EACT,IAAI,EACJ,YAAY,EACZ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,gBAAgB,GACnB,EAAE,iBAAiB;IAkBpB,MAAM,CAAC,EACH,SAAS,EACT,SAAS,EACT,IAAI,EACJ,YAAY,EACZ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,gBAAgB,GACnB,EAAE,iBAAiB;IAiBpB,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,eAAe;IAazC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,iBAAiB;IAKhC,IAAI,CAAC,EACD,IAAI,EACJ,OAAO,EAAE,QAAQ,EACjB,KAAK,EACL,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,UAAU,GACxB,EAAE,iBAAiB;IAcpB,aAAa,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,iBAAiB;IAUzD,aAAa,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,iBAAiB;IAKzD,oBAAoB,CAAC,EACjB,SAAS,EACT,IAAI,EACJ,OAAO,GACV,EAAE,wBAAwB;IAQ3B,oBAAoB,CAAC,EAAE,SAAS,EAAE,EAAE,wBAAwB;CAK/D;AAED,UAAU,iBAAiB;IACvB,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,gBAAgB,CAAC;CACtC;AAED,aAAK,iBAAiB,GAAG,iBAAiB,CAAC;AAE3C,UAAU,eAAe;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,iBAAiB;IACvB,EAAE,EAAE,MAAM,CAAC;CACd;AACD,aAAK,qBAAqB,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;AAE/D,UAAU,iBAAkB,SAAQ,gBAAgB;IAChD,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,iBAAiB;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,aAAK,iBAAiB,GAAG,iBAAiB,CAAC;AAE3C,UAAU,wBAAyB,SAAQ,gBAAgB;IACvD,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,wBAAwB;IAC9B,SAAS,EAAE,MAAM,CAAC;CACrB;AACD,UAAU,4BAA4B;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,EAAE,CAAC;CACzB"}