feature: Expose all types and rename type conflicts

mailgun · Aug 3, 2022 · 6aee0e9 · 6aee0e9
1 parent 249ceaf
commit 6aee0e9
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 16 deletions.
diff --git a/lib/index.ts b/lib/index.ts
@@ -1,6 +1,7 @@
 import Client from './client';
-import { InputFormData } from './types/IFormData';
-import Options from './types/Options';
+import { InputFormData, Options } from './types';
+
+export * from './types';
 
 export default class Mailgun {
   static get default(): typeof Mailgun { return this; }

diff --git a/lib/lists.ts b/lib/lists.ts
@@ -6,7 +6,7 @@ import {
   MailingList,
   ValidationApiResponse,
   StartValidationResult,
-  ValidationResult,
+  ListValidationResult,
   CancelValidationResult,
   MailingListResult,
   MailingListApiResponse
@@ -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(

diff --git a/lib/types/Suppressions/index.ts b/lib/types/Suppressions/index.ts
@@ -0,0 +1,5 @@
+export * from './Bounce';
+export * from './Complaint';
+export * from './Suppressions';
+export * from './Unsubscribe';
+export * from './WhiteList';
diff --git a/lib/types/Webhooks.ts b/lib/types/Webhooks.ts
@@ -24,7 +24,7 @@ export type WebhooksQuery = {
     skip?: number;
 }
 
-export interface ValidationResponse {
+export interface WebhooksValidationResponse {
     code: number;
     message: string;
 }

diff --git a/lib/types/index.ts b/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';
diff --git a/lib/types/lists.ts b/lib/types/lists.ts
@@ -26,7 +26,7 @@ export interface StartValidationResult {
     message: string;
 }
 
-export interface ValidationResponse {
+export interface ListValidationResponse {
     status: string;
     download_url: {
       csv: string;
@@ -51,13 +51,13 @@ export interface ValidationResponse {
       }
     }
 }
-export interface ValidationApiResponse extends ValidationResponse{
+export interface ValidationApiResponse extends ListValidationResponse{
     created_at: number;
 }
-export interface ValidationResultData extends ValidationResponse{
+export interface ValidationResultData extends ListValidationResponse{
     created_at: Date;
 }
-export interface ValidationResult {
+export interface ListValidationResult {
     status: number;
     validationResult: ValidationResultData;
 }

diff --git a/lib/webhooks.ts b/lib/webhooks.ts
@@ -1,7 +1,7 @@
 import urljoin from 'url-join';
 
 import {
-  ValidationResponse,
+  WebhooksValidationResponse,
   WebhookList,
   WebhookResponse,
   WebhooksIds,
@@ -45,7 +45,7 @@ export default class WebhookClient {
 
   _parseWebhookTest(response: { body: { code: number, message: string } })
   : {code: number, message:string} {
-    return { code: response.body.code, message: response.body.message } as ValidationResponse;
+    return { code: response.body.code, message: response.body.message } as WebhooksValidationResponse;
   }
 
   list(domain: string, query: WebhooksQuery): Promise<WebhookList> {
@@ -61,7 +61,7 @@ export default class WebhookClient {
   create(domain: string,
     id: string,
     url: string,
-    test = false): Promise<Webhook | ValidationResponse> {
+    test = false): Promise<Webhook | WebhooksValidationResponse> {
     if (test) {
       return this.request.putWithFD(urljoin('/v3/domains', domain, 'webhooks', id, 'test'), { url })
         .then(this._parseWebhookTest);

diff --git a/test/lists.test.ts b/test/lists.test.ts
@@ -9,7 +9,7 @@ import {
   CancelValidationResult,
   MailingList,
   StartValidationResult,
-  ValidationResult
+  ListValidationResult
 } from '../lib/types/lists';
 import { InputFormData } from '../lib/types/IFormData';
 
@@ -179,7 +179,7 @@ describe('ListsClient', function () {
         }
       });
 
-      return client.validationResult('[email protected]').then(function (data: ValidationResult) {
+      return client.validationResult('[email protected]').then(function (data: ListValidationResult) {
         data.should.eql({
           status: 200,
           validationResult: {