mailgun.js 10.3.0 → 11.0.0

package/Types/Domains/DomainTracking.d.ts

@@ -36,13 +36,14 @@ export type UpdateDomainTrackingResponse = {
     body: UpdatedOpenTracking;
 };
 export type OpenTrackingInfo = {
-    active: 'yes' | 'no' | 'true' | 'false';
+    place_at_the_top?: 'yes' | 'no' | 'true' | 'false' | boolean;
+    active: 'yes' | 'no' | 'true' | 'false' | boolean;
 };
 export type ClickTrackingInfo = {
-    active: 'yes' | 'no' | 'true' | 'false' | 'htmlonly';
+    active?: 'yes' | 'no' | 'true' | 'false' | 'htmlonly' | boolean;
 };
 export type UnsubscribeTrackingInfo = {
-    active: 'yes' | 'no' | 'true' | 'false';
-    html_footer: string;
-    text_footer: string;
+    active?: 'yes' | 'no' | 'true' | 'false' | boolean;
+    html_footer?: string;
+    text_footer?: string;
 };

package/Types/Domains/Domains.d.ts

@@ -1,33 +1,52 @@
 export type DomainsQuery = {
-    authority?: string;
-    state?: 'active' | 'unverified' | 'disabled';
     limit?: number;
     skip?: number;
+    state?: 'active' | 'unverified' | 'disabled';
+    sort?: 'name:asc' | 'name: desc';
+    authority?: string;
+    search?: string;
 };
 export type DomainUpdateInfo = {
     spam_action?: 'disabled' | 'block' | 'tag';
     web_scheme?: 'http' | 'https';
     wildcard?: boolean | 'true' | 'false';
+    mailfrom_host?: string;
+    message_ttl?: number;
+    smtp_password?: string;
+    use_automatic_sender_security?: boolean | 'true' | 'false';
+    web_prefix?: string;
 };
