mailgun.js 4.2.2 → 5.0.1

package/dist/lib/interfaces/Events.d.ts

@@ -1,88 +0,0 @@
-export interface EventsPage {
-    id: string;
-    number: string;
-    url: string;
-}
-export interface PagesList {
-    previous: string;
-    first: string;
-    last: string;
-    next: string;
-}
-export interface EventsResponse {
-    body: {
-        items: [];
-        paging: PagesList;
-    };
-}
-export interface DomainEvent {
-    severity: string;
-    tags: string[];
-    storage: {
-        url: string;
-        key: string;
-    };
-    'delivery-status': {
-        tls: boolean;
-        'mx-host': string;
-        code: number;
-        description: string;
-        'session-seconds': number;
-        utf8: boolean;
-        'attempt-no': number;
-        message: string;
-        'certificate-verified': boolean;
-    };
-    'recipient-domain': string;
-    id: string;
-    campaigns: [];
-    reason: string;
-    'user-variables': {
-        [key: string]: any;
-    };
-    flags: {
-        'is-routed': boolean;
-        'is-authenticated': boolean;
-        'is-system-test': boolean;
-        'is-test-mode': boolean;
-    };
-    'log-level': string;
-    template?: any;
-    timestamp: number;
-    envelope: {
-        transport: string;
-        sender: string;
-        'sending-ip': string;
-        targets: string;
-    };
-    message: {
-        headers: {
-            to: string;
-            'message-id': string;
-            from: string;
-            subject: string;
-        };
-        attachments: [];
-        size: 308;
-    };
-    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;
-}

package/dist/lib/interfaces/IFormData.d.ts

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

package/dist/lib/interfaces/IpPools.d.ts

@@ -1,19 +0,0 @@
-export interface IpPool {
-    description: string;
-    ips: string[];
-    is_linked: boolean;
-    name: string;
-    pool_id: string;
-}
-export interface IpPoolListResponse {
-    body: {
-        ip_pools: IpPool;
-        message: string;
-    };
-}
-export interface IpPoolUpdateData {
-    name: string;
-    description: string;
-    add_ip: string;
-    remove_ip: string;
-}

package/dist/lib/interfaces/Ips.d.ts

@@ -1,10 +0,0 @@
-export interface IpsListResponseBody {
-    assignable_to_pools: boolean;
-    items: string[];
-    total_count: number;
-}
-export interface IpData {
-    ip: string;
-    dedicated: boolean;
-    rdns: string;
-}

package/dist/lib/interfaces/MultipleValidation.d.ts

@@ -1,55 +0,0 @@
-export interface MultipleValidationJob {
-    created_at: number;
-    download_url: {
-        csv: string;
-        json: string;
-    };
-    id: string;
-    quantity: number;
-    records_processed: number;
-    status: 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 CreatedMultipleValidationJob {
-    id: string;
-    message: string;
-}
-export interface PagesList {
-    prev: string;
-    first: string;
-    last: string;
-    next: string;
-}
-export interface MultipleValidationJobsListResult {
-    jobs: MultipleValidationJob[];
-    paging: PagesList;
-    total: number;
-}
-export interface MultipleValidationJobsListResponse {
-    status: 200;
-    body: MultipleValidationJobsListResult;
-}
-export interface CanceledMultipleValidationJob {
-    body: string;
-    status: number;
-}
-export interface IMultipleValidationClient {
-    list(): Promise<MultipleValidationJobsListResult>;
-    get(listId: string): Promise<MultipleValidationJob>;
-    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
-    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
-}

package/dist/lib/interfaces/Options.d.ts

@@ -1,8 +0,0 @@
-interface Options {
-    username: string;
-    key: string;
-    url?: string;
-    public_key?: string;
-    timeout?: number;
-}
-export default Options;

package/dist/lib/interfaces/RequestOptions.d.ts

@@ -1,6 +0,0 @@
-import Options from './Options';
-interface RequestOptions extends Options {
-    headers: any;
-    timeout: number;
-}
-export default RequestOptions;

package/dist/lib/interfaces/StatsOptions.d.ts

@@ -1,21 +0,0 @@
-export interface Stat {
-    time: string | Date;
-    delivered: {
-        smtp: number;
-        http: number;
-        total: number;
-    };
-}
-export interface StatsOptions {
-    start: string | Date;
-    end: string | Date;
-    resolution: string;
-    stats: Stat[];
-}
-export interface StatsQuery {
-    event: string | string[];
-    start: string | Date;
-    end: string | Date;
-    resolution: 'hour' | 'day' | 'month';
-    duration: string;
-}

package/dist/lib/interfaces/Supressions.d.ts

@@ -1,21 +0,0 @@
-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;
-}

