mailgun.js 10.2.3 → 10.3.0

package/Types/Domains/Domains.d.ts

@@ -109,7 +109,7 @@ export type UpdatedDKIMAuthority = {
 };
 export type UpdatedDKIMAuthorityResponse = {
     body: UpdatedDKIMAuthority;
-    status: 200;
+    status: number;
 };
 export type DKIMSelectorInfo = {
     dkimSelector: string;

package/Types/InboxPlacements/Attributes.d.ts

@@ -0,0 +1,21 @@
+export type InboxPlacementsAttributesResult = {
+    items: {
+        attribute: string;
+        values: string[];
+    };
+    status: number;
+};
+export type InboxPlacementsAttributesApiResponse = {
+    body: {
+        items: {
+            attribute: string;
+            values: string[];
+        };
+    };
+    status: number;
+};
+export type InboxPlacementsValuesResult = object;
+export type InboxPlacementsValuesApiResponse = {
+    body: InboxPlacementsValuesResult;
+    status: number;
+};

package/Types/InboxPlacements/Filters.d.ts

@@ -0,0 +1,18 @@
+export type Filter = {
+    parameter: string;
+    description: string;
+};
+export type InboxPlacementsFiltersApiResponse = {
+    body: {
+        supported_filters: {
+            filters: Filter[];
+        };
+    };
+    status: number;
+};
+export type InboxPlacementsFiltersResult = {
+    supported_filters: {
+        filters: Filter[];
+    };
+    status: number;
+};

package/Types/InboxPlacements/InboxPlacements.d.ts

@@ -0,0 +1,22 @@
+export type InboxPlacementsData = {
+    from: string;
+    subject: string;
+    provider_filter?: string[];
+    html?: string;
+    template_name?: string;
+    variables?: {
+        [propName: string]: string;
+    };
+    seed_list?: string;
+};
+export type InboxPlacementsTestResult = {
+    result_id: string;
+    links: {
+        results: string;
+    };
+    status: number;
+};
+export type InboxPlacementsTestResultAPIResponse = {
+    body: InboxPlacementsTestResult;
+    status: number;
+};

package/Types/InboxPlacements/Results/InboxPlacementsResults.d.ts

@@ -0,0 +1,152 @@
+import { PagesList, ParsedPagesList } from '../../Common';
+export type InboxPlacementsResultsQuery = {
+    sender?: string;
+    subject?: string;
+    provider?: string;
+    target_email?: string;
+    time_after?: string | Date;
+    time_before?: string | Date;
+    cursor?: string;
+    sort?: string;
+    offset?: number;
+    ascending?: boolean;
+    limit?: number;
+};
+export type InboxPlacementsResultsDates = {
+    time_after?: string;
+    time_before?: string;
+};
+export type InboxPlacementsResultsApiQuery = Omit<InboxPlacementsResultsQuery, 'time_after' | 'time_before'> & InboxPlacementsResultsDates;
+export type InboxPlacementsSeedResultAPIShape = {
+    email: string;
+    provider: string;
+    destination: string;
+    state: string;
+    originating_ip: string;
+    tags: string[];
+    dkim: string;
+    spf: string;
+    dmarc: string;
+    headers: {
+        key: string;
+        value: string;
+    }[];
+    extensions: {
+        category: string;
+    };
+};
+export type InboxPlacementsBoxAPIShape = {
+    Id: string;
+    kid: string;
+    ID: string;
+    AccountID: string;
+    created_at: string;
+    updated_at: string;
+    last_result_at: string;
+    Seeds: null;
+    target_email: string;
+    sending_domains: null;
+    has_results: boolean;
+    name: string;
+    seed_filter: string;
+    mailing_list: string;
+    CreatedTS: number;
+    tags: string[];
+    SeedQuality: number;
+    is_auto_generated: boolean;
+};
+export type InboxPlacementsBox = Omit<InboxPlacementsBoxAPIShape, 'created_at' | 'updated_at' | 'last_result_at'> & {
+    created_at: Date;
+    updated_at: Date;
+    last_result_at: Date;
+};
+export type InboxPlacementsResultAPIShape = {
+    Id: string;
+    rid: string;
+    result_id: string;
+    AccountID: string;
+    KeyBoxID: string;
+    keybox_email: string;
+    subject: string;
+    sender: string;
+    seedlist_name: string;
+    created_at: string;
+    updated_at: string;
+    status: string;
+    CreatedTS: number;
+    attributes: {
+        [key: string]: string | unknown;
+    };
+    campaign_id: string;
+    sharing_enabled: boolean;
+    sharing_id: string;
+    sharing_expires_at: string;
+    Box: InboxPlacementsBoxAPIShape;
+    seed_results: InboxPlacementsSeedResultAPIShape[];
+    spamassassin: {
+        is_spam: boolean;
+        score: number;
+        required: number;
+        rules: {
+            name: string;
+            points: number;
+            short_description: string;
+            long_description: string;
+        }[];
+    };
+    delivery_stats: {
+        [key: string]: {
+            delivered: number;
+            missing: number;
+            pending: number;
+            spam: number;
+            inbox: number;
+            total: number;
+            provider: string;
+            categories: {
+                primary: number;
+                updates: number;
+            } | object;
+        };
+    };
+};
+export type InboxPlacementsResult = Omit<InboxPlacementsResultAPIShape, 'Id' | 'Box' | 'created_at' | 'updated_at' | 'sharing_expires_at'> & {
+    Box: InboxPlacementsBox;
+    created_at: Date;
+    updated_at: Date;
+    sharing_expires_at: Date;
+    id: string;
+};
+export type InboxPlacementsResultAPIResponse = {
+    body: {
+        result: InboxPlacementsResultAPIShape;
+    };
+    status: number;
+};
+export type InboxPlacementsResultWithStatus = {
+    inboxPlacementResult: InboxPlacementsResult;
+    status: number;
+};
+export type InboxPlacementsResultsListAPIResponse = {
+    body: {
+        items: InboxPlacementsResultAPIShape[];
+        paging: PagesList;
+        total: number;
+    };
+    status: number;
+};
+export type InboxPlacementsResultsList = {
+    items: InboxPlacementsResult[];
+    status: number;
+    pages: ParsedPagesList;
+};
+export type InboxPlacementsDestroyAPIResponse = {
+    body: {
+        Message: string;
+    };
+    status: number;
+};
+export type InboxPlacementsDestroyResult = {
+    Message: string;
+    status: number;
+};

package/Types/InboxPlacements/Results/InboxPlacementsResultsSharing.d.ts

@@ -0,0 +1,27 @@
+export type IPRSharingApiShape = {
+    result_id: string;
+    expires_at: string;
+    enabled: boolean;
+    url_id: string;
+    url: string;
+    api_url: string;
+};
+export type IPRSharingAPIResponse = {
+    body: {
+        sharing: IPRSharingApiShape;
+    };
+    status: number;
+};
+export type IPRSharingResult = Omit<IPRSharingApiShape, 'expires_at'> & {
+    expires_at: Date;
+};
+export type IPRSharingUpdateData = {
+    enabled: boolean;
+};
+export type IPRSharingUpdateAPIResponse = {
+    body: {
+        sharing: IPRSharingApiShape;
+    };
+    status: number;
+};
+export type IPRSharingUpdateResult = IPRSharingResult;

package/Types/InboxPlacements/SeedsLists/SeedsLists.d.ts

@@ -0,0 +1,137 @@
+import { PagesList, ParsedPagesList } from '../../Common';
+export type SeedsListsAPIQueryDates = {
+    time_after?: string;
+    time_before?: string;
+};
+export type SeedAPIShape = {
+    AccountID: string;
+    id: string;
+    token: string;
+    email: string;
+    provider: string;
+    sync_state: string;
+    local_state: string;
+    created_at: string;
+    updated_at: string;
+    message_count: number;
+    max_email_count_hit_at: string;
+    total_msgs: number;
+    matched_msgs: number;
+    spam_message: number;
+    expected_msgs: number;
+    last_sent_to_at: string;
+    last_delivered_at: string;
+    account_quality: number;
+    quality_label: string;
+    password: string;
+    phone_number: string;
+    attributes: {
+        [key: string]: unknown | undefined;
+    };
+    totp: {
+        secret: string;
+    };
+};
+export type Seed = Omit<SeedAPIShape, 'created_at' | 'updated_at' | 'max_email_count_hit_at' | 'last_sent_to_at' | 'last_delivered_at'> & {
+    created_at: Date;
+    updated_at: Date;
+    max_email_count_hit_at: Date;
+    last_sent_to_at: Date;
+    last_delivered_at: Date;
+};
+export type SeedListAPIShape = {
+    Id: string;
+    kid: string;
+    ID: string;
+    AccountID: string;
+    created_at: string;
+    updated_at: string;
+    last_result_at: string;
+    Seeds: SeedAPIShape[] | null;
+    target_email: string;
+    sending_domains: string[];
+    has_results: boolean;
+    name: string;
+    seed_filter: string;
+    mailing_list: string;
+    CreatedTS: number;
+    tags: {
+        sfmc_remote_id?: string;
+        [key: string]: unknown | undefined;
+    };
+    delivery_stats: {
+        all: {
+            delivered: number;
+            missing: number;
+            pending: number;
+            spam: number;
+            inbox: number;
+            total: number;
+            provider: string;
+            categories: {
+                primary: number;
+                promotions: number;
+                updates: number;
+            };
+        };
+    };
+    SeedQuality: number;
+    is_auto_generated: boolean;
+};
+export type SeedList = Omit<SeedListAPIShape, 'Id' | 'created_at' | 'updated_at' | 'last_result_at' | 'Seeds'> & {
+    created_at: Date;
+    updated_at: Date;
+    last_result_at: Date;
+    Seeds: null | Seed[];
+};
+export type SeedsListsAPIResponse = {
+    body: {
+        items: SeedListAPIShape[];
+        paging: PagesList;
+        total: number;
+    };
+    status: number;
+};
+export type SeedsListsResult = {
+    items: SeedList[] | [];
+    status: number;
+    pages: ParsedPagesList;
+};
+export type SeedsListsQuery = {
+    time_after?: string | Date;
+    time_before?: string | Date;
+    name?: string;
+    cursor?: string;
+    sort?: string;
+    offset?: number;
+    ascending?: boolean;
+    limit?: number;
+};
+export type SeedsListsAPIQuery = Omit<SeedsListsQuery, 'time_after' | 'time_before'> & SeedsListsAPIQueryDates;
+export type SeedsListsCreatingData = {
+    sending_domains?: string;
+    name?: string;
+    seed_filter?: string;
+    provider_filter?: string;
+    remote_id?: string;
+};
+export type SeedsListsUpdatingData = Omit<SeedsListsCreatingData, 'remote_id'> & {
+    shuffle?: boolean;
+};
+export type SeedListAPIResponse = {
+    body: SeedListAPIShape;
+    status: number;
+};
+export type SeedListGetAPIResponse = {
+    body: {
+        seedlist: SeedListAPIShape;
+    };
+    status: number;
+};
+export type SeedListResult = SeedList & {
+    status: number;
+};
+export type SeedsListsDestroyApiResponse = {
+    body: null;
+    status: number;
+};

package/Types/InboxPlacements/index.d.ts

@@ -0,0 +1,7 @@
+export * from './InboxPlacements';
+export * from './Attributes';
+export * from './Filters';
+export * from './SeedsLists/SeedsLists';
+export * from './Results/InboxPlacementsResults';
+export * from './Results/InboxPlacementsResultsSharing';
+export * from './providers/InboxPlacementsProviders';

package/Types/InboxPlacements/providers/InboxPlacementsProviders.d.ts

@@ -0,0 +1,23 @@
+export type InboxPlacementsProviderAPIShape = {
+    domain: string;
+    display_name: string;
+    region: string;
+    created_at: string;
+    updated_at: string;
+    max_email_count?: number;
+    unsupported_authentications?: object;
+};
+export type InboxPlacementsProvider = Omit<InboxPlacementsProviderAPIShape, 'created_at' | 'updated_at'> & {
+    created_at: Date;
+    updated_at: Date;
+};
+export type InboxPlacementsProvidersListAPIResponse = {
+    body: {
+        items: InboxPlacementsProviderAPIShape[];
+    };
+    status: number;
+};
+export type InboxPlacementsProvidersList = {
+    items: InboxPlacementsProvider[];
+    status: number;
+};