mailgun.js 4.2.1 → 5.0.0

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

@@ -1,194 +0,0 @@
-import { DomainTemplateItem } from '../domainsTemplates';
-export declare enum YesNo {
-    YES = "yes",
-    NO = "no"
-}
-export declare enum Pages {
-    FIRST = "first",
-    LAST = "last",
-    NEXT = "next",
-    PREV = "prev"
-}
-export interface DomainTemplateData {
-    name: string;
-    description: string;
-    template: string;
-    tag?: string;
-    engine?: string;
-    comment?: string;
-}
-export interface DomainTemplateVersionData {
-    template: string;
-    tag: string;
-    engine?: string;
-    comment?: string;
-    active?: YesNo;
-}
-export interface DomainTemplateUpdateData {
-    description: string;
-}
-export interface DomainTemplateUpdateVersionData {
-    template?: string;
-    comment?: string;
-    active?: YesNo;
-}
-export interface DomainTemplatesQuery {
-    page: Pages;
-    limit: number;
-    p: string;
-}
-export interface 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: {
-        first: string;
-        last: string;
-        next: string;
-        previous: string;
-    };
-}
-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: {
-            first: string;
-            last: string;
-            next: string;
-            previous: string;
-        };
-    };
-}
-export interface ListDomainTemplateVersionsResult {
-    template: DomainTemplateItem;
-    pages: {
-        first: string;
-        last: string;
-        next: string;
-        previous: string;
-    };
-}
-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/dist/lib/interfaces/DomainTracking.d.ts

@@ -1,48 +0,0 @@
-export interface DomainTrackingData {
-    click: {
-        active: boolean;
-    };
-    open: {
-        active: boolean;
-    };
-    unsubscribe: {
-        active: boolean;
-        html_footer: string;
-        text_footer: string;
-    };
-}
-export interface DomainTrackingResponse {
-    status: number;
-    body: {
-        tracking: DomainTrackingData;
-    };
-}
-export interface UpdatedOpenTracking {
-    message: string;
-    open?: {
-        active: boolean;
-    };
-    click?: {
-        active: boolean | 'htmlonly';
-    };
-    unsubscribe?: {
-        active: boolean;
-        html_footer: string;
-        text_footer: string;
-    };
-}
-export interface UpdateDomainTrackingResponse {
-    status: number;
-    body: UpdatedOpenTracking;
-}
-export interface OpenTrackingInfo {
-    active: 'yes' | 'no' | 'true' | 'false';
-}
-export interface ClickTrackingInfo {
-    active: 'yes' | 'no' | 'true' | 'false' | 'htmlonly';
-}
-export interface UnsubscribeTrackingInfo {
-    active: 'yes' | 'no' | 'true' | 'false';
-    html_footer: string;
-    text_footer: string;
-}

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

@@ -1,121 +0,0 @@
-export interface DomainsQuery {
-    authority: string;
-    state: 'active' | 'unverified' | 'disabled';
-    limit: number;
-    skip: number;
-}
-export interface DomainInfo {
-    name: string;
-    smtp_password: string;
-    spam_action?: 'disabled' | 'block' | 'tag';
-    wildcard?: boolean;
-    force_dkim_authority?: boolean | 'true' | 'false';
-    dkim_key_size?: 1024 | 2048;
-    ips?: '';
-    pool_id?: '';
-    web_scheme: 'http' | 'https';
-}
-export interface DomainShortData {
-    name: string;
-    require_tls: boolean;
-    skip_verification: boolean;
-    state: string;
-    wildcard: boolean;
-    spam_action: string;
-    created_at: string;
-    smtp_password: string;
-    smtp_login: string;
-    type: string;
-}
-export interface DomainData extends DomainShortData {
-    id: string;
-    is_disabled: boolean;
-    web_prefix: string;
-    web_scheme: string;
-}
-export interface DomainsListItem extends DomainShortData {
-    receiving_dns_records: null;
-    sending_dns_records: null;
-}
-export interface DNSRecord {
-    cached: any[];
-    name: string;
-    record_type: string;
-    valid: string;
-    value: string;
-}
-export interface DomainResponseData {
-    status: number;
-    body: {
-        domain: DomainData;
-        message?: string;
-        receiving_dns_records: DNSRecord[];
-        sending_dns_records: DNSRecord[];
-    };
-}
-export interface DomainListResponseData {
-    status: number;
-    body: {
-        items: DomainsListItem[];
-        total_count: number;
-    };
-}
-export interface MessageResponse {
-    message: string;
-}
-export interface DestroyedDomainResponse {
-    status: number;
-    body: MessageResponse;
-}
-export interface ConnectionSettings {
-    require_tls: boolean;
-    skip_verification: boolean;
-}
-export interface ConnectionSettingsResponse {
-    body: {
-        connection: ConnectionSettings;
-    };
-    status: number;
-}
-export interface UpdatedConnectionSettings {
-    message: string;
-    require_tls: boolean;
-    skip_verification: boolean;
-}
-export interface UpdatedConnectionSettingsRes {
-    body: UpdatedConnectionSettings;
-    status: number;
-}
-export interface DKIMAuthorityInfo {
-    self: boolean | 'yes' | 'no' | 'true' | 'false';
-}
-export interface UpdatedDKIMAuthority {
-    changed: boolean;
-    message: string;
-    sending_dns_records: DNSRecord[];
-}
-export interface UpdatedDKIMAuthorityResponse {
-    body: UpdatedDKIMAuthority;
-    status: 200;
-}
-export interface DKIMSelectorInfo {
-    dkimSelector: string;
-}
-export interface UpdatedDKIMSelectorResponse {
-    body: MessageResponse;
-    status: number;
-}
-export interface WebPrefixInfo {
-    webPrefix: string;
-}
-export interface UpdatedWebPrefix {
-    message: string;
-}
-export interface UpdatedWebPrefixResponse {
-    body: MessageResponse;
-    status: number;
-}
-export interface ReplacementForPool {
-    pool_id?: string;
-    ip?: string;
-}

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