mailgun.js 7.0.4 → 8.0.0

package/interfaces/Suppressions/Suppressions.d.ts

@@ -0,0 +1,69 @@
+import { Bounce, Complaint, Unsubscribe, WhiteList } from '../../suppressions';
+import { PagesList, ParsedPagesList } from '../NavigationThruPages';
+import { BounceData } from './Bounce';
+import { ComplaintData } from './Complaint';
+import { UnsubscribeData } from './Unsubscribe';
+import { WhiteListData } from './WhiteList';
+export declare enum SuppressionModels {
+    BOUNCES = "bounces",
+    COMPLAINTS = "complaints",
+    UNSUBSCRIBES = "unsubscribes",
+    WHITELISTS = "whitelists"
+}
+export interface SuppressionList {
+    items: (Bounce | Complaint | Unsubscribe | WhiteList)[];
+    pages: ParsedPagesList;
+    status: number;
+}
+export declare type SuppressionListQuery = {
+    limit?: number;
+    page?: string;
+};
+export declare type SuppressionDataType = BounceData | ComplaintData | UnsubscribeData | WhiteListData;
+export interface SuppressionListResponse {
+    body: {
+        items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[];
+        paging: PagesList;
+    };
+    status: number;
+}
+export interface SuppressionResponse {
+    body: BounceData | ComplaintData | UnsubscribeData | WhiteListData;
+    status: number;
+}
+export interface SuppressionDestroyResponse {
+    body: {
+        message: string;
+        value?: string;
+        address?: string;
+    };
+    status: number;
+}
+export interface SuppressionDestroyResult {
+    message: string;
+    value: string;
+    address: string;
+    status: number;
+}
+export declare type SuppressionCreationData = {
+    address: string;
+    code?: number;
+    error?: string;
+    domain?: string;
+    tag?: string;
+    created_at?: string;
+};
+export interface SuppressionCreationResponse {
+    body: {
+        message: string;
+        type?: string;
+        value?: string;
+    };
+    status: number;
+}
+export interface SuppressionCreationResult {
+    message: string;
+    type: string;
+    value: string;
+    status: number;
+}

package/interfaces/Suppressions/Unsubscribe.d.ts

@@ -0,0 +1,11 @@
+export interface UnsubscribeData {
+    address: string;
+    tags: any;
+    created_at: string | Date;
+}
+export interface IUnsubscribe {
+    address: string;
+    tags: any;
+    created_at: Date;
+    type: string;
+}

package/interfaces/Suppressions/WhiteList.d.ts

@@ -0,0 +1,12 @@
+export interface WhiteListData {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: string | Date;
+}
+export interface IWhiteList {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: Date;
+}

package/interfaces/lists.d.ts

@@ -1,7 +1,8 @@
+import { PagesList, ParsedPagesList } from './NavigationThruPages';
 export declare type ListsQuery = {
     address?: string;
     limit?: number;
-    skip?: number;
+    page?: string;
 };
 export declare type CreateUpdateList = {
     address: string;
@@ -67,3 +68,15 @@ export interface MailingList {
     name: string;
     reply_preference: null | string;
 }
+export interface MailingListResult {
+    items: MailingList[];
+    status: number;
+    pages: ParsedPagesList;
+}
+export interface MailingListApiResponse {
+    body: {
+        items: MailingList[];
+        paging: PagesList;
+    };
+    status: number;
+}

package/interfaces/mailListMembers.d.ts

@@ -1,13 +1,17 @@
 import { MailingList } from './lists';
+import { PagesList, ParsedPagesList } from './NavigationThruPages';
 export interface MailListMember {
     address: string;
     name: string;
     subscribed: boolean;
-    vars: string | any;
+    vars: {
+        [key: string]: any;
+    };
 }
 export declare type MailListMembersQuery = {
     subscribed?: 'yes' | 'no';
     limit?: number;
+    page?: string;
 };
 export declare type MultipleMembersData = {
     members: Array<MailListMember>;
@@ -42,8 +46,20 @@ export interface NewMultipleMembersResponse {
     message: string;
     'task-id': string;
 }
+export interface MailListMembersResponse {
+    body: {
+        items: MailListMember[];
+        paging: PagesList;
+    };
+    status: number;
+}
+export interface MailListMembersResult {
+    items: MailListMember[];
+    pages: ParsedPagesList;
+    status: number;
+}
 export interface IMailListsMembers {
-    listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]>;
+    listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMembersResult>;
     getMember(address: string, memberAddress: string): Promise<MailListMember>;
     createMember(mailListAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
     createMembers(mailListAddress: string, data: MultipleMembersData): Promise<NewMultipleMembersResponse>;

package/lists.d.ts

@@ -1,13 +1,15 @@
 import Request from './request';
-import { ListsQuery, CreateUpdateList, DestroyedList, MailingList, StartValidationResult, ValidationResult, CancelValidationResult } from './interfaces/lists';
+import { ListsQuery, CreateUpdateList, DestroyedList, MailingList, StartValidationResult, ValidationResult, CancelValidationResult, MailingListResult, MailingListApiResponse } from './interfaces/lists';
 import { IMailListsMembers } from './interfaces/mailListMembers';
-export default class ListsClient {
+import NavigationThruPages from './common/NavigationThruPages';
+export default class ListsClient extends NavigationThruPages<MailingListResult> {
     baseRoute: string;
     request: Request;
     members: IMailListsMembers;
     constructor(request: Request, members: IMailListsMembers);
     private parseValidationResult;
-    list(query?: ListsQuery): Promise<MailingList[]>;
+    protected parseList(response: MailingListApiResponse): MailingListResult;
+    list(query?: ListsQuery): Promise<MailingListResult>;
     get(mailListAddress: string): Promise<MailingList>;
     create(data: CreateUpdateList): Promise<MailingList>;
     update(mailListAddress: string, data: CreateUpdateList): Promise<MailingList>;

package/mailListMembers.d.ts

@@ -1,11 +1,13 @@
 import Request from './request';
-import { MailListMembersQuery, IMailListsMembers, CreateUpdateMailListMembers, MailListMember, MultipleMembersData, DeletedMember, NewMultipleMembersResponse } from './interfaces/mailListMembers';
-export default class MailListsMembers implements IMailListsMembers {
+import { MailListMembersQuery, IMailListsMembers, CreateUpdateMailListMembers, MailListMember, MultipleMembersData, DeletedMember, NewMultipleMembersResponse, MailListMembersResult, MailListMembersResponse } from './interfaces/mailListMembers';
+import NavigationThruPages from './common/NavigationThruPages';
+export default class MailListsMembers extends NavigationThruPages<MailListMembersResult> implements IMailListsMembers {
     baseRoute: string;
     request: Request;
     constructor(request: Request);
     private checkAndUpdateData;
-    listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]>;
+    protected parseList(response: MailListMembersResponse): MailListMembersResult;
+    listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMembersResult>;
     getMember(mailListAddress: string, mailListMemberAddress: string): Promise<MailListMember>;
     createMember(mailListAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
     createMembers(mailListAddress: string, data: MultipleMembersData): Promise<NewMultipleMembersResponse>;