mailgun.js 8.2.1 → 9.0.0

package/mailgun.web.js.LICENSE.txt

@@ -1,3 +1,3 @@
 /*! https://mths.be/base64 v1.0.0 by @mathias | MIT license */
 
-/*! mailgun.js v8.2.0 */
+/*! mailgun.js v8.2.2 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailgun.js",
-  "version": "8.2.1",
+  "version": "9.0.0",
   "main": "./mailgun.node.js",
   "browser": "./mailgun.web.js",
   "types": "./index.d.ts",

package/version.md

@@ -1 +1 @@
-8.2.1
+9.0.0

package/client.d.ts

@@ -1,29 +0,0 @@
-import Options from './interfaces/Options';
-import DomainClient from './domains';
-import EventClient from './events';
-import StatsClient from './stats';
-import SuppressionClient from './suppressions';
-import WebhookClient from './webhooks';
-import MessagesClient from './messages';
-import RoutesClient from './routes';
-import ValidateClient from './validate';
-import IpsClient from './ips';
-import IpPoolsClient from './ip-pools';
-import ListsClient from './lists';
-import { InputFormData } from './interfaces/IFormData';
-import { IMailgunClient } from './interfaces/IMailgunClient';
-export default class Client implements IMailgunClient {
-    private request;
-    domains: DomainClient;
-    webhooks: WebhookClient;
-    events: EventClient;
-    stats: StatsClient;
-    suppressions: SuppressionClient;
-    messages: MessagesClient;
-    routes: RoutesClient;
-    validate: ValidateClient;
-    ips: IpsClient;
-    ip_pools: IpPoolsClient;
-    lists: ListsClient;
-    constructor(options: Options, formData: InputFormData);
-}

package/common/NavigationThruPages.d.ts

@@ -1,19 +0,0 @@
-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/error.d.ts

@@ -1,8 +0,0 @@
-import APIErrorOptions from './interfaces/APIErrorOptions';
-export default class APIError extends Error {
-    status: number | string;
-    stack: string;
-    details: string;
-    type: string;
-    constructor({ status, statusText, message, body }: APIErrorOptions);
-}

package/interfaces/APIErrorOptions.d.ts

@@ -1,11 +0,0 @@
-interface APIErrorOptions {
-    headers: {
-        [key: string]: any;
-    };
-    status: number | string;
-    message: string;
-    body: any;
-    url: string;
-    statusText: string;
-}
-export default APIErrorOptions;

package/interfaces/ApiResponse.d.ts

@@ -1,5 +0,0 @@
-interface APIResponse {
-    status: number;
-    body: any;
-}
-export default APIResponse;

package/interfaces/DomainCredentials.d.ts

@@ -1,52 +0,0 @@
-export declare type DomainCredentialsQuery = {
-    limit: number;
-    skip: number;
-};
-export declare type DomainCredentials = {
-    login: string;
-    password: string;
-};
-export interface DomainCredentialsItem {
-    created_at: string;
-    login: string;
-    mailbox: string;
-    size_bytes: number | null;
-}
-export interface DomainCredentialsResponseData {
-    status: number;
-    body: {
-        items: DomainCredentialsItem[];
-        total_count: number;
-    };
-}
-export interface DomainCredentialsList {
-    items: DomainCredentialsItem[];
-    totalCount: number;
-}
-export interface DomainCredentialsResult {
-    status: number;
-    message: string;
-    spec?: string;
-}
-export interface CreatedUpdatedDomainCredentialsResponse {
-    status: number;
-    body: {
-        message: string;
-    };
-}
-export interface DeletedDomainCredentialsResponse {
-    status: number;
-    body: {
-        message: string;
-        spec: string;
-    };
-}
-export declare type UpdateDomainCredentialsData = {
-    password: string;
-};
-export interface IDomainCredentials {
-    list(domain: string, query: DomainCredentialsQuery): Promise<DomainCredentialsList>;
-    create(domain: string, data: DomainCredentials): Promise<DomainCredentialsResult>;
-    update(domain: string, credentialsLogin: string, data: UpdateDomainCredentialsData): Promise<DomainCredentialsResult>;
-    destroy(domain: string, credentialsLogin: string): Promise<DomainCredentialsResult>;
-}

package/interfaces/DomainTemplates.d.ts

@@ -1,178 +0,0 @@
-import { DomainTemplateItem } from '../domainsTemplates';
-import { PagesList, ParsedPagesList } from './NavigationThruPages';
-export declare enum YesNo {
-    YES = "yes",
-    NO = "no"
-}
-export declare type DomainTemplateData = {
-    name: string;
-    description: string;
-    template: string;
-    tag?: string;
-    engine?: string;
-    comment?: string;
-};
-export declare type DomainTemplateVersionData = {
-    template: string;
-    tag: string;
-    engine?: string;
-    comment?: string;
-    active?: YesNo;
-};
-export declare type DomainTemplateUpdateData = {
-    description: string;
-};
-export declare type DomainTemplateUpdateVersionData = {
-    template?: string;
-    comment?: string;
-    active?: YesNo;
-};
-export declare type DomainTemplatesQuery = {
-    /** 'page' (optionally 'p') params from previous response's 'paging' object.
-     * Value must be stringified as query params. Ex: '?page=first','?page=next&p=name-of-last-item'
-     .... */
-    page?: `?${string}`;
-    /** Number of records to retrieve. Default value is 10. */
-    limit?: number;
-};
-export declare type TemplateQuery = {
-    active: YesNo;
-};
-export interface ShortTemplateVersion {
-    tag: string;
-    engine: string;
-    mjml: string;
-    createdAt: string | Date;
-    comment: string;
-    active: boolean;
-    id: string;
-}
-export interface TemplateVersion extends ShortTemplateVersion {
-    template: string;
-}
-export interface DomainTemplate {
-    name: string;
-    description: string;
-    createdAt: string | Date;
-    createdBy: string;
-    id: string;
-    version?: TemplateVersion;
-    versions?: ShortTemplateVersion[];
-}
-export interface CreateDomainTemplateAPIResponse {
-    status: number;
-    body: {
-        message: string;
-        template: DomainTemplate;
-    };
-}
-export interface ListDomainTemplatesAPIResponse {
-    status: number;
-    body: {
-        items: DomainTemplate[];
-        paging: {
-            first: string;
-            last: string;
-            next: string;
-            previous: string;
-        };
-    };
-}
-export interface ListDomainTemplatesResult {
-    items: DomainTemplate[];
-    pages: ParsedPagesList;
-    status: number;
-}
-export interface GetDomainTemplateAPIResponse {
-    status: number;
-    body: {
-        template: DomainTemplate;
-    };
-}
-export interface UpdateOrDeleteDomainTemplateAPIResponse {
-    status: number;
-    body: {
-        message: string;
-        template: {
-            name: string;
-        };
-    };
-}
-export interface UpdateOrDeleteDomainTemplateResult {
-    status: number;
-    message: string;
-    templateName?: string;
-}
-export interface NotificationAPIResponse {
-    status: number;
-    body: {
-        message: string;
-    };
-}
-export interface NotificationResult {
-    status: number;
-    message: string;
-}
-export interface CreateDomainTemplateVersionAPIResponse {
-    status: number;
-    body: {
-        message: string;
-        template: DomainTemplate;
-    };
-}
-export interface CreateDomainTemplateVersionResult {
-    status: number;
-    message: string;
-    template: DomainTemplate;
-}
-export interface MutateDomainTemplateVersionAPIResponse {
-    status: number;
-    body: {
-        message: string;
-        template: {
-            name: string;
-            version: {
-                tag: string;
-            };
-        };
-    };
-}
-export interface MutateDomainTemplateVersionResult {
-    status: number;
-    message: string;
-    templateName: string;
-    templateVersion: {
-        tag: string;
-    };
-}
-export interface ListDomainTemplateVersionsAPIResponse {
-    status: number;
-    body: {
-        template: {
-            name: string;
-            description: string;
-            createdAt: string;
-            createdBy: string;
-            id: string;
-            versions: ShortTemplateVersion[];
-        };
-        paging: PagesList;
-    };
-}
-export interface ListDomainTemplateVersionsResult {
-    template: DomainTemplateItem;
-    pages: ParsedPagesList;
-}
-export interface IDomainTemplatesClient {
-    list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
-    get(domain: string, templateName: string, query?: TemplateQuery): Promise<DomainTemplateItem>;
-    create(domain: string, data: DomainTemplateData): Promise<DomainTemplateItem>;
-    update(domain: string, templateName: string, data: DomainTemplateUpdateData): Promise<UpdateOrDeleteDomainTemplateResult>;
-    destroy(domain: string, templateName: string): Promise<UpdateOrDeleteDomainTemplateResult>;
-    destroyAll(domain: string): Promise<NotificationResult>;
-    createVersion(domain: string, templateName: string, data: DomainTemplateVersionData): Promise<CreateDomainTemplateVersionResult>;
-    getVersion(domain: string, templateName: string, tag: string): Promise<DomainTemplateItem>;
-    updateVersion(domain: string, templateName: string, tag: string, data: DomainTemplateUpdateVersionData): Promise<MutateDomainTemplateVersionResult>;
-    destroyVersion(domain: string, templateName: string, tag: string): Promise<MutateDomainTemplateVersionResult>;
-    listVersions(domain: string, templateName: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplateVersionsResult>;
-}

package/interfaces/IFormData.d.ts

@@ -1,7 +0,0 @@
-import * as NodeFormData from 'form-data';
-export interface IFormDataOptions {
-    [key: string]: any;
-}
-export interface InputFormData {
-    new (options?: HTMLFormElement | IFormDataOptions): NodeFormData | FormData;
-}

package/interfaces/IMailgunClient.d.ts

@@ -1,24 +0,0 @@
-import DomainClient from '../domains';
-import EventClient from '../events';
-import IpPoolsClient from '../ip-pools';
-import IpsClient from '../ips';
-import ListsClient from '../lists';
-import MessagesClient from '../messages';
-import RoutesClient from '../routes';
-import StatsClient from '../stats';
-import SuppressionClient from '../suppressions';
-import ValidateClient from '../validate';
-import WebhookClient from '../webhooks';
-export interface IMailgunClient {
-    domains: DomainClient;
-    webhooks: WebhookClient;
-    events: EventClient;
-    stats: StatsClient;
-    suppressions: SuppressionClient;
-    messages: MessagesClient;
-    routes: RoutesClient;
-    validate: ValidateClient;
-    ips: IpsClient;
-    ip_pools: IpPoolsClient;
-    lists: ListsClient;
-}

package/interfaces/Suppressions/Suppressions.d.ts

@@ -1,69 +0,0 @@
-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/WhiteList.d.ts

@@ -1,12 +0,0 @@
-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/Supressions.d.ts

@@ -1,103 +0,0 @@
-import { Bounce, Complaint, Unsubscribe, WhiteList } from '../suppressions';
-export interface BounceData {
-    address: string;
-    code: number;
-    error: string;
-    created_at: string | Date;
-}
-export interface ComplaintData {
-    address: string;
-    created_at: string | Date;
-}
-export interface UnsubscribeData {
-    address: string;
-    tags: any;
-    created_at: string | Date;
-}
-export interface WhiteListData {
-    type: string;
-    value: string;
-    reason: string;
-    createdAt: string | Date;
-}
-export interface ParsedPage {
-    id: string;
-    page: string | null | undefined;
-    address: string | null | undefined;
-    url: string;
-}
-export interface ParsedPagesList {
-    previous: ParsedPage;
-    first: ParsedPage;
-    last: ParsedPage;
-    next: ParsedPage;
-}
-export interface SuppressionList {
-    items: (Bounce | Complaint | Unsubscribe | WhiteList)[];
-    pages: ParsedPagesList;
-}
-export interface PagesList {
-    previous: string;
-    first: string;
-    last: string;
-    next: string;
-}
-export declare enum SuppressionModels {
-    BOUNCES = "bounces",
-    COMPLAINTS = "complaints",
-    UNSUBSCRIBES = "unsubscribes",
-    WHITELISTS = "whitelists"
-}
-export interface PagesListAccumulator {
-    [index: string]: ParsedPage;
-}
-export declare type SuppressionListQuery = {
-    limit?: number;
-};
-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/Webhooks.d.ts

@@ -1,34 +0,0 @@
-export interface APIWebhook {
-    url?: string;
-    urls?: string[];
-}
-export interface WebhookResponseBody {
-    message: string;
-    webhook: APIWebhook;
-}
-export interface WebhookResponse {
-    status: number;
-    body: WebhookResponseBody;
-}
-export interface WebhookList {
-    [id: string]: {
-        urls: string[];
-    };
-}
-export declare type WebhooksQuery = {
-    limit?: number;
-    skip?: number;
-};
-export interface ValidationResponse {
-    code: number;
-    message: string;
-}
-export declare enum WebhooksIds {
-    CLICKED = "clicked",
-    COMPLAINED = "complained",
-    DELIVERED = "delivered",
-    OPENED = "opened",
-    PERMANENT_FAIL = "permanent_fail",
-    TEMPORARY_FAIL = "temporary_fail",
-    UNSUBSCRIBED = "unsubscribe"
-}

package/interfaces/mailListMembers.d.ts

@@ -1,68 +0,0 @@
-import { MailingList } from './lists';
-import { PagesList, ParsedPagesList } from './NavigationThruPages';
-export interface MailListMember {
-    address: string;
-    name: string;
-    subscribed: boolean;
-    vars: {
-        [key: string]: any;
-    };
-}
-export declare type MailListMembersQuery = {
-    subscribed?: 'yes' | 'no';
-    limit?: number;
-    page?: string;
-};
-export declare type MultipleMembersData = {
-    members: Array<MailListMember>;
-    upsert: 'yes' | 'no';
-};
-export declare type MultipleMembersReqData = {
-    members: string;
-    upsert: 'yes' | 'no';
-};
-export interface CreateUpdateMailListMembers {
-    address: string;
-    name?: string;
-    vars?: string;
-    subscribed?: 'yes' | 'no' | boolean;
-    upsert?: 'yes' | 'no';
-}
-export declare type CreateUpdateMailListMembersReq = {
-    address: string;
-    name?: string;
-    vars?: string;
-    subscribed?: 'yes' | 'no' | boolean;
-    upsert?: 'yes' | 'no';
-};
-export interface DeletedMember {
-    member: {
-        address: string;
-    };
-    message: string;
-}
-export interface NewMultipleMembersResponse {
-    list: MailingList;
-    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<MailListMembersResult>;
-    getMember(address: string, memberAddress: string): Promise<MailListMember>;
-    createMember(mailListAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
-    createMembers(mailListAddress: string, data: MultipleMembersData): Promise<NewMultipleMembersResponse>;
-    updateMember(address: string, memberAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
-    destroyMember(address: string, memberAddress: string): Promise<DeletedMember>;
-}

package/ips.d.ts

@@ -1,9 +0,0 @@
-import MgRequest from './request';
-import { IpData, IpsListResponseBody } from './interfaces/Ips';
-export default class IpsClient {
-    request: MgRequest;
-    constructor(request: MgRequest);
-    list(query: any): Promise<IpsListResponseBody>;
-    get(ip: string): Promise<IpData>;
-    private parseIpsResponse;
-}

package/lists.d.ts

@@ -1,20 +0,0 @@
-import Request from './request';
-import { ListsQuery, CreateUpdateList, DestroyedList, MailingList, StartValidationResult, ValidationResult, CancelValidationResult, MailingListResult, MailingListApiResponse } from './interfaces/lists';
-import { IMailListsMembers } from './interfaces/mailListMembers';
-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;
-    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>;
-    destroy(mailListAddress: string): Promise<DestroyedList>;
-    validate(mailListAddress: string): Promise<StartValidationResult>;
-    validationResult(mailListAddress: string): Promise<ValidationResult>;
-    cancelValidation(mailListAddress: string): Promise<CancelValidationResult>;
-}