mailgun.js 7.0.3 → 8.0.1

package/CHANGELOG.md

@@ -2,6 +2,81 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [8.0.1](https://github.com/mailgun/mailgun.js/compare/v8.0.0...v8.0.1) (2022-08-30)
+
+
+### Bug Fixes
+
+* Move webpack-merge to the dev dependencies ([68304c2](https://github.com/mailgun/mailgun.js/commits/68304c20f28ad38b8202ddf008c4a5f0786f1f54))
+
+
+### Other changes
+
+* Update build ([633e539](https://github.com/mailgun/mailgun.js/commits/633e5392b5bc2843fa08e3541a63f5b67179dcf6))
+* Update send-email example ([a5a7c5a](https://github.com/mailgun/mailgun.js/commits/a5a7c5aeaa560cf8e6d6d9936b9c0137e84ba7e9))
+
+## [8.0.0](https://github.com/mailgun/mailgun.js/compare/v7.0.4...v8.0.0) (2022-07-28)
+
+
+### ⚠ BREAKING CHANGES
+
+* (MultipleValidationClient) Changed result interface for Multiple Validation.
+* (ListsClient) property with the name 'skip' was replaced by 'page' in the ListsQuery interface.
+* (ListsClient.list)'list' method changed the response interface to MailingListResult
+* Unify iterating thru pages in Domain Templates
+* (SuppressionClient) Some interfaces moved from Suppressions.d.ts to separate files
+(SuppressionClient.list) Property with name 'address' was replaced by iteratorPosition in the response in 'pages'
+* (EventClient.get) Number propery was replaced by iteratorPosition in pages property of response
+* (DomainTagsClient) Page property was added to DomainTagsQuery.
+* (DomainTagsClient) Status property was added to DomainTagsList.
+* (DomainTagsClient) Address property replaced by iteratorPosition in ParsedPage for list method.
+* (MailListsMembers) Updated listMembers response to be object with MailListMembersResult interface
+
+### Features
+
+* Add query to MultipleValidationClient ([2a7fd64](https://github.com/mailgun/mailgun.js/commits/2a7fd646af22675c75c81d144821f1d05ce87815))
+* Unify iterating thru pages in domain tags ([2ee7bd2](https://github.com/mailgun/mailgun.js/commits/2ee7bd2afee6d397ae41357c9cf66e4c88e7feff))
+* Unify iterating thru pages in Domain Templates ([2dcf453](https://github.com/mailgun/mailgun.js/commits/2dcf453ad9c53d2359620f890edd709f373e9aee))
+* Unify iterating thru pages in events ([41de3bb](https://github.com/mailgun/mailgun.js/commits/41de3bb084dc3c5b90abb81cdcfe7c365b6df097))
+* Unify iterating thru pages in Mailing lists ([40a6859](https://github.com/mailgun/mailgun.js/commits/40a685944057c308e7cb09c7f8d02b2b7177b87e))
+* Unify iterating thru pages in Multiple Validations ([db0d1f8](https://github.com/mailgun/mailgun.js/commits/db0d1f8629dda5849ff54a95607b7b388dde57d9))
+* Unify iterating thru pages in suppressions ([11962dc](https://github.com/mailgun/mailgun.js/commits/11962dcb7f8fe716af4f559ab97984154f3a30c6))
+
+
+### Bug Fixes
+
+* Fix assignment for force_dkim_authority ([ab442fe](https://github.com/mailgun/mailgun.js/commits/ab442fea88631e0e09c9399f14e1498782cc8373))
+
+
+### Breaking changes
+
+* Add pages navigation for mail list members ([a62ebbf](https://github.com/mailgun/mailgun.js/commits/a62ebbfc26768d56d78d1514836e97f8fdf1351f))
+
+
+### Other changes
+
+* Add release:test command ([6fd1e48](https://github.com/mailgun/mailgun.js/commits/6fd1e48f17bfb001f3fa337a85bbca9714025532))
+* Increase test coverage ([93014da](https://github.com/mailgun/mailgun.js/commits/93014dafc2ff91cc9b8ef52830472e9d354cb605))
+* Move duplicate logic to common class ([4603fd2](https://github.com/mailgun/mailgun.js/commits/4603fd2d35c0e94499aa0914b3c42168ece6d203))
+* Regenerate docs ([665068d](https://github.com/mailgun/mailgun.js/commits/665068d210b1b36b17cb4678dab178686db0c232))
+* Update commitlint rules ([a5a8897](https://github.com/mailgun/mailgun.js/commits/a5a8897932cb2499f62aabaf31f6f5c8650236a5))
+* Update readme ([3c32f1b](https://github.com/mailgun/mailgun.js/commits/3c32f1b726c0f19bcd5e009bd36b12c98e23cc8d))
+
+### [7.0.4](https://github.com/mailgun/mailgun.js/compare/v7.0.3...v7.0.4) (2022-07-07)
+
+
+### Bug Fixes
+
+* Message Data (one of text, html, template required) ([abd2862](https://github.com/mailgun/mailgun.js/commits/abd2862fcf36ca54d68dea14cb2b2658d33092ec))
+
+
+### Other changes
+
+* Add content to message data ([a878cc1](https://github.com/mailgun/mailgun.js/commits/a878cc1acb0b4ca441b100278ca0fd2b47d137e3))
+* Add propetry for mime messages ([f701cfb](https://github.com/mailgun/mailgun.js/commits/f701cfb591f08dbb882953bb2b77131fae089bad))
+* Fix build error ([c7fcb5e](https://github.com/mailgun/mailgun.js/commits/c7fcb5e05bd84fc6ef04589bde37846a11f9466d))
+* Fix tests ([b4791c4](https://github.com/mailgun/mailgun.js/commits/b4791c4e746a97aec359635272c2b29cb956ab6f))
+
 ### [7.0.3](https://github.com/mailgun/mailgun.js/compare/v7.0.2...v7.0.3) (2022-06-30)
 
 

package/README.md

@@ -110,6 +110,7 @@ The following service methods are available to instantiated clients. The example
       - [createMembers](#createmembers)
       - [updateMember](#updatemember)
       - [destroyMember](#destroymember)
+  - [Navigation thru lists](#navigation-thru-lists)
   - [Browser Demo](#browser-demo)
 - [Development](#development)
   - [Requirements](#requirements)
@@ -1793,13 +1794,178 @@ mg.lists.members.destroyMember('reply@sample.com', 'bot2@foobar.com')
 
 Promise Returns: response body
 
-```
+```js
 {
   member: { address: 'bot2@foobar.com' },
   message: 'Mailing list member has been deleted'
 }
 ```
 
+## Navigation thru lists
+  Most of the methods that return items in a list support pagination.
+  There are two ways to receive part of the list:
+  1. Provide properties 'limit' and 'page' in the query.
+  This way uses more frequently in the SDK and works for the next methods:
+  - mg.domains.domainTags.list()
+  - mg.domains.domainTemplates.list()
+  - mg.domains.domainTemplates.listVersions()
+  - mg.events.get()
+  - mg.lists.list()
+  - mg.lists.members.listMembers()
+  - mg.validate.list()
+  - mg.suppressions.list()
+
+    The general idea is that after you made the first call with a limit property in the query you will receive a response with a property called pages in it. This property implements the next interface:
+
+    ```TS
+    {
+        previous: {
+            id: string;
+            page: string;
+            iteratorPosition: string | undefined;
+            url: string
+        };
+        first: {
+            id: string;
+            page: string;
+            iteratorPosition: string | undefined;
+            url: string
+        };
+        last: {
+            id: string;
+            page: string;
+            iteratorPosition: string | undefined;
+            url: string
+        };
+        next: {
+            id: string;
+            page: string;
+            iteratorPosition: string | undefined;
+            url: string
+        };
+    }
+    ```
+    To receive the next page you need to add the page property to the query argument. This property should contain a string value from 'page' property in response.pages.(previous/first/last/next).
+
+    Example:
+    ```Js
+    // first call
+    const listMembers = await mg.lists.members.listMembers('your_mailing_list', { limit: 2 });
+
+    /* response
+    {
+      items: [
+        {
+          address: 'test-0@example.com',
+          name: 'test name 0',
+          subscribed: true,
+          vars: [Object]
+        },
+        {
+          address: 'test-1@example.com',
+          name: 'test name 1',
+          subscribed: true,
+          vars: [Object]
+        }
+      ],
+      pages: {
+        first: {
+          id: 'first',
+          page: '?page=first&limit=2',
+          iteratorPosition: undefined,
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=first&limit=2'
+        },
+        last: {
+          id: 'last',
+          page: '?page=last&limit=2',
+          iteratorPosition: undefined,
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=last&limit=2'
+        },
+        next: {
+          id: 'next',
+          page: '?page=next&address=test-1%40example.com&limit=2',
+          iteratorPosition: 'test-1@example.com',
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=next&address=test-1%40example.com&limit=2'
+        },
+        previous: {
+          id: 'previous',
+          page: '?page=prev&address=test-0%40example.com&limit=2',
+          iteratorPosition: 'test-0@example.com',
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=prev&address=test-0%40example.com&limit=2'
+        }
+      }
+    }
+    */
+    // second call
+    const listMembers = await mg.lists.members.listMembers(
+        'your_mailing_list',
+        {
+          limit: 2,
+          page: '?page=next&address=test-1%40example.com&limit=2'
+        }
+      );
+
+    /* response
+    {
+      items: [
+        {
+          address: 'test-2@example.com',
+          name: 'test name 2',
+          subscribed: true,
+          vars: [Object]
+        },
+        {
+          address: 'test-3@example.com',
+          name: 'test name 3',
+          subscribed: true,
+          vars: [Object]
+        }
+      ],
+      pages: {
+        first: {
+          id: 'first',
+          page: '?page=first&limit=2',
+          iteratorPosition: undefined,
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=first&limit=2'
+        },
+        last: {
+          id: 'last',
+          page: '?page=last&limit=2',
+          iteratorPosition: undefined,
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=last&limit=2'
+        },
+        next: {
+          id: 'next',
+          page: '?page=next&address=test-3%40example.com&limit=2',
+          iteratorPosition: 'test-3@example.com',
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=next&address=test-3%40example.com&limit=2'
+        },
+        previous: {
+          id: 'previous',
+          page: '?page=prev&address=test-2%40example.com&limit=2',
+          iteratorPosition: 'test-2@example.com',
+          url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=prev&address=test-2%40example.com&limit=2'
+        }
+      }
+    }
+    */
+    ```
+    2. The second option of navigation is to provide properties 'limit' and 'skip' in the query. This way uses only in a few places for now:
+      - mg.domains.list()
+      - mg.domains.domainCredentials.list()
+      - mg.routes.list()
+      - mg.webhooks.list()
+    The main idea here is quite simple you just need to provide how many records from the start of a list you want to skip and how many to receive. You can do it using the query parameter in each method.
+    Example:
+    ```js
+    const listDomainCredentials = await client.domains.domainCredentials.list(
+    'your_domain_name',
+    {
+      skip: 10,
+      limit: 1
+    }
+    );
+    ```
 
 
 ## Browser Demo

package/common/NavigationThruPages.d.ts

@@ -0,0 +1,19 @@
+import { ParsedPage, ParsedPagesList, QueryWithPage, ResponseWithPaging } 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';
+import Request from '../request';
+export default abstract class NavigationThruPages<T> {
+    request?: Request;
+    constructor(request?: Request);
+    protected parsePage(id: string, pageUrl: string, urlSeparator: string, iteratorName: string | undefined): ParsedPage;
+    protected parsePageLinks(response: ResponseWithPaging, urlSeparator: string, iteratorName?: string): ParsedPagesList;
+    private updateUrlAndQuery;
+    protected requestListWithPages(clientUrl: string, query?: QueryWithPage, Model?: {
+        new (data: BounceData | ComplaintData | UnsubscribeData | WhiteListData): IBounce | IComplaint | IUnsubscribe | IWhiteList;
+    }): Promise<T>;
+    protected abstract parseList(response: ResponseWithPaging, Model?: {
+        new (data: BounceData | ComplaintData | UnsubscribeData | WhiteListData): IBounce | IComplaint | IUnsubscribe | IWhiteList;
+    }): T;
+}

package/domainsTags.d.ts

@@ -1,5 +1,6 @@
 import Request from './request';
-import { DomainTagCountriesAggregation, DomainTagDevicesAggregation, DomainTagProvidersAggregation, DomainTagsItem, DomainTagsItemInfo, DomainTagsList, DomainTagsMessageRes, DomainTagsQuery, DomainTagsStatisticQuery, DomainTagStatAPIResponse, DomainTagStatisticItem, DomainTagStatisticResult, IDomainTagsClient, Resolution } from './interfaces/DomainTags';
+import { DomainTagCountriesAggregation, DomainTagDevicesAggregation, DomainTagProvidersAggregation, DomainTagsItem, DomainTagsItemInfo, DomainTagsList, DomainTagsMessageRes, DomainTagsQuery, DomainTagsResponseData, DomainTagsStatisticQuery, DomainTagStatAPIResponse, DomainTagStatisticItem, DomainTagStatisticResult, IDomainTagsClient, Resolution } from './interfaces/DomainTags';
+import NavigationThruPages from './common/NavigationThruPages';
 export declare class DomainTag implements DomainTagsItem {
     tag: string;
     description: string;
@@ -16,12 +17,11 @@ export declare class DomainTagStatistic implements DomainTagStatisticResult {
     stats: DomainTagStatisticItem[];
     constructor(tagStatisticInfo: DomainTagStatAPIResponse);
 }
-export default class DomainTagsClient implements IDomainTagsClient {
+export default class DomainTagsClient extends NavigationThruPages<DomainTagsList> implements IDomainTagsClient {
     baseRoute: string;
     request: Request;
     constructor(request: Request);
-    private _parsePageLinks;
-    private _parseDomainTagsList;
+    protected parseList(response: DomainTagsResponseData): DomainTagsList;
     private _parseTagStatistic;
     list(domain: string, query?: DomainTagsQuery): Promise<DomainTagsList>;
     get(domain: string, tag: string): Promise<DomainTagsItem>;

package/domainsTemplates.d.ts

@@ -1,5 +1,6 @@
 import Request from './request';
-import { CreateDomainTemplateVersionResult, DomainTemplate, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, IDomainTemplatesClient, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateQuery, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from './interfaces/DomainTemplates';
+import { CreateDomainTemplateVersionResult, DomainTemplate, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, IDomainTemplatesClient, ListDomainTemplatesAPIResponse, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateQuery, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from './interfaces/DomainTemplates';
+import NavigationThruPages from './common/NavigationThruPages';
 export declare class DomainTemplateItem implements DomainTemplate {
     name: string;
     description: string;
@@ -10,7 +11,7 @@ export declare class DomainTemplateItem implements DomainTemplate {
     versions?: ShortTemplateVersion[];
     constructor(domainTemplateFromAPI: DomainTemplate);
 }
-export default class DomainTemplatesClient implements IDomainTemplatesClient {
+export default class DomainTemplatesClient extends NavigationThruPages<ListDomainTemplatesResult> implements IDomainTemplatesClient {
     baseRoute: string;
     request: Request;
     constructor(request: Request);
@@ -19,7 +20,7 @@ export default class DomainTemplatesClient implements IDomainTemplatesClient {
     private parseMutationResponse;
     private parseNotificationResponse;
     private parseMutateTemplateVersionResponse;
-    private parseList;
+    protected parseList(response: ListDomainTemplatesAPIResponse): ListDomainTemplatesResult;
     private parseListTemplateVersions;
     list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
     get(domain: string, templateName: string, query?: TemplateQuery): Promise<DomainTemplateItem>;

package/events.d.ts

@@ -1,11 +1,9 @@
-import { EventsList, EventsPage, EventsQuery, EventsResponse, ParsedPagesList } from './interfaces/Events';
+import NavigationThruPages from './common/NavigationThruPages';
+import { EventsList, EventsQuery, EventsResponse } from './interfaces/Events';
 import Request from './request';
-export default class EventClient {
+export default class EventClient extends NavigationThruPages<EventsList> {
     request: Request;
     constructor(request: Request);
-    _parsePageNumber(url: string): string;
-    _parsePage(id: string, url: string): EventsPage;
-    _parsePageLinks(response: EventsResponse): ParsedPagesList;
-    _parseEventList(response: EventsResponse): EventsList;
+    protected parseList(response: EventsResponse): EventsList;
     get(domain: string, query?: EventsQuery): Promise<EventsList>;
 }

package/interfaces/DomainTags.d.ts

@@ -1,4 +1,5 @@
 import { DomainTagStatistic } from '../domainsTags';
+import { PagesList, ParsedPagesList } from './NavigationThruPages';
 export declare enum Resolution {
     HOUR = "hour",
     DAY = "day",
@@ -6,6 +7,7 @@ export declare enum Resolution {
 }
 export declare type DomainTagsQuery = {
     limit: number;
+    page?: string;
 };
 export declare type DomainTagsStatisticQuery = {
     event: string;
@@ -26,29 +28,6 @@ export interface DomainTagsItem {
     'first-seen': Date;
     'last-seen': Date;
 }
-export interface PagesList {
-    previous: string;
-    first: string;
-    last: string;
-    next: string;
-}
-export interface ParsedPage {
-    id: string;
-    url: string;
-}
-export interface ParsedPagesList {
-    previous: ParsedPage;
-    first: ParsedPage;
-    last: ParsedPage;
-    next: ParsedPage;
-}
-export interface TagsPage {
-    id: string;
-    url: string;
-}
-export interface PagesListAccumulator {
-    [index: string]: TagsPage;
-}
 export interface DomainTagsResponseData {
     status: number;
     body: {
@@ -57,6 +36,7 @@ export interface DomainTagsResponseData {
     };
 }
 export interface DomainTagsList {
+    status: number;
     items: DomainTagsItem[];
     pages: ParsedPagesList;
 }

package/interfaces/DomainTemplates.d.ts

@@ -1,14 +1,9 @@
 import { DomainTemplateItem } from '../domainsTemplates';
+import { PagesList, ParsedPagesList } from './NavigationThruPages';
 export declare enum YesNo {
     YES = "yes",
     NO = "no"
 }
-export declare enum Pages {
-    FIRST = "first",
-    LAST = "last",
-    NEXT = "next",
-    PREV = "prev"
-}
 export declare type DomainTemplateData = {
     name: string;
     description: string;
@@ -33,9 +28,8 @@ export declare type DomainTemplateUpdateVersionData = {
     active?: YesNo;
 };
 export declare type DomainTemplatesQuery = {
-    page: Pages;
+    page: 'string';
     limit: number;
-    p: string;
 };
 export declare type TemplateQuery = {
     active: YesNo;
@@ -82,12 +76,8 @@ export interface ListDomainTemplatesAPIResponse {
 }
 export interface ListDomainTemplatesResult {
     items: DomainTemplate[];
-    pages: {
-        first: string;
-        last: string;
-        next: string;
-        previous: string;
-    };
+    pages: ParsedPagesList;
+    status: number;
 }
 export interface GetDomainTemplateAPIResponse {
     status: number;
@@ -162,22 +152,12 @@ export interface ListDomainTemplateVersionsAPIResponse {
             id: string;
             versions: ShortTemplateVersion[];
         };
-        paging: {
-            first: string;
-            last: string;
-            next: string;
-            previous: string;
-        };
+        paging: PagesList;
     };
 }
 export interface ListDomainTemplateVersionsResult {
     template: DomainTemplateItem;
-    pages: {
-        first: string;
-        last: string;
-        next: string;
-        previous: string;
-    };
+    pages: ParsedPagesList;
 }
 export interface IDomainTemplatesClient {
     list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;

package/interfaces/Events.d.ts

@@ -1,3 +1,4 @@
+import { PagesList, ParsedPagesList } from './NavigationThruPages';
 export interface EventsPage {
     id: string;
     number: string;
@@ -24,17 +25,12 @@ export interface EventsQuery extends FilterField {
     ascending?: 'yes' | 'no';
     limit?: number;
 }
-export interface PagesList {
-    previous: string;
-    first: string;
-    last: string;
-    next: string;
-}
 export interface EventsResponse {
     body: {
         items: [];
         paging: PagesList;
     };
+    status: number;
 }
 export interface DomainEvent {
     severity: string;
@@ -89,21 +85,8 @@ export interface DomainEvent {
     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: DomainEvent[];
     pages: ParsedPagesList;
-}
-export interface PagesListAccumulator {
-    [index: string]: EventsPage;
+    status: number;
 }

package/interfaces/Messages.d.ts

@@ -1,4 +1,31 @@
-export declare type MailgunMessageData = {
+/// <reference types="node" />
+/**
+ * Ensures the object has least one key present and not undefined
+ *
+ * @see {@link https://stackoverflow.com/a/49725198}
+ */
+export declare type AtLeastOneKeyPresent<Object_, Keys extends keyof Object_ = keyof Object_> = Pick<Object_, Exclude<keyof Object_, Keys>> & {
+    [K in Keys]-?: Required<Pick<Object_, K>> & Partial<Pick<Object_, Exclude<Keys, K>>>;
+}[Keys];
+export declare type MailgunMessageContent = AtLeastOneKeyPresent<{
+    /**
+     * Body of the message. (text version)
+     */
+    text?: string;
+    /**
+     * Body of the message. (HTML version)
+     */
+    html?: string;
+    /**
+     * Body of the message. (MIME version)
+     */
+    message?: string | Buffer | Blob;
+    /**
+    * Name of a template stored via [template API](https://documentation.mailgun.com/en/latest/api-templates.html#api-templates). See [Templates](https://documentation.mailgun.com/en/latest/user_manual.html#templating) for more information
+    */
+    template?: string;
+}>;
+export declare type MailgunMessageData = MailgunMessageContent & {
     /**
      * Email address for `From` header
      */
@@ -21,14 +48,6 @@ export declare type MailgunMessageData = {
      * Message subject
      */
     subject?: string;
-    /**
-     * Body of the message. (text version)
-     */
-    text?: string;
-    /**
-     * Body of the message. (HTML version)
-     */
-    html?: string;
     /**
      * [AMP](https://developers.google.com/gmail/ampemail/) part of the message. Please follow google guidelines to compose and send AMP emails.
      */
@@ -45,10 +64,6 @@ export declare type MailgunMessageData = {
      * You can post multiple `inline` values.
      */
     inline?: any;
-    /**
-     * Name of a template stored via [template API](https://documentation.mailgun.com/en/latest/api-templates.html#api-templates). See [Templates](https://documentation.mailgun.com/en/latest/user_manual.html#templating) for more information
-     */
-    template?: string;
     /**
      * Use this parameter to send a message to specific version of a template
      */

package/interfaces/MultipleValidation.d.ts

@@ -1,19 +1,46 @@
-export interface MultipleValidationJob {
+import { PagesList, ParsedPagesList } from './NavigationThruPages';
+export interface MultipleValidationJobData {
     created_at: number;
-    download_url: {
+    id: string;
+    quantity: number;
+    records_processed: number | null;
+    status: string;
+    download_url?: {
         csv: string;
         json: 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 MultipleValidationJobResult {
+    createdAt: Date;
     id: string;
     quantity: number;
-    records_processed: number;
+    recordsProcessed: number | null;
     status: string;
     responseStatusCode: number;
-    summary: {
+    downloadUrl?: {
+        csv: string;
+        json: string;
+    };
+    summary?: {
         result: {
-            catch_all: number;
+            catchAll: number;
             deliverable: number;
-            do_not_send: number;
+            doNotSend: number;
             undeliverable: number;
             unknown: number;
         };
@@ -37,21 +64,23 @@ export interface MultipleValidationCreationDataUpdated {
     multipleValidationFile: Record<string, unknown>;
     [key: string]: unknown | undefined;
 }
-export interface PagesList {
-    prev: string;
-    first: string;
-    last: string;
-    next: string;
-}
 export interface MultipleValidationJobsListResult {
-    jobs: MultipleValidationJob[];
-    paging: PagesList;
+    jobs: MultipleValidationJobResult[];
+    pages: ParsedPagesList;
     total: number;
     status: number;
 }
+export interface MultipleValidationJobsListQuery {
+    limit: number;
+    page: string;
+}
 export interface MultipleValidationJobsListResponse {
-    status: 200;
-    body: MultipleValidationJobsListResult;
+    status: number;
+    body: {
+        paging: PagesList;
+        jobs: MultipleValidationJobData[];
+        total: number;
+    };
 }
 export interface CanceledMultipleValidationJob {
     message: string;
@@ -59,7 +88,7 @@ export interface CanceledMultipleValidationJob {
 }
 export interface IMultipleValidationClient {
     list(): Promise<MultipleValidationJobsListResult>;
-    get(listId: string): Promise<MultipleValidationJob>;
+    get(listId: string): Promise<MultipleValidationJobResult>;
     create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
     destroy(listId: string): Promise<CanceledMultipleValidationJob>;
 }