mailgun.js 8.2.2 → 9.0.1

package/CHANGELOG.md

@@ -2,6 +2,72 @@
 
 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.
 
+### [9.0.1](https://github.com/mailgun/mailgun.js/compare/v9.0.0...v9.0.1) (2023-06-06)
+
+
+### Bug Fixes
+
+* Add public properties to IDomainsClient interface ([f4ca325](https://github.com/mailgun/mailgun.js/commits/f4ca3253c9042cd67739024cc6096996dbdcd026))
+* Add public properties to IMailListsMembers interface ([0782c8d](https://github.com/mailgun/mailgun.js/commits/0782c8d3d04b520cce6eaec51231089ba44864a1))
+* Add public properties to IMultipleValidationClient interface ([f1fd614](https://github.com/mailgun/mailgun.js/commits/f1fd6142c5ccbf5b772ce91d51d165fcb867af54))
+
+
+### Other changes
+
+* Add tests for IDomainsClient public props ([8f1b81e](https://github.com/mailgun/mailgun.js/commits/8f1b81e663d4c26f16e22b3073045abf98061f14))
+
+## [9.0.0](https://github.com/mailgun/mailgun.js/compare/v8.2.2...v9.0.0) (2023-05-29)
+
+
+### ⚠ BREAKING CHANGES
+
+* Types available as a named import from the package
+* Add missing types and interfaces
+* Move StatsClient and StatsContainer classes to different files
+* Move rest of the types to appropriate folders
+* Move common types to another folder
+* Move Validations types to another folder
+* Move Suppressions types to another folder
+* Move MailingLists types to another folder
+* Move domains types to another folder
+* WebhookClient class renamed to WebhooksClient
+* Client class renamed to MailgunClient
+* Options interfase renamed to MailgunClientOptions
+
+### Features
+
+* Add missing types and interfaces ([ea4f289](https://github.com/mailgun/mailgun.js/commits/ea4f2898c93504354c57eb26bf6264dbfdec80e2))
+* Add types,enums, and interfaces to default export from SDK ([6ccc043](https://github.com/mailgun/mailgun.js/commits/6ccc0433569cb55de48125a527cf6d527f329c6f))
+* TS version update ([8523c11](https://github.com/mailgun/mailgun.js/commits/8523c118e2320e13a2d4ce430bbef1d9756dc082))
+* Types available as a named import from the package ([adf93c8](https://github.com/mailgun/mailgun.js/commits/adf93c81391f2224a11432739c0caa75c6c7079b))
+
+
+### Breaking changes
+
+* Group enums to own folder ([306e19a](https://github.com/mailgun/mailgun.js/commits/306e19a56c97ce03c9b8af5fc6363a0726864c61))
+* Group related Classes and Interfaces to folders ([8d785fa](https://github.com/mailgun/mailgun.js/commits/8d785fa1fd6232dca4651b8f38666192369961c3))
+* Move common types to another folder ([d31b802](https://github.com/mailgun/mailgun.js/commits/d31b8026799d5d2d66a940cccb9973e6e78e6681))
+* Move domains types to another folder ([6f5b479](https://github.com/mailgun/mailgun.js/commits/6f5b479d8e03c3e2ba3b40dc6f31982e20f87a47))
+* Move MailingLists types to another folder ([416e7be](https://github.com/mailgun/mailgun.js/commits/416e7be1860e2ce7883fadcbf7d124be23b3bf5b))
+* Move rest of the types to appropriate folders ([4c0c81a](https://github.com/mailgun/mailgun.js/commits/4c0c81a8da036f438cb549d741b6322e8653367a))
+* Move StatsClient and StatsContainer classes to different files ([bfc25cf](https://github.com/mailgun/mailgun.js/commits/bfc25cf9ff926657b73e8dc7c7593f67ec9e2dc7))
+* Move Suppressions types to another folder ([efd2e92](https://github.com/mailgun/mailgun.js/commits/efd2e929b82200bfca7407e424069462a543b7da))
+* Move Validations types to another folder ([a64112a](https://github.com/mailgun/mailgun.js/commits/a64112aa32c8f03b8dd8e467f5a87e9e1a2d4b49))
+
+
+### Other changes
+
+* Add typedock generation step to release ([d7afc0e](https://github.com/mailgun/mailgun.js/commits/d7afc0ea06db5b38f228f1beb32aeeee1b925dd5))
+* Decrease number of eslint warnings ([c372344](https://github.com/mailgun/mailgun.js/commits/c37234443a4a853ac5a668a32ddd140d8bc3d6a9))
+* Merge branch 'master' into expose-types ([53f6435](https://github.com/mailgun/mailgun.js/commits/53f643512686619506cebf8fe59bb546306d6263))
+* Move suppressions classes to different files ([2b692de](https://github.com/mailgun/mailgun.js/commits/2b692deb2b7acb11cb3ce189342d751844d441b5))
+* Rename suppressions.ts file to SuppressionClient.ts ([b3ba0ac](https://github.com/mailgun/mailgun.js/commits/b3ba0acc90111d953f2278b4c0d49729cd649c8b))
+* Update interfaces folder name to be Interfaces in dist ([0b22bcd](https://github.com/mailgun/mailgun.js/commits/0b22bcd6be02b111a1030df2b0d3c0ae6d491e3c))
+* Update readme one more time ([0f5a98b](https://github.com/mailgun/mailgun.js/commits/0f5a98b507d2dca3668d2efda05c0aa7d42a1043))
+* Update registry for npm ([3175093](https://github.com/mailgun/mailgun.js/commits/3175093de9501eb5976387a31c237fdd349da1fd))
+* Update ts-loader and ts-node ([d6b0ba0](https://github.com/mailgun/mailgun.js/commits/d6b0ba0b96a9346a7f7347c0b2ddb40bee16a608))
+* Update Typedoc documentation ([6ae20c2](https://github.com/mailgun/mailgun.js/commits/6ae20c2b82968ac89c4bd01e1a8c45c122c5445e))
+
 ### [8.2.2](https://github.com/mailgun/mailgun.js/compare/v8.2.1...v8.2.2) (2023-05-26)
 
 

package/Classes/Domains/domain.d.ts

@@ -0,0 +1,16 @@
+import { DNSRecord, DomainShortData, TDomain } from '../../Types/Domains';
+export default class Domain implements 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;
+    constructor(data: DomainShortData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
+}

package/{domains.d.ts → Classes/Domains/domains.d.ts}

@@ -1,13 +1,10 @@
-import { DomainsQuery, DomainInfo, DomainShortData, DNSRecord, ConnectionSettings, UpdatedConnectionSettings, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse, ReplacementForPool, MessageResponse } from './interfaces/Domains';
-import APIResponse from './interfaces/ApiResponse';
-import Request from './request';
-import { DomainTrackingData, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, UpdatedOpenTracking } from './interfaces/DomainTracking';
-import { IDomainCredentials } from './interfaces/DomainCredentials';
-import { IDomainTemplatesClient } from './interfaces/DomainTemplates';
+import { IDomainTemplatesClient, IDomainTagsClient, IDomainCredentials, IDomainClient } from '../../Interfaces/Domains';
+import { APIResponse } from '../../Types/Common/ApiResponse';
+import Request from '../common/Request';
 import DomainCredentialsClient from './domainsCredentials';
 import DomainTemplatesClient from './domainsTemplates';
-import { IDomainTagsClient } from './interfaces/DomainTags';
 import DomainTagsClient from './domainsTags';
+import { DNSRecord, DomainShortData, MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse } from '../../Types/Domains';
 export declare class Domain {
     name: string;
     require_tls: boolean;
@@ -23,7 +20,7 @@ export declare class Domain {
     sending_dns_records: DNSRecord[] | null;
     constructor(data: DomainShortData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
 }
-export default class DomainClient {
+export default class DomainClient implements IDomainClient {
     request: Request;
     domainCredentials: IDomainCredentials;
     domainTemplates: IDomainTemplatesClient;

package/Classes/Domains/domainsClient.d.ts

@@ -0,0 +1,36 @@
+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 } from '../../Types/Domains';
+export default class DomainsClient implements IDomainsClient {
+    request: Request;
+    domainCredentials: IDomainCredentials;
+    domainTemplates: IDomainTemplatesClient;
+    domainTags: IDomainTagsClient;
+    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient, domainTemplatesClient: DomainTemplatesClient, domainTagsClient: DomainTagsClient);
+    private _parseMessage;
+    private parseDomainList;
+    private _parseDomain;
+    private _parseTrackingSettings;
+    private _parseTrackingUpdate;
+    list(query?: DomainsQuery): Promise<TDomain[]>;
+    get(domain: string): Promise<TDomain>;
+    create(data: DomainInfo): Promise<TDomain>;
+    verify(domain: string): Promise<TDomain>;
+    destroy(domain: string): Promise<MessageResponse>;
+    getConnection(domain: string): Promise<ConnectionSettings>;
+    updateConnection(domain: string, data: ConnectionSettings): Promise<UpdatedConnectionSettings>;
+    getTracking(domain: string): Promise<DomainTrackingData>;
+    updateTracking(domain: string, type: string, data: OpenTrackingInfo | ClickTrackingInfo | UnsubscribeTrackingInfo): Promise<UpdatedOpenTracking>;
+    getIps(domain: string): Promise<string[]>;
+    assignIp(domain: string, ip: string): Promise<APIResponse>;
+    deleteIp(domain: string, ip: string): Promise<APIResponse>;
+    linkIpPool(domain: string, poolId: string): Promise<APIResponse>;
+    unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
+    updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
+    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResponse>;
+    updateWebPrefix(domain: string, data: WebPrefixInfo): Promise<UpdatedWebPrefixResponse>;
+}

package/{domainsCredentials.d.ts → Classes/Domains/domainsCredentials.d.ts}

@@ -1,5 +1,6 @@
-import Request from './request';
-import { DomainCredentials, DomainCredentialsList, DomainCredentialsQuery, DomainCredentialsResult, IDomainCredentials, UpdateDomainCredentialsData } from './interfaces/DomainCredentials';
+import { IDomainCredentials } from '../../Interfaces/Domains';
+import { DomainCredentialsList, DomainCredentialsResult, DomainCredentialsQuery, DomainCredentials, UpdateDomainCredentialsData } from '../../Types/Domains';
+import Request from '../common/Request';
 export default class DomainCredentialsClient implements IDomainCredentials {
     baseRoute: string;
     request: Request;

package/{domainsTags.d.ts → Classes/Domains/domainsTags.d.ts}

@@ -1,6 +1,8 @@
-import Request from './request';
-import { DomainTagCountriesAggregation, DomainTagDevicesAggregation, DomainTagProvidersAggregation, DomainTagsItem, DomainTagsItemInfo, DomainTagsList, DomainTagsMessageRes, DomainTagsQuery, DomainTagsResponseData, DomainTagsStatisticQuery, DomainTagStatAPIResponse, DomainTagStatisticItem, DomainTagStatisticResult, IDomainTagsClient, Resolution } from './interfaces/DomainTags';
-import NavigationThruPages from './common/NavigationThruPages';
+import Request from '../common/Request';
+import { IDomainTagStatisticResult, IDomainTagsClient } from '../../Interfaces/Domains';
+import NavigationThruPages from '../common/NavigationThruPages';
+import { Resolution } from '../../Enums';
+import { DomainTagsItem, DomainTagsItemInfo, DomainTagStatisticItem, DomainTagStatAPIResponse, DomainTagsList, DomainTagsResponseData, DomainTagsQuery, DomainTagsMessageRes, DomainTagsStatisticQuery, DomainTagCountriesAggregation, DomainTagProvidersAggregation, DomainTagDevicesAggregation } from '../../Types/Domains';
 export declare class DomainTag implements DomainTagsItem {
     tag: string;
     description: string;
@@ -8,7 +10,7 @@ export declare class DomainTag implements DomainTagsItem {
     'last-seen': Date;
     constructor(tagInfo: DomainTagsItemInfo);
 }
-export declare class DomainTagStatistic implements DomainTagStatisticResult {
+export declare class DomainTagStatistic implements IDomainTagStatisticResult {
     tag: string;
     description: string;
     start: Date;

package/{domainsTemplates.d.ts → Classes/Domains/domainsTemplates.d.ts}

@@ -1,7 +1,8 @@
-import Request from './request';
-import { CreateDomainTemplateVersionResult, DomainTemplate, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, IDomainTemplatesClient, ListDomainTemplatesAPIResponse, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateQuery, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from './interfaces/DomainTemplates';
-import NavigationThruPages from './common/NavigationThruPages';
-export declare class DomainTemplateItem implements DomainTemplate {
+import Request from '../common/Request';
+import { CreateDomainTemplateVersionResult, DomainTemplateData, DomainTemplatesQuery, DomainTemplateUpdateData, DomainTemplateUpdateVersionData, DomainTemplateVersionData, ListDomainTemplatesAPIResponse, ListDomainTemplatesResult, ListDomainTemplateVersionsResult, MutateDomainTemplateVersionResult, NotificationResult, ShortTemplateVersion, TemplateQuery, TemplateVersion, UpdateOrDeleteDomainTemplateResult } from '../../Types/Domains';
+import NavigationThruPages from '../common/NavigationThruPages';
+import { IDomainTemplate, IDomainTemplatesClient } from '../../Interfaces/Domains';
+export declare class DomainTemplateItem implements IDomainTemplate {
     name: string;
     description: string;
     createdAt: Date | '';
@@ -9,7 +10,7 @@ export declare class DomainTemplateItem implements DomainTemplate {
     id: string;
     version?: TemplateVersion;
     versions?: ShortTemplateVersion[];
-    constructor(domainTemplateFromAPI: DomainTemplate);
+    constructor(domainTemplateFromAPI: IDomainTemplate);
 }
 export default class DomainTemplatesClient extends NavigationThruPages<ListDomainTemplatesResult> implements IDomainTemplatesClient {
     baseRoute: string;
@@ -23,13 +24,13 @@ export default class DomainTemplatesClient extends NavigationThruPages<ListDomai
     protected parseList(response: ListDomainTemplatesAPIResponse): ListDomainTemplatesResult;
     private parseListTemplateVersions;
     list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult>;
-    get(domain: string, templateName: string, query?: TemplateQuery): Promise<DomainTemplateItem>;
-    create(domain: string, data: DomainTemplateData): Promise<DomainTemplateItem>;
+    get(domain: string, templateName: string, query?: TemplateQuery): Promise<IDomainTemplate>;
+    create(domain: string, data: DomainTemplateData): Promise<IDomainTemplate>;
     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>;
-    getVersion(domain: string, templateName: string, tag: string): Promise<DomainTemplateItem>;
+    getVersion(domain: string, templateName: string, tag: string): Promise<IDomainTemplate>;
     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/{events.d.ts → Classes/Events.d.ts}

@@ -1,7 +1,8 @@
 import NavigationThruPages from './common/NavigationThruPages';
-import { EventsList, EventsQuery, EventsResponse } from './interfaces/Events';
-import Request from './request';
-export default class EventClient extends NavigationThruPages<EventsList> {
+import { EventsList, EventsQuery, EventsResponse } from '../Types/Events';
+import Request from './common/Request';
+import { IEventClient } from '../Interfaces';
+export default class EventClient extends NavigationThruPages<EventsList> implements IEventClient {
     request: Request;
     constructor(request: Request);
     protected parseList(response: EventsResponse): EventsList;

package/{ip-pools.d.ts → Classes/IPPools.d.ts}

@@ -1,6 +1,7 @@
-import Request from './request';
-import { IpPoolCreateData, IpPoolCreateResult, IpPoolDeleteData, IpPoolListResult, IpPoolMessageResult, IpPoolUpdateData } from './interfaces/IpPools';
-export default class IpPoolsClient {
+import Request from './common/Request';
+import { IpPoolCreateData, IpPoolCreateResult, IpPoolDeleteData, IpPoolListResult, IpPoolMessageResult, IpPoolUpdateData } from '../Types/IPPools';
+import { IIPPoolsClient } from '../Interfaces';
+export default class IpPoolsClient implements IIPPoolsClient {
     request: Request;
     constructor(request: Request);
     list(): Promise<IpPoolListResult>;

package/Classes/IPs.d.ts

@@ -0,0 +1,10 @@
+import MgRequest from './common/Request';
+import { IpData, IPsListQuery, IpsListResponseBody } from '../Types/IPs';
+import { IIPsClient } from '../Interfaces';
+export default class IpsClient implements IIPsClient {
+    request: MgRequest;
+    constructor(request: MgRequest);
+    list(query?: IPsListQuery): Promise<IpsListResponseBody>;
+    get(ip: string): Promise<IpData>;
+    private parseIpsResponse;
+}

package/Classes/MailgunClient.d.ts

@@ -0,0 +1,18 @@
+import { MailgunClientOptions } from '../Types/MailgunClient';
+import { InputFormData } from '../Types/Common';
+import { IDomainsClient, IWebHooksClient, IMailgunClient, IMailingListsClient, IEventClient, IStatsClient, ISuppressionClient, IMessagesClient, IRoutesClient, IValidationClient, IIPsClient, IIPPoolsClient } from '../Interfaces';
+export default class MailgunClient implements IMailgunClient {
+    private request;
+    domains: IDomainsClient;
+    webhooks: IWebHooksClient;
+    events: IEventClient;
+    stats: IStatsClient;
+    suppressions: ISuppressionClient;
+    messages: IMessagesClient;
+    routes: IRoutesClient;
+    validate: IValidationClient;
+    ips: IIPsClient;
+    ip_pools: IIPPoolsClient;
+    lists: IMailingListsClient;
+    constructor(options: MailgunClientOptions, formData: InputFormData);
+}

package/{mailListMembers.d.ts → Classes/MailingLists/mailListMembers.d.ts}

@@ -1,6 +1,7 @@
-import Request from './request';
-import { MailListMembersQuery, IMailListsMembers, CreateUpdateMailListMembers, MailListMember, MultipleMembersData, DeletedMember, NewMultipleMembersResponse, MailListMembersResult, MailListMembersResponse } from './interfaces/mailListMembers';
-import NavigationThruPages from './common/NavigationThruPages';
+import Request from '../common/Request';
+import { MailListMembersQuery, CreateUpdateMailListMembers, MailListMember, MultipleMembersData, DeletedMember, NewMultipleMembersResponse, MailListMembersResult, MailListMembersResponse } from '../../Types/MailingLists';
+import NavigationThruPages from '../common/NavigationThruPages';
+import { IMailListsMembers } from '../../Interfaces/MailingLists';
 export default class MailListsMembers extends NavigationThruPages<MailListMembersResult> implements IMailListsMembers {
     baseRoute: string;
     request: Request;

package/Classes/MailingLists/mailingLists.d.ts

@@ -0,0 +1,21 @@
+import Request from '../common/Request';
+import { ListsQuery, CreateUpdateList, DestroyedList, MailingList, StartValidationResult, MailingListValidationResult, MailingListCancelValidationResult, MailingListResult, MailingListApiResponse } from '../../Types/MailingLists';
+import { IMailListsMembers } from '../../Interfaces/MailingLists/MailingListMembers';
+import NavigationThruPages from '../common/NavigationThruPages';
+import { IMailingListsClient } from '../../Interfaces';
+export default class MailingListsClient extends NavigationThruPages<MailingListResult> implements IMailingListsClient {
+    baseRoute: string;
+    request: Request;
+    members: IMailListsMembers;
+    constructor(request: Request, members: IMailListsMembers);
+    private parseValidationResult;
+    protected parseList(response: MailingListApiResponse): MailingListResult;
+    list(query?: ListsQuery): Promise<MailingListResult>;
+    get(mailListAddress: string): Promise<MailingList>;
+    create(data: CreateUpdateList): Promise<MailingList>;
+    update(mailListAddress: string, data: CreateUpdateList): Promise<MailingList>;
+    destroy(mailListAddress: string): Promise<DestroyedList>;
+    validate(mailListAddress: string): Promise<StartValidationResult>;
+    validationResult(mailListAddress: string): Promise<MailingListValidationResult>;
+    cancelValidation(mailListAddress: string): Promise<MailingListCancelValidationResult>;
+}

package/{messages.d.ts → Classes/Messages.d.ts}

@@ -1,6 +1,7 @@
-import { MailgunMessageData, MessagesSendAPIResponse, MessagesSendResult } from './interfaces/Messages';
-import Request from './request';
-export default class MessagesClient {
+import { MailgunMessageData, MessagesSendAPIResponse, MessagesSendResult } from '../Types/Messages';
+import Request from './common/Request';
+import { IMessagesClient } from '../Interfaces';
+export default class MessagesClient implements IMessagesClient {
     request: Request;
     constructor(request: Request);
     private prepareBooleanValues;

package/{routes.d.ts → Classes/Routes.d.ts}

@@ -1,6 +1,7 @@
-import { CreateUpdateRouteData, DestroyRouteResponse, Route, RoutesListQuery, UpdateRouteResponse } from './interfaces/routes';
-import Request from './request';
-export default class RoutesClient {
+import { IRoutesClient } from '../Interfaces';
+import { CreateUpdateRouteData, DestroyRouteResponse, Route, RoutesListQuery, UpdateRouteResponse } from '../Types/Routes';
+import Request from './common/Request';
+export default class RoutesClient implements IRoutesClient {
     request: Request;
     constructor(request: Request);
     list(query: RoutesListQuery): Promise<Route[]>;

package/Classes/Stats/StatsClient.d.ts

@@ -0,0 +1,14 @@
+import Request from '../common/Request';
+import { StatsQuery } from '../../Types/Stats';
+import { ILogger } from '../../Interfaces/Common';
+import { IStatsClient, IStatsContainer } from '../../Interfaces/Stats';
+export default class StatsClient implements IStatsClient {
+    request: Request;
+    private logger;
+    constructor(request: Request, logger?: ILogger);
+    private convertDateToUTC;
+    private prepareSearchParams;
+    private parseStats;
+    getDomain(domain: string, query?: StatsQuery): Promise<IStatsContainer>;
+    getAccount(query?: StatsQuery): Promise<IStatsContainer>;
+}

package/Classes/Stats/StatsContainer.d.ts

@@ -0,0 +1,9 @@
+import { IStatsContainer } from '../../Interfaces/Stats';
+import { Stat, StatsOptions } from '../../Types/Stats';
+export default class StatsContainer implements IStatsContainer {
+    start: Date;
+    end: Date;
+    resolution: string;
+    stats: Stat[];
+    constructor(data: StatsOptions);
+}

package/Classes/Suppressions/Bounce.d.ts

@@ -0,0 +1,10 @@
+import { IBounce } from '../../Interfaces/Suppressions';
+import { BounceData } from '../../Types/Suppressions';
+import Suppression from './Suppression';
+export default class Bounce extends Suppression implements IBounce {
+    address: string;
+    code: number;
+    error: string;
+    created_at: Date;
+    constructor(data: BounceData);
+}

package/Classes/Suppressions/Complaint.d.ts

@@ -0,0 +1,8 @@
+import { IComplaint } from '../../Interfaces/Suppressions';
+import { ComplaintData } from '../../Types/Suppressions';
+import Suppression from './Suppression';
+export default class Complaint extends Suppression implements IComplaint {
+    address: string;
+    created_at: Date;
+    constructor(data: ComplaintData);
+}

package/Classes/Suppressions/Suppression.d.ts

@@ -0,0 +1,5 @@
+import { SuppressionModels } from '../../Enums';
+export default class Suppression {
+    type: string;
+    constructor(type: SuppressionModels);
+}

package/Classes/Suppressions/SuppressionsClient.d.ts

@@ -0,0 +1,23 @@
+import Request from '../common/Request';
+import NavigationThruPages from '../common/NavigationThruPages';
+import Suppression from './Suppression';
+import { IBounce, IComplaint, ISuppressionClient, IUnsubscribe, IWhiteList } from '../../Interfaces/Suppressions';
+import { SuppressionList, SuppressionListResponse, SuppressionDataType, SuppressionCreationData, SuppressionCreationResult, SuppressionListQuery, SuppressionDestroyResult } from '../../Types/Suppressions';
+export default class SuppressionClient extends NavigationThruPages<SuppressionList> implements ISuppressionClient {
+    request: Request;
+    models: Map<string, any>;
+    constructor(request: Request);
+    protected parseList(response: SuppressionListResponse, Model: {
+        new (data: SuppressionDataType): IBounce | IComplaint | IUnsubscribe | IWhiteList;
+    }): SuppressionList;
+    _parseItem<T extends Suppression>(data: SuppressionDataType, Model: {
+        new (dataType: SuppressionDataType): T;
+    }): T;
+    private createWhiteList;
+    private checkType;
+    private prepareResponse;
+    list(domain: string, type: string, query?: SuppressionListQuery): Promise<SuppressionList>;
+    get(domain: string, type: string, address: string): Promise<IBounce | IComplaint | IUnsubscribe | IWhiteList>;
+    create(domain: string, type: string, data: SuppressionCreationData | SuppressionCreationData[]): Promise<SuppressionCreationResult>;
+    destroy(domain: string, type: string, address: string): Promise<SuppressionDestroyResult>;
+}

package/Classes/Suppressions/Unsubscribe.d.ts

@@ -0,0 +1,9 @@
+import { IUnsubscribe } from '../../Interfaces/Suppressions';
+import { UnsubscribeData } from '../../Types/Suppressions';
+import Suppression from './Suppression';
+export default class Unsubscribe extends Suppression implements IUnsubscribe {
+    address: string;
+    tags: string[];
+    created_at: Date;
+    constructor(data: UnsubscribeData);
+}

package/Classes/Suppressions/WhiteList.d.ts

@@ -0,0 +1,9 @@
+import { IWhiteList } from '../../Interfaces/Suppressions';
+import { WhiteListData } from '../../Types/Suppressions';
+import Suppression from './Suppression';
+export default class WhiteList extends Suppression implements IWhiteList {
+    value: string;
+    reason: string;
+    createdAt: Date;
+    constructor(data: WhiteListData);
+}

package/{multipleValidation.d.ts → Classes/Validations/multipleValidation.d.ts}

@@ -1,6 +1,7 @@
-import NavigationThruPages from './common/NavigationThruPages';
-import { CanceledMultipleValidationJob, CreatedMultipleValidationJob, IMultipleValidationClient, MultipleValidationCreationData, MultipleValidationJobsListResult, MultipleValidationJobsListResponse, MultipleValidationJobData, MultipleValidationJobResult, MultipleValidationJobsListQuery } from './interfaces/MultipleValidation';
-import Request from './request';
+import NavigationThruPages from '../common/NavigationThruPages';
+import Request from '../common/Request';
+import { IMultipleValidationClient } from '../../Interfaces/Validations';
+import { MultipleValidationJobResult, MultipleValidationJobData, MultipleValidationJobsListResult, MultipleValidationJobsListResponse, MultipleValidationJobsListQuery, MultipleValidationCreationData, CreatedMultipleValidationJob, CanceledMultipleValidationJob } from '../../Types/Validations/MultipleValidation';
 export declare class MultipleValidationJob implements MultipleValidationJobResult {
     createdAt: Date;
     id: string;

package/Classes/Validations/validate.d.ts

@@ -0,0 +1,9 @@
+import { IValidationClient, IMultipleValidationClient } from '../../Interfaces/Validations';
+import { ValidationResult } from '../../Types/Validations';
+import Request from '../common/Request';
+export default class ValidateClient implements IValidationClient {
+    multipleValidation: IMultipleValidationClient;
+    request: Request;
+    constructor(request: Request, multipleValidationClient: IMultipleValidationClient);
+    get(address: string): Promise<ValidationResult>;
+}

package/Classes/Webhooks.d.ts

@@ -0,0 +1,21 @@
+import { WebhooksIds } from '../Enums';
+import { IWebHooksClient } from '../Interfaces/Webhooks';
+import { WebhookValidationResponse, WebhookList, WebhookResponse, WebhooksQuery, WebhookResult } from '../Types/Webhooks';
+import Request from './common/Request';
+export declare class Webhook implements WebhookResult {
+    id: string;
+    url: string | undefined;
+    constructor(id: string, url: string | undefined);
+}
+export default class WebhooksClient implements IWebHooksClient {
+    request: Request;
+    constructor(request: Request);
+    private _parseWebhookList;
+    _parseWebhookWithID(id: string): (response: WebhookResponse) => WebhookResult;
+    private _parseWebhookTest;
+    list(domain: string, query: WebhooksQuery): Promise<WebhookList>;
+    get(domain: string, id: WebhooksIds): Promise<WebhookResult>;
+    create(domain: string, id: string, url: string, test?: boolean): Promise<WebhookResult | WebhookValidationResponse>;
+    update(domain: string, id: string, url: string): Promise<WebhookResult>;
+    destroy(domain: string, id: string): Promise<WebhookResult>;
+}

package/Classes/common/Error.d.ts

@@ -0,0 +1,8 @@
+import { APIErrorOptions, APIErrorType } from '../../Types/Common';
+export default class APIError extends Error implements APIErrorType {
+    status: number;
+    stack: string;
+    details: string;
+    type: string;
+    constructor({ status, statusText, message, body }: APIErrorOptions);
+}

package/{formDataBuilder.d.ts → Classes/common/FormDataBuilder.d.ts}

@@ -1,5 +1,5 @@
 import * as NodeFormData from 'form-data';
-import { InputFormData } from './interfaces/IFormData';
+import { InputFormData } from '../../Types/Common';
 declare class FormDataBuilder {
     private FormDataConstructor;
     constructor(FormDataConstructor: InputFormData);

package/Classes/common/NavigationThruPages.d.ts

@@ -0,0 +1,17 @@
+import { ParsedPage, ParsedPagesList, QueryWithPage, ResponseWithPaging } from '../../Types/Common';
+import { IBounce, IComplaint, IUnsubscribe, IWhiteList } from '../../Interfaces/Suppressions';
+import Request from './Request';
+import { SuppressionDataType } from '../../Types/Suppressions';
+export default abstract class NavigationThruPages<T> {
+    request?: Request;
+    constructor(request?: Request);
+    protected parsePage(id: string, pageUrl: string, urlSeparator: string, iteratorName: string | undefined): ParsedPage;
+    protected parsePageLinks(response: ResponseWithPaging, urlSeparator: string, iteratorName?: string): ParsedPagesList;
+    private updateUrlAndQuery;
+    protected requestListWithPages(clientUrl: string, query?: QueryWithPage, Model?: {
+        new (data: SuppressionDataType): IBounce | IComplaint | IUnsubscribe | IWhiteList;
+    }): Promise<T>;
+    protected abstract parseList(response: ResponseWithPaging, Model?: {
+        new (data: SuppressionDataType): IBounce | IComplaint | IUnsubscribe | IWhiteList;
+    }): T;
+}

package/{request.d.ts → Classes/common/Request.d.ts}

@@ -1,8 +1,6 @@
 import * as NodeFormData from 'form-data';
-import { RequestOptions } from './interfaces/RequestOptions';
-import { InputFormData } from './interfaces/IFormData';
-import APIResponse from './interfaces/ApiResponse';
-import { IpPoolDeleteData } from './interfaces/IpPools';
+import { RequestOptions, InputFormData, APIResponse } from '../../Types/Common';
+import { IpPoolDeleteData } from '../../Types/IPPools';
 declare class Request {
     private username;
     private key;

package/Enums/index.d.ts

@@ -0,0 +1,24 @@
+export declare enum Resolution {
+    HOUR = "hour",
+    DAY = "day",
+    MONTH = "month"
+}
+export declare enum SuppressionModels {
+    BOUNCES = "bounces",
+    COMPLAINTS = "complaints",
+    UNSUBSCRIBES = "unsubscribes",
+    WHITELISTS = "whitelists"
+}
+export declare enum WebhooksIds {
+    CLICKED = "clicked",
+    COMPLAINED = "complained",
+    DELIVERED = "delivered",
+    OPENED = "opened",
+    PERMANENT_FAIL = "permanent_fail",
+    TEMPORARY_FAIL = "temporary_fail",
+    UNSUBSCRIBED = "unsubscribe"
+}
+export declare enum YesNo {
+    YES = "yes",
+    NO = "no"
+}

package/Interfaces/Common/Logger.d.ts

@@ -0,0 +1,3 @@
+export interface ILogger {
+    warn(message: string): void;
+}

package/Interfaces/Common/index.d.ts

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

package/Interfaces/Domains/DomainCredentials.d.ts

@@ -0,0 +1,7 @@
+import { DomainCredentials, DomainCredentialsList, DomainCredentialsQuery, DomainCredentialsResult, UpdateDomainCredentialsData } from '../../Types/Domains';
+export interface IDomainCredentials {
+    list(domain: string, query: DomainCredentialsQuery): Promise<DomainCredentialsList>;
+    create(domain: string, data: DomainCredentials): Promise<DomainCredentialsResult>;
+    update(domain: string, credentialsLogin: string, data: UpdateDomainCredentialsData): Promise<DomainCredentialsResult>;
+    destroy(domain: string, credentialsLogin: string): Promise<DomainCredentialsResult>;
+}

package/Interfaces/Domains/DomainTags.d.ts

@@ -0,0 +1,20 @@
+import { Resolution } from '../../Enums';
+import { DomainTagCountriesAggregation, DomainTagDevicesAggregation, DomainTagProvidersAggregation, DomainTagsItem, DomainTagsList, DomainTagsMessageRes, DomainTagsStatisticQuery, DomainTagStatisticItem } from '../../Types/Domains';
+export interface IDomainTagStatisticResult {
+    tag: string;
+    description: string;
+    start: Date;
+    end: Date;
+    resolution: Resolution;
+    stats: DomainTagStatisticItem[];
+}
+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<IDomainTagStatisticResult>;
+    countries(domain: string, tag: string): Promise<DomainTagCountriesAggregation>;
+    providers(domain: string, tag: string): Promise<DomainTagProvidersAggregation>;
+    devices(domain: string, tag: string): Promise<DomainTagDevicesAggregation>;
+}