other: Add tests

dist/Types/InboxPlacements/InboxPlacements.d.ts

@@ -1,8 +1,12 @@
 export type InboxPlacementsData = {
     from: string;
     subject: string;
-    html: string;
     provider_filter?: string[];
+    html?: string;
+    template_name?: string;
+    variables?: {
+        [propName: string]: string;
+    };
     seed_list?: string;
 };
 export type InboxPlacementsTestResult = {

dist/Types/InboxPlacements/Results/InboxPlacementsResults.d.ts

@@ -1,16 +1,16 @@
 import { PagesList, ParsedPagesList } from '../../Common';
 export type InboxPlacementsResultsQuery = {
-    sender: string;
-    subject: string;
-    provider: string;
-    target_email: string;
-    time_after: string | Date;
-    time_before: string | Date;
-    cursor: string;
-    sort: string;
-    offset: number;
-    ascending: boolean;
-    limit: number;
+    sender?: string;
+    subject?: string;
+    provider?: string;
+    target_email?: string;
+    time_after?: string | Date;
+    time_before?: string | Date;
+    cursor?: string;
+    sort?: string;
+    offset?: number;
+    ascending?: boolean;
+    limit?: number;
 };
 export type InboxPlacementsResultsDates = {
     time_after?: string;
@@ -115,6 +115,7 @@ export type InboxPlacementsResult = Omit<InboxPlacementsResultAPIShape, 'Id' | '
     created_at: Date;
     updated_at: Date;
     sharing_expires_at: Date;
+    id: string;
 };
 export type InboxPlacementsResultAPIResponse = {
     body: {

dist/Types/InboxPlacements/Results/InboxPlacementsResultsSharing.d.ts

@@ -16,7 +16,12 @@ export type IPRSharingResult = Omit<IPRSharingApiShape, 'expires_at'> & {
     expires_at: Date;
 };
 export type IPRSharingUpdateData = {
-    enabled: true;
+    enabled: boolean;
+};
+export type IPRSharingUpdateAPIResponse = {
+    body: {
+        sharing: IPRSharingApiShape;
+    };
+    status: number;
 };
-export type IPRSharingUpdateAPIResponse = IPRSharingAPIResponse;
 export type IPRSharingUpdateResult = IPRSharingResult;

dist/Types/InboxPlacements/SeedsLists/SeedsLists.d.ts

@@ -93,7 +93,7 @@ export type SeedsListsAPIResponse = {
     status: number;
 };
 export type SeedsListsResult = {
-    items: SeedList[];
+    items: SeedList[] | [];
     status: number;
     pages: ParsedPagesList;
 };

lib/Classes/InboxPlacements/AttributesClient.ts

@@ -29,6 +29,9 @@ export default class InboxPlacementsAttributesClient implements IInboxPlacements
 
   async get(attributeName: string): Promise<InboxPlacementsValuesResult> {
     const response = await this.request.get(`${this.path}/${attributeName}`) as InboxPlacementsValuesApiResponse;
-    return response.body;
+    return {
+      ...response.body,
+      status: response.status
+    };
   }
 }

lib/Classes/InboxPlacements/Results/InboxPlacementsResultsClient.ts

@@ -104,10 +104,11 @@ Consider using string type for property "${key}" to avoid auto-converting`);
     const inboxPlacementsResult: InboxPlacementsResult = {
       ...data,
       Box: box,
-      ...handledSeedListDates
+      ...handledSeedListDates,
+      id: data.Id,
     };
 
-    delete (inboxPlacementsResult as {Id?: string}).Id;
+    delete (inboxPlacementsResult as {ID?: string}).ID;
 
     return inboxPlacementsResult;
   }

lib/Classes/InboxPlacements/SeedsLists/SeedsListsClient.ts

@@ -128,9 +128,11 @@ Consider using string type for property "${key}" to avoid auto-converting`);
   }
 
   protected parseList(response: SeedsListsAPIResponse): SeedsListsResult {
-    const data = {} as SeedsListsResult;
+    const data = {
+      items: []
+    } as SeedsListsResult;
 
-    data.items = response.body.items.map(
+    data.items = response.body.items?.map(
       (item: SeedListAPIShape): SeedList => this.prepareSeedList(item)
     );
 
@@ -143,7 +145,10 @@ Consider using string type for property "${key}" to avoid auto-converting`);
   async list(query: SeedsListsQuery): Promise<SeedsListsResult> {
     const queryData = this.prepareQueryData(query);
     const response: SeedsListsAPIResponse = await this.request.get('/v4/inbox/seedlists', queryData) as SeedsListsAPIResponse;
-    return this.parseList(response);
+    return {
+      ...this.parseList(response),
+      status: 200
+    };
   }
 
   async get(id: string): Promise<SeedListResult> {

lib/Classes/InboxPlacements/inboxPlacements.ts

@@ -8,7 +8,8 @@ export default class InboxPlacementsClient implements IInboxPlacementsClient {
   request: Request;
   public seedsLists: ISeedsListsClient;
   public results: IInboxPlacementsResultsClient;
-  providers: IInboxPlacementsProvidersClient
+  public providers: IInboxPlacementsProvidersClient;
+
   constructor(
     request: Request,
     seedsListsClient: ISeedsListsClient,

lib/Types/InboxPlacements/InboxPlacements.ts

@@ -2,8 +2,12 @@
 export type InboxPlacementsData = {
   from: string;
   subject: string;
-  html: string;
   provider_filter?: string[];
+  html?: string;
+  template_name?: string;
+  variables?: {
+    [propName: string]: string;
+  }
   seed_list?: string;
 }
 

lib/Types/InboxPlacements/Results/InboxPlacementsResults.ts

@@ -2,17 +2,17 @@ import { PagesList, ParsedPagesList } from '../../Common';
 
 /* eslint-disable camelcase */
 export type InboxPlacementsResultsQuery = {
-  sender: string;
-  subject: string;
-  provider: string;
-  target_email: string;
-  time_after: string | Date;
-  time_before: string | Date;
-  cursor: string;
-  sort: string;
-  offset: number;
-  ascending: boolean;
-  limit: number;
+  sender?: string;
+  subject?: string;
+  provider?: string;
+  target_email?: string;
+  time_after?: string | Date;
+  time_before?: string | Date;
+  cursor?: string;
+  sort?: string;
+  offset?: number;
+  ascending?: boolean;
+  limit?: number;
 };
 
 export type InboxPlacementsResultsDates = {
@@ -59,7 +59,7 @@ export type InboxPlacementsBoxAPIShape = {
   CreatedTS: number;
   tags: string[];
   SeedQuality: number;
-  is_auto_generated: boolean
+  is_auto_generated: boolean;
 };
 
 export type InboxPlacementsBox = Omit<InboxPlacementsBoxAPIShape, 'created_at'| 'updated_at' | 'last_result_at'> & {
@@ -124,6 +124,7 @@ export type InboxPlacementsResult = Omit<InboxPlacementsResultAPIShape, 'Id' | '
   created_at: Date;
   updated_at: Date;
   sharing_expires_at: Date;
+  id: string;
 };
 
 export type InboxPlacementsResultAPIResponse = {

lib/Types/InboxPlacements/Results/InboxPlacementsResultsSharing.ts

@@ -20,8 +20,13 @@ export type IPRSharingResult = Omit<IPRSharingApiShape, 'expires_at'> & {
 };
 
 export type IPRSharingUpdateData = {
-  enabled: true;
+  enabled: boolean;
 };
 
-export type IPRSharingUpdateAPIResponse = IPRSharingAPIResponse;
+export type IPRSharingUpdateAPIResponse = {
+  body: {
+    sharing:IPRSharingApiShape
+  };
+  status: number;
+};
 export type IPRSharingUpdateResult = IPRSharingResult;

lib/Types/InboxPlacements/SeedsLists/SeedsLists.ts

@@ -105,7 +105,7 @@ export type SeedsListsAPIResponse = {
 };
 
 export type SeedsListsResult = {
-  items: SeedList[];
+  items: SeedList[] | [];
   status: number;
   pages: ParsedPagesList
 };

test/InboxPlacements.test.ts

@@ -0,0 +1,83 @@
+import formData from 'form-data';
+
+import nock from 'nock';
+import Request from '../lib/Classes/common/Request';
+
+import { InputFormData, RequestOptions } from '../lib/Types/Common';
+
+import { IInboxPlacementsClient } from '../lib/Interfaces';
+import InboxPlacementsClient from '../lib/Classes/InboxPlacements/inboxPlacements';
+
+import SeedsListsClient from '../lib/Classes/InboxPlacements/SeedsLists/SeedsListsClient';
+import InboxPlacementsResultsClient from '../lib/Classes/InboxPlacements/Results/InboxPlacementsResultsClient';
+import InboxPlacementsProvidersClient from '../lib/Classes/InboxPlacements/providers/InboxPlacementsProviders';
+
+
+// TODO: fix types
+describe('Inbox Placements Client', () => {
+  let client: IInboxPlacementsClient;
+  let api: nock.Scope;
+
+  beforeEach(() => {
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
+    client = new InboxPlacementsClient(
+      reqObject,
+      {} as SeedsListsClient,
+      {} as InboxPlacementsResultsClient,
+      {} as InboxPlacementsProvidersClient
+    );
+    api = nock('https://api.mailgun.net');
+  });
+
+  afterEach(() => {
+    api.done();
+  });
+
+  describe('runTest', () => {
+    it('runs inbox placements test', async () => {
+      const providers = [
+        {
+          domain: 'aol.com',
+          display_name: 'AOL',
+          region: 'Global',
+          created_at: '2023-01-04T17:40:03.400Z',
+          updated_at: '2023-02-17T17:20:12.172Z'
+        },
+        {
+          domain: 'att.net',
+          display_name: 'AT&T',
+          region: 'UnitedStates',
+          created_at: '2023-01-04T17:42:30.576Z',
+          updated_at: '2023-02-17T17:20:20.664Z'
+        },
+        {
+          domain: 'comcast.net',
+          display_name: 'Comcast / Xfinity',
+          region: 'United States',
+          created_at: '2023-02-16T20:24:10.789Z',
+          updated_at: '2023-02-16T20:24:10.789Z'
+        }
+      ];
+      api.post('/v4/inbox/tests').reply(200, {
+        result_id: 'test_result_id',
+        links: {
+          results: 'test_results'
+        }
+      });
+
+      const runTestResponse = await client.runTest({
+        from: 'from',
+        subject: 'subject',
+        provider_filter: ['test'],
+        html: 'some html',
+      });
+      runTestResponse.should.eql({
+        result_id: 'test_result_id',
+        links: {
+          results: 'test_results'
+        },
+        status: 200
+      });
+    });
+  });
+});

test/InboxPlacements_Providers.test.ts

@@ -0,0 +1,70 @@
+import formData from 'form-data';
+
+import nock from 'nock';
+import Request from '../lib/Classes/common/Request';
+
+import { InputFormData, RequestOptions } from '../lib/Types/Common';
+
+import InboxPlacementsProvidersClient from '../lib/Classes/InboxPlacements/providers/InboxPlacementsProviders';
+import { IInboxPlacementsProvidersClient } from '../lib/Interfaces/InboxPlacements/providers/InboxPlacementsProviders';
+
+// TODO: fix types
+describe('Inbox Placements Providers', () => {
+  let client: IInboxPlacementsProvidersClient;
+  let api: nock.Scope;
+
+  beforeEach(() => {
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
+    client = new InboxPlacementsProvidersClient(reqObject);
+    api = nock('https://api.mailgun.net');
+  });
+
+  afterEach(() => {
+    api.done();
+  });
+
+  describe('list', () => {
+    it('fetches inbox placements providers lists', async () => {
+      const providers = [
+        {
+          domain: 'aol.com',
+          display_name: 'AOL',
+          region: 'Global',
+          created_at: '2023-01-04T17:40:03.400Z',
+          updated_at: '2023-02-17T17:20:12.172Z'
+        },
+        {
+          domain: 'att.net',
+          display_name: 'AT&T',
+          region: 'UnitedStates',
+          created_at: '2023-01-04T17:42:30.576Z',
+          updated_at: '2023-02-17T17:20:20.664Z'
+        },
+        {
+          domain: 'comcast.net',
+          display_name: 'Comcast / Xfinity',
+          region: 'United States',
+          created_at: '2023-02-16T20:24:10.789Z',
+          updated_at: '2023-02-16T20:24:10.789Z'
+        }
+      ];
+      api.get('/v4/inbox/providers').reply(200, {
+        items: providers
+      });
+
+      const IPProviders = await client.list();
+      IPProviders.should.be.an('object').to.have.property('items');
+      IPProviders.should.be.an('object').to.have.property('status');
+      IPProviders.status.should.be.equal(200);
+
+      IPProviders.items.should.be.an('array').to.have.property('length').to.equal(3);
+
+      const expectedProviders = providers.map((provider) => ({
+        ...provider,
+        created_at: new Date(provider.created_at),
+        updated_at: new Date(provider.updated_at)
+      }));
+      IPProviders.items.should.eql(expectedProviders);
+    });
+  });
+});