package/dist/lib/interfaces/Validate.d.ts

@@ -1,12 +0,0 @@
-export interface ValidationResult {
-    address: string;
-    is_disposable_address: boolean;
-    is_role_address: boolean;
-    reason: string[];
-    result: string;
-    risk: string;
-}
-export interface ValidationResponse {
-    status: number;
-    body: ValidationResult;
-}

package/dist/lib/interfaces/Webhooks.d.ts

@@ -1,25 +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 interface WebhooksQuery {
-    limit?: number;
-    skip?: number;
-}
-export interface ValidationResponse {
-    code: number;
-    message: string;
-}

package/dist/lib/interfaces/lists.d.ts

@@ -1,25 +0,0 @@
-export interface ListsQuery {
-    address?: string;
-    limit?: number;
-    skip?: number;
-}
-export interface CreateUpdateList {
-    address: string;
-    name?: string;
-    description?: string;
-    access_level?: 'readonly' | 'members' | 'everyone';
-    reply_preference?: 'list' | 'sender';
-}
-export interface DestroyedList {
-    address: string;
-    message: string;
-}
-export interface MailingList {
-    access_level: string;
-    address: string;
-    created_at: string;
-    description: string;
-    members_count: number;
-    name: string;
-    reply_preference: null | string;
-}

package/dist/lib/interfaces/mailListMembers.d.ts

@@ -1,52 +0,0 @@
-import { MailingList } from './lists';
-export interface MailListMember {
-    address: string;
-    name: string;
-    subscribed: boolean;
-    vars: string | any;
-}
-export interface MailListMembersQuery {
-    subscribed?: 'yes' | 'no';
-    limit?: number;
-}
-export interface MultipleMembersData {
-    members: Array<MailListMember>;
-    upsert: 'yes' | 'no';
-}
-export interface MultipleMembersReqData {
-    members: string;
-    upsert: 'yes' | 'no';
-}
-export interface CreateUpdateMailListMembers {
-    address: string;
-    name?: string;
-    vars?: string;
-    subscribed?: 'yes' | 'no' | boolean;
-    upsert?: 'yes' | 'no';
-}
-export interface 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 IMailListsMembers {
-    listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]>;
-    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/dist/lib/interfaces/routes.d.ts

@@ -1,25 +0,0 @@
-export interface Route {
-    actions: string[];
-    created_at: string;
-    description: string;
-    expression: string;
-    id: string;
-    priority: number;
-}
-export interface UpdateRouteResponse extends Route {
-    message: string;
-}
-export interface DestroyRouteResponse {
-    id: string;
-    message: string;
-}
-export interface CreateUpdateRouteData {
-    priority?: number;
-    description?: string;
-    expression: string;
-    action: string[];
-}
-export interface RoutesListQuery {
-    limit?: number;
-    skip?: number;
-}

package/dist/lib/ip-pools.d.ts

@@ -1,21 +0,0 @@
-import Request from './request';
-import { IpPool, IpPoolUpdateData } from './interfaces/IpPools';
-export default class IpPoolsClient {
-    request: Request;
-    constructor(request: Request);
-    list(query: any): Promise<IpPool[]>;
-    create(data: {
-        name: string;
-        description?: string;
-        ips?: string[];
-    }): Promise<{
-        message: string;
-        pool_id: string;
-    }>;
-    update(poolId: string, data: IpPoolUpdateData): Promise<any>;
-    delete(poolId: string, data: {
-        id: string;
-        pool_id: string;
-    }): Promise<any>;
-    private parseIpPoolsResponse;
-}

package/dist/lib/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 | IpData>;
-    get(ip: string): Promise<IpsListResponseBody | IpData>;
-    private parseIpsResponse;
-}

package/dist/lib/lists.d.ts

@@ -1,14 +0,0 @@
-import Request from './request';
-import { ListsQuery, CreateUpdateList, DestroyedList, MailingList } from './interfaces/lists';
-import { IMailListsMembers } from './interfaces/mailListMembers';
-export default class ListsClient {
-    baseRoute: string;
-    request: Request;
-    members: IMailListsMembers;
-    constructor(request: Request, members: IMailListsMembers);
-    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>;
-}

