mailgun.js 8.2.2 → 9.0.1

package/{interfaces → Types/Domains}/DomainTags.d.ts

@@ -1,10 +1,5 @@
-import { DomainTagStatistic } from '../domainsTags';
-import { PagesList, ParsedPagesList } from './NavigationThruPages';
-export declare enum Resolution {
-    HOUR = "hour",
-    DAY = "day",
-    MONTH = "month"
-}
+import { Resolution } from '../../Enums';
+import { PagesList, ParsedPagesList } from '../Common';
 export type DomainTagsQuery = {
     limit: number;
     page?: string;
@@ -16,35 +11,35 @@ export type DomainTagsStatisticQuery = {
     resolution?: Resolution;
     duration?: string;
 };
-export interface DomainTagsItemInfo {
+export type DomainTagsItemInfo = {
     tag: string;
     description: string;
     'first-seen': string;
     'last-seen': string;
-}
-export interface DomainTagsItem {
+};
+export type DomainTagsItem = {
     tag: string;
     description: string;
     'first-seen': Date;
     'last-seen': Date;
-}
-export interface DomainTagsResponseData {
+};
+export type DomainTagsResponseData = {
     status: number;
     body: {
         items: DomainTagsItemInfo[];
         paging: PagesList;
     };
-}
-export interface DomainTagsList {
+};
+export type DomainTagsList = {
     status: number;
     items: DomainTagsItem[];
     pages: ParsedPagesList;
-}
-export interface DomainTagsMessageRes {
+};
+export type DomainTagsMessageRes = {
     message: string;
     status?: number;
-}
-export interface DomainTagAPIResponseStatsItem {
+};
+export type DomainTagAPIResponseStatsItem = {
     time: string;
     accepted?: {
         incoming: number;
@@ -88,8 +83,8 @@ export interface DomainTagAPIResponseStatsItem {
     stored?: {
         total: number;
     };
-}
-export interface DomainTagStatAPIResponse {
+};
+export type DomainTagStatAPIResponse = {
     body: {
         tag: string;
         description: string;
@@ -98,19 +93,11 @@ export interface DomainTagStatAPIResponse {
         resolution: Resolution;
         stats: DomainTagAPIResponseStatsItem[];
     };
-}
-export interface DomainTagStatisticItem extends Omit<DomainTagAPIResponseStatsItem, 'time'> {
+};
+export type DomainTagStatisticItem = Omit<DomainTagAPIResponseStatsItem, 'time'> & {
     time: Date;
-}
-export interface DomainTagStatisticResult {
-    tag: string;
-    description: string;
-    start: Date;
-    end: Date;
-    resolution: Resolution;
-    stats: DomainTagStatisticItem[];
-}
-export interface DomainTagCountriesAPIResponse {
+};
+export type DomainTagCountriesAPIResponse = {
     body: {
         tag: string;
         country: {
@@ -124,8 +111,8 @@ export interface DomainTagCountriesAPIResponse {
             };
         };
     };
-}
-export interface DomainTagCountriesAggregation {
+};
+export type DomainTagCountriesAggregation = {
     tag: string;
     country: {
         [key: string]: {
@@ -137,8 +124,8 @@ export interface DomainTagCountriesAggregation {
             unsubscribed: number;
         };
     };
-}
-export interface DomainTagProvidersAPIResponse {
+};
+export type DomainTagProvidersAPIResponse = {
     body: {
         tag: string;
         provider: {
@@ -155,8 +142,8 @@ export interface DomainTagProvidersAPIResponse {
         };
     };
     status: number;
-}
-export interface DomainTagProvidersAggregation {
+};
+export type DomainTagProvidersAggregation = {
     tag: string;
     provider: {
         [key: string]: {
@@ -170,39 +157,29 @@ export interface DomainTagProvidersAggregation {
             unsubscribed: number;
         };
     };
-}
-export interface DeviceStatistic {
+};
+export type DeviceStatistic = {
     clicked: number;
     complained: number;
     opened: number;
     unique_clicked: number;
     unique_opened: number;
     unsubscribed: number;
-}
-export interface DevicesTypes {
+};
+export type DevicesTypes = {
     desktop: DeviceStatistic;
     mobile: DeviceStatistic;
     tablet: DeviceStatistic;
     unknown: DeviceStatistic;
-}
-export interface DomainTagDevicesAPIResponse {
+};
+export type DomainTagDevicesAPIResponse = {
     body: {
         tag: string;
         device: DevicesTypes;
     };
     status: number;
-}
-export interface DomainTagDevicesAggregation {
+};
+export type 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/Types/Domains/DomainTemplates.d.ts

@@ -0,0 +1,153 @@
+import { YesNo } from '../../Enums';
+import { IDomainTemplate } from '../../Interfaces/Domains';
+import { PagesList, ParsedPagesList } from '../Common';
+export type DomainTemplateData = {
+    name: string;
+    description: string;
+    template: string;
+    tag?: string;
+    engine?: string;
+    comment?: string;
+};
+export type DomainTemplateVersionData = {
+    template: string;
+    tag: string;
+    engine?: string;
+    comment?: string;
+    active?: YesNo;
+};
+export type DomainTemplateUpdateData = {
+    description: string;
+};
+export type DomainTemplateUpdateVersionData = {
+    template?: string;
+    comment?: string;
+    active?: YesNo;
+};
+export 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 type TemplateQuery = {
+    active: YesNo;
+};
+export type ShortTemplateVersion = {
+    tag: string;
+    engine: string;
+    mjml: string;
+    createdAt: string | Date;
+    comment: string;
+    active: boolean;
+    id: string;
+};
+export type TemplateVersion = ShortTemplateVersion & {
+    template: string;
+};
+export type CreateDomainTemplateAPIResponse = {
+    status: number;
+    body: {
+        message: string;
+        template: IDomainTemplate;
+    };
+};
+export type ListDomainTemplatesAPIResponse = {
+    status: number;
+    body: {
+        items: IDomainTemplate[];
+        paging: {
+            first: string;
+            last: string;
+            next: string;
+            previous: string;
+        };
+    };
+};
+export type ListDomainTemplatesResult = {
+    items: IDomainTemplate[];
+    pages: ParsedPagesList;
+    status: number;
+};
+export type GetDomainTemplateAPIResponse = {
+    status: number;
+    body: {
+        template: IDomainTemplate;
+    };
+};
+export type UpdateOrDeleteDomainTemplateAPIResponse = {
+    status: number;
+    body: {
+        message: string;
+        template: {
+            name: string;
+        };
+    };
+};
+export type UpdateOrDeleteDomainTemplateResult = {
+    status: number;
+    message: string;
+    templateName?: string;
+};
+export type NotificationAPIResponse = {
+    status: number;
+    body: {
+        message: string;
+    };
+};
+export type NotificationResult = {
+    status: number;
+    message: string;
+};
+export type CreateDomainTemplateVersionAPIResponse = {
+    status: number;
+    body: {
+        message: string;
+        template: IDomainTemplate;
+    };
+};
+export type CreateDomainTemplateVersionResult = {
+    status: number;
+    message: string;
+    template: IDomainTemplate;
+};
+export type MutateDomainTemplateVersionAPIResponse = {
+    status: number;
+    body: {
+        message: string;
+        template: {
+            name: string;
+            version: {
+                tag: string;
+            };
+        };
+    };
+};
+export type MutateDomainTemplateVersionResult = {
+    status: number;
+    message: string;
+    templateName: string;
+    templateVersion: {
+        tag: string;
+    };
+};
+export type ListDomainTemplateVersionsAPIResponse = {
+    status: number;
+    body: {
+        template: {
+            name: string;
+            description: string;
+            createdAt: string;
+            createdBy: string;
+            id: string;
+            versions: ShortTemplateVersion[];
+        };
+        paging: PagesList;
+    };
+};
+export type ListDomainTemplateVersionsResult = {
+    template: IDomainTemplate;
+    pages: ParsedPagesList;
+};

package/{interfaces → Types/Domains}/DomainTracking.d.ts

@@ -1,4 +1,4 @@
-export interface DomainTrackingData {
+export type DomainTrackingData = {
     click: {
         active: boolean;
     };
@@ -10,14 +10,14 @@ export interface DomainTrackingData {
         html_footer: string;
         text_footer: string;
     };
-}
-export interface DomainTrackingResponse {
+};
+export type DomainTrackingResponse = {
     status: number;
     body: {
         tracking: DomainTrackingData;
     };
-}
-export interface UpdatedOpenTracking {
+};
+export type UpdatedOpenTracking = {
     message: string;
     open?: {
         active: boolean;
@@ -30,11 +30,11 @@ export interface UpdatedOpenTracking {
         html_footer: string;
         text_footer: string;
     };
-}
-export interface UpdateDomainTrackingResponse {
+};
+export type UpdateDomainTrackingResponse = {
     status: number;
     body: UpdatedOpenTracking;
-}
+};
 export type OpenTrackingInfo = {
     active: 'yes' | 'no' | 'true' | 'false';
 };

package/{interfaces → Types/Domains}/Domains.d.ts

@@ -4,7 +4,7 @@ export type DomainsQuery = {
     limit?: number;
     skip?: number;
 };
-export interface DomainInfo {
+export type DomainInfo = {
     name: string;
     smtp_password: string;
     spam_action?: 'disabled' | 'block' | 'tag';
@@ -14,8 +14,8 @@ export interface DomainInfo {
     ips?: '';
     pool_id?: '';
     web_scheme: 'http' | 'https';
-}
-export interface DomainShortData {
+};
+export type DomainShortData = {
     name: string;
     require_tls: boolean;
     skip_verification: boolean;
@@ -26,13 +26,13 @@ export interface DomainShortData {
     smtp_password: string;
     smtp_login: string;
     type: string;
-}
-export interface DomainData extends DomainShortData {
+};
+export type DomainData = 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;
@@ -53,69 +53,83 @@ export type DomainResponseData = {
         sending_dns_records: DNSRecord[];
     };
 };
-export interface DomainListResponseData {
+export type DomainListResponseData = {
     status: number;
     body: {
         items: DomainsListItem[] | null;
         total_count: number;
     };
-}
-export interface MessageResponse {
+};
+export type MessageResponse = {
     message: string;
-}
-export interface DestroyedDomainResponse {
+};
+export type DestroyedDomainResponse = {
     status: number;
     body: MessageResponse;
-}
+};
 export type ConnectionSettings = {
     require_tls: boolean;
     skip_verification: boolean;
 };
-export interface ConnectionSettingsResponse {
+export type ConnectionSettingsResponse = {
     body: {
         connection: ConnectionSettings;
     };
     status: number;
-}
-export interface UpdatedConnectionSettings {
+};
+export type UpdatedConnectionSettings = {
     message: string;
     require_tls: boolean;
     skip_verification: boolean;
-}
-export interface UpdatedConnectionSettingsRes {
+};
+export type UpdatedConnectionSettingsRes = {
     body: UpdatedConnectionSettings;
     status: number;
-}
-export interface DKIMAuthorityInfo {
+};
+export type DKIMAuthorityInfo = {
     self: boolean | 'yes' | 'no' | 'true' | 'false';
-}
-export interface UpdatedDKIMAuthority {
+};
+export type UpdatedDKIMAuthority = {
     changed: boolean;
     message: string;
     sending_dns_records: DNSRecord[];
-}
-export interface UpdatedDKIMAuthorityResponse {
+};
+export type UpdatedDKIMAuthorityResponse = {
     body: UpdatedDKIMAuthority;
     status: 200;
-}
-export interface DKIMSelectorInfo {
+};
+export type DKIMSelectorInfo = {
     dkimSelector: string;
-}
-export interface UpdatedDKIMSelectorResponse {
+};
+export type UpdatedDKIMSelectorResponse = {
     body: MessageResponse;
     status: number;
-}
-export interface WebPrefixInfo {
+};
+export type WebPrefixInfo = {
     webPrefix: string;
-}
-export interface UpdatedWebPrefix {
+};
+export type UpdatedWebPrefix = {
     message: string;
-}
-export interface UpdatedWebPrefixResponse {
+};
+export type UpdatedWebPrefixResponse = {
     body: MessageResponse;
     status: number;
-}
-export interface ReplacementForPool {
+};
+export type ReplacementForPool = {
     pool_id?: string;
     ip?: string;
-}
+};
+export type TDomain = {
+    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;
+    receiving_dns_records: DNSRecord[] | null;
+    sending_dns_records: DNSRecord[] | null;
+};

package/Types/Domains/index.d.ts

@@ -0,0 +1,5 @@
+export * from './DomainCredentials';
+export * from './Domains';
+export * from './DomainTags';
+export * from './DomainTemplates';
+export * from './DomainTracking';

package/{interfaces → Types/Events}/Events.d.ts

@@ -1,10 +1,10 @@
-import { PagesList, ParsedPagesList } from './NavigationThruPages';
-export interface EventsPage {
+import { PagesList, ParsedPagesList } from '../Common';
+export type EventsPage = {
     id: string;
     number: string;
     url: string;
-}
-export interface FilterField {
+};
+export type FilterField = {
     event?: string;
     list?: string;
     attachment?: string;
@@ -17,22 +17,22 @@ export interface FilterField {
     recipients?: string;
     tags?: string;
     severity?: string;
-}
-export interface EventsQuery extends FilterField {
+};
+export type EventsQuery = FilterField & {
     page?: string;
     begin?: string;
     end?: string;
     ascending?: 'yes' | 'no';
     limit?: number;
-}
-export interface EventsResponse {
+};
+export type EventsResponse = {
     body: {
         items: [];
         paging: PagesList;
     };
     status: number;
-}
-export interface DomainEvent {
+};
+export type DomainEvent = {
     severity: string;
     tags: string[];
     storage: {
@@ -55,7 +55,7 @@ export interface DomainEvent {
     campaigns: [];
     reason: string;
     'user-variables': {
-        [key: string]: any;
+        [key: string]: unknown;
     };
     flags: {
         'is-routed': boolean;
@@ -64,7 +64,7 @@ export interface DomainEvent {
         'is-test-mode': boolean;
     };
     'log-level': string;
-    template?: any;
+    template?: unknown;
     timestamp: number;
     envelope: {
         transport: string;
@@ -84,9 +84,9 @@ export interface DomainEvent {
     };
     recipient: string;
     event: string;
-}
-export interface EventsList {
+};
+export type EventsList = {
     items: DomainEvent[];
     pages: ParsedPagesList;
     status: number;
-}
+};

package/Types/Events/index.d.ts

@@ -0,0 +1 @@
+export * from './Events';

package/{interfaces → Types/IPPools}/IpPools.d.ts

@@ -1,22 +1,22 @@
-export interface IpPool {
+export type IpPool = {
     description: string;
     ips: string[];
     is_linked: boolean;
     name: string;
     pool_id: string;
-}
-export interface IpPoolListResponse {
+};
+export type IpPoolListResponse = {
     body: {
         ip_pools: IpPool;
         message: string;
     };
     status: number;
-}
-export interface IpPoolListResult {
+};
+export type IpPoolListResult = {
     ip_pools: IpPool;
     message: string;
     status: number;
-}
+};
 export type IpPoolUpdateData = {
     name: string;
     description: string;

package/Types/IPPools/index.d.ts

@@ -0,0 +1 @@
+export * from './IpPools';

package/{interfaces/Ips.d.ts → Types/IPs/IPs.d.ts}

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

package/Types/IPs/index.d.ts

@@ -0,0 +1 @@
+export * from './IPs';

package/{interfaces/Options.d.ts → Types/MailgunClient/MailgunClientOptions.d.ts}

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

package/Types/MailgunClient/index.d.ts

@@ -0,0 +1 @@
+export * from './MailgunClientOptions';