Expose types

lib/client.ts

@@ -1,7 +1,7 @@
 /* eslint-disable camelcase */
 import Request from './request';
-import Options from './interfaces/Options';
-import { RequestOptions } from './interfaces/RequestOptions';
+import { Options } from './types/Options';
+import { RequestOptions } from './types/RequestOptions';
 
 import DomainClient from './domains';
 import EventClient from './events';
@@ -15,12 +15,12 @@ import IpsClient from './ips';
 import IpPoolsClient from './ip-pools';
 import ListsClient from './lists';
 import MailListsMembers from './mailListMembers';
-import { InputFormData } from './interfaces/IFormData';
+import { InputFormData } from './types/IFormData';
 import DomainCredentialsClient from './domainsCredentials';
 import MultipleValidationClient from './multipleValidation';
 import DomainTemplatesClient from './domainsTemplates';
 import DomainTagsClient from './domainsTags';
-import { IMailgunClient } from './interfaces/IMailgunClient';
+import { IMailgunClient } from './types/IMailgunClient';
 
 export default class Client implements IMailgunClient {
   private request;

lib/common/NavigationThruPages.ts

@@ -1,18 +1,18 @@
 import urljoin from 'url-join';
 import APIError from '../error';
-import APIErrorOptions from '../interfaces/APIErrorOptions';
+import { APIErrorOptions } from '../types/APIErrorOptions';
 import {
   PagesListAccumulator,
   ParsedPage,
   ParsedPagesList,
   QueryWithPage,
   ResponseWithPaging,
   UpdatedUrlAndQuery
-} from '../interfaces/NavigationThruPages';
-import { BounceData, IBounce } from '../interfaces/Suppressions/Bounce';
-import { ComplaintData, IComplaint } from '../interfaces/Suppressions/Complaint';
-import { IUnsubscribe, UnsubscribeData } from '../interfaces/Suppressions/Unsubscribe';
-import { IWhiteList, WhiteListData } from '../interfaces/Suppressions/WhiteList';
+} from '../types/NavigationThruPages';
+import { BounceData, IBounce } from '../types/Suppressions/Bounce';
+import { ComplaintData, IComplaint } from '../types/Suppressions/Complaint';
+import { IUnsubscribe, UnsubscribeData } from '../types/Suppressions/Unsubscribe';
+import { IWhiteList, WhiteListData } from '../types/Suppressions/WhiteList';
 import Request from '../request';
 
 export default abstract class NavigationThruPages <T> {

lib/domains.ts

@@ -21,11 +21,11 @@ import {
   UpdatedWebPrefixResponse,
   ReplacementForPool,
   MessageResponse,
-} from './interfaces/Domains';
+} from './types/Domains';
 
-import APIResponse from './interfaces/ApiResponse';
+import { APIResponse } from './types/ApiResponse';
 import APIError from './error';
-import APIErrorOptions from './interfaces/APIErrorOptions';
+import { APIErrorOptions } from './types/APIErrorOptions';
 
 import Request from './request';
 import {
@@ -36,12 +36,12 @@ import {
   UnsubscribeTrackingInfo,
   UpdateDomainTrackingResponse,
   UpdatedOpenTracking
-} from './interfaces/DomainTracking';
-import { IDomainCredentials } from './interfaces/DomainCredentials';
-import { IDomainTemplatesClient } from './interfaces/DomainTemplates';
+} from './types/DomainTracking';
+import { IDomainCredentials } from './types/DomainCredentials';
+import { IDomainTemplatesClient } from './types/DomainTemplates';
 import DomainCredentialsClient from './domainsCredentials';
 import DomainTemplatesClient from './domainsTemplates';
