@cakemail-org/ui-components-v2 2.2.4 → 2.2.6
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/dist/cjs/index.js +59 -10
- package/dist/cjs/models/emailAPI/index.d.ts +15 -11
- package/dist/cjs/models/emailAPI/types.d.ts +36 -11
- package/dist/cjs/services/emailAPI/index.d.ts +3 -0
- package/dist/esm/index.js +59 -11
- package/dist/esm/models/emailAPI/index.d.ts +15 -11
- package/dist/esm/models/emailAPI/types.d.ts +36 -11
- package/dist/esm/services/emailAPI/index.d.ts +3 -0
- package/package.json +1 -1
package/dist/cjs/index.js
CHANGED
|
@@ -10462,6 +10462,15 @@ function getEmail(_a) {
|
|
|
10462
10462
|
}
|
|
10463
10463
|
});
|
|
10464
10464
|
}
|
|
10465
|
+
function renderEmail(_a) {
|
|
10466
|
+
var id = _a.id;
|
|
10467
|
+
return callApi({
|
|
10468
|
+
url: uiKitConfig.GATEWAY_PROXY + "/v2/emails/".concat(id, "/render"),
|
|
10469
|
+
fetchOptions: {
|
|
10470
|
+
method: exports.EMethods.get
|
|
10471
|
+
}
|
|
10472
|
+
});
|
|
10473
|
+
}
|
|
10465
10474
|
|
|
10466
10475
|
function createForm(_a) {
|
|
10467
10476
|
var form = _a.form, type = _a.type;
|
|
@@ -16696,7 +16705,7 @@ function ResourceEdit(_a) {
|
|
|
16696
16705
|
title,
|
|
16697
16706
|
" ",
|
|
16698
16707
|
status && React.createElement(material.Box, { className: "statusCheckmark ".concat(status || "") },
|
|
16699
|
-
React.createElement(Icon, { name: "Checkmark10", color: "white" }))),
|
|
16708
|
+
React.createElement(Icon, { name: status === "valid" ? "Checkmark10" : "X14", color: "white" }))),
|
|
16700
16709
|
desc && React.createElement(material.Typography, { variant: "body1", color: "shade500.main" }, desc)),
|
|
16701
16710
|
editable && React.createElement(material.Box, null,
|
|
16702
16711
|
React.createElement(Button, { onClick: handleToggleOpen, color: "body1", variant: 'outlined', iconOnly: true },
|
|
@@ -17649,19 +17658,40 @@ exports.EEmailAttachementTypes = void 0;
|
|
|
17649
17658
|
EEmailAttachementTypes["xls"] = "xls";
|
|
17650
17659
|
EEmailAttachementTypes["xlsx"] = "xlsx";
|
|
17651
17660
|
})(exports.EEmailAttachementTypes || (exports.EEmailAttachementTypes = {}));
|
|
17661
|
+
exports.EEmailStatuses = void 0;
|
|
17662
|
+
(function (EEmailStatuses) {
|
|
17663
|
+
EEmailStatuses["submitted"] = "submitted";
|
|
17664
|
+
EEmailStatuses["delivered"] = "delivered";
|
|
17665
|
+
EEmailStatuses["queued"] = "queued";
|
|
17666
|
+
EEmailStatuses["rejected"] = "rejected";
|
|
17667
|
+
EEmailStatuses["error"] = "error";
|
|
17668
|
+
EEmailStatuses["bounced"] = "bounced";
|
|
17669
|
+
EEmailStatuses["spam"] = "spam";
|
|
17670
|
+
EEmailStatuses["unsubscribed"] = "unsubscribed";
|
|
17671
|
+
EEmailStatuses["global_unsubscribed"] = "global_unsubscribed";
|
|
17672
|
+
EEmailStatuses["other"] = "other";
|
|
17673
|
+
})(exports.EEmailStatuses || (exports.EEmailStatuses = {}));
|
|
17652
17674
|
|
|
17653
17675
|
var Email = /** @class */ (function () {
|
|
17654
17676
|
function Email(params) {
|
|
17655
|
-
this.
|
|
17677
|
+
this.email_id = params.email_id;
|
|
17656
17678
|
this.email = params.email;
|
|
17679
|
+
this.status = params.status;
|
|
17680
|
+
this.provider = params.provider;
|
|
17681
|
+
this.submitted_time = params.submitted_time;
|
|
17682
|
+
this.unsubscribed = params.unsubscribed;
|
|
17683
|
+
this.global_unsubscribed = params.global_unsubscribed;
|
|
17684
|
+
this.soft_bounced = params.soft_bounced;
|
|
17685
|
+
this.hard_bounced = params.hard_bounced;
|
|
17686
|
+
this.reported_as_spam = params.reported_as_spam;
|
|
17687
|
+
this.open = params.open;
|
|
17688
|
+
this.click = params.click;
|
|
17689
|
+
this.list_id = params.list_id;
|
|
17657
17690
|
this.sender = params.sender;
|
|
17658
17691
|
this.content = params.content;
|
|
17659
17692
|
this.tracking = params.tracking;
|
|
17660
17693
|
this.additional_headers = params.additional_headers;
|
|
17661
|
-
this.group_id = params.group_id;
|
|
17662
17694
|
this.tags = params.tags;
|
|
17663
|
-
this.queue_id = params.queue_id;
|
|
17664
|
-
this.attachments = params.attachments;
|
|
17665
17695
|
}
|
|
17666
17696
|
Email.prototype.toJson = function () {
|
|
17667
17697
|
return modelToJson(this);
|
|
@@ -17674,10 +17704,10 @@ var Email = /** @class */ (function () {
|
|
|
17674
17704
|
var options = __rest(_a, []);
|
|
17675
17705
|
return __generator(this, function (_b) {
|
|
17676
17706
|
if (options.filter) {
|
|
17677
|
-
options.filter += ";email_id==" + this.
|
|
17707
|
+
options.filter += ";email_id==" + this.email_id;
|
|
17678
17708
|
}
|
|
17679
17709
|
else {
|
|
17680
|
-
options.filter = "email_id==" + this.
|
|
17710
|
+
options.filter = "email_id==" + this.email_id;
|
|
17681
17711
|
}
|
|
17682
17712
|
return [2 /*return*/, listEmailLogs(options)];
|
|
17683
17713
|
});
|
|
@@ -17693,6 +17723,13 @@ var Email = /** @class */ (function () {
|
|
|
17693
17723
|
});
|
|
17694
17724
|
});
|
|
17695
17725
|
};
|
|
17726
|
+
Email.prototype.render = function () {
|
|
17727
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
17728
|
+
return __generator(this, function (_a) {
|
|
17729
|
+
return [2 /*return*/, renderEmail({ id: this.email_id.toString() })];
|
|
17730
|
+
});
|
|
17731
|
+
});
|
|
17732
|
+
};
|
|
17696
17733
|
return Email;
|
|
17697
17734
|
}());
|
|
17698
17735
|
|
|
@@ -18112,10 +18149,18 @@ var ListPopupModel = /** @class */ (function () {
|
|
|
18112
18149
|
};
|
|
18113
18150
|
ListPopupModel.prototype.save = function (popup) {
|
|
18114
18151
|
return __awaiter(this, void 0, void 0, function () {
|
|
18152
|
+
var dataToUpdate;
|
|
18115
18153
|
var _this = this;
|
|
18116
18154
|
return __generator(this, function (_a) {
|
|
18117
|
-
|
|
18118
|
-
|
|
18155
|
+
dataToUpdate = popup || this.toJson();
|
|
18156
|
+
return [2 /*return*/, updatePopup({ id: this.id, popup: dataToUpdate }).then(function (data) {
|
|
18157
|
+
trackEvent(exports.EEvents.POPUP_UPDATED, {
|
|
18158
|
+
id: _this.id,
|
|
18159
|
+
name: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.name,
|
|
18160
|
+
list_id: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.list_id,
|
|
18161
|
+
form_id: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.form_id,
|
|
18162
|
+
branding: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.branding,
|
|
18163
|
+
});
|
|
18119
18164
|
return new PopupModel(data.data);
|
|
18120
18165
|
})];
|
|
18121
18166
|
});
|
|
@@ -18522,7 +18567,10 @@ var PopupsFactory = /** @class */ (function () {
|
|
|
18522
18567
|
return __generator(this, function (_b) {
|
|
18523
18568
|
return [2 /*return*/, createPopup(popup).then(function (data) {
|
|
18524
18569
|
trackEvent(exports.EEvents.POPUP_CREATED, {
|
|
18525
|
-
name: data.data.name
|
|
18570
|
+
name: data.data.name,
|
|
18571
|
+
list_id: data.data.list_id,
|
|
18572
|
+
form_id: data.data.form_id,
|
|
18573
|
+
branding: data.data.branding,
|
|
18526
18574
|
});
|
|
18527
18575
|
return new PopupModel(data.data);
|
|
18528
18576
|
})];
|
|
@@ -19179,6 +19227,7 @@ exports.removeEmptyProperties = removeEmptyProperties;
|
|
|
19179
19227
|
exports.removeQueryParams = removeQueryParams;
|
|
19180
19228
|
exports.removeTrailingChar = removeTrailingChar;
|
|
19181
19229
|
exports.renderCampaign = renderCampaign;
|
|
19230
|
+
exports.renderEmail = renderEmail;
|
|
19182
19231
|
exports.renderForm = renderForm;
|
|
19183
19232
|
exports.renderPopup = renderPopup;
|
|
19184
19233
|
exports.renderPublicHtmlForm = renderPublicHtmlForm;
|
|
@@ -1,35 +1,39 @@
|
|
|
1
1
|
import { TEmailLog, TEmailReport } from "../../factories";
|
|
2
2
|
import { TGetEmailReport, TListEmailLogs } from "../../services/emailAPI";
|
|
3
3
|
import { TGenericListReturn } from "../../types";
|
|
4
|
-
import { TEmail,
|
|
4
|
+
import { EEmailStatuses, TEmail, TEmailContent } from "./types";
|
|
5
5
|
export declare class Email {
|
|
6
|
-
readonly
|
|
6
|
+
readonly email_id: number;
|
|
7
7
|
readonly email: string;
|
|
8
8
|
readonly sender: {
|
|
9
9
|
id: string;
|
|
10
10
|
name: string;
|
|
11
11
|
email: string;
|
|
12
12
|
};
|
|
13
|
-
readonly content:
|
|
14
|
-
subject: string;
|
|
15
|
-
template_id: number;
|
|
16
|
-
html: string;
|
|
17
|
-
text: string;
|
|
18
|
-
};
|
|
13
|
+
readonly content: TEmailContent;
|
|
19
14
|
readonly tracking: {
|
|
20
15
|
opens: boolean;
|
|
21
16
|
clicks_html: boolean;
|
|
22
17
|
clicks_text: boolean;
|
|
23
18
|
};
|
|
24
19
|
readonly additional_headers: any[];
|
|
25
|
-
readonly group_id: number;
|
|
26
20
|
readonly tags: string[];
|
|
27
|
-
readonly
|
|
28
|
-
readonly
|
|
21
|
+
readonly status: EEmailStatuses;
|
|
22
|
+
readonly provider: string;
|
|
23
|
+
readonly submitted_time: number;
|
|
24
|
+
readonly unsubscribed: boolean;
|
|
25
|
+
readonly global_unsubscribed: boolean;
|
|
26
|
+
readonly soft_bounced: boolean;
|
|
27
|
+
readonly hard_bounced: boolean;
|
|
28
|
+
readonly reported_as_spam: boolean;
|
|
29
|
+
readonly open: number;
|
|
30
|
+
readonly click: number;
|
|
31
|
+
readonly list_id: number;
|
|
29
32
|
constructor(params: TEmail);
|
|
30
33
|
toJson(): any;
|
|
31
34
|
set<T extends keyof this>(property: T, value: this[T]): void;
|
|
32
35
|
listLogs({ ...options }: TListEmailLogs): Promise<TGenericListReturn<TEmailLog>>;
|
|
33
36
|
getReport({ ...options }: TGetEmailReport): Promise<TEmailReport[]>;
|
|
37
|
+
render(): Promise<string>;
|
|
34
38
|
}
|
|
35
39
|
export * from "./types";
|
|
@@ -1,27 +1,30 @@
|
|
|
1
1
|
export type TEmail = {
|
|
2
|
-
|
|
2
|
+
email_id: number;
|
|
3
3
|
email: string;
|
|
4
|
+
status: EEmailStatuses;
|
|
5
|
+
provider: string;
|
|
6
|
+
submitted_time: number;
|
|
7
|
+
unsubscribed: boolean;
|
|
8
|
+
global_unsubscribed: boolean;
|
|
9
|
+
soft_bounced: boolean;
|
|
10
|
+
hard_bounced: boolean;
|
|
11
|
+
reported_as_spam: boolean;
|
|
12
|
+
open: number;
|
|
13
|
+
click: number;
|
|
14
|
+
list_id: number;
|
|
4
15
|
sender: {
|
|
5
16
|
id: string;
|
|
6
17
|
name: string;
|
|
7
18
|
email: string;
|
|
8
19
|
};
|
|
9
|
-
content:
|
|
10
|
-
subject: string;
|
|
11
|
-
template_id: number;
|
|
12
|
-
html: string;
|
|
13
|
-
text: string;
|
|
14
|
-
};
|
|
20
|
+
content: TEmailContent;
|
|
15
21
|
tracking: {
|
|
16
22
|
opens: boolean;
|
|
17
23
|
clicks_html: boolean;
|
|
18
24
|
clicks_text: boolean;
|
|
19
25
|
};
|
|
20
|
-
additional_headers:
|
|
21
|
-
group_id: number;
|
|
26
|
+
additional_headers: TEmailCustomAttribute[];
|
|
22
27
|
tags: string[];
|
|
23
|
-
queue_id: number;
|
|
24
|
-
attachments: TEmailAttachement[];
|
|
25
28
|
};
|
|
26
29
|
export type TEmailAttachement = {
|
|
27
30
|
filename: string;
|
|
@@ -39,3 +42,25 @@ export declare enum EEmailAttachementTypes {
|
|
|
39
42
|
"xls" = "xls",
|
|
40
43
|
"xlsx" = "xlsx"
|
|
41
44
|
}
|
|
45
|
+
export declare enum EEmailStatuses {
|
|
46
|
+
"submitted" = "submitted",
|
|
47
|
+
"delivered" = "delivered",
|
|
48
|
+
"queued" = "queued",
|
|
49
|
+
"rejected" = "rejected",
|
|
50
|
+
"error" = "error",
|
|
51
|
+
"bounced" = "bounced",
|
|
52
|
+
"spam" = "spam",
|
|
53
|
+
"unsubscribed" = "unsubscribed",
|
|
54
|
+
"global_unsubscribed" = "global_unsubscribed",
|
|
55
|
+
"other" = "other"
|
|
56
|
+
}
|
|
57
|
+
export type TEmailCustomAttribute = {
|
|
58
|
+
name: string;
|
|
59
|
+
value: string;
|
|
60
|
+
};
|
|
61
|
+
export type TEmailContent = {
|
|
62
|
+
subject: string;
|
|
63
|
+
template_id: number;
|
|
64
|
+
custom_attributes: TEmailCustomAttribute[];
|
|
65
|
+
type: "marketing" | "transactional";
|
|
66
|
+
};
|
|
@@ -7,4 +7,7 @@ export declare function getEmailActivitySummary({ ...options }: TGetEmailActivit
|
|
|
7
7
|
export declare function getEmail({ id }: {
|
|
8
8
|
id: string;
|
|
9
9
|
}): Promise<any>;
|
|
10
|
+
export declare function renderEmail({ id }: {
|
|
11
|
+
id: string;
|
|
12
|
+
}): Promise<any>;
|
|
10
13
|
export * from "./types";
|
package/dist/esm/index.js
CHANGED
|
@@ -10442,6 +10442,15 @@ function getEmail(_a) {
|
|
|
10442
10442
|
}
|
|
10443
10443
|
});
|
|
10444
10444
|
}
|
|
10445
|
+
function renderEmail(_a) {
|
|
10446
|
+
var id = _a.id;
|
|
10447
|
+
return callApi({
|
|
10448
|
+
url: uiKitConfig.GATEWAY_PROXY + "/v2/emails/".concat(id, "/render"),
|
|
10449
|
+
fetchOptions: {
|
|
10450
|
+
method: EMethods.get
|
|
10451
|
+
}
|
|
10452
|
+
});
|
|
10453
|
+
}
|
|
10445
10454
|
|
|
10446
10455
|
function createForm(_a) {
|
|
10447
10456
|
var form = _a.form, type = _a.type;
|
|
@@ -16676,7 +16685,7 @@ function ResourceEdit(_a) {
|
|
|
16676
16685
|
title,
|
|
16677
16686
|
" ",
|
|
16678
16687
|
status && React__default.createElement(Box, { className: "statusCheckmark ".concat(status || "") },
|
|
16679
|
-
React__default.createElement(Icon, { name: "Checkmark10", color: "white" }))),
|
|
16688
|
+
React__default.createElement(Icon, { name: status === "valid" ? "Checkmark10" : "X14", color: "white" }))),
|
|
16680
16689
|
desc && React__default.createElement(Typography$1, { variant: "body1", color: "shade500.main" }, desc)),
|
|
16681
16690
|
editable && React__default.createElement(Box, null,
|
|
16682
16691
|
React__default.createElement(Button, { onClick: handleToggleOpen, color: "body1", variant: 'outlined', iconOnly: true },
|
|
@@ -17629,19 +17638,40 @@ var EEmailAttachementTypes;
|
|
|
17629
17638
|
EEmailAttachementTypes["xls"] = "xls";
|
|
17630
17639
|
EEmailAttachementTypes["xlsx"] = "xlsx";
|
|
17631
17640
|
})(EEmailAttachementTypes || (EEmailAttachementTypes = {}));
|
|
17641
|
+
var EEmailStatuses;
|
|
17642
|
+
(function (EEmailStatuses) {
|
|
17643
|
+
EEmailStatuses["submitted"] = "submitted";
|
|
17644
|
+
EEmailStatuses["delivered"] = "delivered";
|
|
17645
|
+
EEmailStatuses["queued"] = "queued";
|
|
17646
|
+
EEmailStatuses["rejected"] = "rejected";
|
|
17647
|
+
EEmailStatuses["error"] = "error";
|
|
17648
|
+
EEmailStatuses["bounced"] = "bounced";
|
|
17649
|
+
EEmailStatuses["spam"] = "spam";
|
|
17650
|
+
EEmailStatuses["unsubscribed"] = "unsubscribed";
|
|
17651
|
+
EEmailStatuses["global_unsubscribed"] = "global_unsubscribed";
|
|
17652
|
+
EEmailStatuses["other"] = "other";
|
|
17653
|
+
})(EEmailStatuses || (EEmailStatuses = {}));
|
|
17632
17654
|
|
|
17633
17655
|
var Email = /** @class */ (function () {
|
|
17634
17656
|
function Email(params) {
|
|
17635
|
-
this.
|
|
17657
|
+
this.email_id = params.email_id;
|
|
17636
17658
|
this.email = params.email;
|
|
17659
|
+
this.status = params.status;
|
|
17660
|
+
this.provider = params.provider;
|
|
17661
|
+
this.submitted_time = params.submitted_time;
|
|
17662
|
+
this.unsubscribed = params.unsubscribed;
|
|
17663
|
+
this.global_unsubscribed = params.global_unsubscribed;
|
|
17664
|
+
this.soft_bounced = params.soft_bounced;
|
|
17665
|
+
this.hard_bounced = params.hard_bounced;
|
|
17666
|
+
this.reported_as_spam = params.reported_as_spam;
|
|
17667
|
+
this.open = params.open;
|
|
17668
|
+
this.click = params.click;
|
|
17669
|
+
this.list_id = params.list_id;
|
|
17637
17670
|
this.sender = params.sender;
|
|
17638
17671
|
this.content = params.content;
|
|
17639
17672
|
this.tracking = params.tracking;
|
|
17640
17673
|
this.additional_headers = params.additional_headers;
|
|
17641
|
-
this.group_id = params.group_id;
|
|
17642
17674
|
this.tags = params.tags;
|
|
17643
|
-
this.queue_id = params.queue_id;
|
|
17644
|
-
this.attachments = params.attachments;
|
|
17645
17675
|
}
|
|
17646
17676
|
Email.prototype.toJson = function () {
|
|
17647
17677
|
return modelToJson(this);
|
|
@@ -17654,10 +17684,10 @@ var Email = /** @class */ (function () {
|
|
|
17654
17684
|
var options = __rest(_a, []);
|
|
17655
17685
|
return __generator(this, function (_b) {
|
|
17656
17686
|
if (options.filter) {
|
|
17657
|
-
options.filter += ";email_id==" + this.
|
|
17687
|
+
options.filter += ";email_id==" + this.email_id;
|
|
17658
17688
|
}
|
|
17659
17689
|
else {
|
|
17660
|
-
options.filter = "email_id==" + this.
|
|
17690
|
+
options.filter = "email_id==" + this.email_id;
|
|
17661
17691
|
}
|
|
17662
17692
|
return [2 /*return*/, listEmailLogs(options)];
|
|
17663
17693
|
});
|
|
@@ -17673,6 +17703,13 @@ var Email = /** @class */ (function () {
|
|
|
17673
17703
|
});
|
|
17674
17704
|
});
|
|
17675
17705
|
};
|
|
17706
|
+
Email.prototype.render = function () {
|
|
17707
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
17708
|
+
return __generator(this, function (_a) {
|
|
17709
|
+
return [2 /*return*/, renderEmail({ id: this.email_id.toString() })];
|
|
17710
|
+
});
|
|
17711
|
+
});
|
|
17712
|
+
};
|
|
17676
17713
|
return Email;
|
|
17677
17714
|
}());
|
|
17678
17715
|
|
|
@@ -18092,10 +18129,18 @@ var ListPopupModel = /** @class */ (function () {
|
|
|
18092
18129
|
};
|
|
18093
18130
|
ListPopupModel.prototype.save = function (popup) {
|
|
18094
18131
|
return __awaiter(this, void 0, void 0, function () {
|
|
18132
|
+
var dataToUpdate;
|
|
18095
18133
|
var _this = this;
|
|
18096
18134
|
return __generator(this, function (_a) {
|
|
18097
|
-
|
|
18098
|
-
|
|
18135
|
+
dataToUpdate = popup || this.toJson();
|
|
18136
|
+
return [2 /*return*/, updatePopup({ id: this.id, popup: dataToUpdate }).then(function (data) {
|
|
18137
|
+
trackEvent(EEvents.POPUP_UPDATED, {
|
|
18138
|
+
id: _this.id,
|
|
18139
|
+
name: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.name,
|
|
18140
|
+
list_id: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.list_id,
|
|
18141
|
+
form_id: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.form_id,
|
|
18142
|
+
branding: dataToUpdate === null || dataToUpdate === void 0 ? void 0 : dataToUpdate.branding,
|
|
18143
|
+
});
|
|
18099
18144
|
return new PopupModel(data.data);
|
|
18100
18145
|
})];
|
|
18101
18146
|
});
|
|
@@ -18502,7 +18547,10 @@ var PopupsFactory = /** @class */ (function () {
|
|
|
18502
18547
|
return __generator(this, function (_b) {
|
|
18503
18548
|
return [2 /*return*/, createPopup(popup).then(function (data) {
|
|
18504
18549
|
trackEvent(EEvents.POPUP_CREATED, {
|
|
18505
|
-
name: data.data.name
|
|
18550
|
+
name: data.data.name,
|
|
18551
|
+
list_id: data.data.list_id,
|
|
18552
|
+
form_id: data.data.form_id,
|
|
18553
|
+
branding: data.data.branding,
|
|
18506
18554
|
});
|
|
18507
18555
|
return new PopupModel(data.data);
|
|
18508
18556
|
})];
|
|
@@ -18890,4 +18938,4 @@ var UsersFactory = /** @class */ (function () {
|
|
|
18890
18938
|
return UsersFactory;
|
|
18891
18939
|
}());
|
|
18892
18940
|
|
|
18893
|
-
export { AccountModel, AccountsFactory, ActionBarContainer, ActionBarContainerHandler, AssetManager, AutomationModel, AutomationsFactory, Avatar, BillingFactory, BrandWrapper, BrandsFactory, Button, ButtonMenu, CampaignModel, CampaignsFactory, Checkbox, Chip, CircularProgress, CodeInput, ColManager, ColorTextField, CommonFormModel, ContactModel, ContactsFactory, ContentSectionContainer, CountryDropdown, CustomerModel, DataTable, DataTableHead, DataTableRow, DateCalendar, DatePicker, DateTimeCalendar, DateTimePicker, Dialog, DialogActions, DialogHandler, DialogTitle, Divider, Drawer, DrawerHandler, DropMenu, Dropdown, EApiLanguages, EAssetManagerMatchType, ECampaignStatuses, EEMailSummaryStatuses, EEditorType, EEmailAttachementTypes, EEmailLogType, EEmailLogTypeParam, EEmailProviders, EEmailSummaryEngagement, EEvents, EListAttributeType, EMethods, EOperatorTypes, EPartialInfoPool, EPopupBranding, EPopupBrowserType, EPopupCloseButtonPosition, EPopupDeviceType, EPopupDisplayFrequency, EPopupPosition, EPopupTriggerType, EStorageType, ETaskType, ElementContains, Email, EmailAPIFactory, EmptyContent, EnhancedFormModel, FileUpload, FilterBar, FormModel, FormsFactory, FullBar, GenericWrapper, GenericWrapperContext, GroupedActions, Header, Icon, IconPill, InformationGroup, InlineTextEdit, LinearProgress, Link, ListCampaignModel, ListModel, ListPopupModel, ListTemplateModel, ListsFactory, LoadingContainer, LocationTextField, Logo, MD5, MetricCard, Modal, ModalHandler, ModalHeading, OverlayHandler, PhoneTextField, PopupModel, PopupsFactory, Radio, ResourceEdit, Search, SenderModel, SendersFactory, SideMenu, SideMenuContainer, SideMenuItem, SubNav, SummaryEnhancedFormModel, SupportFactory, SuppressedEmailsFactory, SystemEmailsFactory, SystemEmailsModel, TagsFactory, TasksFactory, TemplateModel, TemplatesFactory, TextField, TimePicker, TimeSelector, Toggle, TopMenu, Typography, UserModel, UsersFactory, acceptListPolicy, addPartialInformation, addSuppressedEmail, addToImpersonificationTree, amIImpersonating, amILoggedInService, archiveCampaign, areAllPropertiesEmpty, buildMUITheme, callApi, camelCase, camelToSnakeCase, cancelCampaign, capitalizeFirstLetter, cleanPostHogId, clearImpersonificationTree, clearStorage, connectToZendeskSupportService, copyToClipboard, createAccount, createBrand, createCampaign, createCampaignLogsExports, createCampaignsReportsExport, createForm, createPopup, createSuppressedEmailExport, createTemplate, deepMergeObject, deleteAnyAutomation, deleteAutomation, deleteCampaign, deleteCampaignsReportsExport, deleteForm, deleteList, deletePartialInformation, deletePopup, deleteStorageItem, deleteSuppressedEmail, deleteTaskService, deleteTemplate, deleteUser, deleteWorkflow, descendingComparator, disableForm, disablePopup, downloadCampaignLogExport, downloadCampaignsReportsExport, downloadContactsExport, downloadListLogExport, downloadSuppressedEmailExport, emptyAccountAddress, emptyAccountLimits, enableForm, enablePopup, enrichBrand, enrichOrganization, enrichProfile, eventCondition, eventIdentify, eventLogout, fetchRetry, fetchRoute, findNestedProperty, formatNumber, getAccount, getAccountReport, getAdjustedBillingCycle, getAllAutomationStats, getAutomation, getAutomationEmailContent, getAutomationExecutionsCount, getAutomationStats, getBeeTokenService, getBestLocalMatch, getBrand, getBrandService, getBrandUrl, getCalendarFormat, getCampaign, getCampaignLinks, getCampaignLinksReport, getCampaignLogs, getCampaignLogsExports, getCampaignReport, getCampaignRevisions, getCampaignsReportsExport, getComparator, getCustomerProfile, getDate, getDomainFromEmail, getDomainsFromEmails, getDomainsService, getEmail, getEmailActivitySummary, getEmailReport, getEndOfDate, getForm, getHashQueryWithoutHistory, getIconSize, getList, getListLogs, getListReport, getNestedProperty, getPopup, getPropertyValue, getSender, getStartOfDate, getStorage, getSuppressedEmailExport, getTColor, getTaskService, getTemplate, getUnixTime, getUrlQueryParam, getUser, getUtmCookies, googlePlacesMapper, hasDecimal, impersonateService, initFieldValidation, initPostHog, isColorLight, isDomainValidService, isSimpleType, isValidEmail, isValidString, isValidUrl, lisTEmailTags, listAccounts, listAutomations, listCampaigns, listCampaignsReportsExports, listContacts, listEmailLogs, listForms, listList, listListAttributes, listListInterests, listPopups, listSenders, listSuppressedEmails, listSystemEmails, listTasksService, listTemplates, listUsers, listWorkflows, logOutService, loginService, miliToSecond, modelSet, modelToJson, originalBrand, patchForm, popImpersonificationTree, postMessage, publishForm, publishPopup, reScheduleCampaign, removeEmptyProperties, removeQueryParams, removeTrailingChar, renderCampaign, renderForm, renderPopup, renderPublicHtmlForm, renderTemplate, requestSupportService, resendVerificationEmail, resumeCampaign, saveList, scheduleCampaign, searchCustomerProfiles, sendCampaignTest, setBrandHeadElements, setStorage, shareTemplate, splitArray, splitObject, stableSort, startPromisePool, suspendCampaign, trackEvent, truncateEmail, truncateText, uiKitConfig, unArchiveCampaign, unScheduleCampaign, unshareTemplate, updateAccount, updateAndClearUrlParams, updateAnyAutomation, updateAutomation, updateCampaign, updatePopup, updateSystemEmails, updateTemplate, updateUser, updateWorkflow, validateColor, validateEmail, validateGenericInput, validateUrl, wait, whiteLabelBrand, whoAmi };
|
|
18941
|
+
export { AccountModel, AccountsFactory, ActionBarContainer, ActionBarContainerHandler, AssetManager, AutomationModel, AutomationsFactory, Avatar, BillingFactory, BrandWrapper, BrandsFactory, Button, ButtonMenu, CampaignModel, CampaignsFactory, Checkbox, Chip, CircularProgress, CodeInput, ColManager, ColorTextField, CommonFormModel, ContactModel, ContactsFactory, ContentSectionContainer, CountryDropdown, CustomerModel, DataTable, DataTableHead, DataTableRow, DateCalendar, DatePicker, DateTimeCalendar, DateTimePicker, Dialog, DialogActions, DialogHandler, DialogTitle, Divider, Drawer, DrawerHandler, DropMenu, Dropdown, EApiLanguages, EAssetManagerMatchType, ECampaignStatuses, EEMailSummaryStatuses, EEditorType, EEmailAttachementTypes, EEmailLogType, EEmailLogTypeParam, EEmailProviders, EEmailStatuses, EEmailSummaryEngagement, EEvents, EListAttributeType, EMethods, EOperatorTypes, EPartialInfoPool, EPopupBranding, EPopupBrowserType, EPopupCloseButtonPosition, EPopupDeviceType, EPopupDisplayFrequency, EPopupPosition, EPopupTriggerType, EStorageType, ETaskType, ElementContains, Email, EmailAPIFactory, EmptyContent, EnhancedFormModel, FileUpload, FilterBar, FormModel, FormsFactory, FullBar, GenericWrapper, GenericWrapperContext, GroupedActions, Header, Icon, IconPill, InformationGroup, InlineTextEdit, LinearProgress, Link, ListCampaignModel, ListModel, ListPopupModel, ListTemplateModel, ListsFactory, LoadingContainer, LocationTextField, Logo, MD5, MetricCard, Modal, ModalHandler, ModalHeading, OverlayHandler, PhoneTextField, PopupModel, PopupsFactory, Radio, ResourceEdit, Search, SenderModel, SendersFactory, SideMenu, SideMenuContainer, SideMenuItem, SubNav, SummaryEnhancedFormModel, SupportFactory, SuppressedEmailsFactory, SystemEmailsFactory, SystemEmailsModel, TagsFactory, TasksFactory, TemplateModel, TemplatesFactory, TextField, TimePicker, TimeSelector, Toggle, TopMenu, Typography, UserModel, UsersFactory, acceptListPolicy, addPartialInformation, addSuppressedEmail, addToImpersonificationTree, amIImpersonating, amILoggedInService, archiveCampaign, areAllPropertiesEmpty, buildMUITheme, callApi, camelCase, camelToSnakeCase, cancelCampaign, capitalizeFirstLetter, cleanPostHogId, clearImpersonificationTree, clearStorage, connectToZendeskSupportService, copyToClipboard, createAccount, createBrand, createCampaign, createCampaignLogsExports, createCampaignsReportsExport, createForm, createPopup, createSuppressedEmailExport, createTemplate, deepMergeObject, deleteAnyAutomation, deleteAutomation, deleteCampaign, deleteCampaignsReportsExport, deleteForm, deleteList, deletePartialInformation, deletePopup, deleteStorageItem, deleteSuppressedEmail, deleteTaskService, deleteTemplate, deleteUser, deleteWorkflow, descendingComparator, disableForm, disablePopup, downloadCampaignLogExport, downloadCampaignsReportsExport, downloadContactsExport, downloadListLogExport, downloadSuppressedEmailExport, emptyAccountAddress, emptyAccountLimits, enableForm, enablePopup, enrichBrand, enrichOrganization, enrichProfile, eventCondition, eventIdentify, eventLogout, fetchRetry, fetchRoute, findNestedProperty, formatNumber, getAccount, getAccountReport, getAdjustedBillingCycle, getAllAutomationStats, getAutomation, getAutomationEmailContent, getAutomationExecutionsCount, getAutomationStats, getBeeTokenService, getBestLocalMatch, getBrand, getBrandService, getBrandUrl, getCalendarFormat, getCampaign, getCampaignLinks, getCampaignLinksReport, getCampaignLogs, getCampaignLogsExports, getCampaignReport, getCampaignRevisions, getCampaignsReportsExport, getComparator, getCustomerProfile, getDate, getDomainFromEmail, getDomainsFromEmails, getDomainsService, getEmail, getEmailActivitySummary, getEmailReport, getEndOfDate, getForm, getHashQueryWithoutHistory, getIconSize, getList, getListLogs, getListReport, getNestedProperty, getPopup, getPropertyValue, getSender, getStartOfDate, getStorage, getSuppressedEmailExport, getTColor, getTaskService, getTemplate, getUnixTime, getUrlQueryParam, getUser, getUtmCookies, googlePlacesMapper, hasDecimal, impersonateService, initFieldValidation, initPostHog, isColorLight, isDomainValidService, isSimpleType, isValidEmail, isValidString, isValidUrl, lisTEmailTags, listAccounts, listAutomations, listCampaigns, listCampaignsReportsExports, listContacts, listEmailLogs, listForms, listList, listListAttributes, listListInterests, listPopups, listSenders, listSuppressedEmails, listSystemEmails, listTasksService, listTemplates, listUsers, listWorkflows, logOutService, loginService, miliToSecond, modelSet, modelToJson, originalBrand, patchForm, popImpersonificationTree, postMessage, publishForm, publishPopup, reScheduleCampaign, removeEmptyProperties, removeQueryParams, removeTrailingChar, renderCampaign, renderEmail, renderForm, renderPopup, renderPublicHtmlForm, renderTemplate, requestSupportService, resendVerificationEmail, resumeCampaign, saveList, scheduleCampaign, searchCustomerProfiles, sendCampaignTest, setBrandHeadElements, setStorage, shareTemplate, splitArray, splitObject, stableSort, startPromisePool, suspendCampaign, trackEvent, truncateEmail, truncateText, uiKitConfig, unArchiveCampaign, unScheduleCampaign, unshareTemplate, updateAccount, updateAndClearUrlParams, updateAnyAutomation, updateAutomation, updateCampaign, updatePopup, updateSystemEmails, updateTemplate, updateUser, updateWorkflow, validateColor, validateEmail, validateGenericInput, validateUrl, wait, whiteLabelBrand, whoAmi };
|
|
@@ -1,35 +1,39 @@
|
|
|
1
1
|
import { TEmailLog, TEmailReport } from "../../factories";
|
|
2
2
|
import { TGetEmailReport, TListEmailLogs } from "../../services/emailAPI";
|
|
3
3
|
import { TGenericListReturn } from "../../types";
|
|
4
|
-
import { TEmail,
|
|
4
|
+
import { EEmailStatuses, TEmail, TEmailContent } from "./types";
|
|
5
5
|
export declare class Email {
|
|
6
|
-
readonly
|
|
6
|
+
readonly email_id: number;
|
|
7
7
|
readonly email: string;
|
|
8
8
|
readonly sender: {
|
|
9
9
|
id: string;
|
|
10
10
|
name: string;
|
|
11
11
|
email: string;
|
|
12
12
|
};
|
|
13
|
-
readonly content:
|
|
14
|
-
subject: string;
|
|
15
|
-
template_id: number;
|
|
16
|
-
html: string;
|
|
17
|
-
text: string;
|
|
18
|
-
};
|
|
13
|
+
readonly content: TEmailContent;
|
|
19
14
|
readonly tracking: {
|
|
20
15
|
opens: boolean;
|
|
21
16
|
clicks_html: boolean;
|
|
22
17
|
clicks_text: boolean;
|
|
23
18
|
};
|
|
24
19
|
readonly additional_headers: any[];
|
|
25
|
-
readonly group_id: number;
|
|
26
20
|
readonly tags: string[];
|
|
27
|
-
readonly
|
|
28
|
-
readonly
|
|
21
|
+
readonly status: EEmailStatuses;
|
|
22
|
+
readonly provider: string;
|
|
23
|
+
readonly submitted_time: number;
|
|
24
|
+
readonly unsubscribed: boolean;
|
|
25
|
+
readonly global_unsubscribed: boolean;
|
|
26
|
+
readonly soft_bounced: boolean;
|
|
27
|
+
readonly hard_bounced: boolean;
|
|
28
|
+
readonly reported_as_spam: boolean;
|
|
29
|
+
readonly open: number;
|
|
30
|
+
readonly click: number;
|
|
31
|
+
readonly list_id: number;
|
|
29
32
|
constructor(params: TEmail);
|
|
30
33
|
toJson(): any;
|
|
31
34
|
set<T extends keyof this>(property: T, value: this[T]): void;
|
|
32
35
|
listLogs({ ...options }: TListEmailLogs): Promise<TGenericListReturn<TEmailLog>>;
|
|
33
36
|
getReport({ ...options }: TGetEmailReport): Promise<TEmailReport[]>;
|
|
37
|
+
render(): Promise<string>;
|
|
34
38
|
}
|
|
35
39
|
export * from "./types";
|
|
@@ -1,27 +1,30 @@
|
|
|
1
1
|
export type TEmail = {
|
|
2
|
-
|
|
2
|
+
email_id: number;
|
|
3
3
|
email: string;
|
|
4
|
+
status: EEmailStatuses;
|
|
5
|
+
provider: string;
|
|
6
|
+
submitted_time: number;
|
|
7
|
+
unsubscribed: boolean;
|
|
8
|
+
global_unsubscribed: boolean;
|
|
9
|
+
soft_bounced: boolean;
|
|
10
|
+
hard_bounced: boolean;
|
|
11
|
+
reported_as_spam: boolean;
|
|
12
|
+
open: number;
|
|
13
|
+
click: number;
|
|
14
|
+
list_id: number;
|
|
4
15
|
sender: {
|
|
5
16
|
id: string;
|
|
6
17
|
name: string;
|
|
7
18
|
email: string;
|
|
8
19
|
};
|
|
9
|
-
content:
|
|
10
|
-
subject: string;
|
|
11
|
-
template_id: number;
|
|
12
|
-
html: string;
|
|
13
|
-
text: string;
|
|
14
|
-
};
|
|
20
|
+
content: TEmailContent;
|
|
15
21
|
tracking: {
|
|
16
22
|
opens: boolean;
|
|
17
23
|
clicks_html: boolean;
|
|
18
24
|
clicks_text: boolean;
|
|
19
25
|
};
|
|
20
|
-
additional_headers:
|
|
21
|
-
group_id: number;
|
|
26
|
+
additional_headers: TEmailCustomAttribute[];
|
|
22
27
|
tags: string[];
|
|
23
|
-
queue_id: number;
|
|
24
|
-
attachments: TEmailAttachement[];
|
|
25
28
|
};
|
|
26
29
|
export type TEmailAttachement = {
|
|
27
30
|
filename: string;
|
|
@@ -39,3 +42,25 @@ export declare enum EEmailAttachementTypes {
|
|
|
39
42
|
"xls" = "xls",
|
|
40
43
|
"xlsx" = "xlsx"
|
|
41
44
|
}
|
|
45
|
+
export declare enum EEmailStatuses {
|
|
46
|
+
"submitted" = "submitted",
|
|
47
|
+
"delivered" = "delivered",
|
|
48
|
+
"queued" = "queued",
|
|
49
|
+
"rejected" = "rejected",
|
|
50
|
+
"error" = "error",
|
|
51
|
+
"bounced" = "bounced",
|
|
52
|
+
"spam" = "spam",
|
|
53
|
+
"unsubscribed" = "unsubscribed",
|
|
54
|
+
"global_unsubscribed" = "global_unsubscribed",
|
|
55
|
+
"other" = "other"
|
|
56
|
+
}
|
|
57
|
+
export type TEmailCustomAttribute = {
|
|
58
|
+
name: string;
|
|
59
|
+
value: string;
|
|
60
|
+
};
|
|
61
|
+
export type TEmailContent = {
|
|
62
|
+
subject: string;
|
|
63
|
+
template_id: number;
|
|
64
|
+
custom_attributes: TEmailCustomAttribute[];
|
|
65
|
+
type: "marketing" | "transactional";
|
|
66
|
+
};
|
|
@@ -7,4 +7,7 @@ export declare function getEmailActivitySummary({ ...options }: TGetEmailActivit
|
|
|
7
7
|
export declare function getEmail({ id }: {
|
|
8
8
|
id: string;
|
|
9
9
|
}): Promise<any>;
|
|
10
|
+
export declare function renderEmail({ id }: {
|
|
11
|
+
id: string;
|
|
12
|
+
}): Promise<any>;
|
|
10
13
|
export * from "./types";
|