mailgun.js 10.4.0 → 11.1.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.
 
+## [11.1.0](https://github.com/mailgun/mailgun.js/compare/v11.0.0...v11.1.0) (2025-01-09)
+
+
+### Features
+
+* Adding Secure Tracking API support ([b5ff1e0](https://github.com/mailgun/mailgun.js/commits/b5ff1e0a4c6982b302add9b25712818082a62fd0))
+
+## [11.0.0](https://github.com/mailgun/mailgun.js/compare/v10.4.0...v11.0.0) (2025-01-09)
+
+
+### Other changes
+
+* Update readme by domain templates ([8e12c86](https://github.com/mailgun/mailgun.js/commits/8e12c867e3b9e34cd43ccb59d1b94bf69e2a0a03))
+
+
+### Breaking changes
+
+* Update domains client to use v4 of API ([a2efc8c](https://github.com/mailgun/mailgun.js/commits/a2efc8c9e45cde9376af7bb2df467d9a45260f7d))
+
 ## [10.4.0](https://github.com/mailgun/mailgun.js/compare/v10.3.0...v10.4.0) (2024-12-30)
 
 

package/Classes/Domains/domain.d.ts

@@ -1,4 +1,4 @@
-import { DNSRecord, DomainData, DomainShortData, TDomain } from '../../Types/Domains';
+import { DNSRecord, DomainData, TDomain } from '../../Types/Domains';
 export default class Domain implements TDomain {
     name: string;
     require_tls: boolean;
@@ -6,15 +6,18 @@ export default class Domain implements 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;
-    constructor(data: DomainShortData | DomainData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
+    id: string;
+    is_disabled: boolean;
+    web_prefix: string;
+    web_scheme: string;
+    use_automatic_sender_security: boolean;
+    dkim_host?: string;
+    mailfrom_host?: string;
+    constructor(data: DomainData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
 }

package/Classes/Domains/domainsClient.d.ts

@@ -1,38 +1,66 @@
 import { IDomainTemplatesClient, IDomainTagsClient, IDomainCredentials, IDomainsClient } from '../../Interfaces/Domains';
 import { APIResponse } from '../../Types/Common/ApiResponse';
 import Request from '../common/Request';
-import DomainCredentialsClient from './domainsCredentials';
-import DomainTemplatesClient from './domainsTemplates';
-import DomainTagsClient from './domainsTags';
-import { MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse, TDomain, DomainUpdateInfo } from '../../Types/Domains';
+import { MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, WebPrefixInfo, UpdatedWebPrefixResponse, TDomain, DomainUpdateInfo, DomainGetQuery, UpdatedDKIMSelectorResult } from '../../Types/Domains';
+import { ILogger, IDomainTrackingClient } from '../../Interfaces';
 export default class DomainsClient implements IDomainsClient {
     request: Request;
     domainCredentials: IDomainCredentials;
     domainTemplates: IDomainTemplatesClient;
     domainTags: IDomainTagsClient;
-    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient, domainTemplatesClient: DomainTemplatesClient, domainTagsClient: DomainTagsClient);
+    domainTracking: IDomainTrackingClient;
+    private logger;
+    constructor(request: Request, domainCredentialsClient: IDomainCredentials, domainTemplatesClient: IDomainTemplatesClient, domainTagsClient: IDomainTagsClient, domainTracking: IDomainTrackingClient, logger?: ILogger);
     private _handleBoolValues;
     private _parseMessage;
     private parseDomainList;
     private _parseDomain;
-    private _parseTrackingSettings;
-    private _parseTrackingUpdate;
     list(query?: DomainsQuery): Promise<TDomain[]>;
-    get(domain: string): Promise<TDomain>;
+    get(domain: string, query?: DomainGetQuery): Promise<TDomain>;
     create(data: DomainInfo): Promise<TDomain>;
     update(domain: string, data: DomainUpdateInfo): Promise<TDomain>;
     verify(domain: string): Promise<TDomain>;
     destroy(domain: string): Promise<MessageResponse>;
     getConnection(domain: string): Promise<ConnectionSettings>;
     updateConnection(domain: string, data: ConnectionSettings): Promise<UpdatedConnectionSettings>;
+    /**
+    * @deprecated 'domains.getTracking' method is deprecated, and will be removed.
+    * Please use 'domains.domainTracking.getTracking' instead.
+    */
     getTracking(domain: string): Promise<DomainTrackingData>;
+    /**
+    * @deprecated 'domains.updateTracking' method is deprecated, and will be removed.
+    * Please use 'domains.domainTracking.updateTracking' instead.
+    */
     updateTracking(domain: string, type: string, data: OpenTrackingInfo | ClickTrackingInfo | UnsubscribeTrackingInfo): Promise<UpdatedOpenTracking>;
+    /**
+    * @deprecated "domains.getIps" method is deprecated, and will be removed in the future releases.
+    */
     getIps(domain: string): Promise<string[]>;
+    /**
+    * @deprecated "domains.assignIp" method is deprecated, and will be removed in the future releases.
+    */
     assignIp(domain: string, ip: string): Promise<APIResponse>;
+    /**
+    * @deprecated "domains.deleteIp" method is deprecated, and will be moved to the IpsClient.
+    */
     deleteIp(domain: string, ip: string): Promise<APIResponse>;
+    /**
+    * @deprecated "domains.linkIpPool" method is deprecated, and will be removed
+    * in the future releases.
+    */
     linkIpPool(domain: string, poolId: string): Promise<APIResponse>;
+    /**
+    * @deprecated "domains.unlinkIpPoll" method is deprecated, and will be moved into the IpsClient
+    * in the future releases.
+    */
     unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
     updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
-    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResponse>;
+    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResult>;
+    /**
+    * @deprecated "domains.updateWebPrefix" method is deprecated.
+    * Please use domains.update to set new "web_prefix".
+    * Current method will be removed in the future releases.
+    */
     updateWebPrefix(domain: string, data: WebPrefixInfo): Promise<UpdatedWebPrefixResponse>;
 }

package/Classes/Domains/domainsTemplates.d.ts

@@ -29,9 +29,9 @@ export default class DomainTemplatesClient extends NavigationThruPages<ListDomai
     update(domain: string, templateName: string, data: DomainTemplateUpdateData): Promise<UpdateOrDeleteDomainTemplateResult>;
     destroy(domain: string, templateName: string): Promise<UpdateOrDeleteDomainTemplateResult>;
     destroyAll(domain: string): Promise<NotificationResult>;
-    createVersion(domain: string, templateName: string, data: DomainTemplateVersionData): Promise<CreateDomainTemplateVersionResult>;
+    listVersions(domain: string, templateName: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplateVersionsResult>;
     getVersion(domain: string, templateName: string, tag: string): Promise<IDomainTemplate>;
+    createVersion(domain: string, templateName: string, data: DomainTemplateVersionData): Promise<CreateDomainTemplateVersionResult>;
     updateVersion(domain: string, templateName: string, tag: string, data: DomainTemplateUpdateVersionData): Promise<MutateDomainTemplateVersionResult>;
     destroyVersion(domain: string, templateName: string, tag: string): Promise<MutateDomainTemplateVersionResult>;
-    listVersions(domain: string, templateName: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplateVersionsResult>;
 }

package/Classes/Domains/domainsTracking.d.ts

@@ -0,0 +1,15 @@
+import { IDomainTrackingClient } from '../../Interfaces';
+import { ClickTrackingInfo, DomainTrackingData, GenerateDomainTrackingCertificateResponse, GetDomainTrackingCertificateResponse, OpenTrackingInfo, RegenerateDomainTrackingCertificateResponse, UnsubscribeTrackingInfo, UpdatedOpenTracking } from '../../Types';
+import Request from '../common/Request';
+export default class DomainTrackingClient implements IDomainTrackingClient {
+    request: Request;
+    constructor(request: Request);
+    private _parseTrackingSettings;
+    private _parseTrackingUpdate;
+    private _isOpenTrackingInfoWitPlace;
+    get(domain: string): Promise<GetDomainTrackingCertificateResponse>;
+    generate(domain: string): Promise<GenerateDomainTrackingCertificateResponse>;
+    regenerate(domain: string): Promise<RegenerateDomainTrackingCertificateResponse>;
+    getTracking(domain: string): Promise<DomainTrackingData>;
+    updateTracking(domain: string, type: string, data: OpenTrackingInfo | ClickTrackingInfo | UnsubscribeTrackingInfo): Promise<UpdatedOpenTracking>;
+}

package/Interfaces/Domains/DomainTracking.d.ts

@@ -0,0 +1,8 @@
+import { ClickTrackingInfo, DomainTrackingData, GenerateDomainTrackingCertificateResponse, GetDomainTrackingCertificateResponse, OpenTrackingInfo, RegenerateDomainTrackingCertificateResponse, UnsubscribeTrackingInfo, UpdatedOpenTracking } from '../../Types';
+export interface IDomainTrackingClient {
+    get(domain: string): Promise<GetDomainTrackingCertificateResponse>;
+    generate(domain: string): Promise<GenerateDomainTrackingCertificateResponse>;
+    regenerate(domain: string): Promise<RegenerateDomainTrackingCertificateResponse>;
+    getTracking(domain: string): Promise<DomainTrackingData>;
+    updateTracking(domain: string, type: string, data: OpenTrackingInfo | ClickTrackingInfo | UnsubscribeTrackingInfo): Promise<UpdatedOpenTracking>;
+}

package/Interfaces/Domains/DomainsClient.d.ts

@@ -1,14 +1,16 @@
 import { APIResponse } from '../../Types/Common';
-import { ClickTrackingInfo, ConnectionSettings, DKIMAuthorityInfo, DKIMSelectorInfo, DomainInfo, DomainsQuery, DomainTrackingData, DomainUpdateInfo, MessageResponse, OpenTrackingInfo, ReplacementForPool, TDomain, UnsubscribeTrackingInfo, UpdatedConnectionSettings, UpdatedDKIMAuthority, UpdatedDKIMSelectorResponse, UpdatedOpenTracking, UpdatedWebPrefixResponse, WebPrefixInfo } from '../../Types/Domains';
+import { ClickTrackingInfo, ConnectionSettings, DKIMAuthorityInfo, DKIMSelectorInfo, DomainGetQuery, DomainInfo, DomainsQuery, DomainTrackingData, DomainUpdateInfo, MessageResponse, OpenTrackingInfo, ReplacementForPool, TDomain, UnsubscribeTrackingInfo, UpdatedConnectionSettings, UpdatedDKIMAuthority, UpdatedDKIMSelectorResult, UpdatedOpenTracking, UpdatedWebPrefixResponse, WebPrefixInfo } from '../../Types/Domains';
 import { IDomainCredentials } from './DomainCredentials';
 import { IDomainTagsClient } from './DomainTags';
 import { IDomainTemplatesClient } from './DomainTemplates';
+import { IDomainTrackingClient } from './DomainTracking';
 export interface IDomainsClient {
     domainCredentials: IDomainCredentials;
     domainTemplates: IDomainTemplatesClient;
     domainTags: IDomainTagsClient;
+    domainTracking: IDomainTrackingClient;
     list(query?: DomainsQuery): Promise<TDomain[]>;
-    get(domain: string): Promise<TDomain>;
+    get(domain: string, query?: DomainGetQuery): Promise<TDomain>;
     create(data: DomainInfo): Promise<TDomain>;
     update(domain: string, data: DomainUpdateInfo): Promise<TDomain>;
     verify(domain: string): Promise<TDomain>;
@@ -23,6 +25,6 @@ export interface IDomainsClient {
     linkIpPool(domain: string, pool_id: string): Promise<APIResponse>;
     unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
     updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
-    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResponse>;
+    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResult>;
     updateWebPrefix(domain: string, data: WebPrefixInfo): Promise<UpdatedWebPrefixResponse>;
 }

package/Interfaces/Domains/index.d.ts

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