mailgun.js 5.0.3 → 5.1.0

package/{lib/interfaces/DomainTemplates.ts → interfaces/DomainTemplates.d.ts}

@@ -1,17 +1,14 @@
 import { DomainTemplateItem } from '../domainsTemplates';
-
-export enum YesNo {
-    YES = 'yes',
-    NO = 'no'
-}
-
-export enum Pages {
-    FIRST = 'first',
-    LAST = 'last',
-    NEXT = 'next',
-    PREV = 'prev'
-}
-/* eslint-disable camelcase */
+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;
@@ -20,7 +17,6 @@ export interface DomainTemplateData {
     engine?: string;
     comment?: string;
 }
-
 export interface DomainTemplateVersionData {
     template: string;
     tag: string;
@@ -28,27 +24,22 @@ export interface DomainTemplateVersionData {
     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 TemplateQuery {
     active: YesNo;
 }
-
 export interface ShortTemplateVersion {
     tag: string;
     engine: string;
@@ -58,8 +49,7 @@ export interface ShortTemplateVersion {
     active: boolean;
     id: string;
 }
-
-export interface TemplateVersion extends ShortTemplateVersion{
+export interface TemplateVersion extends ShortTemplateVersion {
     template: string;
 }
 export interface DomainTemplate {
@@ -71,7 +61,6 @@ export interface DomainTemplate {
     version?: TemplateVersion;
     versions?: ShortTemplateVersion[];
 }
-
 export interface CreateDomainTemplateAPIResponse {
     status: number;
     body: {
@@ -79,7 +68,6 @@ export interface CreateDomainTemplateAPIResponse {
         template: DomainTemplate;
     };
 }
-
 export interface ListDomainTemplatesAPIResponse {
     status: number;
     body: {
@@ -92,52 +80,45 @@ export interface ListDomainTemplatesAPIResponse {
         };
     };
 }
-
 export interface ListDomainTemplatesResult {
-        items: DomainTemplate[];
-        pages: {
-            first: string;
-            last: string;
-            next: string;
-            previous: string;
-        };
+    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
-        }
+            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: {
@@ -145,13 +126,11 @@ export interface CreateDomainTemplateVersionAPIResponse {
         template: DomainTemplate;
     };
 }
-
 export interface CreateDomainTemplateVersionResult {
     status: number;
     message: string;
     template: DomainTemplate;
 }
-
 export interface MutateDomainTemplateVersionAPIResponse {
     status: number;
     body: {
@@ -160,20 +139,18 @@ export interface MutateDomainTemplateVersionAPIResponse {
             name: string;
             version: {
                 tag: string;
-            }
+            };
         };
     };
 }
-
 export interface MutateDomainTemplateVersionResult {
     status: number;
     message: string;
     templateName: string;
     templateVersion: {
         tag: string;
-    }
+    };
 }
-
 export interface ListDomainTemplateVersionsAPIResponse {
     status: number;
     body: {
@@ -183,8 +160,8 @@ export interface ListDomainTemplateVersionsAPIResponse {
             createdAt: string;
             createdBy: string;
             id: string;
-            versions: ShortTemplateVersion[]
-        }
+            versions: ShortTemplateVersion[];
+        };
         paging: {
             first: string;
             last: string;
@@ -193,7 +170,6 @@ export interface ListDomainTemplateVersionsAPIResponse {
         };
     };
 }
-
 export interface ListDomainTemplateVersionsResult {
     template: DomainTemplateItem;
     pages: {
@@ -203,36 +179,16 @@ export interface ListDomainTemplateVersionsResult {
         previous: string;
     };
 }
-
 export interface IDomainTemplatesClient {
-    list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>
-    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>
-    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>
+    list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
+    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>;
+    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/{lib/interfaces/DomainTracking.ts → interfaces/DomainTracking.d.ts}

@@ -1,47 +1,48 @@
-/* eslint-disable camelcase */
-
 export interface DomainTrackingData {
-    click: { active: boolean };
-    open: { active: boolean };
+    click: {
+        active: boolean;
+    };
+    open: {
+        active: boolean;
+    };
     unsubscribe: {
         active: boolean;
         html_footer: string;
         text_footer: string;
-    }
+    };
 }
-
 export interface DomainTrackingResponse {
     status: number;
     body: {
-        tracking: DomainTrackingData
+        tracking: DomainTrackingData;
     };
 }
-
 export interface UpdatedOpenTracking {
     message: string;
-    open?: { active: boolean };
-    click?: { active: boolean | 'htmlonly'};
+    open?: {
+        active: boolean;
+    };
+    click?: {
+        active: boolean | 'htmlonly';
+    };
     unsubscribe?: {
-        active: boolean,
+        active: boolean;
         html_footer: string;
         text_footer: string;
     };
 }
-
 export interface UpdateDomainTrackingResponse {
     status: number;
     body: UpdatedOpenTracking;
 }
-
 export interface OpenTrackingInfo {
-    active: 'yes'| 'no' | 'true' | 'false';
+    active: 'yes' | 'no' | 'true' | 'false';
 }
 export interface ClickTrackingInfo {
-    active: 'yes'| 'no' | 'true' | 'false' | 'htmlonly';
+    active: 'yes' | 'no' | 'true' | 'false' | 'htmlonly';
 }
-
 export interface UnsubscribeTrackingInfo {
-    active: 'yes'| 'no' | 'true' | 'false';
+    active: 'yes' | 'no' | 'true' | 'false';
     html_footer: string;
     text_footer: string;
 }

package/{lib/interfaces/Domains.ts → interfaces/Domains.d.ts}

@@ -1,11 +1,9 @@
-/* eslint-disable camelcase */
 export interface DomainsQuery {
-    authority? : string;
+    authority?: string;
     state?: 'active' | 'unverified' | 'disabled';
     limit?: number;
     skip?: number;
 }
-
 export interface DomainInfo {
     name: string;
     smtp_password: string;
@@ -15,9 +13,8 @@ export interface DomainInfo {
     dkim_key_size?: 1024 | 2048;
     ips?: '';
     pool_id?: '';
-    web_scheme: 'http' | 'https'
+    web_scheme: 'http' | 'https';
 }
-
 export interface DomainShortData {
     name: string;
     require_tls: boolean;
@@ -29,20 +26,17 @@ export interface DomainShortData {
     smtp_password: string;
     smtp_login: string;
     type: string;
-
 }
-export interface DomainData extends DomainShortData{
+export interface DomainData extends DomainShortData {
     id: string;
     is_disabled: boolean;
     web_prefix: string;
     web_scheme: string;
 }
-
-export interface DomainsListItem extends DomainShortData{
+export interface DomainsListItem extends DomainShortData {
     receiving_dns_records: null;
     sending_dns_records: null;
 }
-
 export interface DNSRecord {
     cached: any[];
     name: string;
@@ -50,7 +44,6 @@ export interface DNSRecord {
     valid: string;
     value: string;
 }
-
 export interface DomainResponseData {
     status: number;
     body: {
@@ -58,84 +51,70 @@ export interface DomainResponseData {
         message?: string;
         receiving_dns_records: DNSRecord[];
         sending_dns_records: DNSRecord[];
-    }
+    };
 }
-
 export interface DomainListResponseData {
     status: number;
     body: {
         items: DomainsListItem[];
         total_count: number;
-    }
+    };
 }
-
 export interface MessageResponse {
-    message : string
+    message: string;
 }
-
 export interface DestroyedDomainResponse {
     status: number;
-    body: MessageResponse
+    body: MessageResponse;
 }
-
 export interface ConnectionSettings {
     require_tls: boolean;
     skip_verification: boolean;
 }
 export interface ConnectionSettingsResponse {
     body: {
-        connection: ConnectionSettings
-    }
-    status: number
+        connection: ConnectionSettings;
+    };
+    status: number;
 }
-
 export interface UpdatedConnectionSettings {
-    message: string,
-    require_tls: boolean,
-    skip_verification: boolean
+    message: string;
+    require_tls: boolean;
+    skip_verification: boolean;
 }
-
 export interface UpdatedConnectionSettingsRes {
-    body: UpdatedConnectionSettings,
-    status: number
+    body: UpdatedConnectionSettings;
+    status: number;
 }
-
 export interface DKIMAuthorityInfo {
-    self: boolean | 'yes' | 'no' | 'true' |'false'
+    self: boolean | 'yes' | 'no' | 'true' | 'false';
 }
-
 export interface UpdatedDKIMAuthority {
-    changed: boolean,
-    message: string,
-    sending_dns_records: DNSRecord[]
+    changed: boolean;
+    message: string;
+    sending_dns_records: DNSRecord[];
 }
-
 export interface UpdatedDKIMAuthorityResponse {
-    body: UpdatedDKIMAuthority,
-    status: 200
+    body: UpdatedDKIMAuthority;
+    status: 200;
 }
-
 export interface DKIMSelectorInfo {
-    dkimSelector: string
+    dkimSelector: string;
 }
-
 export interface UpdatedDKIMSelectorResponse {
-    body:MessageResponse,
-    status: number
+    body: MessageResponse;
+    status: number;
 }
-
 export interface WebPrefixInfo {
-    webPrefix: string
+    webPrefix: string;
 }
-
 export interface UpdatedWebPrefix {
-    message : string
+    message: string;
 }
 export interface UpdatedWebPrefixResponse {
-    body:MessageResponse,
-    status: number
+    body: MessageResponse;
+    status: number;
 }
-
 export interface ReplacementForPool {
     pool_id?: string;
     ip?: string;

package/{lib/interfaces/Events.ts → interfaces/Events.d.ts}

@@ -13,14 +13,14 @@ export interface EventsResponse {
     body: {
         items: [];
         paging: PagesList;
-    }
+    };
 }
 export interface DomainEvent {
     severity: string;
     tags: string[];
     storage: {
         url: string;
-        key: string
+        key: string;
     };
     'delivery-status': {
         tls: boolean;
@@ -31,7 +31,7 @@ export interface DomainEvent {
         utf8: boolean;
         'attempt-no': number;
         message: string;
-        'certificate-verified': boolean
+        'certificate-verified': boolean;
     };
     'recipient-domain': string;
     id: string;
@@ -44,35 +44,34 @@ export interface DomainEvent {
         'is-routed': boolean;
         'is-authenticated': boolean;
         'is-system-test': boolean;
-        'is-test-mode': boolean
+        'is-test-mode': boolean;
     };
-    'log-level' : string;
+    'log-level': string;
     template?: any;
     timestamp: number;
     envelope: {
         transport: string;
         sender: string;
         'sending-ip': string;
-        targets: string
+        targets: string;
     };
     message: {
         headers: {
             to: string;
             'message-id': string;
             from: string;
-            subject: string
+            subject: string;
         };
         attachments: [];
-        size: 308
+        size: 308;
     };
     recipient: string;
     event: string;
 }
-
-export interface ParsedPage{
+export interface ParsedPage {
     id: string;
     number: string;
-    url: string
+    url: string;
 }
 export interface ParsedPagesList {
     previous: ParsedPage;
@@ -85,5 +84,5 @@ export interface EventsList {
     pages: ParsedPagesList;
 }
 export interface PagesListAccumulator {
-    [index: string]: EventsPage
+    [index: string]: EventsPage;
 }

package/{lib/interfaces/IFormData.ts → interfaces/IFormData.d.ts}

@@ -1,9 +1,7 @@
 import * as NodeFormData from 'form-data';
-
 export interface IFormDataOptions {
-  [key: string]: any;
+    [key: string]: any;
 }
-
 export interface InputFormData {
-  new (options?: HTMLFormElement | IFormDataOptions): NodeFormData | FormData;
+    new (options?: HTMLFormElement | IFormDataOptions): NodeFormData | FormData;
 }

package/interfaces/IMailgunClient.d.ts

@@ -0,0 +1,24 @@
+import DomainClient from '../domains';
+import EventClient from '../events';
+import IpPoolsClient from '../ip-pools';
+import IpsClient from '../ips';
+import ListsClient from '../lists';
+import MessagesClient from '../messages';
+import RoutesClient from '../routes';
+import StatsClient from '../stats';
+import SuppressionClient from '../suppressions';
+import ValidateClient from '../validate';
+import WebhookClient from '../webhooks';
+export interface IMailgunClient {
+    domains: DomainClient;
+    webhooks: WebhookClient;
+    events: EventClient;
+    stats: StatsClient;
+    suppressions: SuppressionClient;
+    messages: MessagesClient;
+    routes: RoutesClient;
+    validate: ValidateClient;
+    ips: IpsClient;
+    ip_pools: IpPoolsClient;
+    lists: ListsClient;
+}

package/interfaces/IpPools.d.ts

@@ -0,0 +1,19 @@
+export interface IpPool {
+    description: string;
+    ips: string[];
+    is_linked: boolean;
+    name: string;
+    pool_id: string;
+}
+export interface IpPoolListResponse {
+    body: {
+        ip_pools: IpPool;
+        message: string;
+    };
+}
+export interface IpPoolUpdateData {
+    name: string;
+    description: string;
+    add_ip: string;
+    remove_ip: string;
+}

package/interfaces/Ips.d.ts

@@ -0,0 +1,10 @@
+export interface IpsListResponseBody {
+    assignable_to_pools: boolean;
+    items: string[];
+    total_count: number;
+}
+export interface IpData {
+    ip: string;
+    dedicated: boolean;
+    rdns: string;
+}