mailgun.js 4.2.2 → 5.0.1

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

@@ -1,52 +0,0 @@
-export interface DomainCredentialsQuery {
-    limit: number;
-    skip: number;
-}
-export interface 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 interface 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/dist/lib/interfaces/DomainTags.d.ts

@@ -1,228 +0,0 @@
-import { DomainTagStatistic } from '../domainsTags';
-export declare enum Resolution {
-    HOUR = "hour",
-    DAY = "day",
-    MONTH = "month"
-}
-export interface DomainTagsQuery {
-    limit: number;
-}
-export interface DomainTagsStatisticQuery {
-    event: string;
-    start?: number;
-    end?: number;
-    resolution?: Resolution;
-    duration?: string;
-}
-export interface DomainTagsItemInfo {
-    tag: string;
-    description: string;
-    'first-seen': string;
-    'last-seen': string;
-}
-export interface DomainTagsItem {
-    tag: string;
-    description: string;
-    '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: {
-        items: DomainTagsItemInfo[];
-        paging: PagesList;
-    };
-}
-export interface DomainTagsList {
-    items: DomainTagsItem[];
-    pages: ParsedPagesList;
-}
-export interface DomainTagsMessageRes {
-    message: string;
-    status?: number;
-}
-export interface DomainTagAPIResponseStatsItem {
-    time: string;
-    accepted?: {
-        incoming: number;
-        outgoing: number;
-        total: number;
-    };
-    delivered?: {
-        smtp: number;
-        http: number;
-        optimized: number;
-        total: number;
-    };
-    opened?: {
-        total: number;
-    };
-    failed?: {
-        temporary: {
-            espblock: number;
-            total: number;
-        };
-        permanent: {
-            'suppress-bounce': number;
-            'suppress-unsubscribe': number;
-            'suppress-complaint': number;
-            bounce: number;
-            'delayed-bounce': number;
-            webhook: number;
-            optimized: number;
-            total: number;
-        };
-    };
-    clicked?: {
-        total: number;
-    };
-    unsubscribed?: {
-        total: number;
-    };
-    complained?: {
-        total: number;
-    };
-    stored?: {
-        total: number;
-    };
-}
-export interface DomainTagStatAPIResponse {
-    body: {
-        tag: string;
-        description: string;
-        start: string;
-        end: string;
-        resolution: Resolution;
-        stats: DomainTagAPIResponseStatsItem[];
-    };
-}
-export interface DomainTagStatisticItem extends Omit<DomainTagAPIResponseStatsItem, 'time'> {
-    time: Date;
-}
-export interface DomainTagStatisticResult {
-    tag: string;
-    description: string;
-    start: Date;
-    end: Date;
-    resolution: Resolution;
-    stats: DomainTagStatisticItem[];
-}
-export interface DomainTagCountriesAPIResponse {
-    body: {
-        tag: string;
-        country: {
-            [key: string]: {
-                clicked: number;
-                complained: number;
-                opened: number;
-                unique_clicked: number;
-                unique_opened: number;
-                unsubscribed: number;
-            };
-        };
-    };
-}
-export interface DomainTagCountriesAggregation {
-    tag: string;
-    country: {
-        [key: string]: {
-            clicked: number;
-            complained: number;
-            opened: number;
-            unique_clicked: number;
-            unique_opened: number;
-            unsubscribed: number;
-        };
-    };
-}
-export interface DomainTagProvidersAPIResponse {
-    body: {
-        tag: string;
-        provider: {
-            [key: string]: {
-                accepted: number;
-                clicked: number;
-                complained: number;
-                delivered: number;
-                opened: number;
-                unique_clicked: number;
-                unique_opened: number;
-                unsubscribed: number;
-            };
-        };
-    };
-    status: number;
-}
-export interface DomainTagProvidersAggregation {
-    tag: string;
-    provider: {
-        [key: string]: {
-            accepted: number;
-            clicked: number;
-            complained: number;
-            delivered: number;
-            opened: number;
-            unique_clicked: number;
-            unique_opened: number;
-            unsubscribed: number;
-        };
-    };
-}
-export interface DeviceStatistic {
-    clicked: number;
-    complained: number;
-    opened: number;
-    unique_clicked: number;
-    unique_opened: number;
-    unsubscribed: number;
-}
-export interface DevicesTypes {
-    desktop: DeviceStatistic;
-    mobile: DeviceStatistic;
-    tablet: DeviceStatistic;
-    unknown: DeviceStatistic;
-}
-export interface DomainTagDevicesAPIResponse {
-    body: {
-        tag: string;
-        device: DevicesTypes;
-    };
-    status: number;
-}
-export interface DomainTagDevicesAggregation {
-    tag: string;
-    device: DevicesTypes;
-}
-export interface IDomainTagsClient {
-    list(domain: string): Promise<DomainTagsList>;
-    get(domain: string, tag: string): Promise<DomainTagsItem>;
-    update(domain: string, tag: string, description: string): Promise<DomainTagsMessageRes>;
-    destroy(domain: string, tag: string): Promise<DomainTagsMessageRes>;
-    statistic(domain: string, tag: string, query: DomainTagsStatisticQuery): Promise<DomainTagStatistic>;
-    countries(domain: string, tag: string): Promise<DomainTagCountriesAggregation>;
-    providers(domain: string, tag: string): Promise<DomainTagProvidersAggregation>;
-    devices(domain: string, tag: string): Promise<DomainTagDevicesAggregation>;
-}

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