mailgun.js 4.1.3 → 4.2.0

package/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [4.2.0](https://github.com/mailgun/mailgun.js/compare/v4.1.6...v4.2.0) (2022-02-02)
+
+
+### Features
+
+* Add domains tags functionality ([6cc41e3](https://github.com/mailgun/mailgun.js/commits/6cc41e30f20f70d9dc4a4ec247a600e553d706f4))
+
+
+### Other changes
+
+* Add tests for new functionality ([e741689](https://github.com/mailgun/mailgun.js/commits/e741689123de9648c35eee4e31f95bb38b86aa78))
+
+### [4.1.6](https://github.com/mailgun/mailgun.js/compare/v4.1.5...v4.1.6) (2022-01-24)
+
+
+### Bug Fixes
+
+* Update "mocha" to fix "nanoid" dependency ([4e122cf](https://github.com/mailgun/mailgun.js/commits/4e122cffc6d35967bf70380a9003938949a6f442))
+* Update "typedoc" version to fix "marked" version ([a84a252](https://github.com/mailgun/mailgun.js/commits/a84a25231e877313c2756cefd89da64d98065196))
+
+
+### Other changes
+
+* Recompile documentation ([f068746](https://github.com/mailgun/mailgun.js/commits/f0687462e35c237909fbf133a0c563da4a87f6bd))
+
+### [4.1.5](https://github.com/mailgun/mailgun.js/compare/v4.1.4...v4.1.5) (2022-01-24)
+
+### [4.1.4](https://github.com/mailgun/mailgun.js/compare/v4.1.3...v4.1.4) (2021-12-23)
+
+
+### Bug Fixes
+
+* Add query parameter for the get method in domain templates client ([5aa5cb1](https://github.com/mailgun/mailgun.js/commits/5aa5cb1d5cbc3e23f9e65f8fbf41350dfd7cd435))
+
 ### [4.1.3](https://github.com/mailgun/mailgun.js/compare/v4.1.2...v4.1.3) (2021-12-23)
 
 ### [4.1.2](https://github.com/mailgun/mailgun.js/compare/v4.1.1...v4.1.2) (2021-12-14)

package/README.md

@@ -136,7 +136,7 @@ Method naming conventions:
 
 #### create
 
-`mg.messages.create(domain, data)` - [api docs](https://documentation.mailgun.com/api-sending.html#sending)
+`mg.messages.create(domain, data)` - [api docs](https://documentation.mailgun.com/en/latest/api-sending.html)
 
 Options:
 

package/dist/lib/domains.d.ts

@@ -6,6 +6,8 @@ import { IDomainCredentials } from './interfaces/DomainCredentials';
 import { IDomainTemplatesClient } from './interfaces/DomainTemplates';
 import DomainCredentialsClient from './domainsCredentials';
 import DomainTemplatesClient from './domainsTemplates';
+import { IDomainTagsClient } from './interfaces/DomainTags';
+import DomainTagsClient from './domainsTags';
 export declare class Domain {
     name: string;
     require_tls: boolean;
@@ -25,7 +27,8 @@ export default class DomainClient {
     request: Request;
     domainCredentials: IDomainCredentials;
     domainTemplates: IDomainTemplatesClient;
-    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient, domainTemplatesClient: DomainTemplatesClient);
+    domainTags: IDomainTagsClient;
+    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient, domainTemplatesClient: DomainTemplatesClient, domainTagsClient: DomainTagsClient);
     private _parseMessage;
     private _parseDomainList;
     private _parseDomain;

package/dist/lib/domainsTags.d.ts

@@ -0,0 +1,34 @@
+import Request from './request';
+import { DomainTagCountriesAggregation, DomainTagDevicesAggregation, DomainTagProvidersAggregation, DomainTagsItem, DomainTagsItemInfo, DomainTagsList, DomainTagsMessageRes, DomainTagsQuery, DomainTagsStatisticQuery, DomainTagStatAPIResponse, DomainTagStatisticItem, DomainTagStatisticResult, IDomainTagsClient, Resolution } from './interfaces/DomainTags';
+export declare class DomainTag implements DomainTagsItem {
+    tag: string;
+    description: string;
+    'first-seen': Date;
+    'last-seen': Date;
+    constructor(tagInfo: DomainTagsItemInfo);
+}
+export declare class DomainTagStatistic implements DomainTagStatisticResult {
+    tag: string;
+    description: string;
+    start: Date;
+    end: Date;
+    resolution: Resolution;
+    stats: DomainTagStatisticItem[];
+    constructor(tagStatisticInfo: DomainTagStatAPIResponse);
+}
+export default class DomainTagsClient implements IDomainTagsClient {
+    baseRoute: string;
+    request: Request;
+    constructor(request: Request);
+    private _parsePageLinks;
+    private _parseDomainTagsList;
+    private _parseTagStatistic;
+    list(domain: string, query?: DomainTagsQuery): 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/domainsTemplates.d.ts

@@ -1,5 +1,5 @@
 import Request from './request';
-import { CreateDomainTemplateVersionResult, DomainTemplate, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, IDomainTemplatesClient, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from './interfaces/DomainTemplates';
+import { CreateDomainTemplateVersionResult, DomainTemplate, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, IDomainTemplatesClient, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateQuery, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from './interfaces/DomainTemplates';
 export declare class DomainTemplateItem implements DomainTemplate {
     name: string;
     description: string;
@@ -22,7 +22,7 @@ export default class DomainTemplatesClient implements IDomainTemplatesClient {
     private parseList;
     private parseListTemplateVersions;
     list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
-    get(domain: string, templateName: string): Promise<DomainTemplateItem>;
+    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>;

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

@@ -0,0 +1,228 @@
+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

@@ -37,6 +37,9 @@ export interface DomainTemplatesQuery {
     limit: number;
     p: string;
 }
+export interface TemplateQuery {
+    active: YesNo;
+}
 export interface ShortTemplateVersion {
     tag: string;
     engine: string;
@@ -178,7 +181,7 @@ export interface ListDomainTemplateVersionsResult {
 }
 export interface IDomainTemplatesClient {
     list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
-    get(domain: string, templateName: string): Promise<DomainTemplateItem>;
+    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>;