mailgun.js 7.0.2 → 8.0.0

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>;
 }

package/interfaces/NavigationThruPages.d.ts

@@ -0,0 +1,33 @@
+export interface PagesList {
+    previous: string;
+    first: string;
+    last: string;
+    next: string;
+}
+export interface ParsedPage {
+    id: string;
+    page: string;
+    iteratorPosition: string | undefined;
+    url: string;
+}
+export interface ParsedPagesList {
+    previous: ParsedPage;
+    first: ParsedPage;
+    last: ParsedPage;
+    next: ParsedPage;
+}
+export interface PagesListAccumulator {
+    [index: string]: ParsedPage;
+}
+export interface ResponseWithPaging {
+    body: {
+        paging: PagesList;
+    };
+}
+export interface QueryWithPage {
+    page?: string;
+}
+export interface UpdatedUrlAndQuery {
+    url: string;
+    updatedQuery: Record<string, unknown>;
+}

package/interfaces/Suppressions/Bounce.d.ts

@@ -0,0 +1,13 @@
+export interface BounceData {
+    address: string;
+    code: number;
+    error: string;
+    created_at: string | Date;
+}
+export interface IBounce {
+    address: string;
+    code: number;
+    error: string;
+    created_at: Date;
+    type: string;
+}

package/interfaces/Suppressions/Complaint.d.ts

@@ -0,0 +1,9 @@
+export interface ComplaintData {
+    address: string;
+    created_at: string | Date;
+}
+export interface IComplaint {
+    address: string;
+    created_at: Date;
+    type: string;
+}

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>;