mailgun.js 4.0.1 → 4.1.3

package/.eslintrc

@@ -30,6 +30,7 @@
     "class-methods-use-this": 0,
     "prefer-destructuring": 0,
     "import/extensions": 0,
+    "no-shadow": "off",
     "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
     "import/no-extraneous-dependencies" :["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}]
   },
@@ -42,7 +43,8 @@
       ],
       "parser": "@typescript-eslint/parser",
       "rules": {
-        "import/extensions": 0
+        "import/extensions": 0,
+        "@typescript-eslint/no-shadow": ["error"]
         // "import/no-extraneous-dependencies" :["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}]
       },
       "plugins": [

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 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.1.3](https://github.com/mailgun/mailgun.js/compare/v4.1.2...v4.1.3) (2021-12-23)
+
+### [4.1.2](https://github.com/mailgun/mailgun.js/compare/v4.1.1...v4.1.2) (2021-12-14)
+
+
+### Bug Fixes
+
+* Update stats methods to allow an array of events ([#216](https://github.com/mailgun/mailgun.js/issues/216)) ([3b0fc41](https://github.com/mailgun/mailgun.js/commits/3b0fc411a4fa34a27cfd255a914adb17499f3af6))
+
+### [4.1.1](https://github.com/mailgun/mailgun.js/compare/v4.1.0...v4.1.1) (2021-12-13)
+
+
+### Bug Fixes
+
+* Ip_pools create and update methods fix ([#215](https://github.com/mailgun/mailgun.js/issues/215)) ([eb1830d](https://github.com/mailgun/mailgun.js/commits/eb1830de472737c0b3dc6a4cb8856f73b52d20c2))
+
+## [4.1.0](https://github.com/mailgun/mailgun.js/compare/v4.0.1...v4.1.0) (2021-11-30)
+
+
+### Features
+
+* Add support of whitelists into suppressions client ([#214](https://github.com/mailgun/mailgun.js/issues/214)) ([1e4fb84](https://github.com/mailgun/mailgun.js/commits/1e4fb84d2528751a9c2dddd1599d2bc0e12b1fdd))
+
 ### [4.0.1](https://github.com/mailgun/mailgun.js/compare/v4.0.0...v4.0.1) (2021-11-25)
 
 

package/dist/lib/domains.d.ts

@@ -2,7 +2,10 @@ import { DomainsQuery, DomainInfo, DomainShortData, DNSRecord, ConnectionSetting
 import APIResponse from './interfaces/ApiResponse';
 import Request from './request';
 import { DomainTrackingData, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, UpdatedOpenTracking } from './interfaces/DomainTracking';
+import { IDomainCredentials } from './interfaces/DomainCredentials';
+import { IDomainTemplatesClient } from './interfaces/DomainTemplates';
 import DomainCredentialsClient from './domainsCredentials';
+import DomainTemplatesClient from './domainsTemplates';
 export declare class Domain {
     name: string;
     require_tls: boolean;
@@ -20,8 +23,9 @@ export declare class Domain {
 }
 export default class DomainClient {
     request: Request;
-    domainCredentials: DomainCredentialsClient;
-    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient);
+    domainCredentials: IDomainCredentials;
+    domainTemplates: IDomainTemplatesClient;
+    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient, domainTemplatesClient: DomainTemplatesClient);
     private _parseMessage;
     private _parseDomainList;
     private _parseDomain;

package/dist/lib/domainsTemplates.d.ts

@@ -0,0 +1,35 @@
+import Request from './request';
+import { CreateDomainTemplateVersionResult, DomainTemplate, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, IDomainTemplatesClient, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from './interfaces/DomainTemplates';
+export declare class DomainTemplateItem implements DomainTemplate {
+    name: string;
+    description: string;
+    createdAt: Date | '';
+    createdBy: string;
+    id: string;
+    version?: TemplateVersion;
+    versions?: ShortTemplateVersion[];
+    constructor(domainTemplateFromAPI: DomainTemplate);
+}
+export default class DomainTemplatesClient implements IDomainTemplatesClient {
+    baseRoute: string;
+    request: Request;
+    constructor(request: Request);
+    private parseCreationResponse;
+    private parseCreationVersionResponse;
+    private parseMutationResponse;
+    private parseNotificationResponse;
+    private parseMutateTemplateVersionResponse;
+    private parseList;
+    private parseListTemplateVersions;
+    list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
+    get(domain: string, templateName: string): Promise<DomainTemplateItem>;
+    create(domain: string, data: DomainTemplateData): Promise<DomainTemplateItem>;
+    update(domain: string, templateName: string, data: DomainTemplateUpdateData): Promise<UpdateOrDeleteDomainTemplateResult>;
+    destroy(domain: string, templateName: string): Promise<UpdateOrDeleteDomainTemplateResult>;
+    destroyAll(domain: string): Promise<NotificationResult>;
+    createVersion(domain: string, templateName: string, data: DomainTemplateVersionData): Promise<CreateDomainTemplateVersionResult>;
+    getVersion(domain: string, templateName: string, tag: string): Promise<DomainTemplateItem>;
+    updateVersion(domain: string, templateName: string, tag: string, data: DomainTemplateUpdateVersionData): Promise<MutateDomainTemplateVersionResult>;
+    destroyVersion(domain: string, templateName: string, tag: string): Promise<MutateDomainTemplateVersionResult>;
+    listVersions(domain: string, templateName: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplateVersionsResult>;
+}

package/dist/lib/interfaces/DomainTemplates.d.ts

@@ -0,0 +1,191 @@
+import { DomainTemplateItem } from '../domainsTemplates';
+export declare enum YesNo {
+    YES = "yes",
+    NO = "no"
+}
+export declare enum Pages {
+    FIRST = "first",
+    LAST = "last",
+    NEXT = "next",
+    PREV = "prev"
+}
+export interface DomainTemplateData {
+    name: string;
+    description: string;
+    template: string;
+    tag?: string;
+    engine?: string;
+    comment?: string;
+}
+export interface DomainTemplateVersionData {
+    template: string;
+    tag: string;
+    engine?: string;
+    comment?: string;
+    active?: YesNo;
+}
+export interface DomainTemplateUpdateData {
+    description: string;
+}
+export interface DomainTemplateUpdateVersionData {
+    template?: string;
+    comment?: string;
+    active?: YesNo;
+}
+export interface DomainTemplatesQuery {
+    page: Pages;
+    limit: number;
+    p: string;
+}
+export interface ShortTemplateVersion {
+    tag: string;
+    engine: string;
+    mjml: string;
+    createdAt: string | Date;
+    comment: string;
+    active: boolean;
+    id: string;
+}
+export interface TemplateVersion extends ShortTemplateVersion {
+    template: string;
+}
+export interface DomainTemplate {
+    name: string;
+    description: string;
+    createdAt: string | Date;
+    createdBy: string;
+    id: string;
+    version?: TemplateVersion;
+    versions?: ShortTemplateVersion[];
+}
+export interface CreateDomainTemplateAPIResponse {
+    status: number;
+    body: {
+        message: string;
+        template: DomainTemplate;
+    };
+}
+export interface ListDomainTemplatesAPIResponse {
+    status: number;
+    body: {
+        items: DomainTemplate[];
+        paging: {
+            first: string;
+            last: string;
+            next: string;
+            previous: string;
+        };
+    };
+}
+export interface ListDomainTemplatesResult {
+    items: DomainTemplate[];
+    pages: {
+        first: string;
+        last: string;
+        next: string;
+        previous: string;
+    };
+}
+export interface GetDomainTemplateAPIResponse {
+    status: number;
+    body: {
+        template: DomainTemplate;
+    };
+}
+export interface UpdateOrDeleteDomainTemplateAPIResponse {
+    status: number;
+    body: {
+        message: string;
+        template: {
+            name: string;
+        };
+    };
+}
+export interface UpdateOrDeleteDomainTemplateResult {
+    status: number;
+    message: string;
+    templateName?: string;
+}
+export interface NotificationAPIResponse {
+    status: number;
+    body: {
+        message: string;
+    };
+}
+export interface NotificationResult {
+    status: number;
+    message: string;
+}
+export interface CreateDomainTemplateVersionAPIResponse {
+    status: number;
+    body: {
+        message: string;
+        template: DomainTemplate;
+    };
+}
+export interface CreateDomainTemplateVersionResult {
+    status: number;
+    message: string;
+    template: DomainTemplate;
+}
+export interface MutateDomainTemplateVersionAPIResponse {
+    status: number;
+    body: {
+        message: string;
+        template: {
+            name: string;
+            version: {
+                tag: string;
+            };
+        };
+    };
+}
+export interface MutateDomainTemplateVersionResult {
+    status: number;
+    message: string;
+    templateName: string;
+    templateVersion: {
+        tag: string;
+    };
+}
+export interface ListDomainTemplateVersionsAPIResponse {
+    status: number;
+    body: {
+        template: {
+            name: string;
+            description: string;
+            createdAt: string;
+            createdBy: string;
+            id: string;
+            versions: ShortTemplateVersion[];
+        };
+        paging: {
+            first: string;
+            last: string;
+            next: string;
+            previous: string;
+        };
+    };
+}
+export interface ListDomainTemplateVersionsResult {
+    template: DomainTemplateItem;
+    pages: {
+        first: string;
+        last: string;
+        next: string;
+        previous: string;
+    };
+}
+export interface IDomainTemplatesClient {
+    list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
+    get(domain: string, templateName: string): Promise<DomainTemplateItem>;
+    create(domain: string, data: DomainTemplateData): Promise<DomainTemplateItem>;
+    update(domain: string, templateName: string, data: DomainTemplateUpdateData): Promise<UpdateOrDeleteDomainTemplateResult>;
+    destroy(domain: string, templateName: string): Promise<UpdateOrDeleteDomainTemplateResult>;
+    destroyAll(domain: string): Promise<NotificationResult>;
+    createVersion(domain: string, templateName: string, data: DomainTemplateVersionData): Promise<CreateDomainTemplateVersionResult>;
+    getVersion(domain: string, templateName: string, tag: string): Promise<DomainTemplateItem>;
+    updateVersion(domain: string, templateName: string, tag: string, data: DomainTemplateUpdateVersionData): Promise<MutateDomainTemplateVersionResult>;
+    destroyVersion(domain: string, templateName: string, tag: string): Promise<MutateDomainTemplateVersionResult>;
+    listVersions(domain: string, templateName: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplateVersionsResult>;
+}

package/dist/lib/interfaces/StatsOptions.d.ts

@@ -1,14 +1,21 @@
-interface StatsOptions {
+export interface Stat {
+    time: string | Date;
+    delivered: {
+        smtp: number;
+        http: number;
+        total: number;
+    };
+}
+export interface StatsOptions {
     start: string | Date;
     end: string | Date;
     resolution: string;
-    stats: {
-        time: string | Date;
-        delivered: {
-            smtp: number;
-            http: number;
-            total: number;
-        };
-    }[];
+    stats: Stat[];
+}
+export interface StatsQuery {
+    event: string | string[];
+    start: string | Date;
+    end: string | Date;
+    resolution: 'hour' | 'day' | 'month';
+    duration: string;
 }
-export default StatsOptions;

package/dist/lib/interfaces/Supressions.d.ts

@@ -13,3 +13,9 @@ export interface UnsubscribeData {
     tags: any;
     created_at: string | Date;
 }
+export interface WhiteListData {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: string | Date;
+}

package/dist/lib/request.d.ts

@@ -19,6 +19,7 @@ declare class Request {
     post(url: string, data: any, options?: any): Promise<APIResponse>;
     postWithFD(url: string, data: any): Promise<APIResponse>;
     putWithFD(url: string, data: any): Promise<APIResponse>;
+    patchWithFD(url: string, data: any): Promise<APIResponse>;
     createFormData(data: any): NodeFormData | FormData;
     private addMimeDataToFD;
     private addFilesToFD;

package/dist/lib/stats.d.ts

@@ -1,19 +1,20 @@
 import Request from './request';
-import StatsOptions from './interfaces/StatsOptions';
+import { StatsQuery, StatsOptions, Stat } from './interfaces/StatsOptions';
 declare class Stats {
     start: Date;
     end: Date;
     resolution: string;
-    stats: any;
+    stats: Stat[];
     constructor(data: StatsOptions);
 }
 export default class StatsClient {
     request: Request;
     constructor(request: Request);
+    private prepareSearchParams;
     _parseStats(response: {
         body: StatsOptions;
     }): Stats;
-    getDomain(domain: string, query: any): Promise<Stats>;
-    getAccount(query: any): Promise<Stats>;
+    getDomain(domain: string, query?: StatsQuery): Promise<Stats>;
+    getAccount(query?: StatsQuery): Promise<Stats>;
 }
 export {};

package/dist/lib/suppressions.d.ts

@@ -1,5 +1,5 @@
 import Request from './request';
-import { BounceData, ComplaintData, UnsubscribeData } from './interfaces/Supressions';
+import { BounceData, ComplaintData, UnsubscribeData, WhiteListData } from './interfaces/Supressions';
 declare class Bounce {
     type: string;
     address: string;
@@ -21,13 +21,21 @@ declare class Unsubscribe {
     created_at: Date;
     constructor(data: UnsubscribeData);
 }
-declare type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe;
+declare class WhiteList {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: Date;
+    constructor(data: WhiteListData);
+}
+declare type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe | typeof WhiteList;
 export default class SuppressionClient {
     request: any;
     models: {
         bounces: typeof Bounce;
         complaints: typeof Complaint;
         unsubscribes: typeof Unsubscribe;
+        whitelists: typeof WhiteList;
     };
     constructor(request: Request);
     _parsePage(id: string, pageUrl: string): {
@@ -49,7 +57,8 @@ export default class SuppressionClient {
     }, Model: TModel): any;
     _parseItem(response: {
         body: any;
-    }, Model: TModel): Bounce | Complaint | Unsubscribe;
+    }, Model: TModel): Bounce | Complaint | Unsubscribe | WhiteList;
+    private createWhiteList;
     list(domain: string, type: string, query: any): any;
     get(domain: string, type: string, address: string): any;
     create(domain: string, type: string, data: any): any;