mailgun.js 8.2.0 → 8.2.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/CHANGELOG.md +22 -0
- package/interfaces/DomainCredentials.d.ts +3 -3
- package/interfaces/DomainTags.d.ts +2 -2
- package/interfaces/DomainTemplates.d.ts +6 -6
- package/interfaces/DomainTracking.d.ts +3 -3
- package/interfaces/Domains.d.ts +3 -3
- package/interfaces/IpPools.d.ts +7 -7
- package/interfaces/Messages.d.ts +5 -5
- package/interfaces/StatsOptions.d.ts +1 -1
- package/interfaces/Suppressions/Suppressions.d.ts +3 -3
- package/interfaces/Validate.d.ts +1 -1
- package/interfaces/Webhooks.d.ts +1 -1
- package/interfaces/lists.d.ts +2 -2
- package/interfaces/mailListMembers.d.ts +4 -4
- package/interfaces/routes.d.ts +2 -2
- package/mailgun.node.js +2 -2
- package/mailgun.node.js.LICENSE.txt +1 -1
- package/mailgun.web.js +2 -2
- package/mailgun.web.js.LICENSE.txt +1 -1
- package/package.json +1 -1
- package/version.md +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,28 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
### [8.2.2](https://github.com/mailgun/mailgun.js/compare/v8.2.1...v8.2.2) (2023-05-26)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* **deps-dev:** bump webpack from 5.70.0 to 5.76.0 ([3b28232](https://github.com/mailgun/mailgun.js/commits/3b2823281e5ff59f1d04e55bf4f37da6bc691df7))
|
|
11
|
+
* **deps:** bump yaml and @commitlint/cli ([c6d1538](https://github.com/mailgun/mailgun.js/commits/c6d153874e306a8b4209b544005918e5307ce332))
|
|
12
|
+
|
|
13
|
+
### [8.2.1](https://github.com/mailgun/mailgun.js/compare/v8.2.0...v8.2.1) (2023-03-06)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* **#342:** Items Can be Missing When Paging ([95ca758](https://github.com/mailgun/mailgun.js/commits/95ca7587eba6067a278179f7f015366c97a4f757)), closes [#342](https://github.com/mailgun/mailgun.js/issues/342)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Other changes
|
|
22
|
+
|
|
23
|
+
* Udpate build ([1db5554](https://github.com/mailgun/mailgun.js/commits/1db555450f63d21f415c164cfef43de377399133))
|
|
24
|
+
* Update eslit rules for tests ([0d0a00d](https://github.com/mailgun/mailgun.js/commits/0d0a00db7a2dc342dfc3e615ce51a07c597cdbc1))
|
|
25
|
+
* Update suppressions tests to decrease usage of any ([2d3754a](https://github.com/mailgun/mailgun.js/commits/2d3754a4b632a074d7275535ea708380bfa064ad))
|
|
26
|
+
|
|
5
27
|
## [8.2.0](https://github.com/mailgun/mailgun.js/compare/v8.1.0...v8.2.0) (2023-03-02)
|
|
6
28
|
|
|
7
29
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type DomainCredentialsQuery = {
|
|
2
2
|
limit: number;
|
|
3
3
|
skip: number;
|
|
4
4
|
};
|
|
5
|
-
export
|
|
5
|
+
export type DomainCredentials = {
|
|
6
6
|
login: string;
|
|
7
7
|
password: string;
|
|
8
8
|
};
|
|
@@ -41,7 +41,7 @@ export interface DeletedDomainCredentialsResponse {
|
|
|
41
41
|
spec: string;
|
|
42
42
|
};
|
|
43
43
|
}
|
|
44
|
-
export
|
|
44
|
+
export type UpdateDomainCredentialsData = {
|
|
45
45
|
password: string;
|
|
46
46
|
};
|
|
47
47
|
export interface IDomainCredentials {
|
|
@@ -5,11 +5,11 @@ export declare enum Resolution {
|
|
|
5
5
|
DAY = "day",
|
|
6
6
|
MONTH = "month"
|
|
7
7
|
}
|
|
8
|
-
export
|
|
8
|
+
export type DomainTagsQuery = {
|
|
9
9
|
limit: number;
|
|
10
10
|
page?: string;
|
|
11
11
|
};
|
|
12
|
-
export
|
|
12
|
+
export type DomainTagsStatisticQuery = {
|
|
13
13
|
event: string;
|
|
14
14
|
start?: number;
|
|
15
15
|
end?: number;
|
|
@@ -4,7 +4,7 @@ export declare enum YesNo {
|
|
|
4
4
|
YES = "yes",
|
|
5
5
|
NO = "no"
|
|
6
6
|
}
|
|
7
|
-
export
|
|
7
|
+
export type DomainTemplateData = {
|
|
8
8
|
name: string;
|
|
9
9
|
description: string;
|
|
10
10
|
template: string;
|
|
@@ -12,22 +12,22 @@ export declare type DomainTemplateData = {
|
|
|
12
12
|
engine?: string;
|
|
13
13
|
comment?: string;
|
|
14
14
|
};
|
|
15
|
-
export
|
|
15
|
+
export type DomainTemplateVersionData = {
|
|
16
16
|
template: string;
|
|
17
17
|
tag: string;
|
|
18
18
|
engine?: string;
|
|
19
19
|
comment?: string;
|
|
20
20
|
active?: YesNo;
|
|
21
21
|
};
|
|
22
|
-
export
|
|
22
|
+
export type DomainTemplateUpdateData = {
|
|
23
23
|
description: string;
|
|
24
24
|
};
|
|
25
|
-
export
|
|
25
|
+
export type DomainTemplateUpdateVersionData = {
|
|
26
26
|
template?: string;
|
|
27
27
|
comment?: string;
|
|
28
28
|
active?: YesNo;
|
|
29
29
|
};
|
|
30
|
-
export
|
|
30
|
+
export type DomainTemplatesQuery = {
|
|
31
31
|
/** 'page' (optionally 'p') params from previous response's 'paging' object.
|
|
32
32
|
* Value must be stringified as query params. Ex: '?page=first','?page=next&p=name-of-last-item'
|
|
33
33
|
.... */
|
|
@@ -35,7 +35,7 @@ export declare type DomainTemplatesQuery = {
|
|
|
35
35
|
/** Number of records to retrieve. Default value is 10. */
|
|
36
36
|
limit?: number;
|
|
37
37
|
};
|
|
38
|
-
export
|
|
38
|
+
export type TemplateQuery = {
|
|
39
39
|
active: YesNo;
|
|
40
40
|
};
|
|
41
41
|
export interface ShortTemplateVersion {
|
|
@@ -35,13 +35,13 @@ export interface UpdateDomainTrackingResponse {
|
|
|
35
35
|
status: number;
|
|
36
36
|
body: UpdatedOpenTracking;
|
|
37
37
|
}
|
|
38
|
-
export
|
|
38
|
+
export type OpenTrackingInfo = {
|
|
39
39
|
active: 'yes' | 'no' | 'true' | 'false';
|
|
40
40
|
};
|
|
41
|
-
export
|
|
41
|
+
export type ClickTrackingInfo = {
|
|
42
42
|
active: 'yes' | 'no' | 'true' | 'false' | 'htmlonly';
|
|
43
43
|
};
|
|
44
|
-
export
|
|
44
|
+
export type UnsubscribeTrackingInfo = {
|
|
45
45
|
active: 'yes' | 'no' | 'true' | 'false';
|
|
46
46
|
html_footer: string;
|
|
47
47
|
text_footer: string;
|
package/interfaces/Domains.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type DomainsQuery = {
|
|
2
2
|
authority?: string;
|
|
3
3
|
state?: 'active' | 'unverified' | 'disabled';
|
|
4
4
|
limit?: number;
|
|
@@ -44,7 +44,7 @@ export interface DNSRecord {
|
|
|
44
44
|
valid: string;
|
|
45
45
|
value: string;
|
|
46
46
|
}
|
|
47
|
-
export
|
|
47
|
+
export type DomainResponseData = {
|
|
48
48
|
status: number;
|
|
49
49
|
body: {
|
|
50
50
|
domain: DomainData;
|
|
@@ -67,7 +67,7 @@ export interface DestroyedDomainResponse {
|
|
|
67
67
|
status: number;
|
|
68
68
|
body: MessageResponse;
|
|
69
69
|
}
|
|
70
|
-
export
|
|
70
|
+
export type ConnectionSettings = {
|
|
71
71
|
require_tls: boolean;
|
|
72
72
|
skip_verification: boolean;
|
|
73
73
|
};
|
package/interfaces/IpPools.d.ts
CHANGED
|
@@ -17,38 +17,38 @@ export interface IpPoolListResult {
|
|
|
17
17
|
message: string;
|
|
18
18
|
status: number;
|
|
19
19
|
}
|
|
20
|
-
export
|
|
20
|
+
export type IpPoolUpdateData = {
|
|
21
21
|
name: string;
|
|
22
22
|
description: string;
|
|
23
23
|
ips: string[];
|
|
24
24
|
};
|
|
25
|
-
export
|
|
25
|
+
export type IpPoolMessageResponse = {
|
|
26
26
|
body: {
|
|
27
27
|
message: string;
|
|
28
28
|
};
|
|
29
29
|
status: number;
|
|
30
30
|
};
|
|
31
|
-
export
|
|
31
|
+
export type IpPoolMessageResult = {
|
|
32
32
|
message: string;
|
|
33
33
|
status: number;
|
|
34
34
|
};
|
|
35
|
-
export
|
|
35
|
+
export type IpPoolDeleteData = {
|
|
36
36
|
ip?: string;
|
|
37
37
|
pool_id?: string;
|
|
38
38
|
};
|
|
39
|
-
export
|
|
39
|
+
export type IpPoolCreateData = {
|
|
40
40
|
name: string;
|
|
41
41
|
description?: string;
|
|
42
42
|
ips?: string[];
|
|
43
43
|
};
|
|
44
|
-
export
|
|
44
|
+
export type IpPoolCreateResponse = {
|
|
45
45
|
body: {
|
|
46
46
|
message: string;
|
|
47
47
|
pool_id: string;
|
|
48
48
|
};
|
|
49
49
|
status: number;
|
|
50
50
|
};
|
|
51
|
-
export
|
|
51
|
+
export type IpPoolCreateResult = {
|
|
52
52
|
status: number;
|
|
53
53
|
message: string;
|
|
54
54
|
pool_id: string;
|
package/interfaces/Messages.d.ts
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
*
|
|
5
5
|
* @see {@link https://stackoverflow.com/a/49725198}
|
|
6
6
|
*/
|
|
7
|
-
export
|
|
7
|
+
export type AtLeastOneKeyPresent<Object_, Keys extends keyof Object_ = keyof Object_> = Pick<Object_, Exclude<keyof Object_, Keys>> & {
|
|
8
8
|
[K in Keys]-?: Required<Pick<Object_, K>> & Partial<Pick<Object_, Exclude<Keys, K>>>;
|
|
9
9
|
}[Keys];
|
|
10
|
-
export
|
|
10
|
+
export type MailgunMessageContent = AtLeastOneKeyPresent<{
|
|
11
11
|
/**
|
|
12
12
|
* Body of the message. (text version)
|
|
13
13
|
*/
|
|
@@ -25,7 +25,7 @@ export declare type MailgunMessageContent = AtLeastOneKeyPresent<{
|
|
|
25
25
|
*/
|
|
26
26
|
template?: string;
|
|
27
27
|
}>;
|
|
28
|
-
export
|
|
28
|
+
export type MailgunMessageData = MailgunMessageContent & {
|
|
29
29
|
/**
|
|
30
30
|
* Email address for `From` header
|
|
31
31
|
*/
|
|
@@ -39,11 +39,11 @@ export declare type MailgunMessageData = MailgunMessageContent & {
|
|
|
39
39
|
/**
|
|
40
40
|
* Same as `To` but for `carbon copy`
|
|
41
41
|
*/
|
|
42
|
-
cc?: string;
|
|
42
|
+
cc?: string | string[];
|
|
43
43
|
/**
|
|
44
44
|
* Same as `To` but for `blind carbon copy`
|
|
45
45
|
*/
|
|
46
|
-
bcc?: string;
|
|
46
|
+
bcc?: string | string[];
|
|
47
47
|
/**
|
|
48
48
|
* Message subject
|
|
49
49
|
*/
|
|
@@ -12,7 +12,7 @@ export interface StatsOptions {
|
|
|
12
12
|
resolution: string;
|
|
13
13
|
stats: Stat[];
|
|
14
14
|
}
|
|
15
|
-
export
|
|
15
|
+
export type StatsEvent = 'accepted' | 'delivered' | 'opened' | 'clicked' | 'unsubscribed' | 'stored' | 'complained' | 'failed';
|
|
16
16
|
export interface StatsQuery {
|
|
17
17
|
event: StatsEvent | StatsEvent[];
|
|
18
18
|
start?: string | Date;
|
|
@@ -15,11 +15,11 @@ export interface SuppressionList {
|
|
|
15
15
|
pages: ParsedPagesList;
|
|
16
16
|
status: number;
|
|
17
17
|
}
|
|
18
|
-
export
|
|
18
|
+
export type SuppressionListQuery = {
|
|
19
19
|
limit?: number;
|
|
20
20
|
page?: string;
|
|
21
21
|
};
|
|
22
|
-
export
|
|
22
|
+
export type SuppressionDataType = BounceData | ComplaintData | UnsubscribeData | WhiteListData;
|
|
23
23
|
export interface SuppressionListResponse {
|
|
24
24
|
body: {
|
|
25
25
|
items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[];
|
|
@@ -45,7 +45,7 @@ export interface SuppressionDestroyResult {
|
|
|
45
45
|
address: string;
|
|
46
46
|
status: number;
|
|
47
47
|
}
|
|
48
|
-
export
|
|
48
|
+
export type SuppressionCreationData = {
|
|
49
49
|
address: string;
|
|
50
50
|
code?: number;
|
|
51
51
|
error?: string;
|
package/interfaces/Validate.d.ts
CHANGED
package/interfaces/Webhooks.d.ts
CHANGED
package/interfaces/lists.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { PagesList, ParsedPagesList } from './NavigationThruPages';
|
|
2
|
-
export
|
|
2
|
+
export type ListsQuery = {
|
|
3
3
|
address?: string;
|
|
4
4
|
limit?: number;
|
|
5
5
|
page?: string;
|
|
6
6
|
};
|
|
7
|
-
export
|
|
7
|
+
export type CreateUpdateList = {
|
|
8
8
|
address: string;
|
|
9
9
|
name?: string;
|
|
10
10
|
description?: string;
|
|
@@ -8,16 +8,16 @@ export interface MailListMember {
|
|
|
8
8
|
[key: string]: any;
|
|
9
9
|
};
|
|
10
10
|
}
|
|
11
|
-
export
|
|
11
|
+
export type MailListMembersQuery = {
|
|
12
12
|
subscribed?: 'yes' | 'no';
|
|
13
13
|
limit?: number;
|
|
14
14
|
page?: string;
|
|
15
15
|
};
|
|
16
|
-
export
|
|
16
|
+
export type MultipleMembersData = {
|
|
17
17
|
members: Array<MailListMember>;
|
|
18
18
|
upsert: 'yes' | 'no';
|
|
19
19
|
};
|
|
20
|
-
export
|
|
20
|
+
export type MultipleMembersReqData = {
|
|
21
21
|
members: string;
|
|
22
22
|
upsert: 'yes' | 'no';
|
|
23
23
|
};
|
|
@@ -28,7 +28,7 @@ export interface CreateUpdateMailListMembers {
|
|
|
28
28
|
subscribed?: 'yes' | 'no' | boolean;
|
|
29
29
|
upsert?: 'yes' | 'no';
|
|
30
30
|
}
|
|
31
|
-
export
|
|
31
|
+
export type CreateUpdateMailListMembersReq = {
|
|
32
32
|
address: string;
|
|
33
33
|
name?: string;
|
|
34
34
|
vars?: string;
|
package/interfaces/routes.d.ts
CHANGED
|
@@ -13,13 +13,13 @@ export interface DestroyRouteResponse {
|
|
|
13
13
|
id: string;
|
|
14
14
|
message: string;
|
|
15
15
|
}
|
|
16
|
-
export
|
|
16
|
+
export type CreateUpdateRouteData = {
|
|
17
17
|
priority?: number;
|
|
18
18
|
description?: string;
|
|
19
19
|
expression: string;
|
|
20
20
|
action: string[];
|
|
21
21
|
};
|
|
22
|
-
export
|
|
22
|
+
export type RoutesListQuery = {
|
|
23
23
|
limit?: number;
|
|
24
24
|
skip?: number;
|
|
25
25
|
};
|