-export type DomainUpdateInfoReq = DomainUpdateInfo & {
+export type DomainUpdateInfoReq = Omit<DomainUpdateInfo, 'message_ttl'> & {
     wildcard?: 'true' | 'false';
+    use_automatic_sender_security?: 'true' | 'false';
 };
 export type DomainInfo = DomainUpdateInfo & {
     name: string;
-    smtp_password: string;
-    force_dkim_authority?: boolean | 'true' | 'false';
+    dkim_host_name?: string;
     dkim_key_size?: 1024 | 2048;
-    ips?: '';
+    dkim_selector?: string;
+    encrypt_incoming_message?: boolean | 'true' | 'false';
+    force_dkim_authority?: boolean | 'true' | 'false';
+    force_root_dkim_host?: boolean | 'true' | 'false';
     pool_id?: '';
+    ips?: '';
 };
 export type DomainInfoReq = DomainInfo & {
     force_dkim_authority?: 'true' | 'false';
 };
 export type BoolToString = {
-    force_dkim_authority?: DomainInfo['force_dkim_authority'];
-    wildcard?: DomainUpdateInfo['wildcard'];
+    encrypt_incoming_message: DomainInfo['encrypt_incoming_message'];
+    force_dkim_authority: DomainInfo['force_dkim_authority'];
+    force_root_dkim_host: DomainInfo['force_root_dkim_host'];
+    wildcard: DomainInfo['wildcard'];
+    use_automatic_sender_security: DomainInfo['use_automatic_sender_security'];
 };
-export type DomainShortData = {
+export type DomainData = {
+    id: string;
+    is_disabled: boolean;
+    web_prefix: string;
+    web_scheme: string;
+    use_automatic_sender_security: boolean;
     name: string;
     require_tls: boolean;
     skip_verification: boolean;
@@ -38,14 +57,10 @@ export type DomainShortData = {
     smtp_password: string;
     smtp_login: string;
     type: string;
+    dkim_host?: string;
+    mailfrom_host?: string;
 };
-export type DomainData = DomainShortData & {
-    id: string;
-    is_disabled: boolean;
-    web_prefix: string;
-    web_scheme: string;
-};
-export interface DomainsListItem extends DomainShortData {
+export interface DomainsListItem extends DomainData {
     receiving_dns_records: null;
     sending_dns_records: null;
 }
@@ -81,13 +96,11 @@ export type DestroyedDomainResponse = {
     body: MessageResponse;
 };
 export type ConnectionSettings = {
-    require_tls: boolean;
-    skip_verification: boolean;
+    require_tls?: boolean;
+    skip_verification?: boolean;
 };
 export type ConnectionSettingsResponse = {
-    body: {
-        connection: ConnectionSettings;
-    };
+    body: ConnectionSettings;
     status: number;
 };
 export type UpdatedConnectionSettings = {
@@ -118,6 +131,9 @@ export type UpdatedDKIMSelectorResponse = {
     body: MessageResponse;
     status: number;
 };
+export type UpdatedDKIMSelectorResult = MessageResponse & {
+    status: number;
+};
 export type WebPrefixInfo = {
     webPrefix: string;
 };
@@ -139,14 +155,23 @@ export type TDomain = {
     state: string;
     wildcard: boolean;
     spam_action: string;
-    created_at: string;
+    created_at: Date;
     smtp_password: string;
     smtp_login: string;
     type: string;
     receiving_dns_records: DNSRecord[] | null;
     sending_dns_records: DNSRecord[] | null;
-    id?: string;
-    is_disabled?: boolean;
-    web_prefix?: string;
-    web_scheme?: string;
+    id: string;
+    is_disabled: boolean;
+    web_prefix: string;
+    web_scheme: string;
+    use_automatic_sender_security: boolean;
+    message?: string;
+    dkim_host?: string;
+    mailfrom_host?: string;
+};
+export type DomainDynamicPropsType = Pick<DomainData, 'dkim_host' | 'mailfrom_host'>;
+export type DomainGetQuery = {
+    extended?: boolean;
+    with_dns?: boolean;
 };

package/Types/Metrics/Metrics.d.ts

@@ -0,0 +1,100 @@
+import { Resolution } from '../../Enums';
+export type MetricsFilterValue = {
+    label?: string;
+    value: string;
+};
+export type MetricsFilter = {
+    attribute: string;
+    comparator: string;
+    values: MetricsFilterValue[];
+};
+export type MetricsQuery = {
+    start?: Date | string;
+    end?: Date | string;
+    resolution?: Resolution;
+    duration?: string;
+    dimensions?: string[];
+    metrics?: string[];
+    filter?: {
+        AND: MetricsFilter[];
+    };
+    include_subaccounts?: boolean;
+    include_aggregates?: boolean;
+};
+export type Metrics = {
+    accepted_outgoing_count?: number;
+    delivered_smtp_count?: number;
+    accepted_count?: number;
+    delivered_http_count?: number;
+    accepted_incoming_count?: number;
+    delivered_optimized_count?: number;
+    stored_count?: number;
+    delivered_count?: number;
+    processed_count?: number;
+    sent_count?: number;
+    opened_count?: number;
+    unique_opened_count?: number;
+    clicked_count?: number;
+    unique_clicked_count?: number;
+    complained_count?: number;
+    permanent_failed_count?: number;
+    failed_count?: number;
+    rate_limit_count?: number;
+    unsubscribed_count?: number;
+    temporary_failed_count?: number;
+    permanent_failed_optimized_count?: number;
+    bounced_count?: number;
+    esp_block_count?: number;
+    webhook_count?: number;
+    delayed_bounce_count?: number;
+    soft_bounces_count?: number;
+    permanent_failed_old_count?: number;
+    suppressed_bounces_count?: number;
+    delivered_subsequent_count?: number;
+    delivered_rate?: string;
+    delayed_first_attempt_count?: number;
+    unsubscribed_rate?: string;
+    delivered_first_attempt_count?: number;
+    opened_rate?: string;
+    suppressed_complaints_count?: number;
+    delivered_two_plus_attempts_count?: number;
+    hard_bounces_count?: number;
+    suppressed_unsubscribed_count?: number;
+    unique_opened_rate?: string;
+    fail_rate?: string;
+    complained_rate?: string;
+    clicked_rate?: string;
+    unique_clicked_rate?: string;
+    bounce_rate?: string;
+    delayed_rate?: string;
+    permanent_fail_rate?: string;
+    temporary_fail_rate?: string;
+};
+export type MetricsPagination = {
+    sort: string;
+    skip: number;
+    limit: number;
+    total: number;
+};
+export type MetricsDimension = {
+    dimension: string;
+    value: string;
+    display_value: string;
+};
+export type MetricsResponseItem = {
+    dimensions: MetricsDimension[];
+    metrics: Metrics;
+};
+export type MetricsResult = {
+    items: MetricsResponseItem[];
+    resolution: string;
+    start: Date | null;
+    aggregates: {
+        metrics: Metrics;
+    };
+    dimensions: string[];
+    pagination: MetricsPagination;
+    end: Date | null;
+    duration?: string;
+    status: number;
+};

package/Types/Metrics/MetricsAPI.d.ts

@@ -0,0 +1,20 @@
+import { Metrics, MetricsPagination, MetricsQuery, MetricsResponseItem } from './Metrics';
+export type MetricsAPIQuery = Omit<MetricsQuery, 'start' | 'end'> & {
+    start?: string;
+    end?: string;
+};
+export type MetricsAPIResponse = {
+    status: number;
+    body: {
+        items: MetricsResponseItem[];
+        resolution: string;
+        start: string;
+        aggregates: {
+            metrics: Metrics;
+        };
+        dimensions: string[];
+        pagination: MetricsPagination;
+        end: string;
+        duration?: string;
+    };
+};

package/Types/Metrics/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Metrics';
+export * from './MetricsAPI';