intercom-client 2.10.6 → 3.0.0-2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +696 -390
- 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 +41 -37
- 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 +231 -254
- 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 +111 -71
- 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 +156 -75
- 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 +288 -42
- 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 +43 -43
- 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 +26 -59
- 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 +33 -27
- 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 +68 -72
- 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 +27 -32
- 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 +94 -53
- 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 +55 -47
- package/dist/bulk.js +0 -46
- package/dist/counts.js +0 -63
- package/dist/note.js +0 -38
- package/dist/snippet.js +0 -114
- package/dist/user-data.js +0 -100
- package/dist/user.js +0 -110
- package/dist/visitor.js +0 -47
|
@@ -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 @@
|
|
|
1
|
+
{"version":3,"file":"company.types.js","sourceRoot":"","sources":["../../lib/company/company.types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { Client } from '.';
|
|
2
|
+
import { PaginationParams, JavascriptObject, Order, Paginated, Timestamp } 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
|
+
interface DeleteCompanyResponse {
|
|
42
|
+
id: string;
|
|
43
|
+
object: 'company';
|
|
44
|
+
deleted: boolean;
|
|
45
|
+
}
|
|
46
|
+
interface ListCompaniesData extends PaginationParams {
|
|
47
|
+
order?: Order;
|
|
48
|
+
tagId?: string;
|
|
49
|
+
segmentId?: string;
|
|
50
|
+
}
|
|
51
|
+
interface AttachContactData {
|
|
52
|
+
contactId: string;
|
|
53
|
+
companyId: string;
|
|
54
|
+
}
|
|
55
|
+
declare type DetachContactData = AttachContactData;
|
|
56
|
+
interface ListAttachedContactsData extends PaginationParams {
|
|
57
|
+
companyId: string;
|
|
58
|
+
}
|
|
59
|
+
interface ListAttachedSegmentsData {
|
|
60
|
+
companyId: string;
|
|
61
|
+
}
|
|
62
|
+
interface ListAttachedSegmentsResponse {
|
|
63
|
+
type: 'list';
|
|
64
|
+
data: SegmentObject[];
|
|
65
|
+
}
|
|
66
|
+
export {};
|
|
67
|
+
//# 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,EACZ,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,UAAU,qBAAqB;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,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"}
|
package/dist/company.js
CHANGED
|
@@ -1,72 +1,112 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
14
|
-
|
|
15
|
-
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
|
|
16
|
-
|
|
17
|
-
var Company = function () {
|
|
18
|
-
function Company(client) {
|
|
19
|
-
_classCallCheck(this, Company);
|
|
20
|
-
|
|
21
|
-
this.client = client;
|
|
22
|
-
this.scroll = new _scroll2.default(this.client, 'companie');
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
_createClass(Company, [{
|
|
26
|
-
key: 'create',
|
|
27
|
-
value: function create(data, f) {
|
|
28
|
-
return this.client.post('/companies', data, f);
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
var tslib_1 = require("tslib");
|
|
4
|
+
var scroll_1 = (0, tslib_1.__importDefault)(require("./scroll"));
|
|
5
|
+
var url_1 = require("./util/url");
|
|
6
|
+
var Company = /** @class */ (function () {
|
|
7
|
+
function Company(client) {
|
|
8
|
+
this.client = client;
|
|
9
|
+
this.baseUrl = 'companies';
|
|
10
|
+
this.client = client;
|
|
11
|
+
this.scroll = new scroll_1.default(this.client, this.baseUrl);
|
|
29
12
|
}
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
return this.client.
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
|
|
13
|
+
Company.prototype.create = function (_a) {
|
|
14
|
+
var createdAt = _a.createdAt, companyId = _a.companyId, name = _a.name, monthlySpend = _a.monthlySpend, plan = _a.plan, size = _a.size, website = _a.website, industry = _a.industry, customAttributes = _a.customAttributes;
|
|
15
|
+
var data = {
|
|
16
|
+
remote_created_at: createdAt,
|
|
17
|
+
company_id: companyId,
|
|
18
|
+
name: name,
|
|
19
|
+
monthly_spend: monthlySpend,
|
|
20
|
+
plan: plan,
|
|
21
|
+
size: size,
|
|
22
|
+
website: website,
|
|
23
|
+
industry: industry,
|
|
24
|
+
custom_attributes: customAttributes,
|
|
25
|
+
};
|
|
26
|
+
return this.client.post({
|
|
27
|
+
url: "/".concat(this.baseUrl),
|
|
28
|
+
data: data,
|
|
29
|
+
});
|
|
30
|
+
};
|
|
31
|
+
Company.prototype.update = function (_a) {
|
|
32
|
+
var createdAt = _a.createdAt, companyId = _a.companyId, name = _a.name, monthlySpend = _a.monthlySpend, plan = _a.plan, size = _a.size, website = _a.website, industry = _a.industry, customAttributes = _a.customAttributes;
|
|
33
|
+
var data = {
|
|
34
|
+
remote_created_at: createdAt,
|
|
35
|
+
name: name,
|
|
36
|
+
monthly_spend: monthlySpend,
|
|
37
|
+
plan: plan,
|
|
38
|
+
size: size,
|
|
39
|
+
website: website,
|
|
40
|
+
industry: industry,
|
|
41
|
+
custom_attributes: customAttributes,
|
|
42
|
+
};
|
|
43
|
+
return this.client.put({
|
|
44
|
+
url: "/".concat(this.baseUrl, "/").concat(companyId),
|
|
45
|
+
data: data,
|
|
46
|
+
});
|
|
47
|
+
};
|
|
48
|
+
Company.prototype.find = function (_a) {
|
|
49
|
+
var companyId = _a.companyId, name = _a.name;
|
|
50
|
+
var query = {
|
|
51
|
+
company_id: companyId,
|
|
52
|
+
name: name,
|
|
53
|
+
};
|
|
54
|
+
return this.client.get({
|
|
55
|
+
url: "/".concat(this.baseUrl),
|
|
56
|
+
params: (0, url_1.encodeParamsForURL)(query),
|
|
57
|
+
});
|
|
58
|
+
};
|
|
59
|
+
Company.prototype.delete = function (_a) {
|
|
60
|
+
var id = _a.id;
|
|
61
|
+
return this.client.delete({
|
|
62
|
+
url: "/".concat(this.baseUrl, "/").concat(id),
|
|
63
|
+
});
|
|
64
|
+
};
|
|
65
|
+
Company.prototype.list = function (_a) {
|
|
66
|
+
var page = _a.page, per_page = _a.perPage, order = _a.order, tag_id = _a.tagId, segment_id = _a.segmentId;
|
|
67
|
+
var params = {
|
|
68
|
+
page: page,
|
|
69
|
+
per_page: per_page,
|
|
70
|
+
order: order,
|
|
71
|
+
tag_id: tag_id,
|
|
72
|
+
segment_id: segment_id,
|
|
73
|
+
};
|
|
74
|
+
return this.client.get({
|
|
75
|
+
url: "/".concat(this.baseUrl),
|
|
76
|
+
params: params,
|
|
77
|
+
});
|
|
78
|
+
};
|
|
79
|
+
Company.prototype.attachContact = function (_a) {
|
|
80
|
+
var contactId = _a.contactId, companyId = _a.companyId;
|
|
81
|
+
var data = {
|
|
82
|
+
id: companyId,
|
|
83
|
+
};
|
|
84
|
+
return this.client.post({
|
|
85
|
+
url: "/".concat(this.client.contacts.baseUrl, "/").concat(contactId, "/").concat(this.baseUrl),
|
|
86
|
+
data: data,
|
|
87
|
+
});
|
|
88
|
+
};
|
|
89
|
+
Company.prototype.detachContact = function (_a) {
|
|
90
|
+
var contactId = _a.contactId, companyId = _a.companyId;
|
|
91
|
+
return this.client.delete({
|
|
92
|
+
url: "/".concat(this.client.contacts.baseUrl, "/").concat(contactId, "/").concat(this.baseUrl, "/").concat(companyId),
|
|
93
|
+
});
|
|
94
|
+
};
|
|
95
|
+
Company.prototype.listAttachedContacts = function (_a) {
|
|
96
|
+
var companyId = _a.companyId, page = _a.page, perPage = _a.perPage;
|
|
97
|
+
var params = { page: page, perPage: perPage };
|
|
98
|
+
return this.client.get({
|
|
99
|
+
url: "/".concat(this.baseUrl, "/").concat(companyId, "/").concat(this.client.contacts.baseUrl),
|
|
100
|
+
params: params,
|
|
101
|
+
});
|
|
102
|
+
};
|
|
103
|
+
Company.prototype.listAttachedSegments = function (_a) {
|
|
104
|
+
var companyId = _a.companyId;
|
|
105
|
+
return this.client.get({
|
|
106
|
+
url: "/".concat(this.baseUrl, "/").concat(companyId, "/").concat(this.client.segments.baseUrl),
|
|
107
|
+
});
|
|
108
|
+
};
|
|
109
|
+
return Company;
|
|
110
|
+
}());
|
|
111
|
+
exports.default = Company;
|
|
112
|
+
//# sourceMappingURL=company.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"company.js","sourceRoot":"","sources":["../lib/company.ts"],"names":[],"mappings":";;;AAUA,iEAA8B;AAE9B,kCAAgD;AAEhD;IAII,iBAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAH3B,YAAO,GAAG,WAAW,CAAC;QAIlC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAU,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACjE,CAAC;IACD,wBAAM,GAAN,UAAO,EAUa;YAThB,SAAS,eAAA,EACT,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,YAAY,kBAAA,EACZ,IAAI,UAAA,EACJ,IAAI,UAAA,EACJ,OAAO,aAAA,EACP,QAAQ,cAAA,EACR,gBAAgB,sBAAA;QAEhB,IAAM,IAAI,GAAG;YACT,iBAAiB,EAAE,SAAS;YAC5B,UAAU,EAAE,SAAS;YACrB,IAAI,MAAA;YACJ,aAAa,EAAE,YAAY;YAC3B,IAAI,MAAA;YACJ,IAAI,MAAA;YACJ,OAAO,SAAA;YACP,QAAQ,UAAA;YACR,iBAAiB,EAAE,gBAAgB;SACtC,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,wBAAM,GAAN,UAAO,EAUa;YAThB,SAAS,eAAA,EACT,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,YAAY,kBAAA,EACZ,IAAI,UAAA,EACJ,IAAI,UAAA,EACJ,OAAO,aAAA,EACP,QAAQ,cAAA,EACR,gBAAgB,sBAAA;QAEhB,IAAM,IAAI,GAAG;YACT,iBAAiB,EAAE,SAAS;YAC5B,IAAI,MAAA;YACJ,aAAa,EAAE,YAAY;YAC3B,IAAI,MAAA;YACJ,IAAI,MAAA;YACJ,OAAO,SAAA;YACP,QAAQ,UAAA;YACR,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,SAAS,CAAE;YACpC,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAAoC;YAAlC,SAAS,eAAA,EAAE,IAAI,UAAA;QAClB,IAAM,KAAK,GAAG;YACV,UAAU,EAAE,SAAS;YACrB,IAAI,MAAA;SACP,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,EAAE,IAAA,wBAAkB,EACtB,KAAuD,CAC1D;SACJ,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,sBAAI,GAAJ,UAAK,EAMe;YALhB,IAAI,UAAA,EACK,QAAQ,aAAA,EACjB,KAAK,WAAA,EACE,MAAM,WAAA,EACF,UAAU,eAAA;QAErB,IAAM,MAAM,GAAG;YACX,IAAI,MAAA;YACJ,QAAQ,UAAA;YACR,KAAK,OAAA;YACL,MAAM,QAAA;YACN,UAAU,YAAA;SACb,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAwB;YAC1C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,+BAAa,GAAb,UAAc,EAA2C;YAAzC,SAAS,eAAA,EAAE,SAAS,eAAA;QAChC,IAAM,IAAI,GAAG;YACT,EAAE,EAAE,SAAS;SAChB,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,OAAO,CAAE;YACpE,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,+BAAa,GAAb,UAAc,EAA2C;YAAzC,SAAS,eAAA,EAAE,SAAS,eAAA;QAChC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAgB;YACrC,GAAG,EAAE,WAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,OAAO,cAAI,SAAS,CAAE;SACpF,CAAC,CAAC;IACP,CAAC;IACD,sCAAoB,GAApB,UAAqB,EAIM;YAHvB,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,OAAO,aAAA;QAEP,IAAM,MAAM,GAAG,EAAE,IAAI,MAAA,EAAE,OAAO,SAAA,EAAE,CAAC;QAEjC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA2B;YAC7C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAE;YACpE,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,sCAAoB,GAApB,UAAqB,EAAuC;YAArC,SAAS,eAAA;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA+B;YACjD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAE;SACvE,CAAC,CAAC;IACP,CAAC;IACL,cAAC;AAAD,CAAC,AArID,IAqIC"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { JavascriptObject, Role, Timestamp } from '../common/common.types';
|
|
2
|
+
export interface ContactObject {
|
|
3
|
+
type: 'contact';
|
|
4
|
+
id: string;
|
|
5
|
+
workspace_id: string;
|
|
6
|
+
external_id: string;
|
|
7
|
+
role: Role;
|
|
8
|
+
email: string;
|
|
9
|
+
phone: string;
|
|
10
|
+
name: string;
|
|
11
|
+
avatar: string;
|
|
12
|
+
owner_id: number;
|
|
13
|
+
social_profiles: Array<SocialProfileObject>;
|
|
14
|
+
has_hard_bounced: boolean;
|
|
15
|
+
marked_email_as_spam: boolean;
|
|
16
|
+
unsubscribed_from_emails: boolean;
|
|
17
|
+
created_at: Timestamp;
|
|
18
|
+
updated_at: Timestamp;
|
|
19
|
+
signed_up_at: Timestamp;
|
|
20
|
+
last_seen_at: Timestamp;
|
|
21
|
+
last_replied_at: Timestamp;
|
|
22
|
+
last_contacted_at: Timestamp;
|
|
23
|
+
last_email_opened_at: Timestamp;
|
|
24
|
+
last_email_clicked_at: Timestamp;
|
|
25
|
+
language_override: string;
|
|
26
|
+
browser: string;
|
|
27
|
+
browser_version: string;
|
|
28
|
+
browser_language: string;
|
|
29
|
+
os: string;
|
|
30
|
+
location: LocationObject;
|
|
31
|
+
android_app_name: string | null;
|
|
32
|
+
android_app_version: string | null;
|
|
33
|
+
android_device: string | null;
|
|
34
|
+
android_os_version: string | null;
|
|
35
|
+
android_sdk_version: string | null;
|
|
36
|
+
android_last_seen_at: Timestamp | null;
|
|
37
|
+
ios_app_name: string | null;
|
|
38
|
+
ios_app_version: string | null;
|
|
39
|
+
ios_device: string | null;
|
|
40
|
+
ios_os_version: string | null;
|
|
41
|
+
ios_sdk_version: string | null;
|
|
42
|
+
ios_last_seen_at: Timestamp | null;
|
|
43
|
+
custom_attributes: JavascriptObject;
|
|
44
|
+
tags: AddressableList;
|
|
45
|
+
notes: AddressableList;
|
|
46
|
+
companies: AddressableList;
|
|
47
|
+
referrer: string;
|
|
48
|
+
utm_campaign: string | null;
|
|
49
|
+
utm_content: string | null;
|
|
50
|
+
utm_medium: string | null;
|
|
51
|
+
utm_source: string | null;
|
|
52
|
+
utm_term: string | null;
|
|
53
|
+
}
|
|
54
|
+
interface LocationObject {
|
|
55
|
+
type: 'location';
|
|
56
|
+
country: string;
|
|
57
|
+
region: string;
|
|
58
|
+
city: string;
|
|
59
|
+
country_code: string;
|
|
60
|
+
continent_code: string;
|
|
61
|
+
}
|
|
62
|
+
interface SocialProfileObject {
|
|
63
|
+
type: 'social_profile';
|
|
64
|
+
name: string;
|
|
65
|
+
url: string;
|
|
66
|
+
}
|
|
67
|
+
interface AddressableList {
|
|
68
|
+
type: 'list';
|
|
69
|
+
data: Array<AddressableObject>;
|
|
70
|
+
url: string;
|
|
71
|
+
total_count: number;
|
|
72
|
+
has_more: boolean;
|
|
73
|
+
}
|
|
74
|
+
interface AddressableObject {
|
|
75
|
+
type: 'company' | 'note' | 'tag';
|
|
76
|
+
id: string;
|
|
77
|
+
url: string;
|
|
78
|
+
}
|
|
79
|
+
export {};
|
|
80
|
+
//# sourceMappingURL=contact.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contact.types.d.ts","sourceRoot":"","sources":["../../lib/contact/contact.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAE3E,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC5C,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;IAClC,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,CAAC;IACtB,YAAY,EAAE,SAAS,CAAC;IACxB,YAAY,EAAE,SAAS,CAAC;IACxB,eAAe,EAAE,SAAS,CAAC;IAC3B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,oBAAoB,EAAE,SAAS,CAAC;IAChC,qBAAqB,EAAE,SAAS,CAAC;IACjC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,cAAc,CAAC;IACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,oBAAoB,EAAE,SAAS,GAAG,IAAI,CAAC;IACvC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,SAAS,GAAG,IAAI,CAAC;IACnC,iBAAiB,EAAE,gBAAgB,CAAC;IACpC,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,eAAe,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,UAAU,cAAc;IACpB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,mBAAmB;IACzB,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACf;AAED,UAAU,eAAe;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;CACf"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contact.types.js","sourceRoot":"","sources":["../../lib/contact/contact.types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { Client } from '.';
|
|
2
|
+
import { ContactObject } from './contact/contact.types';
|
|
3
|
+
import { GenericSearchFilters, Leaves, Paginated } from './common/common.types';
|
|
4
|
+
import { ListCompaniesResponse } from './company/company.types';
|
|
5
|
+
import { SegmentObject } from './segment/segment.types';
|
|
6
|
+
import { TagObject } from './tag/tag.types';
|
|
7
|
+
import { SubscriptionObject } from './subscription/subscription.types';
|
|
8
|
+
export default class Contact {
|
|
9
|
+
private readonly client;
|
|
10
|
+
readonly baseUrl = "contacts";
|
|
11
|
+
constructor(client: Client);
|
|
12
|
+
createUser({ externalId, phone, name, avatar, signedUpAt, lastSeenAt, ownerId, isUnsubscribedFromEmails, customAttributes, }: CreateUserData): Promise<ContactObject>;
|
|
13
|
+
createLead(data?: CreateLeadData): Promise<ContactObject>;
|
|
14
|
+
find({ id }: RetrieveContactData): Promise<ContactObject>;
|
|
15
|
+
update({ id, role, externalId, phone, name, avatar, signedUpAt, lastSeenAt, ownerId, isUnsubscribedFromMails, customAttributes, }: UpdateContactData): Promise<ContactObject>;
|
|
16
|
+
mergeLeadInUser({ leadId, userId }: MergeLeadInUserContactData): Promise<ContactObject>;
|
|
17
|
+
search({ data }: SearchContactRequest): Promise<SearchContactResponse>;
|
|
18
|
+
list({ perPage, startingAfter }: ListAllContactsData): Promise<ListContactsResponse>;
|
|
19
|
+
delete({ id }: DeleteContactData): Promise<DeleteContactResponse>;
|
|
20
|
+
archive({ id }: ArchiveContactData): Promise<ArchiveContactResponse>;
|
|
21
|
+
unarchive({ id }: UnarchiveContactData): Promise<ArchiveContactResponse>;
|
|
22
|
+
listAttachedCompanies({ id, perPage, page }: ListAttachedCompaniesData): Promise<ListCompaniesResponse>;
|
|
23
|
+
listAttachedTags({ id }: RetrieveContactData): Promise<ListAttachedTagsResponse>;
|
|
24
|
+
listAttachedSegments({ id }: RetrieveContactData): Promise<ListAttachedSegmentsResponse>;
|
|
25
|
+
listAttachedEmailSubscriptions({ id }: RetrieveContactData): Promise<ListAttachedEmailSubscriptionsResponse>;
|
|
26
|
+
}
|
|
27
|
+
declare type CreateContactRequest = Pick<ContactObject, 'role'> & Partial<Pick<ContactObject, 'external_id' | 'email' | 'phone' | 'name' | 'avatar' | 'signed_up_at' | 'last_seen_at' | 'owner_id' | 'unsubscribed_from_emails' | 'custom_attributes'>>;
|
|
28
|
+
interface CreateUserData {
|
|
29
|
+
externalId?: CreateContactRequest['external_id'];
|
|
30
|
+
phone?: CreateContactRequest['phone'];
|
|
31
|
+
name?: CreateContactRequest['name'];
|
|
32
|
+
avatar?: CreateContactRequest['avatar'];
|
|
33
|
+
signedUpAt?: CreateContactRequest['signed_up_at'];
|
|
34
|
+
lastSeenAt?: CreateContactRequest['last_seen_at'];
|
|
35
|
+
ownerId?: CreateContactRequest['owner_id'];
|
|
36
|
+
isUnsubscribedFromEmails?: CreateContactRequest['unsubscribed_from_emails'];
|
|
37
|
+
customAttributes?: CreateContactRequest['custom_attributes'];
|
|
38
|
+
}
|
|
39
|
+
interface CreateLeadData {
|
|
40
|
+
phone?: CreateContactRequest['phone'];
|
|
41
|
+
name?: CreateContactRequest['name'];
|
|
42
|
+
avatar?: CreateContactRequest['avatar'];
|
|
43
|
+
signedUpAt?: CreateContactRequest['signed_up_at'];
|
|
44
|
+
lastSeenAt?: CreateContactRequest['last_seen_at'];
|
|
45
|
+
ownerId?: CreateContactRequest['owner_id'];
|
|
46
|
+
isUnsubscribedFromMails?: CreateContactRequest['unsubscribed_from_emails'];
|
|
47
|
+
customAttributes?: CreateContactRequest['custom_attributes'];
|
|
48
|
+
}
|
|
49
|
+
interface RetrieveContactData {
|
|
50
|
+
id: string;
|
|
51
|
+
}
|
|
52
|
+
declare type UpdateContactRequest = Partial<Pick<ContactObject, 'role' | 'external_id' | 'email' | 'phone' | 'name' | 'avatar' | 'signed_up_at' | 'last_seen_at' | 'owner_id' | 'unsubscribed_from_emails' | 'custom_attributes'>>;
|
|
53
|
+
declare type UpdateContactData = {
|
|
54
|
+
id: string;
|
|
55
|
+
role?: UpdateContactRequest['role'];
|
|
56
|
+
externalId?: UpdateContactRequest['external_id'];
|
|
57
|
+
phone?: UpdateContactRequest['phone'];
|
|
58
|
+
name?: UpdateContactRequest['name'];
|
|
59
|
+
avatar?: UpdateContactRequest['avatar'];
|
|
60
|
+
signedUpAt?: UpdateContactRequest['signed_up_at'];
|
|
61
|
+
lastSeenAt?: UpdateContactRequest['last_seen_at'];
|
|
62
|
+
ownerId?: UpdateContactRequest['owner_id'];
|
|
63
|
+
isUnsubscribedFromMails?: UpdateContactRequest['unsubscribed_from_emails'];
|
|
64
|
+
customAttributes?: UpdateContactRequest['custom_attributes'];
|
|
65
|
+
};
|
|
66
|
+
interface DeleteContactData {
|
|
67
|
+
id: string;
|
|
68
|
+
}
|
|
69
|
+
interface DeleteContactResponse {
|
|
70
|
+
id: string;
|
|
71
|
+
object: ContactObject;
|
|
72
|
+
deleted: boolean;
|
|
73
|
+
}
|
|
74
|
+
interface ArchiveContactData {
|
|
75
|
+
id: string;
|
|
76
|
+
}
|
|
77
|
+
interface ArchiveContactResponse {
|
|
78
|
+
id: string;
|
|
79
|
+
object: ContactObject;
|
|
80
|
+
archived: boolean;
|
|
81
|
+
}
|
|
82
|
+
declare type UnarchiveContactData = ArchiveContactData;
|
|
83
|
+
interface MergeLeadInUserContactData {
|
|
84
|
+
leadId: string;
|
|
85
|
+
userId: string;
|
|
86
|
+
}
|
|
87
|
+
export declare enum SearchContactOrderBy {
|
|
88
|
+
ASC = "ascending",
|
|
89
|
+
DESC = "descending"
|
|
90
|
+
}
|
|
91
|
+
interface SearchContactPagination {
|
|
92
|
+
pagination: {
|
|
93
|
+
per_page: number;
|
|
94
|
+
starting_after?: string;
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
interface SearchContactOrder {
|
|
98
|
+
sort: {
|
|
99
|
+
field: Leaves<ContactObject>;
|
|
100
|
+
order: SearchContactOrderBy;
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
interface SearchContactRequest {
|
|
104
|
+
data: GenericSearchFilters<ContactObject> & Partial<SearchContactPagination> & Partial<SearchContactOrder>;
|
|
105
|
+
}
|
|
106
|
+
declare type SearchContactResponse = Paginated<ContactObject>;
|
|
107
|
+
interface ListAllContactsData {
|
|
108
|
+
perPage?: number;
|
|
109
|
+
startingAfter?: string;
|
|
110
|
+
}
|
|
111
|
+
declare type ListContactsResponse = Paginated<ContactObject>;
|
|
112
|
+
declare type ListAttachedTagsResponse = {
|
|
113
|
+
type: string;
|
|
114
|
+
tags: Array<TagObject>;
|
|
115
|
+
};
|
|
116
|
+
declare type ListAttachedSegmentsResponse = {
|
|
117
|
+
type: string;
|
|
118
|
+
data: Array<SegmentObject>;
|
|
119
|
+
};
|
|
120
|
+
declare type ListAttachedEmailSubscriptionsResponse = {
|
|
121
|
+
type: string;
|
|
122
|
+
data: Array<SubscriptionObject>;
|
|
123
|
+
};
|
|
124
|
+
declare type ListAttachedCompaniesData = {
|
|
125
|
+
id: string;
|
|
126
|
+
perPage?: number;
|
|
127
|
+
page?: number;
|
|
128
|
+
};
|
|
129
|
+
export {};
|
|
130
|
+
//# sourceMappingURL=contact.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contact.d.ts","sourceRoot":"","sources":["../lib/contact.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EACH,oBAAoB,EACpB,MAAM,EACN,SAAS,EAEZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE,MAAM,CAAC,OAAO,OAAO,OAAO;IAGZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,SAAgB,OAAO,cAAc;gBAER,MAAM,EAAE,MAAM;IAG3C,UAAU,CAAC,EACP,UAAU,EACV,KAAK,EACL,IAAI,EACJ,MAAM,EACN,UAAU,EACV,UAAU,EACV,OAAO,EACP,wBAAwB,EACxB,gBAAgB,GACnB,EAAE,cAAc;IAmBjB,UAAU,CAAC,IAAI,CAAC,EAAE,cAAc;IAiBhC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;IAKhC,MAAM,CAAC,EACH,EAAE,EACF,IAAI,EACJ,UAAU,EACV,KAAK,EACL,IAAI,EACJ,MAAM,EACN,UAAU,EACV,UAAU,EACV,OAAO,EACP,uBAAuB,EACvB,gBAAgB,GACnB,EAAE,iBAAiB;IAmBpB,eAAe,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,0BAA0B;IAW9D,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,oBAAoB;IAMrC,IAAI,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,EAAE,mBAAmB;IAUpD,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,iBAAiB;IAKhC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,kBAAkB;IAKlC,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,oBAAoB;IAKtC,qBAAqB,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,yBAAyB;IAUtE,gBAAgB,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;IAK5C,oBAAoB,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;IAKhD,8BAA8B,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;CAK7D;AAED,aAAK,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,GACnD,OAAO,CACH,IAAI,CACA,aAAa,EACX,aAAa,GACb,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,cAAc,GACd,cAAc,GACd,UAAU,GACV,0BAA0B,GAC1B,mBAAmB,CACxB,CACJ,CAAC;AAEN,UAAU,cAAc;IACpB,UAAU,CAAC,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC3C,wBAAwB,CAAC,EAAE,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IAC5E,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;CAChE;AAED,UAAU,cAAc;IACpB,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC3C,uBAAuB,CAAC,EAAE,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IAC3E,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;CAChE;AAED,UAAU,mBAAmB;IACzB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,aAAK,oBAAoB,GAAG,OAAO,CAC/B,IAAI,CACA,aAAa,EACX,MAAM,GACN,aAAa,GACb,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,cAAc,GACd,cAAc,GACd,UAAU,GACV,0BAA0B,GAC1B,mBAAmB,CACxB,CACJ,CAAC;AAEF,aAAK,iBAAiB,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,UAAU,CAAC,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC3C,uBAAuB,CAAC,EAAE,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IAC3E,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;CAChE,CAAC;AAEF,UAAU,iBAAiB;IACvB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,qBAAqB;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,UAAU,kBAAkB;IACxB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,sBAAsB;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,aAAK,oBAAoB,GAAG,kBAAkB,CAAC;AAS/C,UAAU,0BAA0B;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,oBAAoB;IAC5B,GAAG,cAAc;IACjB,IAAI,eAAe;CACtB;AACD,UAAU,uBAAuB;IAC7B,UAAU,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;CACL;AAED,UAAU,kBAAkB;IACxB,IAAI,EAAE;QACF,KAAK,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7B,KAAK,EAAE,oBAAoB,CAAC;KAC/B,CAAC;CACL;AAED,UAAU,oBAAoB;IAC1B,IAAI,EAAE,oBAAoB,CAAC,aAAa,CAAC,GACrC,OAAO,CAAC,uBAAuB,CAAC,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACnC;AAED,aAAK,qBAAqB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAOtD,UAAU,mBAAmB;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,aAAK,oBAAoB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAErD,aAAK,wBAAwB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC1B,CAAC;AAEF,aAAK,4BAA4B,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAC9B,CAAC;AAEF,aAAK,sCAAsC,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACnC,CAAC;AAEF,aAAK,yBAAyB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
|