mailgun.js 5.0.0 → 5.0.3

package/.eslintrc

@@ -19,7 +19,7 @@
         }
       }
   },
-  "ignorePatterns": ["docs/assets/js/*", "dist/**"],
+  "ignorePatterns": ["docs/assets/js/*", "dist/**", "docs/**"],
   "rules": {
     "tsdoc/syntax": "warn",
     "comma-dangle": 0,

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 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.
 
+### [5.0.3](https://github.com/mailgun/mailgun.js/compare/v5.0.2...v5.0.3) (2022-03-23)
+
+
+### Bug Fixes
+
+* Remove deprecated url package ([406eb56](https://github.com/mailgun/mailgun.js/commits/406eb56916bd52ca8e3d9b1ffacf419d42db5a86))
+* TypeError -> mailgun_js_1.default is not a constructor ([ff91333](https://github.com/mailgun/mailgun.js/commits/ff91333c3f34434c54e993da62a61dc38d6196f4))
+* Update DomainsQuery interface for mg.domains.list ([b55eb52](https://github.com/mailgun/mailgun.js/commits/b55eb52c18eb6d81dd3e6fcb991a8b7b5a75a4ab))
+* Update get method in Domain templates client interface to have an optional parameter ([12868a8](https://github.com/mailgun/mailgun.js/commits/12868a88e5465d4f3dcb3e3797522c7b4fc552a0))
+
+
+### Other changes
+
+* Update webpack release config ([240038a](https://github.com/mailgun/mailgun.js/commits/240038a180eb0ad6a704bf24ed01e3c241bef5d5))
+
+### [5.0.2](https://github.com/mailgun/mailgun.js/compare/v5.0.1...v5.0.2) (2022-03-14)
+
+
+### Bug Fixes
+
+* Make `StatsQuery` interface properties optional, add `StatsEvent` type ([91a2d6a](https://github.com/mailgun/mailgun.js/commits/91a2d6ae22f2c9cb86ee64ccab636d23926bb6d1))
+
+### [5.0.1](https://github.com/mailgun/mailgun.js/compare/v5.0.0...v5.0.1) (2022-02-23)
+
+
+### Bug Fixes
+
+* Resolve ts strict mode issues ([473f6a2](https://github.com/mailgun/mailgun.js/commits/473f6a2909bfa72e9d779d1233485767eac6f323))
+
 ## [5.0.0](https://github.com/mailgun/mailgun.js/compare/v4.2.2...v5.0.0) (2022-02-23)
 
 

package/dist/mailgun.js.d.ts

@@ -6,11 +6,11 @@ declare module 'mailgun.js' {
     import Client from 'mailgun.js/client';
     import { InputFormData } from 'mailgun.js/interfaces/IFormData';
     import Options from 'mailgun.js/interfaces/Options';
-    class Mailgun {
+    export default class Mailgun {
+        static get default(): typeof Mailgun;
         constructor(FormData: InputFormData);
         client(options: Options): Client;
     }
-    export = Mailgun;
 }
 
 declare module 'mailgun.js/client' {
@@ -44,7 +44,7 @@ declare module 'mailgun.js/client' {
 }
 
 declare module 'mailgun.js/interfaces/IFormData' {
-    import NodeFormData from 'form-data';
+    import * as NodeFormData from 'form-data';
     export interface IFormDataOptions {
         [key: string]: any;
     }
@@ -155,80 +155,61 @@ declare module 'mailgun.js/stats' {
 
 declare module 'mailgun.js/suppressions' {
     import Request from 'mailgun.js/request';
-    import { BounceData, ComplaintData, UnsubscribeData, WhiteListData } from 'mailgun.js/interfaces/Supressions';
-    class Bounce {
+    import { BounceData, ComplaintData, ParsedPage, ParsedPagesList, SuppressionCreationData, SuppressionCreationResult, SuppressionDestroyResult, SuppressionList, SuppressionListQuery, SuppressionListResponse, SuppressionModels, UnsubscribeData, WhiteListData } from 'mailgun.js/interfaces/Supressions';
+    export class Suppression {
         type: string;
+        constructor(type: SuppressionModels);
+    }
+    export class Bounce extends Suppression {
         address: string;
         code: number;
         error: string;
         created_at: Date;
         constructor(data: BounceData);
     }
-    class Complaint {
-        type: string;
-        address: any;
+    export class Complaint extends Suppression {
+        address: string | undefined;
         created_at: Date;
         constructor(data: ComplaintData);
     }
-    class Unsubscribe {
-        type: string;
+    export class Unsubscribe extends Suppression {
         address: string;
-        tags: any;
+        tags: string[];
         created_at: Date;
         constructor(data: UnsubscribeData);
     }
-    class WhiteList {
-        type: string;
+    export class WhiteList extends Suppression {
         value: string;
         reason: string;
         createdAt: Date;
         constructor(data: WhiteListData);
     }
-    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;
-        };
+        request: Request;
+        models: Map<string, any>;
         constructor(request: Request);
-        _parsePage(id: string, pageUrl: string): {
-            id: string;
-            page: string | string[];
-            address: string | string[];
-            url: string;
-        };
-        _parsePageLinks(response: {
-            body: {
-                paging: any;
-            };
-        }): any;
-        _parseList(response: {
-            body: {
-                items: any;
-                paging: any;
-            };
-        }, Model: TModel): any;
-        _parseItem(response: {
-            body: any;
-        }, Model: TModel): Bounce | Complaint | Unsubscribe | WhiteList;
-        list(domain: string, type: string, query: any): any;
-        get(domain: string, type: string, address: string): any;
-        create(domain: string, type: string, data: any): any;
-        destroy(domain: string, type: string, address: string): any;
+        _parsePage(id: string, pageUrl: string): ParsedPage;
+        _parsePageLinks(response: SuppressionListResponse): ParsedPagesList;
+        _parseList(response: SuppressionListResponse, Model: {
+            new (data: BounceData | ComplaintData | UnsubscribeData | WhiteListData): Bounce | Complaint | Unsubscribe | WhiteList;
+        }): SuppressionList;
+        _parseItem<T extends Suppression>(data: BounceData | ComplaintData | UnsubscribeData | WhiteListData, Model: {
+            new (data: BounceData | ComplaintData | UnsubscribeData | WhiteListData): T;
+        }): T;
+        list(domain: string, type: string, query?: SuppressionListQuery): Promise<SuppressionList>;
+        get(domain: string, type: string, address: string): Promise<Bounce | Complaint | Unsubscribe | WhiteList>;
+        create(domain: string, type: string, data: SuppressionCreationData | SuppressionCreationData[]): Promise<SuppressionCreationResult>;
+        destroy(domain: string, type: string, address: string): Promise<SuppressionDestroyResult>;
     }
-    export {};
 }
 
 declare module 'mailgun.js/webhooks' {
-    import { ValidationResponse, WebhookList, WebhookResponse, WebhooksQuery } from 'mailgun.js/interfaces/Webhooks';
+    import { ValidationResponse, WebhookList, WebhookResponse, WebhooksIds, WebhooksQuery } from 'mailgun.js/interfaces/Webhooks';
     import Request from 'mailgun.js/request';
     class Webhook {
         id: string;
-        url: string;
-        constructor(id: string, url: string);
+        url: string | undefined;
+        constructor(id: string, url: string | undefined);
     }
     export default class WebhookClient {
         request: Request;
@@ -249,7 +230,7 @@ declare module 'mailgun.js/webhooks' {
             message: string;
         };
         list(domain: string, query: WebhooksQuery): Promise<WebhookList>;
-        get(domain: string, id: string): Promise<Webhook>;
+        get(domain: string, id: WebhooksIds): Promise<Webhook>;
         create(domain: string, id: string, url: string, test?: boolean): Promise<Webhook | ValidationResponse>;
         update(domain: string, id: string, url: string): Promise<Webhook>;
         destroy(domain: string, id: string): Promise<Webhook>;
@@ -348,10 +329,10 @@ declare module 'mailgun.js/lists' {
 
 declare module 'mailgun.js/interfaces/Domains' {
     export interface DomainsQuery {
-        authority: string;
-        state: 'active' | 'unverified' | 'disabled';
-        limit: number;
-        skip: number;
+        authority?: string;
+        state?: 'active' | 'unverified' | 'disabled';
+        limit?: number;
+        skip?: number;
     }
     export interface DomainInfo {
         name: string;
@@ -479,7 +460,7 @@ declare module 'mailgun.js/interfaces/ApiResponse' {
 }
 
 declare module 'mailgun.js/request' {
-    import NodeFormData from 'form-data';
+    import * as NodeFormData from 'form-data';
     import RequestOptions from 'mailgun.js/interfaces/RequestOptions';
     import { InputFormData } from 'mailgun.js/interfaces/IFormData';
     import APIResponse from 'mailgun.js/interfaces/ApiResponse';
@@ -793,7 +774,7 @@ declare module 'mailgun.js/interfaces/DomainTemplates' {
     }
     export interface IDomainTemplatesClient {
         list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
-        get(domain: string, templateName: string, query: TemplateQuery): Promise<DomainTemplateItem>;
+        get(domain: string, templateName: string, query?: TemplateQuery): 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>;
@@ -1222,16 +1203,18 @@ declare module 'mailgun.js/interfaces/StatsOptions' {
         resolution: string;
         stats: Stat[];
     }
+    export type StatsEvent = 'accepted' | 'delivered' | 'opened' | 'clicked' | 'unsubscribed' | 'stored' | 'rejected' | 'complained' | 'failed-temporary' | 'failed-permanent';
     export interface StatsQuery {
-        event: string | string[];
-        start: string | Date;
-        end: string | Date;
-        resolution: 'hour' | 'day' | 'month';
-        duration: string;
+        event: StatsEvent | StatsEvent[];
+        start?: string | Date;
+        end?: string | Date;
+        resolution?: 'hour' | 'day' | 'month';
+        duration?: string;
     }
 }
 
 declare module 'mailgun.js/interfaces/Supressions' {
+    import { Bounce, Complaint, Unsubscribe, WhiteList } from 'mailgun.js/suppressions';
     export interface BounceData {
         address: string;
         code: number;
@@ -1253,6 +1236,87 @@ declare module 'mailgun.js/interfaces/Supressions' {
         reason: string;
         createdAt: string | Date;
     }
+    export interface ParsedPage {
+        id: string;
+        page: string | null | undefined;
+        address: string | null | undefined;
+        url: string;
+    }
+    export interface ParsedPagesList {
+        previous: ParsedPage;
+        first: ParsedPage;
+        last: ParsedPage;
+        next: ParsedPage;
+    }
+    export interface SuppressionList {
+        items: (Bounce | Complaint | Unsubscribe | WhiteList)[];
+        pages: ParsedPagesList;
+    }
+    export interface PagesList {
+        previous: string;
+        first: string;
+        last: string;
+        next: string;
+    }
+    export enum SuppressionModels {
+        BOUNCES = "bounces",
+        COMPLAINTS = "complaints",
+        UNSUBSCRIBES = "unsubscribes",
+        WHITELISTS = "whitelists"
+    }
+    export interface PagesListAccumulator {
+        [index: string]: ParsedPage;
+    }
+    export interface SuppressionListQuery {
+        limit?: number;
+    }
+    export interface SuppressionListResponse {
+        body: {
+            items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[];
+            paging: PagesList;
+        };
+        status: number;
+    }
+    export interface SuppressionResponse {
+        body: BounceData | ComplaintData | UnsubscribeData | WhiteListData;
+        status: number;
+    }
+    export interface SuppressionDestroyResponse {
+        body: {
+            message: string;
+            value?: string;
+            address?: string;
+        };
+        status: number;
+    }
+    export interface SuppressionDestroyResult {
+        message: string;
+        value: string;
+        address: string;
+        status: number;
+    }
+    export interface SuppressionCreationData {
+        address: string;
+        code?: number;
+        error?: string;
+        domain?: string;
+        tag?: string;
+        created_at?: string;
+    }
+    export interface SuppressionCreationResponse {
+        body: {
+            message: string;
+            type?: string;
+            value?: string;
+        };
+        status: number;
+    }
+    export interface SuppressionCreationResult {
+        message: string;
+        type: string;
+        value: string;
+        status: number;
+    }
 }
 
 declare module 'mailgun.js/interfaces/Webhooks' {
@@ -1281,6 +1345,15 @@ declare module 'mailgun.js/interfaces/Webhooks' {
         code: number;
         message: string;
     }
+    export enum WebhooksIds {
+        CLICKED = "clicked",
+        COMPLAINED = "complained",
+        DELIVERED = "delivered",
+        OPENED = "opened",
+        PERMANENT_FAIL = "permanent_fail",
+        TEMPORARY_FAIL = "temporary_fail",
+        UNSUBSCRIBED = "unsubscribe"
+    }
 }
 
 declare module 'mailgun.js/interfaces/routes' {