mailgun.js 3.7.1 → 4.0.1

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

@@ -15,9 +15,73 @@ export interface EventsResponse {
         paging: PagesList;
     };
 }
+export interface DomainEvent {
+    severity: string;
+    tags: string[];
+    storage: {
+        url: string;
+        key: string;
+    };
+    'delivery-status': {
+        tls: boolean;
+        'mx-host': string;
+        code: number;
+        description: string;
+        'session-seconds': number;
+        utf8: boolean;
+        'attempt-no': number;
+        message: string;
+        'certificate-verified': boolean;
+    };
+    'recipient-domain': string;
+    id: string;
+    campaigns: [];
+    reason: string;
+    'user-variables': {
+        [key: string]: any;
+    };
+    flags: {
+        'is-routed': boolean;
+        'is-authenticated': boolean;
+        'is-system-test': boolean;
+        'is-test-mode': boolean;
+    };
+    'log-level': string;
+    template?: any;
+    timestamp: number;
+    envelope: {
+        transport: string;
+        sender: string;
+        'sending-ip': string;
+        targets: string;
+    };
+    message: {
+        headers: {
+            to: string;
+            'message-id': string;
+            from: string;
+            subject: string;
+        };
+        attachments: [];
+        size: 308;
+    };
+    recipient: string;
+    event: string;
+}
+export interface ParsedPage {
+    id: string;
+    number: string;
+    url: string;
+}
+export interface ParsedPagesList {
+    previous: ParsedPage;
+    first: ParsedPage;
+    last: ParsedPage;
+    next: ParsedPage;
+}
 export interface EventsList {
-    items: [];
-    pages: PagesList;
+    items: DomainEvent[];
+    pages: ParsedPagesList;
 }
 export interface PagesListAccumulator {
     [index: string]: EventsPage;

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

@@ -0,0 +1,55 @@
+export interface MultipleValidationJob {
+    created_at: number;
+    download_url: {
+        csv: string;
+        json: string;
+    };
+    id: string;
+    quantity: number;
+    records_processed: number;
+    status: string;
+    summary: {
+        result: {
+            catch_all: number;
+            deliverable: number;
+            do_not_send: number;
+            undeliverable: number;
+            unknown: number;
+        };
+        risk: {
+            high: number;
+            low: number;
+            medium: number;
+            unknown: number;
+        };
+    };
+}
+export interface CreatedMultipleValidationJob {
+    id: string;
+    message: string;
+}
+export interface PagesList {
+    prev: string;
+    first: string;
+    last: string;
+    next: string;
+}
+export interface MultipleValidationJobsListResult {
+    jobs: MultipleValidationJob[];
+    paging: PagesList;
+    total: number;
+}
+export interface MultipleValidationJobsListResponse {
+    status: 200;
+    body: MultipleValidationJobsListResult;
+}
+export interface CanceledMultipleValidationJob {
+    body: string;
+    status: number;
+}
+export interface IMultipleValidationClient {
+    list(): Promise<MultipleValidationJobsListResult>;
+    get(listId: string): Promise<MultipleValidationJob>;
+    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
+    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
+}

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

@@ -0,0 +1,12 @@
+export interface ValidationResult {
+    address: string;
+    is_disposable_address: boolean;
+    is_role_address: boolean;
+    reason: string[];
+    result: string;
+    risk: string;
+}
+export interface ValidationResponse {
+    status: number;
+    body: ValidationResult;
+}

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

@@ -7,7 +7,7 @@ export interface WebhookResponseBody {
     webhook: APIWebhook;
 }
 export interface WebhookResponse {
-    status: string;
+    status: number;
     body: WebhookResponseBody;
 }
 export interface WebhookList {
@@ -19,3 +19,7 @@ export interface WebhooksQuery {
     limit?: number;
     skip?: number;
 }
+export interface ValidationResponse {
+    code: number;
+    message: string;
+}

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

@@ -7,7 +7,7 @@ export interface CreateUpdateList {
     address: string;
     name?: string;
     description?: string;
-    access_level?: 'read-only' | 'members' | 'everyone';
+    access_level?: 'readonly' | 'members' | 'everyone';
     reply_preference?: 'list' | 'sender';
 }
 export interface DestroyedList {

package/dist/lib/multipleValidation.d.ts

@@ -0,0 +1,10 @@
+import { CanceledMultipleValidationJob, CreatedMultipleValidationJob, IMultipleValidationClient, MultipleValidationJob, MultipleValidationJobsListResult } from './interfaces/MultipleValidation';
+import Request from './request';
+export default class MultipleValidationClient implements IMultipleValidationClient {
+    request: Request;
+    constructor(request: Request);
+    list(): Promise<MultipleValidationJobsListResult>;
+    get(listId: string): Promise<MultipleValidationJob>;
+    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
+    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
+}

package/dist/lib/parse.d.ts

@@ -1,6 +0,0 @@
-import Request from './request';
-export default class ParseClient {
-    request: Request;
-    constructor(request: Request);
-    get(addresses: string[] | string, enableDnsEspChecks: boolean): Promise<any>;
-}

package/dist/lib/request.d.ts

@@ -8,7 +8,7 @@ declare class Request {
     private url;
     private timeout;
     private headers;
-    private formData;
+    private FormDataConstructor;
     constructor(options: RequestOptions, formData: InputFormData);
     request(method: string, url: string, inputOptions?: any): Promise<APIResponse>;
     query(method: string, url: string, query: any, options?: any): Promise<APIResponse>;
@@ -20,6 +20,9 @@ declare class Request {
     postWithFD(url: string, data: any): Promise<APIResponse>;
     putWithFD(url: string, data: any): Promise<APIResponse>;
     createFormData(data: any): NodeFormData | FormData;
+    private addMimeDataToFD;
+    private addFilesToFD;
+    private addCommonPropertyToFD;
     put(url: string, data: any, options?: any): Promise<APIResponse>;
     patch(url: string, data: any, options?: any): Promise<APIResponse>;
     delete(url: string, data?: any, options?: any): Promise<APIResponse>;

package/dist/lib/validate.d.ts

@@ -1,6 +1,9 @@
+import { IMultipleValidationClient } from './interfaces/MultipleValidation';
+import { ValidationResult } from './interfaces/Validate';
 import Request from './request';
 export default class ValidateClient {
+    multipleValidation: IMultipleValidationClient;
     request: Request;
-    constructor(request: Request);
-    get(address: string): Promise<any>;
+    constructor(request: Request, multipleValidationClient: IMultipleValidationClient);
+    get(address: string): Promise<ValidationResult>;
 }

package/dist/lib/webhooks.d.ts

@@ -1,4 +1,4 @@
-import { WebhookList, WebhookResponse, WebhooksQuery } from './interfaces/Webhooks';
+import { ValidationResponse, WebhookList, WebhookResponse, WebhooksQuery } from './interfaces/Webhooks';
 import Request from './request';
 declare class Webhook {
     id: string;
@@ -6,7 +6,7 @@ declare class Webhook {
     constructor(id: string, url: string);
 }
 export default class WebhookClient {
-    request: any;
+    request: Request;
     constructor(request: Request);
     _parseWebhookList(response: {
         body: {
@@ -25,7 +25,7 @@ export default class WebhookClient {
     };
     list(domain: string, query: WebhooksQuery): Promise<WebhookList>;
     get(domain: string, id: string): Promise<Webhook>;
-    create(domain: string, id: string, url: string, test?: boolean): 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>;
 }