mailgun.js 12.1.1 → 12.3.0

package/Types/Classes/Domains/domainsClient.d.ts

@@ -1,4 +1,4 @@
-import { IDomainTemplatesClient, IDomainTagsClient, IDomainCredentials, IDomainsClient } from '../../Interfaces/Domains/index.js';
+import { IDomainTemplatesClient, IDomainTagsClient, IDomainCredentials, IDomainsClient, IDomainKeysClient } from '../../Interfaces/Domains/index.js';
 import { APIResponse } from '../../Types/Common/ApiResponse.js';
 import Request from '../common/Request.js';
 import { MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, WebPrefixInfo, UpdatedWebPrefixResponse, TDomain, DomainUpdateInfo, DomainGetQuery, UpdatedDKIMSelectorResult } from '../../Types/Domains/index.js';
@@ -9,8 +9,9 @@ export default class DomainsClient implements IDomainsClient {
     domainTemplates: IDomainTemplatesClient;
     domainTags: IDomainTagsClient;
     domainTracking: IDomainTrackingClient;
+    domainKeys: IDomainKeysClient;
     private logger;
-    constructor(request: Request, domainCredentialsClient: IDomainCredentials, domainTemplatesClient: IDomainTemplatesClient, domainTagsClient: IDomainTagsClient, domainTracking: IDomainTrackingClient, logger?: ILogger);
+    constructor(request: Request, domainCredentialsClient: IDomainCredentials, domainTemplatesClient: IDomainTemplatesClient, domainTagsClient: IDomainTagsClient, domainTracking: IDomainTrackingClient, domainKeysClient: IDomainKeysClient, logger?: ILogger);
     private _handleBoolValues;
     private _parseMessage;
     private parseDomainList;
@@ -55,7 +56,17 @@ export default class DomainsClient implements IDomainsClient {
     * in the future releases.
     */
     unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
+    /**
+    * @deprecated "domains.updateDKIMAuthority" method is deprecated,
+    * and moved into the "domains.domainKeys.updateDKIMAuthority".
+    * Current method will be removed in the future releases.
+    */
     updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
+    /**
+    * @deprecated "domains.updateDKIMSelector" method is deprecated,
+    * and moved into the "domains.domainKeys.updateDKIMSelector".
+    * Current method will be removed in the future releases.
+    */
     updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResult>;
     /**
     * @deprecated "domains.updateWebPrefix" method is deprecated.

package/Types/Classes/Domains/domainsKeys.d.ts

@@ -0,0 +1,19 @@
+import { DKIMSelectorInfo, UpdatedDKIMSelectorResult, UpdatedDKIMAuthority, DKIMAuthorityInfo, DomainKeyCreateData, DomainKeyCreateDataResult, DomainKeysListResult, DomainKeysListAllQuery, DomainKeysListAllResult, DomainKeysListAllApi, DeletedDomainKeysResult, ActivateDomainKeyResponse, DeactivateDomainKeyResponse } from '../../Types/Domains/index.js';
+import Request from '../common/Request.js';
+import { IDomainKeysClient } from '../../Interfaces/Domains/index.js';
+import NavigationThruPages from '../common/NavigationThruPages.js';
+export default class DomainKeysClient extends NavigationThruPages<DomainKeysListAllResult> implements IDomainKeysClient {
+    baseRoute: string;
+    request: Request;
+    constructor(request: Request);
+    private _parseDomainKeysList;
+    protected parseList(response: DomainKeysListAllApi): DomainKeysListAllResult;
+    list(domainName: string): Promise<DomainKeysListResult>;
+    listAll(query?: DomainKeysListAllQuery): Promise<DomainKeysListAllResult>;
+    create(data: DomainKeyCreateData): Promise<DomainKeyCreateDataResult>;
+    activate(domainName: string, selector: string): Promise<ActivateDomainKeyResponse>;
+    deactivate(domainName: string, selector: string): Promise<DeactivateDomainKeyResponse>;
+    destroy(domain: string, selector: string): Promise<DeletedDomainKeysResult>;
+    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResult>;
+    updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
+}

package/Types/Classes/Messages.d.ts

@@ -1,4 +1,4 @@
-import { MailgunMessageData, MessagesSendAPIResponse, MessagesSendResult } from '../Types/index.js';
+import { ClearMessagesQueueResult, MailgunMessageData, MessagesQueueStatusResult, MessagesSendAPIResponse, MessagesSendResult, StoredEmailResponse } from '../Types/index.js';
 import Request from './common/Request.js';
 import { IMessagesClient } from '../Interfaces/index.js';
 export default class MessagesClient implements IMessagesClient {
@@ -7,4 +7,22 @@ export default class MessagesClient implements IMessagesClient {
     private prepareBooleanValues;
     _parseResponse(response: MessagesSendAPIResponse): MessagesSendResult;
     create(domain: string, data: MailgunMessageData): Promise<MessagesSendResult>;
+    retrieveStoredEmail(domain: string, storageKey: string): Promise<StoredEmailResponse>;
+    /**
+     * domain: string
+     * Domain name used to send the message
+     *
+     * storageKey: string
+     * Storage key from the email's associated events
+     * (Example: Accepted/Delivered events storage.key field)
+     *
+     * recipients: string
+     * Email address of the recipient(s). You can use commas to separate multiple recipients
+     */
+    resendEmail(domain: string, storageKey: string, recipients: string): Promise<MessagesSendResult>;
+    getMessagesQueueStatus(domain: string): Promise<MessagesQueueStatusResult>;
+    /** Deletes all scheduled and undelivered mail from the domain queue.
+     * https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/delete-v3--domain-name--envelopes
+    */
+    clearMessagesQueue(domain: string, storageUrl: string): Promise<ClearMessagesQueueResult>;
 }

package/Types/Classes/Subaccounts.d.ts

@@ -1,13 +1,18 @@
 import type Request from './common/Request.js';
 import { ISubaccountsClient } from '../Interfaces/index.js';
-import { SubaccountListResponseData, SubaccountResponseData, SubaccountsQuery } from '../Types/index.js';
+import { SubaccountDestroyResponse, SubaccountFeaturesData, SubaccountFeaturesResult, SubaccountListResponseData, SubaccountResponseData, SubaccountSendingLimitResponse, SubaccountSetSendingLimitResponse, SubaccountsQuery } from '../Types/index.js';
 export default class SubaccountsClient implements ISubaccountsClient {
     request: Request;
     static SUBACCOUNT_HEADER: string;
     constructor(request: Request);
+    private convertToDate;
     list(query?: SubaccountsQuery): Promise<SubaccountListResponseData>;
     get(id: string): Promise<SubaccountResponseData>;
     create(name: string): Promise<SubaccountResponseData>;
+    destroy(id: string): Promise<SubaccountDestroyResponse>;
+    getMonthlySendingLimit(id: string): Promise<SubaccountSendingLimitResponse>;
+    setMonthlySendingLimit(id: string, limit: number): Promise<SubaccountSetSendingLimitResponse>;
+    updateSubaccountFeature(id: string, features: SubaccountFeaturesData): Promise<SubaccountFeaturesResult>;
     enable(id: string): Promise<SubaccountResponseData>;
     disable(id: string): Promise<SubaccountResponseData>;
 }

package/Types/Classes/common/Request.d.ts

@@ -1,4 +1,4 @@
-import { RequestOptions, InputFormData, APIResponse, IpPoolDeleteData, FormDataInput, RequestData, GetQueryTypes, PostDataTypes, PutDataTypes, CommandQuery, PutOptionsType, PutQueryTypes, onCallReqConfig } from '../../Types/index.js';
+import { RequestOptions, InputFormData, APIResponse, IpPoolDeleteData, FormDataInput, RequestData, GetQueryTypes, PostDataTypes, PutDataTypes, CommandQuery, PutOptionsType, PutQueryTypes, onCallReqConfig, DeleteQueryTypes } from '../../Types/index.js';
 import { IRequestProvider } from '../../Interfaces/index.js';
 declare class Request {
     private url;
@@ -7,7 +7,7 @@ declare class Request {
     constructor(options: RequestOptions, formData: InputFormData);
     request(method: string, url: string, onCallOptions?: {
         body?: RequestData;
-        query?: GetQueryTypes | PutQueryTypes;
+        query?: GetQueryTypes | PutQueryTypes | DeleteQueryTypes;
     }, config?: onCallReqConfig): Promise<APIResponse>;
     setSubaccountHeader(subAccountId: string): void;
     resetSubaccountHeader(): void;
@@ -19,6 +19,6 @@ declare class Request {
     putWithFD(url: string, data: FormDataInput): Promise<APIResponse>;
     patchWithFD(url: string, data: FormDataInput): Promise<APIResponse>;
     put(url: string, data?: PutDataTypes, queryObject?: PutOptionsType): Promise<APIResponse>;
-    delete(url: string, data?: IpPoolDeleteData): Promise<APIResponse>;
+    delete(url: string, data?: IpPoolDeleteData, queryObject?: DeleteQueryTypes): Promise<APIResponse>;
 }
 export default Request;

package/Types/Interfaces/Domains/DomainKeys.d.ts

@@ -0,0 +1,11 @@
+import type { ActivateDomainKeyResponse, DeactivateDomainKeyResponse, DeletedDomainKeysResult, DKIMAuthorityInfo, DKIMSelectorInfo, DomainKeyCreateData, DomainKeyCreateDataResult, DomainKeysListAllQuery, DomainKeysListAllResult, DomainKeysListResult, UpdatedDKIMAuthority, UpdatedDKIMSelectorResult } from '../../Types/Domains/index.js';
+export interface IDomainKeysClient {
+    list(domainName: string): Promise<DomainKeysListResult>;
+    listAll(query: DomainKeysListAllQuery): Promise<DomainKeysListAllResult>;
+    create(data: DomainKeyCreateData): Promise<DomainKeyCreateDataResult>;
+    destroy(domain: string, selector: string): Promise<DeletedDomainKeysResult>;
+    activate(domainName: string, selector: string): Promise<ActivateDomainKeyResponse>;
+    deactivate(domainName: string, selector: string): Promise<DeactivateDomainKeyResponse>;
+    updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
+    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResult>;
+}

package/Types/Interfaces/Domains/index.d.ts

@@ -3,3 +3,4 @@ export * from './DomainTags.js';
 export * from './DomainTemplates.js';
 export * from './DomainsClient.js';
 export * from './DomainTracking.js';
+export * from './DomainKeys.js';

package/Types/Interfaces/Subaccounts/ISubaccountsClient.d.ts

@@ -1,8 +1,11 @@
-import { SubaccountListResponseData, SubaccountResponseData, SubaccountsQuery } from '../../Types/index.js';
+import { SubaccountDestroyResponse, SubaccountListResponseData, SubaccountResponseData, SubaccountSendingLimitResponse, SubaccountSetSendingLimitResponse, SubaccountsQuery } from '../../Types/index.js';
 export interface ISubaccountsClient {
     list(query?: SubaccountsQuery): Promise<SubaccountListResponseData>;
     get(id: string): Promise<SubaccountResponseData>;
     create(name: string): Promise<SubaccountResponseData>;
     disable(id: string): Promise<SubaccountResponseData>;
     enable(id: string): Promise<SubaccountResponseData>;
+    destroy(id: string): Promise<SubaccountDestroyResponse>;
+    getMonthlySendingLimit(id: string): Promise<SubaccountSendingLimitResponse>;
+    setMonthlySendingLimit(id: string, limit: number): Promise<SubaccountSetSendingLimitResponse>;
 }

package/Types/Types/Common/RequestOptions.d.ts

@@ -4,7 +4,7 @@ import type { IPsListQuery } from '../IPs/index.js';
 import type { RoutesListQuery } from '../Routes/index.js';
 import type { SubaccountsQuery } from '../Subaccounts/index.js';
 import type { WebhooksQuery } from '../Webhooks/index.js';
-import type { ConnectionSettings, DomainCredentialsQuery, DomainGetAPIQuery, DomainsQuery, DomainTagsStatisticQuery, DomainTemplatesQuery, TemplateQuery } from '../Domains/index.js';
+import type { ConnectionSettings, DeletedDomainKeysQuery, DomainCredentialsQuery, DomainGetAPIQuery, DomainsQuery, DomainTagsStatisticQuery, DomainTemplatesQuery, TemplateQuery } from '../Domains/index.js';
 import type { InboxPlacementsData, InboxPlacementsResultsApiQuery, SeedsListsAPIQuery, SeedsListsUpdatingData } from '../InboxPlacements/index.js';
 import type { ValidationQuery } from '../Validations/index.js';
 import type { IpPoolDeleteData } from '../IPPools/index.js';
@@ -35,6 +35,7 @@ export type OnCallRequestOptions = {
 export type GetQueryTypes = IPsListQuery | RoutesListQuery | SubaccountsQuery | WebhooksQuery | DomainsQuery | DomainGetAPIQuery | DomainCredentialsQuery | DomainTagsStatisticQuery | TemplateQuery | DomainTemplatesQuery | InboxPlacementsResultsApiQuery | SeedsListsAPIQuery | {
     searchParams?: Array<Array<string>>;
 } | ValidationQuery;
+export type DeleteQueryTypes = DeletedDomainKeysQuery;
 export type PostDataTypes = InboxPlacementsData | MetricsQuery | string;
 export type PutDataTypes = SeedsListsUpdatingData | object | FormDataInput | ConnectionSettings;
 export type RequestData = IpPoolDeleteData | PostDataTypes | PutDataTypes | NodeFormData | FormData;
@@ -43,17 +44,19 @@ type EnableQuery = ContainsPrefix<'enabled='>;
 type DkimSelectorQuery = ContainsPrefix<'dkim_selector='>;
 type SelfQuery = ContainsPrefix<'self='>;
 type WebPrefixQuery = ContainsPrefix<'web_prefix='>;
-export type PutQueryTypes = EnableQuery | DkimSelectorQuery | SelfQuery | WebPrefixQuery;
+type LimitQuery = ContainsPrefix<'limit='>;
+export type PutQueryTypes = EnableQuery | DkimSelectorQuery | SelfQuery | WebPrefixQuery | LimitQuery;
 export type PutOptionsType = {
     query?: PutQueryTypes;
 };
 export type CommandQuery = {
-    query?: PutQueryTypes;
+    query?: PutQueryTypes | DeleteQueryTypes;
 };
 export type onCallReqConfig = {
     isFormURLEncoded?: boolean;
     isMultipartFormData?: boolean;
     isApplicationJSON?: boolean;
     dataSize?: number;
+    isStorageAPI?: boolean;
 };
 export {};

package/Types/Types/Domains/DomainKeys.d.ts

@@ -0,0 +1,70 @@
+import type { PagesList, ParsedPagesList } from '../index.js';
+import type { DNSRecord } from './index.js';
+export type DomainKeyItem = {
+    'signing_domain': string;
+    selector: string;
+    'dns_record': Omit<DNSRecord, 'priority'> & {
+        'is_active': boolean;
+    };
+};
+export type DomainKeyCreateDataResult = Omit<DomainKeyItem, 'dns_record'> & {
+    'dns_record': Omit<DNSRecord, 'priority'> & {
+        'is_active': boolean;
+    };
+    status: number;
+};
+export type DomainKeyCreateData = {
+    signingDomain: string;
+    selector: string;
+    bits?: '1024' | '2048';
+    pem?: string;
+};
+export type DomainKeyCreateDataApi = Omit<DomainKeyCreateData, 'signingDomain'> & {
+    'signing_domain': string;
+};
+export type DomainKeysList = {
+    items: DomainKeyItem[];
+};
+export type DomainKeysListResult = {
+    items: DomainKeyItem[];
+    status: number;
+};
+export type DomainKeysListAllQuery = {
+    page?: string;
+    limit?: number;
+    signingDomain?: string;
+    selector?: string;
+};
+export type DomainKeysListAllResult = {
+    items: DomainKeyItem[];
+    status: number;
+    pages: ParsedPagesList;
+};
+export type DomainKeysListAllApi = {
+    status: number;
+    body: {
+        items: DomainKeyItem[];
+        paging: PagesList;
+    };
+};
+export type DeletedDomainKeysQuery = {
+    'signing_domain': string;
+    selector: string;
+};
+export type DeletedDomainKeysResult = {
+    message: string;
+};
+export type ActivateDomainKeyResponse = {
+    message: string;
+    authority: string;
+    selector: string;
+    active: boolean;
+    status: number;
+};
+export type DeactivateDomainKeyResponse = {
+    message: string;
+    authority: string;
+    selector: string;
+    active: boolean;
+    status: number;
+};

package/Types/Types/Domains/index.d.ts

@@ -3,3 +3,4 @@ export * from './Domains.js';
 export * from './DomainTags.js';
 export * from './DomainTemplates.js';
 export * from './DomainTracking.js';
+export * from './DomainKeys.js';

package/Types/Types/Messages/Messages.d.ts

@@ -202,3 +202,61 @@ export type MessagesSendResult = {
     status: number;
     details?: string;
 };
+export type MessageHeader = [string, string];
+export type StoredEmailResponse = {
+    'Content-Type': string;
+    From: string;
+    'Message-Id': string;
+    'Mime-Version': string;
+    Subject: string;
+    To: string;
+    sender: string;
+    recipients: string;
+    from?: string;
+    subject?: string;
+    'body-html': string;
+    'body-plain': string;
+    attachments?: [
+        {
+            name: string;
+            'content-type': string;
+            size: number;
+            url: string;
+        }
+    ];
+    'content-id-map'?: object;
+    'message-headers': MessageHeader[];
+    'stripped-html': string;
+    'stripped-text': string;
+    'stripped-signature': string;
+    'Content-Transfer-Encoding'?: string;
+    'X-Mailgun-Tag'?: string;
+    'X-Mailgun-Template-Name'?: string;
+    'X-Mailgun-Template-Variables'?: string;
+    'X-Mailgun-Deliver-By'?: string;
+};
+type QueueStatusAPI = {
+    'is_disabled': boolean;
+    disabled: {
+        until: string;
+        reason: string;
+    };
+};
+type QueueStatus = Omit<QueueStatusAPI, 'disabled'> & {
+    disabled: {
+        until: Date | '';
+        reason: string;
+    };
+};
+export type MessagesQueueStatusAPIResponse = {
+    regular: QueueStatusAPI;
+    scheduled: QueueStatusAPI;
+};
+export type MessagesQueueStatusResult = {
+    regular: QueueStatus;
+    scheduled: QueueStatus;
+};
+export type ClearMessagesQueueResult = {
+    message: string;
+};
+export {};

package/Types/Types/Subaccounts/Subaccounts.d.ts

@@ -4,15 +4,64 @@ export type SubaccountsQuery = {
     skip?: number;
     sort?: 'asc' | 'desc';
 };
-export type SubaccountListItem = {
+export type SubaccountFeatureValue = {
+    enabled: boolean;
+};
+export type SubaccountFeatures = {
+    email_preview?: SubaccountFeatureValue;
+    inbox_placement?: SubaccountFeatureValue;
+    sending?: SubaccountFeatureValue;
+    validations?: SubaccountFeatureValue;
+    validations_bulk?: SubaccountFeatureValue;
+};
+export type SubaccountFeaturesResult = {
+    features: SubaccountFeatures;
+};
+export type SubaccountFeaturesData = {
+    email_preview?: boolean;
+    inbox_placement?: boolean;
+    sending?: boolean;
+    validations?: boolean;
+    validations_bulk?: boolean;
+};
+export type SubaccountApiItem = {
     id: string;
     name: string;
     status: string;
+    created_at: string;
+    updated_at: string;
+    features: SubaccountFeatures;
+};
+export type SubaccountItem = Omit<SubaccountApiItem, 'created_at' | 'updated_at'> & {
+    created_at: Date;
+    updated_at: Date;
+};
+export type SubaccountListAPIResponseData = {
+    body: {
+        subaccounts: SubaccountApiItem[];
+        total: number;
+    };
 };
 export type SubaccountListResponseData = {
-    subaccounts: SubaccountListItem[];
+    subaccounts: SubaccountItem[];
     total: number;
 };
+export type SubaccountAPIResponseData = {
+    body: {
+        subaccount: SubaccountApiItem;
+    };
+};
 export type SubaccountResponseData = {
-    subaccount: SubaccountListItem;
+    subaccount: SubaccountItem;
+};
+export type SubaccountSendingLimitResponse = {
+    limit: number;
+    current: number;
+    period: string;
+};
+export type SubaccountSetSendingLimitResponse = {
+    success: boolean;
+};
+export type SubaccountDestroyResponse = {
+    message: string;
 };