-import { IDomainTagsClient } from './interfaces/DomainTags';
+import { IDomainTagsClient } from './types/DomainTags';
 import DomainTagsClient from './domainsTags';
 
 export class Domain {

lib/domainsCredentials.ts

@@ -1,5 +1,5 @@
 import urljoin from 'url-join';
-import APIResponse from './interfaces/ApiResponse';
+import { APIResponse } from './types/ApiResponse';
 import Request from './request';
 
 import {
@@ -12,7 +12,7 @@ import {
   DomainCredentialsResult,
   IDomainCredentials,
   UpdateDomainCredentialsData
-} from './interfaces/DomainCredentials';
+} from './types/DomainCredentials';
 
 export default class DomainCredentialsClient implements IDomainCredentials {
   baseRoute: string;

lib/domainsTags.ts

@@ -1,5 +1,5 @@
 import urljoin from 'url-join';
-import APIResponse from './interfaces/ApiResponse';
+import { APIResponse } from './types/ApiResponse';
 import Request from './request';
 
 import {
@@ -22,7 +22,7 @@ import {
   DomainTagStatisticResult,
   IDomainTagsClient,
   Resolution
-} from './interfaces/DomainTags';
+} from './types/DomainTags';
 import NavigationThruPages from './common/NavigationThruPages';
 
 export class DomainTag implements DomainTagsItem {

lib/domainsTemplates.ts

@@ -25,7 +25,7 @@ import {
   TemplateVersion,
   UpdateOrDeleteDomainTemplateAPIResponse,
   UpdateOrDeleteDomainTemplateResult
-} from './interfaces/DomainTemplates';
+} from './types/DomainTemplates';
 import NavigationThruPages from './common/NavigationThruPages';
 
 export class DomainTemplateItem implements DomainTemplate {

lib/error.ts

@@ -1,4 +1,4 @@
-import APIErrorOptions from './interfaces/APIErrorOptions';
+import { APIErrorOptions } from './types/APIErrorOptions';
 
 export default class APIError extends Error {
   status: number | string;

lib/events.ts

@@ -4,7 +4,7 @@ import {
   EventsList,
   EventsQuery,
   EventsResponse,
-} from './interfaces/Events';
+} from './types/Events';
 
 import Request from './request';
 

lib/formDataBuilder.ts

@@ -1,5 +1,5 @@
 import * as NodeFormData from 'form-data';
-import { InputFormData } from './interfaces/IFormData';
+import { InputFormData } from './types/IFormData';
 
 class FormDataBuilder {
   private FormDataConstructor: InputFormData;

lib/index.ts

@@ -1,6 +1,7 @@
 import Client from './client';
-import { InputFormData } from './interfaces/IFormData';
-import Options from './interfaces/Options';
+import { InputFormData, Options } from './types';
+
+export * from './types';
 
 export default class Mailgun {
   static get default(): typeof Mailgun { return this; }

lib/ip-pools.ts

@@ -11,7 +11,7 @@ import {
   IpPoolMessageResponse,
   IpPoolMessageResult,
   IpPoolUpdateData,
-} from './interfaces/IpPools';
+} from './types/IpPools';
 
 export default class IpPoolsClient {
   request: Request;

lib/ips.ts

@@ -1,5 +1,5 @@
 import MgRequest from './request';
-import { IpData, IpsListResponseBody } from './interfaces/Ips';
+import { IpData, IpsListResponseBody } from './types/Ips';
 
 export default class IpsClient {
   request: MgRequest;

lib/lists.ts

@@ -6,12 +6,12 @@ import {
   MailingList,
   ValidationApiResponse,
   StartValidationResult,
-  ValidationResult,
+  ListValidationResult,
   CancelValidationResult,
   MailingListResult,
   MailingListApiResponse
-} from './interfaces/lists';
-import { IMailListsMembers } from './interfaces/mailListMembers';
+} from './types/lists';
+import { IMailListsMembers } from './types/mailListMembers';
 import NavigationThruPages from './common/NavigationThruPages';
 
 export default class ListsClient
@@ -27,14 +27,14 @@ export default class ListsClient
     this.members = members;
   }
 
-  private parseValidationResult(status: number, data: ValidationApiResponse): ValidationResult {
+  private parseValidationResult(status: number, data: ValidationApiResponse): ListValidationResult {
     return {
       status,
       validationResult: {
         ...data,
         created_at: new Date(data.created_at * 1000) // add millisecond to Unix timestamp
       }
-    } as ValidationResult;
+    } as ListValidationResult;
   }
 
   protected parseList(response: MailingListApiResponse): MailingListResult {
@@ -80,7 +80,7 @@ export default class ListsClient
       }) as StartValidationResult);
   }
 
-  validationResult(mailListAddress: string): Promise<ValidationResult> {
+  validationResult(mailListAddress: string): Promise<ListValidationResult> {
     return this.request.get(`${this.baseRoute}/${mailListAddress}/validate`)
       .then(
         (response) => this.parseValidationResult(

lib/mailListMembers.ts

@@ -12,7 +12,7 @@ import {
   NewMultipleMembersResponse,
   MailListMembersResult,
   MailListMembersResponse
-} from './interfaces/mailListMembers';
+} from './types/mailListMembers';
 import NavigationThruPages from './common/NavigationThruPages';
 
 export default class MailListsMembers

lib/messages.ts

@@ -1,10 +1,10 @@
 import APIError from './error';
-import APIErrorOptions from './interfaces/APIErrorOptions';
+import { APIErrorOptions } from './types/APIErrorOptions';
 import {
   MailgunMessageData,
   MessagesSendAPIResponse,
   MessagesSendResult
-} from './interfaces/Messages';
+} from './types/Messages';
 import Request from './request';
 
 export default class MessagesClient {

lib/multipleValidation.ts

@@ -1,5 +1,5 @@
 import NavigationThruPages from './common/NavigationThruPages';
-import APIResponse from './interfaces/ApiResponse';
+import { APIResponse } from './types/ApiResponse';
 import {
   CanceledMultipleValidationJob,
   CreatedMultipleValidationJob,
@@ -12,7 +12,7 @@ import {
   MultipleValidationJobResult,
   MultipleValidationJobsListQuery
 }
-  from './interfaces/MultipleValidation';
+  from './types/MultipleValidation';
 import Request from './request';
 
 export class MultipleValidationJob implements MultipleValidationJobResult {

lib/request.ts

@@ -3,12 +3,12 @@ import urljoin from 'url-join';
 import axios, { AxiosError, AxiosResponse } from 'axios';
 import * as NodeFormData from 'form-data';
 import APIError from './error';
-import { OnCallEmptyHeaders, OnCallRequestOptions, RequestOptions } from './interfaces/RequestOptions';
-import APIErrorOptions from './interfaces/APIErrorOptions';
-import { InputFormData } from './interfaces/IFormData';
-import APIResponse from './interfaces/ApiResponse';
+import { OnCallEmptyHeaders, OnCallRequestOptions, RequestOptions } from './types/RequestOptions';
+import { APIErrorOptions } from './types/APIErrorOptions';
+import { InputFormData } from './types/IFormData';
+import { APIResponse } from './types/ApiResponse';
 import FormDataBuilder from './formDataBuilder';
-import { IpPoolDeleteData } from './interfaces/IpPools';
+import { IpPoolDeleteData } from './types/IpPools';
 
 class Request {
   private username: string;

lib/routes.ts

@@ -1,6 +1,6 @@
 import {
   CreateUpdateRouteData, DestroyRouteResponse, Route, RoutesListQuery, UpdateRouteResponse
-} from './interfaces/routes';
+} from './types/routes';
 import Request from './request';
 
 export default class RoutesClient {

lib/stats.ts

@@ -1,6 +1,6 @@
 import urljoin from 'url-join';
 import Request from './request';
-import { StatsQuery, StatsOptions, Stat } from './interfaces/StatsOptions';
+import { StatsQuery, StatsOptions, Stat } from './types/StatsOptions';
 
 class Stats {
   start: Date;

lib/suppressions.ts

@@ -14,13 +14,13 @@ import {
   SuppressionListResponse,
   SuppressionModels,
   SuppressionResponse,
-} from './interfaces/Suppressions/Suppressions';
+} from './types/Suppressions/Suppressions';
 import APIError from './error';
-import APIErrorOptions from './interfaces/APIErrorOptions';
-import { IBounce, BounceData } from './interfaces/Suppressions/Bounce';
-import { IComplaint, ComplaintData } from './interfaces/Suppressions/Complaint';
-import { IUnsubscribe, UnsubscribeData } from './interfaces/Suppressions/Unsubscribe';
-import { IWhiteList, WhiteListData } from './interfaces/Suppressions/WhiteList';
+import { APIErrorOptions } from './types/APIErrorOptions';
+import { IBounce, BounceData } from './types/Suppressions/Bounce';
+import { IComplaint, ComplaintData } from './types/Suppressions/Complaint';
+import { IUnsubscribe, UnsubscribeData } from './types/Suppressions/Unsubscribe';
+import { IWhiteList, WhiteListData } from './types/Suppressions/WhiteList';
 import NavigationThruPages from './common/NavigationThruPages';
 
 const createOptions = {

lib/interfaces/APIErrorOptions.ts → lib/types/APIErrorOptions.ts

@@ -1,10 +1,8 @@
-interface APIErrorOptions {
+export interface APIErrorOptions {
   headers: { [key: string]: any };
   status: number | string;
   message: string;
   body: any;
   url: string;
   statusText: string;
 }
-
-export default APIErrorOptions;

lib/types/ApiResponse.ts

@@ -0,0 +1,4 @@
+export interface APIResponse {
+  status: number;
+  body: any;
+}

lib/interfaces/Options.ts → lib/types/Options.ts

@@ -1,10 +1,8 @@
 /* eslint-disable camelcase */
- interface Options {
+export interface Options {
   username: string;
   key: string;
   url?: string;
   public_key?: string;
   timeout?: number;
 }
-
-export default Options;

lib/interfaces/RequestOptions.ts → lib/types/RequestOptions.ts

@@ -1,5 +1,5 @@
-import { AxiosRequestHeaders } from 'axios'
-import Options from './Options';
+import { AxiosRequestHeaders } from 'axios';
+import { Options } from './Options';
 
 export interface OnCallEmptyHeaders {
   [key: string]: undefined;

lib/types/Suppressions/index.ts

@@ -0,0 +1,5 @@
+export * from './Bounce';
+export * from './Complaint';
+export * from './Suppressions';
+export * from './Unsubscribe';
+export * from './WhiteList';

lib/interfaces/Webhooks.ts → lib/types/Webhooks.ts

@@ -24,7 +24,7 @@ export type WebhooksQuery = {
     skip?: number;
 }
 
-export interface ValidationResponse {
+export interface WebhooksValidationResponse {
     code: number;
     message: string;
 }

lib/types/index.ts

@@ -0,0 +1,24 @@
+export * from './APIErrorOptions';
+export * from './ApiResponse';
+export * from './DomainCredentials';
+export * from './DomainTags';
+export * from './DomainTemplates';
+export * from './DomainTracking';
+export * from './Domains';
+export * from './Events';
+export * from './IFormData';
+export * from './IMailgunClient';
+export * from './IpPools';
+export * from './Ips';
+export * from './Messages';
+export * from './MultipleValidation';
+export * from './NavigationThruPages';
+export * from './Options';
+export * from './RequestOptions';
+export * from './StatsOptions';
+export * from './Suppressions';
+export * from './Validate';
+export * from './Webhooks';
+export * from './lists';
+export * from './mailListMembers';
+export * from './routes';