package/dist/lib/mailListMembers.d.ts

@@ -1,14 +0,0 @@
-import Request from './request';
-import { MailListMembersQuery, IMailListsMembers, CreateUpdateMailListMembers, MailListMember, MultipleMembersData, DeletedMember, NewMultipleMembersResponse } from './interfaces/mailListMembers';
-export default class MailListsMembers implements IMailListsMembers {
-    baseRoute: string;
-    request: Request;
-    constructor(request: Request);
-    private checkAndUpdateData;
-    listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]>;
-    getMember(mailListAddress: string, mailListMemberAddress: string): Promise<MailListMember>;
-    createMember(mailListAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
-    createMembers(mailListAddress: string, data: MultipleMembersData): Promise<NewMultipleMembersResponse>;
-    updateMember(mailListAddress: string, mailListMemberAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
-    destroyMember(mailListAddress: string, mailListMemberAddress: string): Promise<DeletedMember>;
-}

package/dist/lib/messages.d.ts

@@ -1,9 +0,0 @@
-import Request from './request';
-export default class MessagesClient {
-    request: Request;
-    constructor(request: Request);
-    _parseResponse(response: {
-        body: any;
-    }): any;
-    create(domain: string, data: any): Promise<any>;
-}

package/dist/lib/multipleValidation.d.ts

@@ -1,10 +0,0 @@
-import { CanceledMultipleValidationJob, CreatedMultipleValidationJob, IMultipleValidationClient, MultipleValidationJob, MultipleValidationJobsListResult } from './interfaces/MultipleValidation';
-import Request from './request';
-export default class MultipleValidationClient implements IMultipleValidationClient {
-    request: Request;
-    constructor(request: Request);
-    list(): Promise<MultipleValidationJobsListResult>;
-    get(listId: string): Promise<MultipleValidationJob>;
-    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
-    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
-}

package/dist/lib/request.d.ts

@@ -1,31 +0,0 @@
-import NodeFormData from 'form-data';
-import RequestOptions from './interfaces/RequestOptions';
-import { InputFormData } from './interfaces/IFormData';
-import APIResponse from './interfaces/ApiResponse';
-declare class Request {
-    private username;
-    private key;
-    private url;
-    private timeout;
-    private headers;
-    private FormDataConstructor;
-    constructor(options: RequestOptions, formData: InputFormData);
-    request(method: string, url: string, inputOptions?: any): Promise<APIResponse>;
-    query(method: string, url: string, query: any, options?: any): Promise<APIResponse>;
-    command(method: string, url: string, data: any, options?: any): Promise<APIResponse>;
-    get(url: string, query?: any, options?: any): Promise<APIResponse>;
-    head(url: string, query: any, options: any): Promise<APIResponse>;
-    options(url: string, query: any, options: any): Promise<APIResponse>;
-    post(url: string, data: any, options?: any): Promise<APIResponse>;
-    postWithFD(url: string, data: any): Promise<APIResponse>;
-    putWithFD(url: string, data: any): Promise<APIResponse>;
-    patchWithFD(url: string, data: any): Promise<APIResponse>;
-    createFormData(data: any): NodeFormData | FormData;
-    private addMimeDataToFD;
-    private addFilesToFD;
-    private addCommonPropertyToFD;
-    put(url: string, data: any, options?: any): Promise<APIResponse>;
-    patch(url: string, data: any, options?: any): Promise<APIResponse>;
-    delete(url: string, data?: any, options?: any): Promise<APIResponse>;
-}
-export default Request;

package/dist/lib/routes.d.ts

@@ -1,11 +0,0 @@
-import { CreateUpdateRouteData, DestroyRouteResponse, Route, RoutesListQuery, UpdateRouteResponse } from './interfaces/routes';
-import Request from './request';
-export default class RoutesClient {
-    request: Request;
-    constructor(request: Request);
-    list(query: RoutesListQuery): Promise<Route[]>;
-    get(id: string): Promise<Route>;
-    create(data: CreateUpdateRouteData): Promise<Route>;
-    update(id: string, data: CreateUpdateRouteData): Promise<UpdateRouteResponse>;
-    destroy(id: string): Promise<DestroyRouteResponse>;
-}

package/dist/lib/stats.d.ts

@@ -1,20 +0,0 @@
-import Request from './request';
-import { StatsQuery, StatsOptions, Stat } from './interfaces/StatsOptions';
-declare class Stats {
-    start: Date;
-    end: Date;
-    resolution: string;
-    stats: Stat[];
-    constructor(data: StatsOptions);
-}
-export default class StatsClient {
-    request: Request;
-    constructor(request: Request);
-    private prepareSearchParams;
-    _parseStats(response: {
-        body: StatsOptions;
-    }): Stats;
-    getDomain(domain: string, query?: StatsQuery): Promise<Stats>;
-    getAccount(query?: StatsQuery): Promise<Stats>;
-}
-export {};

package/dist/lib/suppressions.d.ts

@@ -1,67 +0,0 @@
-import Request from './request';
-import { BounceData, ComplaintData, UnsubscribeData, WhiteListData } from './interfaces/Supressions';
-declare class Bounce {
-    type: string;
-    address: string;
-    code: number;
-    error: string;
-    created_at: Date;
-    constructor(data: BounceData);
-}
-declare class Complaint {
-    type: string;
-    address: any;
-    created_at: Date;
-    constructor(data: ComplaintData);
-}
-declare class Unsubscribe {
-    type: string;
-    address: string;
-    tags: any;
-    created_at: Date;
-    constructor(data: UnsubscribeData);
-}
-declare class WhiteList {
-    type: string;
-    value: string;
-    reason: string;
-    createdAt: Date;
-    constructor(data: WhiteListData);
-}
-declare type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe | typeof WhiteList;
-export default class SuppressionClient {
-    request: any;
-    models: {
-        bounces: typeof Bounce;
-        complaints: typeof Complaint;
-        unsubscribes: typeof Unsubscribe;
-        whitelists: typeof WhiteList;
-    };
-    constructor(request: Request);
-    _parsePage(id: string, pageUrl: string): {
-        id: string;
-        page: string | string[];
-        address: string | string[];
-        url: string;
-    };
-    _parsePageLinks(response: {
-        body: {
-            paging: any;
-        };
-    }): any;
-    _parseList(response: {
-        body: {
-            items: any;
-            paging: any;
-        };
-    }, Model: TModel): any;
-    _parseItem(response: {
-        body: any;
-    }, Model: TModel): Bounce | Complaint | Unsubscribe | WhiteList;
-    private createWhiteList;
-    list(domain: string, type: string, query: any): any;
-    get(domain: string, type: string, address: string): any;
-    create(domain: string, type: string, data: any): any;
-    destroy(domain: string, type: string, address: string): any;
-}
-export {};

package/dist/lib/validate.d.ts

@@ -1,9 +0,0 @@
-import { IMultipleValidationClient } from './interfaces/MultipleValidation';
-import { ValidationResult } from './interfaces/Validate';
-import Request from './request';
-export default class ValidateClient {
-    multipleValidation: IMultipleValidationClient;
-    request: Request;
-    constructor(request: Request, multipleValidationClient: IMultipleValidationClient);
-    get(address: string): Promise<ValidationResult>;
-}

package/dist/lib/webhooks.d.ts

@@ -1,32 +0,0 @@
-import { ValidationResponse, WebhookList, WebhookResponse, WebhooksQuery } from './interfaces/Webhooks';
-import Request from './request';
-declare class Webhook {
-    id: string;
-    url: string;
-    constructor(id: string, url: string);
-}
-export default class WebhookClient {
-    request: Request;
-    constructor(request: Request);
-    _parseWebhookList(response: {
-        body: {
-            webhooks: WebhookList;
-        };
-    }): WebhookList;
-    _parseWebhookWithID(id: string): (response: WebhookResponse) => Webhook;
-    _parseWebhookTest(response: {
-        body: {
-            code: number;
-            message: string;
-        };
-    }): {
-        code: number;
-        message: string;
-    };
-    list(domain: string, query: WebhooksQuery): Promise<WebhookList>;
-    get(domain: string, id: string): Promise<Webhook>;
-    create(domain: string, id: string, url: string, test?: boolean): Promise<Webhook | ValidationResponse>;
-    update(domain: string, id: string, url: string): Promise<Webhook>;
-    destroy(domain: string, id: string): Promise<Webhook>;
-}
-export {};