mailgun.js 5.1.0 → 5.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.
 
+## [5.2.0](https://github.com/mailgun/mailgun.js/compare/v5.1.0...v5.2.0) (2022-04-11)
+
+
+### Features
+
+* Add validation methods to mailing list client ([224790c](https://github.com/mailgun/mailgun.js/commits/224790c4c20466a2203856d703b51e7d4a03a195))
+
 ## [5.1.0](https://github.com/mailgun/mailgun.js/compare/v5.0.5...v5.1.0) (2022-04-08)
 
 

package/interfaces/lists.d.ts

@@ -14,6 +14,50 @@ export interface DestroyedList {
     address: string;
     message: string;
 }
+export interface StartValidationResult {
+    status: number;
+    id: string;
+    message: string;
+}
+export interface ValidationResponse {
+    status: string;
+    download_url: {
+        csv: string;
+        json: string;
+    };
+    id: string;
+    quantity: number;
+    records_processed: number;
+    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 ValidationApiResponse extends ValidationResponse {
+    created_at: number;
+}
+export interface ValidationResultData extends ValidationResponse {
+    created_at: Date;
+}
+export interface ValidationResult {
+    status: number;
+    validationResult: ValidationResultData;
+}
+export interface CancelValidationResult {
+    status: number;
+    message: string;
+}
 export interface MailingList {
     access_level: string;
     address: string;

package/lists.d.ts

@@ -1,14 +1,18 @@
 import Request from './request';
-import { ListsQuery, CreateUpdateList, DestroyedList, MailingList } from './interfaces/lists';
+import { ListsQuery, CreateUpdateList, DestroyedList, MailingList, StartValidationResult, ValidationResult, CancelValidationResult } from './interfaces/lists';
 import { IMailListsMembers } from './interfaces/mailListMembers';
 export default class ListsClient {
     baseRoute: string;
     request: Request;
     members: IMailListsMembers;
     constructor(request: Request, members: IMailListsMembers);
+    private parseValidationResult;
     list(query?: ListsQuery): Promise<MailingList[]>;
     get(mailListAddress: string): Promise<MailingList>;
     create(data: CreateUpdateList): Promise<MailingList>;
     update(mailListAddress: string, data: CreateUpdateList): Promise<MailingList>;
     destroy(mailListAddress: string): Promise<DestroyedList>;
+    validate(mailListAddress: string): Promise<StartValidationResult>;
+    validationResult(mailListAddress: string): Promise<ValidationResult>;
+    cancelValidation(mailListAddress: string): Promise<CancelValidationResult>;
 }