ts-mailcow-api 0.8.3 → 0.8.5

package/dist/Endpoints/mailbox-endpoint.d.ts

@@ -1,58 +1,58 @@
-import { ACLEditRequest, MailboxDeleteRequest, MailboxEditRequest, MailboxPostRequest, Mailbox, MailcowResponse, PushoverEditRequest, QuarantaineEditRequest, SpamScoreEditRequest } from '../types';
-import MailcowClient from '../index';
-/**
- * Interface for all Mailbox endpoints.
- */
-export interface MailboxEndpoints {
-    /**
-     * Endpoint for creating a mailbox.
-     * @param payload - The creation payload.
-     */
-    create(payload: MailboxPostRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for deleting a mailbox.
-     * @param payload - The deletion payload.
-     */
-    delete(payload: MailboxDeleteRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for editing a mailbox.
-     * @param payload
-     */
-    edit(payload: MailboxEditRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for getting a mailbox.
-     * @param mailbox - The mailbox to get
-     */
-    get(mailbox: string | 'all'): Promise<Mailbox[]>;
-    /**
-     * Endpoint for editing a mailbox's pushover settings.
-     * @param payload - The edit payload.
-     */
-    editPushover(payload: PushoverEditRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for editing a mailbox's quarantine settings.
-     * @param payload - The edit payload.
-     */
-    editQuarantine(payload: QuarantaineEditRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for editing a mailbox's spam score settings.
-     * @param payload - The edit payload.
-     */
-    editSpamScore(payload: SpamScoreEditRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for editing a mailbox's ACL settings.
-     * @param payload - The edit payload.
-     */
-    editUserACL(payload: ACLEditRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint fot getting a mailbox's active sieve.
-     * @param mailbox - The mailbox to get.
-     */
-    getActiveUserSieve(mailbox: string): Promise<string[]>;
-}
-/**
- * Binder function between the MailcowClient class and the MailboxEndpoints
- * @param bind - The MailcowClient to bind.
- * @internal
- */
-export declare function mailboxEndpoints(bind: MailcowClient): MailboxEndpoints;
+import { ACLEditRequest, MailboxDeleteRequest, MailboxEditRequest, MailboxPostRequest, Mailbox, MailcowResponse, PushoverEditRequest, QuarantaineEditRequest, SpamScoreEditRequest } from '../types';
+import MailcowClient from '../index';
+/**
+ * Interface for all Mailbox endpoints.
+ */
+export interface MailboxEndpoints {
+    /**
+     * Endpoint for creating a mailbox.
+     * @param payload - The creation payload.
+     */
+    create(payload: MailboxPostRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for deleting a mailbox.
+     * @param payload - The deletion payload.
+     */
+    delete(payload: MailboxDeleteRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for editing a mailbox.
+     * @param payload
+     */
+    edit(payload: MailboxEditRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for getting a mailbox.
+     * @param mailbox - The mailbox to get
+     */
+    get(mailbox: string | 'all'): Promise<Mailbox[]>;
+    /**
+     * Endpoint for editing a mailbox's pushover settings.
+     * @param payload - The edit payload.
+     */
+    editPushover(payload: PushoverEditRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for editing a mailbox's quarantine settings.
+     * @param payload - The edit payload.
+     */
+    editQuarantine(payload: QuarantaineEditRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for editing a mailbox's spam score settings.
+     * @param payload - The edit payload.
+     */
+    editSpamScore(payload: SpamScoreEditRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for editing a mailbox's ACL settings.
+     * @param payload - The edit payload.
+     */
+    editUserACL(payload: ACLEditRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint fot getting a mailbox's active sieve.
+     * @param mailbox - The mailbox to get.
+     */
+    getActiveUserSieve(mailbox: string): Promise<string[]>;
+}
+/**
+ * Binder function between the MailcowClient class and the MailboxEndpoints
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+export declare function mailboxEndpoints(bind: MailcowClient): MailboxEndpoints;

package/dist/Endpoints/mailbox-endpoint.js

@@ -1,42 +1,42 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mailboxEndpoints = void 0;
-const request_factory_1 = require("../request-factory");
-/**
- * Binder function between the MailcowClient class and the MailboxEndpoints
- * @param bind - The MailcowClient to bind.
- * @internal
- */
-function mailboxEndpoints(bind) {
-    return {
-        create(payload) {
-            return bind.requestFactory.post('/api/v1/add/mailbox', payload);
-        },
-        delete(payload) {
-            return bind.requestFactory.post('/api/v1/delete/mailbox', payload.mailboxes);
-        },
-        edit(payload) {
-            return bind.requestFactory.post('/api/v1/edit/mailbox', payload);
-        },
-        get(mailbox = 'all') {
-            return request_factory_1.wrapPromiseToArray(bind.requestFactory.get(`/api/v1/get/mailbox/${mailbox}`));
-        },
-        editPushover(payload) {
-            return bind.requestFactory.post('/api/v1/edit/pushover', payload);
-        },
-        editQuarantine(payload) {
-            return bind.requestFactory.post('/api/v1/edit/quarantine_notification', payload);
-        },
-        editSpamScore(payload) {
-            return bind.requestFactory.post('/api/v1/edit/spam-score', payload);
-        },
-        editUserACL(payload) {
-            return bind.requestFactory.post('/api/v1/edit/user-acl', payload);
-        },
-        getActiveUserSieve(mailbox) {
-            return bind.requestFactory.get(`/api/v1/get/active-user-sieve/${mailbox}`);
-        }
-    };
-}
-exports.mailboxEndpoints = mailboxEndpoints;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mailboxEndpoints = void 0;
+const request_factory_1 = require("../request-factory");
+/**
+ * Binder function between the MailcowClient class and the MailboxEndpoints
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+function mailboxEndpoints(bind) {
+    return {
+        create(payload) {
+            return bind.requestFactory.post('/api/v1/add/mailbox', payload);
+        },
+        delete(payload) {
+            return bind.requestFactory.post('/api/v1/delete/mailbox', payload.mailboxes);
+        },
+        edit(payload) {
+            return bind.requestFactory.post('/api/v1/edit/mailbox', payload);
+        },
+        get(mailbox = 'all') {
+            return (0, request_factory_1.wrapPromiseToArray)(bind.requestFactory.get(`/api/v1/get/mailbox/${mailbox}`));
+        },
+        editPushover(payload) {
+            return bind.requestFactory.post('/api/v1/edit/pushover', payload);
+        },
+        editQuarantine(payload) {
+            return bind.requestFactory.post('/api/v1/edit/quarantine_notification', payload);
+        },
+        editSpamScore(payload) {
+            return bind.requestFactory.post('/api/v1/edit/spam-score', payload);
+        },
+        editUserACL(payload) {
+            return bind.requestFactory.post('/api/v1/edit/user-acl', payload);
+        },
+        getActiveUserSieve(mailbox) {
+            return bind.requestFactory.get(`/api/v1/get/active-user-sieve/${mailbox}`);
+        }
+    };
+}
+exports.mailboxEndpoints = mailboxEndpoints;
 //# sourceMappingURL=mailbox-endpoint.js.map

package/dist/Endpoints/mailbox-endpoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"mailbox-endpoint.js","sourceRoot":"","sources":["../../src/Endpoints/mailbox-endpoint.ts"],"names":[],"mappings":";;;AAYA,wDAAwD;AA6DxD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,SAAS,CAClB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAA2B;YAC9B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,GAAG,CAAC,UAAkB,KAAK;YACzB,OAAO,oCAAkB,CACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,uBAAwB,OAAQ,EAAE,CAAC,CACtC,CAAC;QACJ,CAAC;QAED,YAAY,CAAC,OAA4B;YACvC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,cAAc,CAAC,OAA+B;YAC5C,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sCAAsC,EACtC,OAAO,CACR,CAAC;QACJ,CAAC;QAED,aAAa,CAAC,OAA6B;YACzC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,yBAAyB,EACzB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,WAAW,CAAC,OAAuB;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,kBAAkB,CAAC,OAAe;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAkC,OAAQ,EAAE,CAC7C,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAhED,4CAgEC"}
+{"version":3,"file":"mailbox-endpoint.js","sourceRoot":"","sources":["../../src/Endpoints/mailbox-endpoint.ts"],"names":[],"mappings":";;;AAYA,wDAAwD;AA6DxD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,SAAS,CAClB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAA2B;YAC9B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,GAAG,CAAC,UAAkB,KAAK;YACzB,OAAO,IAAA,oCAAkB,EACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,uBAAwB,OAAQ,EAAE,CAAC,CACtC,CAAC;QACJ,CAAC;QAED,YAAY,CAAC,OAA4B;YACvC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,cAAc,CAAC,OAA+B;YAC5C,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sCAAsC,EACtC,OAAO,CACR,CAAC;QACJ,CAAC;QAED,aAAa,CAAC,OAA6B;YACzC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,yBAAyB,EACzB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,WAAW,CAAC,OAAuB;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,kBAAkB,CAAC,OAAe;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAkC,OAAQ,EAAE,CAC7C,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAhED,4CAgEC"}

package/dist/Endpoints/syncjob-endpoints.d.ts

@@ -1,24 +1,24 @@
-import MailcowClient from '../index';
-import { MailcowResponse, Syncjob, SyncjobDeleteRequest, SyncjobPostRequest, SyncjobUpdateRequest } from '../types';
-export interface SyncjobEndpoints {
-    /**
-     * Endpoint for creating sync jobs.
-     * @param payload - The creation payload.
-     */
-    create(payload: SyncjobPostRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for editing sync jobs.
-     * @param payload - The edit payload.
-     */
-    edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for deleting sync jobs
-     * @param payload - The deletion payload.
-     */
-    delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse>;
-    /**
-     * Endpoint for getting all sync jobs.
-     */
-    getAll(): Promise<Syncjob[]>;
-}
-export declare function syncjobEndpoints(bind: MailcowClient): SyncjobEndpoints;
+import MailcowClient from '../index';
+import { MailcowResponse, Syncjob, SyncjobDeleteRequest, SyncjobPostRequest, SyncjobUpdateRequest } from '../types';
+export interface SyncjobEndpoints {
+    /**
+     * Endpoint for creating sync jobs.
+     * @param payload - The creation payload.
+     */
+    create(payload: SyncjobPostRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for editing sync jobs.
+     * @param payload - The edit payload.
+     */
+    edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for deleting sync jobs
+     * @param payload - The deletion payload.
+     */
+    delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for getting all sync jobs.
+     */
+    getAll(): Promise<Syncjob[]>;
+}
+export declare function syncjobEndpoints(bind: MailcowClient): SyncjobEndpoints;

package/dist/Endpoints/syncjob-endpoints.js

@@ -1,21 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.syncjobEndpoints = void 0;
-function syncjobEndpoints(bind) {
-    return {
-        getAll() {
-            return bind.requestFactory.get('/api/v1/get/syncjobs/all/no_log');
-        },
-        create(payload) {
-            return bind.requestFactory.post('/api/v1/add/syncjob', payload);
-        },
-        edit(payload) {
-            return bind.requestFactory.post('/api/v1/edit/syncjob', payload);
-        },
-        delete(payload) {
-            return bind.requestFactory.post('/api/v1/delete/syncjob', payload.items);
-        }
-    };
-}
-exports.syncjobEndpoints = syncjobEndpoints;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncjobEndpoints = void 0;
+function syncjobEndpoints(bind) {
+    return {
+        getAll() {
+            return bind.requestFactory.get('/api/v1/get/syncjobs/all/no_log');
+        },
+        create(payload) {
+            return bind.requestFactory.post('/api/v1/add/syncjob', payload);
+        },
+        edit(payload) {
+            return bind.requestFactory.post('/api/v1/edit/syncjob', payload);
+        },
+        delete(payload) {
+            return bind.requestFactory.post('/api/v1/delete/syncjob', payload.items);
+        }
+    };
+}
+exports.syncjobEndpoints = syncjobEndpoints;
 //# sourceMappingURL=syncjob-endpoints.js.map

package/dist/index.d.ts

@@ -1,86 +1,86 @@
-/**
- * @module MailcowClient
- */
-import { AxiosRequestConfig } from 'axios';
-import { DomainEndpoints } from './Endpoints/domain-endpoints';
-import { AntiSpamEndpoints } from './Endpoints/antispam-endpoints';
-import { MailboxEndpoints } from './Endpoints/mailbox-endpoint';
-import RequestFactory from './request-factory';
-import { AliasEndpoints } from './Endpoints/alias-endpoints';
-import { SyncjobEndpoints } from './Endpoints/syncjob-endpoints';
-import { ForwardingEndpoints } from './Endpoints/forwarding-endpoints';
-import { LogEndpoints } from './Endpoints/log-endpoints';
-/**
- * Class containing all the logic to interface with the Mailcow API in TypeScript.
- * @external
- */
-declare class MailcowClient {
-    /**
-     * The base URL of the Mailcow API.
-     */
-    readonly BASE_URL: string;
-    /**
-     * The API key of the Mailcow API.
-     */
-    readonly API_KEY: string;
-    /**
-     * The headers used for every request.
-     * @internal
-     */
-    HEADERS: AxiosRequestConfig;
-    /**
-     * Creates a MailcowClient using the given URL and API key.
-     * @param BASE_URL - The base URL of the Mailcow API.
-     * @param API_KEY  - The API key of the Mailcow API.
-     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
-     */
-    constructor(BASE_URL: string, API_KEY: string, EXTRA_AXIOS_CONFIG: AxiosRequestConfig);
-    /**
-     * Factory method pattern for creating HTTP requests.
-     * @internal
-     */
-    requestFactory: RequestFactory;
-    /**
-     * All endpoints related to Aliases.
-     * See {@link AliasEndpoints}
-     * @external
-     */
-    aliases: AliasEndpoints;
-    /**
-     * All endpoints related to Domains.
-     * See {@link DomainEndpoints}
-     * @external
-     */
-    domains: DomainEndpoints;
-    /**
-     * All endpoints related to spam policies.
-     * See {@link AntiSpamEndpoints}
-     * @external
-     */
-    spamPolicy: AntiSpamEndpoints;
-    /**
-     * All endpoints related to mailboxes.
-     * See {@link MailboxEndpoints}
-     * @external
-     */
-    mailbox: MailboxEndpoints;
-    /**
-     * All endpoints related to sync jobs.
-     * See {@link SyncjobEndpoints}
-     * @external
-     */
-    syncjobs: SyncjobEndpoints;
-    /**
-     * All endpoints related to forwarding hosts.
-     * See {@link ForwardingEndpoints}
-     * @external
-     */
-    forwardingHosts: ForwardingEndpoints;
-    /**
-     * All endpoints related to logs.
-     * See {@link LogEndpoints}
-     * @external
-     */
-    logs: LogEndpoints;
-}
-export default MailcowClient;
+/**
+ * @module MailcowClient
+ */
+import { AxiosRequestConfig } from 'axios';
+import { DomainEndpoints } from './Endpoints/domain-endpoints';
+import { AntiSpamEndpoints } from './Endpoints/antispam-endpoints';
+import { MailboxEndpoints } from './Endpoints/mailbox-endpoint';
+import RequestFactory from './request-factory';
+import { AliasEndpoints } from './Endpoints/alias-endpoints';
+import { SyncjobEndpoints } from './Endpoints/syncjob-endpoints';
+import { ForwardingEndpoints } from './Endpoints/forwarding-endpoints';
+import { LogEndpoints } from './Endpoints/log-endpoints';
+/**
+ * Class containing all the logic to interface with the Mailcow API in TypeScript.
+ * @external
+ */
+declare class MailcowClient {
+    /**
+     * The base URL of the Mailcow API.
+     */
+    readonly BASE_URL: string;
+    /**
+     * The API key of the Mailcow API.
+     */
+    readonly API_KEY: string;
+    /**
+     * The headers used for every request.
+     * @internal
+     */
+    HEADERS: AxiosRequestConfig;
+    /**
+     * Creates a MailcowClient using the given URL and API key.
+     * @param BASE_URL - The base URL of the Mailcow API.
+     * @param API_KEY  - The API key of the Mailcow API.
+     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
+     */
+    constructor(BASE_URL: string, API_KEY: string, EXTRA_AXIOS_CONFIG?: AxiosRequestConfig);
+    /**
+     * Factory method pattern for creating HTTP requests.
+     * @internal
+     */
+    requestFactory: RequestFactory;
+    /**
+     * All endpoints related to Aliases.
+     * See {@link AliasEndpoints}
+     * @external
+     */
+    aliases: AliasEndpoints;
+    /**
+     * All endpoints related to Domains.
+     * See {@link DomainEndpoints}
+     * @external
+     */
+    domains: DomainEndpoints;
+    /**
+     * All endpoints related to spam policies.
+     * See {@link AntiSpamEndpoints}
+     * @external
+     */
+    spamPolicy: AntiSpamEndpoints;
+    /**
+     * All endpoints related to mailboxes.
+     * See {@link MailboxEndpoints}
+     * @external
+     */
+    mailbox: MailboxEndpoints;
+    /**
+     * All endpoints related to sync jobs.
+     * See {@link SyncjobEndpoints}
+     * @external
+     */
+    syncjobs: SyncjobEndpoints;
+    /**
+     * All endpoints related to forwarding hosts.
+     * See {@link ForwardingEndpoints}
+     * @external
+     */
+    forwardingHosts: ForwardingEndpoints;
+    /**
+     * All endpoints related to logs.
+     * See {@link LogEndpoints}
+     * @external
+     */
+    logs: LogEndpoints;
+}
+export default MailcowClient;

package/dist/index.js

@@ -1,83 +1,83 @@
-"use strict";
-/**
- * @module MailcowClient
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const domain_endpoints_1 = require("./Endpoints/domain-endpoints");
-const antispam_endpoints_1 = require("./Endpoints/antispam-endpoints");
-const mailbox_endpoint_1 = require("./Endpoints/mailbox-endpoint");
-const request_factory_1 = require("./request-factory");
-const alias_endpoints_1 = require("./Endpoints/alias-endpoints");
-const syncjob_endpoints_1 = require("./Endpoints/syncjob-endpoints");
-const forwarding_endpoints_1 = require("./Endpoints/forwarding-endpoints");
-const log_endpoints_1 = require("./Endpoints/log-endpoints");
-/**
- * Class containing all the logic to interface with the Mailcow API in TypeScript.
- * @external
- */
-class MailcowClient {
-    /**
-     * Creates a MailcowClient using the given URL and API key.
-     * @param BASE_URL - The base URL of the Mailcow API.
-     * @param API_KEY  - The API key of the Mailcow API.
-     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
-     */
-    constructor(BASE_URL, API_KEY, EXTRA_AXIOS_CONFIG) {
-        /**
-         * Factory method pattern for creating HTTP requests.
-         * @internal
-         */
-        this.requestFactory = new request_factory_1.default(this);
-        /**
-         * All endpoints related to Aliases.
-         * See {@link AliasEndpoints}
-         * @external
-         */
-        this.aliases = alias_endpoints_1.aliasEndpoints(this);
-        /**
-         * All endpoints related to Domains.
-         * See {@link DomainEndpoints}
-         * @external
-         */
-        this.domains = domain_endpoints_1.domainEndpoints(this);
-        /**
-         * All endpoints related to spam policies.
-         * See {@link AntiSpamEndpoints}
-         * @external
-         */
-        this.spamPolicy = antispam_endpoints_1.antiSpamEndpoints(this);
-        /**
-         * All endpoints related to mailboxes.
-         * See {@link MailboxEndpoints}
-         * @external
-         */
-        this.mailbox = mailbox_endpoint_1.mailboxEndpoints(this);
-        /**
-         * All endpoints related to sync jobs.
-         * See {@link SyncjobEndpoints}
-         * @external
-         */
-        this.syncjobs = syncjob_endpoints_1.syncjobEndpoints(this);
-        /**
-         * All endpoints related to forwarding hosts.
-         * See {@link ForwardingEndpoints}
-         * @external
-         */
-        this.forwardingHosts = forwarding_endpoints_1.forwardingEndpoints(this);
-        /**
-         * All endpoints related to logs.
-         * See {@link LogEndpoints}
-         * @external
-         */
-        this.logs = log_endpoints_1.logEndpoints(this);
-        this.BASE_URL = BASE_URL.charAt(BASE_URL.length - 1) === '/' ? BASE_URL : BASE_URL.concat('/');
-        this.API_KEY = API_KEY;
-        // Set the correct Axios headers.
-        this.HEADERS = Object.assign({ headers: {
-                'Content-Type': 'application/json',
-                'X-API-Key': this.API_KEY
-            } }, EXTRA_AXIOS_CONFIG);
-    }
-}
-exports.default = MailcowClient;
+"use strict";
+/**
+ * @module MailcowClient
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const domain_endpoints_1 = require("./Endpoints/domain-endpoints");
+const antispam_endpoints_1 = require("./Endpoints/antispam-endpoints");
+const mailbox_endpoint_1 = require("./Endpoints/mailbox-endpoint");
+const request_factory_1 = require("./request-factory");
+const alias_endpoints_1 = require("./Endpoints/alias-endpoints");
+const syncjob_endpoints_1 = require("./Endpoints/syncjob-endpoints");
+const forwarding_endpoints_1 = require("./Endpoints/forwarding-endpoints");
+const log_endpoints_1 = require("./Endpoints/log-endpoints");
+/**
+ * Class containing all the logic to interface with the Mailcow API in TypeScript.
+ * @external
+ */
+class MailcowClient {
+    /**
+     * Creates a MailcowClient using the given URL and API key.
+     * @param BASE_URL - The base URL of the Mailcow API.
+     * @param API_KEY  - The API key of the Mailcow API.
+     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
+     */
+    constructor(BASE_URL, API_KEY, EXTRA_AXIOS_CONFIG) {
+        /**
+         * Factory method pattern for creating HTTP requests.
+         * @internal
+         */
+        this.requestFactory = new request_factory_1.default(this);
+        /**
+         * All endpoints related to Aliases.
+         * See {@link AliasEndpoints}
+         * @external
+         */
+        this.aliases = (0, alias_endpoints_1.aliasEndpoints)(this);
+        /**
+         * All endpoints related to Domains.
+         * See {@link DomainEndpoints}
+         * @external
+         */
+        this.domains = (0, domain_endpoints_1.domainEndpoints)(this);
+        /**
+         * All endpoints related to spam policies.
+         * See {@link AntiSpamEndpoints}
+         * @external
+         */
+        this.spamPolicy = (0, antispam_endpoints_1.antiSpamEndpoints)(this);
+        /**
+         * All endpoints related to mailboxes.
+         * See {@link MailboxEndpoints}
+         * @external
+         */
+        this.mailbox = (0, mailbox_endpoint_1.mailboxEndpoints)(this);
+        /**
+         * All endpoints related to sync jobs.
+         * See {@link SyncjobEndpoints}
+         * @external
+         */
+        this.syncjobs = (0, syncjob_endpoints_1.syncjobEndpoints)(this);
+        /**
+         * All endpoints related to forwarding hosts.
+         * See {@link ForwardingEndpoints}
+         * @external
+         */
+        this.forwardingHosts = (0, forwarding_endpoints_1.forwardingEndpoints)(this);
+        /**
+         * All endpoints related to logs.
+         * See {@link LogEndpoints}
+         * @external
+         */
+        this.logs = (0, log_endpoints_1.logEndpoints)(this);
+        this.BASE_URL = BASE_URL.charAt(BASE_URL.length - 1) === '/' ? BASE_URL : BASE_URL.concat('/');
+        this.API_KEY = API_KEY;
+        // Set the correct Axios headers.
+        this.HEADERS = Object.assign({ headers: {
+                'Content-Type': 'application/json',
+                'X-API-Key': this.API_KEY
+            } }, EXTRA_AXIOS_CONFIG);
+    }
+}
+exports.default = MailcowClient;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAGH,mEAAgF;AAChF,uEAAsF;AACtF,mEAAkF;AAClF,uDAA+C;AAC/C,iEAA6E;AAC7E,qEAAmF;AACnF,2EAA4F;AAC5F,6DAAuE;AAEvE;;;GAGG;AACH,MAAM,aAAa;IAiBjB;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAe,EAAE,kBAAsC;QAcrF;;;WAGG;QACI,mBAAc,GAAG,IAAI,yBAAc,CAAC,IAAI,CAAC,CAAA;QAEhD;;;;WAIG;QACI,YAAO,GAAmB,gCAAc,CAAC,IAAI,CAAC,CAAA;QAErD;;;;WAIG;QACI,YAAO,GAAoB,kCAAe,CAAC,IAAI,CAAC,CAAA;QAEvD;;;;WAIG;QACI,eAAU,GAAsB,sCAAiB,CAAC,IAAI,CAAC,CAAA;QAE9D;;;;WAIG;QACI,YAAO,GAAqB,mCAAgB,CAAC,IAAI,CAAC,CAAA;QAEzD;;;;WAIG;QACI,aAAQ,GAAqB,oCAAgB,CAAC,IAAI,CAAC,CAAA;QAE1D;;;;WAIG;QACI,oBAAe,GAAwB,0CAAmB,CAAC,IAAI,CAAC,CAAA;QAEvE;;;;WAIG;QACI,SAAI,GAAiB,4BAAY,CAAC,IAAI,CAAC,CAAA;QAlE5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/F,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,iCAAiC;QACjC,IAAI,CAAC,OAAO,mBACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,IAAI,CAAC,OAAO;aAC1B,IACE,kBAAkB,CACtB,CAAC;IACJ,CAAC;CAwDF;AAED,kBAAe,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAGH,mEAAgF;AAChF,uEAAsF;AACtF,mEAAkF;AAClF,uDAA+C;AAC/C,iEAA6E;AAC7E,qEAAmF;AACnF,2EAA4F;AAC5F,6DAAuE;AAEvE;;;GAGG;AACH,MAAM,aAAa;IAiBjB;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAe,EAAE,kBAAuC;QActF;;;WAGG;QACI,mBAAc,GAAG,IAAI,yBAAc,CAAC,IAAI,CAAC,CAAA;QAEhD;;;;WAIG;QACI,YAAO,GAAmB,IAAA,gCAAc,EAAC,IAAI,CAAC,CAAA;QAErD;;;;WAIG;QACI,YAAO,GAAoB,IAAA,kCAAe,EAAC,IAAI,CAAC,CAAA;QAEvD;;;;WAIG;QACI,eAAU,GAAsB,IAAA,sCAAiB,EAAC,IAAI,CAAC,CAAA;QAE9D;;;;WAIG;QACI,YAAO,GAAqB,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAA;QAEzD;;;;WAIG;QACI,aAAQ,GAAqB,IAAA,oCAAgB,EAAC,IAAI,CAAC,CAAA;QAE1D;;;;WAIG;QACI,oBAAe,GAAwB,IAAA,0CAAmB,EAAC,IAAI,CAAC,CAAA;QAEvE;;;;WAIG;QACI,SAAI,GAAiB,IAAA,4BAAY,EAAC,IAAI,CAAC,CAAA;QAlE5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/F,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,iCAAiC;QACjC,IAAI,CAAC,OAAO,mBACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,IAAI,CAAC,OAAO;aAC1B,IACE,kBAAkB,CACtB,CAAC;IACJ,CAAC;CAwDF;AAED,kBAAe,aAAa,CAAC"}