ts-mailcow-api 0.7.0 → 0.8.2

package/README.md

@@ -57,21 +57,21 @@ mcc.mailbox.get().then((e) => {
 - [x] Get sync jobs
 
 ### Forwarding Hosts
-- [ ] Add Forward Host
-- [ ] Delete Forward Host
-- [ ] Get Forwarding Hosts
+- [x] Add Forward Host
+- [x] Delete Forward Host
+- [x] Get Forwarding Hosts
 
 ### Logs
-- [ ] Get ACME logs
-- [ ] Get Api logs
-- [ ] Get Autodiscover logs
-- [ ] Get Dovecot logs
-- [ ] Get Netfilter logs
-- [ ] Get Postfix logs
-- [ ] Get Ratelimit logs
-- [ ] Get Rspamd logs
-- [ ] Get SOGo logs
-- [ ] Get Watchdog logs
+- [x] Get ACME logs
+- [x] Get Api logs
+- [x] Get Autodiscover logs
+- [x] Get Dovecot logs
+- [x] Get Netfilter logs
+- [x] Get Postfix logs
+- [x] Get Ratelimit logs
+- [x] Get Rspamd logs
+- [x] Get SOGo logs
+- [x] Get Watchdog logs
 
 ### Queue Manager
 - [ ] Delete Queue

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

@@ -0,0 +1,27 @@
+import MailcowClient from '../index';
+import { ForwardingCreateRequest, ForwardingDeleteRequest, ForwardingHost, MailcowResponse } from '../types';
+/**
+ * Interface for all Forwarding Hosts endpoints.
+ */
+export interface ForwardingEndpoints {
+    /**
+     * Endpoint for deleting forwarding host.
+     * @param payload - The deletion payload
+     */
+    delete(payload: ForwardingDeleteRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for creating forwarding host.
+     * @param payload - The creation payload
+     */
+    create(payload: ForwardingCreateRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for getting all forwarding host.
+     */
+    getAll(): Promise<ForwardingHost[]>;
+}
+/**
+ * Binder function between the MailcowClient class and the ForwardingEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+export declare function forwardingEndpoints(bind: MailcowClient): ForwardingEndpoints;

package/dist/Endpoints/forwarding-endpoints.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forwardingEndpoints = void 0;
+/**
+ * Binder function between the MailcowClient class and the ForwardingEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+function forwardingEndpoints(bind) {
+    return {
+        delete(payload) {
+            return bind.requestFactory.post('/api/v1/delete/fwdhost', payload.items);
+        },
+        create(payload) {
+            return bind.requestFactory.post('/api/v1/add/fwdhost', payload);
+        },
+        getAll() {
+            return bind.requestFactory.get('/api/v1/get/fwdhost/all');
+        }
+    };
+}
+exports.forwardingEndpoints = forwardingEndpoints;
+//# sourceMappingURL=forwarding-endpoints.js.map

package/dist/Endpoints/forwarding-endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forwarding-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/forwarding-endpoints.ts"],"names":[],"mappings":";;;AAyBA;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,OAAO;QACL,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,KAAK,CACd,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,yBAAyB,CAC1B,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AApBD,kDAoBC"}

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

@@ -0,0 +1,55 @@
+import MailcowClient from '../index';
+import { ACMELog, ADLog, APILog, DCLog, NFLog, PFLog, RLLog, RSLog, SGLog, WDLog } from '../types';
+export interface LogEndpoints {
+    /**
+     * Endpoint for returning ACME Logs.
+     * @param count - The number of logs to return.
+     */
+    acme(count: number): Promise<ACMELog[]>;
+    /**
+     * Endpoint for returning API Logs.
+     * @param count - The number of logs to return.
+     */
+    api(count: number): Promise<APILog[]>;
+    /**
+     * Endpoint for returning Autodiscover Logs.
+     * @param count - The number of logs to return.
+     */
+    autodiscover(count: number): Promise<ADLog[]>;
+    /**
+     * Endpoint for returning dovecot Logs.
+     * @param count - The number of logs to return.
+     */
+    dovecot(count: number): Promise<DCLog[]>;
+    /**
+     * Endpoint for returning Netfilter Logs.
+     * @param count - The number of logs to return.
+     */
+    netfilter(count: number): Promise<NFLog[]>;
+    /**
+     * Endpoint for returning Postfix Logs.
+     * @param count - The number of logs to return.
+     */
+    postfix(count: number): Promise<PFLog[]>;
+    /**
+     * Endpoint for returning Rate limited Logs.
+     * @param count - The number of logs to return.
+     */
+    ratelimited(count: number): Promise<RLLog[]>;
+    /**
+     * Endpoint for returning Rspamd Logs.
+     * @param count - The number of logs to return.
+     */
+    rspamd(count: number): Promise<RSLog[]>;
+    /**
+     * Endpoint for returning SOGo Logs.
+     * @param count - The number of logs to return.
+     */
+    sogo(count: number): Promise<SGLog[]>;
+    /**
+     * Endpoint for returning Watchdog Logs.
+     * @param count - The number of logs to return.
+     */
+    watchdog(count: number): Promise<WDLog[]>;
+}
+export declare function logEndpoints(bind: MailcowClient): LogEndpoints;

package/dist/Endpoints/log-endpoints.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logEndpoints = void 0;
+function logEndpoints(bind) {
+    return {
+        acme(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/acme/${count}`);
+        },
+        api(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/api/${count}`);
+        },
+        autodiscover(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/autodiscover/${count}`);
+        },
+        dovecot(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/dovecot/${count}`);
+        },
+        netfilter(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/netfilter/${count}`);
+        },
+        postfix(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/postfix/${count}`);
+        },
+        ratelimited(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/ratelimited/${count}`);
+        },
+        rspamd(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/rspamd-history/${count}`);
+        },
+        sogo(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/sogo/${count}`);
+        },
+        watchdog(count) {
+            return bind.requestFactory.get(`/api/v1/get/logs/watchdog/${count}`);
+        }
+    };
+}
+exports.logEndpoints = logEndpoints;
+//# sourceMappingURL=log-endpoints.js.map

package/dist/Endpoints/log-endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/log-endpoints.ts"],"names":[],"mappings":";;;AA4EA,SAAgB,YAAY,CAAC,IAAmB;IAC9C,OAAO;QACL,IAAI,CAAC,KAAa;YAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,yBAAyB,KAAK,EAAE,CACjC,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,KAAa;YACf,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,wBAAwB,KAAK,EAAE,CAChC,CAAC;QACJ,CAAC;QACD,YAAY,CAAC,KAAa;YACxB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAiC,KAAK,EAAE,CACzC,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,KAAa;YACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,4BAA4B,KAAK,EAAE,CACpC,CAAC;QACJ,CAAC;QACD,SAAS,CAAC,KAAa;YACrB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,8BAA8B,KAAK,EAAE,CACtC,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,KAAa;YACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,4BAA4B,KAAK,EAAE,CACpC,CAAC;QACJ,CAAC;QACD,WAAW,CAAC,KAAa;YACvB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,gCAAgC,KAAK,EAAE,CACxC,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,KAAa;YAClB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,mCAAmC,KAAK,EAAE,CAC3C,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,KAAa;YAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,yBAAyB,KAAK,EAAE,CACjC,CAAC;QACJ,CAAC;QACD,QAAQ,CAAC,KAAa;YACpB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,6BAA6B,KAAK,EAAE,CACrC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AArDD,oCAqDC"}

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

@@ -1,5 +1,5 @@
-import MailcowClient from "../index";
-import { MailcowResponse, Syncjob, SyncjobDeleteRequest, SyncjobPostRequest, SyncjobUpdateRequest } from "../types";
+import MailcowClient from '../index';
+import { MailcowResponse, Syncjob, SyncjobDeleteRequest, SyncjobPostRequest, SyncjobUpdateRequest } from '../types';
 export interface SyncjobEndpoints {
     /**
      * Endpoint for creating sync jobs.

package/dist/Endpoints/syncjob-endpoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"syncjob-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/syncjob-endpoints.ts"],"names":[],"mappings":";;;AA4BA,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAiC,CAClC,CAAA;QACH,CAAC;QACD,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAA6B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CACR,CAAA;QACH,CAAC;QACD,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,KAAK,CACd,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC;AA1BD,4CA0BC"}
+{"version":3,"file":"syncjob-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/syncjob-endpoints.ts"],"names":[],"mappings":";;;AA4BA,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAiC,CAClC,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAA6B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,KAAK,CACd,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA1BD,4CA0BC"}

package/dist/index.d.ts

@@ -7,7 +7,9 @@ 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 { 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
@@ -67,5 +69,17 @@ declare class MailcowClient {
      * @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

@@ -9,6 +9,8 @@ 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
@@ -55,7 +57,19 @@ class MailcowClient {
          * @external
          */
         this.syncjobs = syncjob_endpoints_1.syncjobEndpoints(this);
-        this.BASE_URL = BASE_URL;
+        /**
+         * 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 = {

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;AAEnF;;;GAGG;AACH,MAAM,aAAa;IAiBjB;;;;OAIG;IACH,YAAY,QAAgB,EAAE,OAAe;QAa7C;;;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;QAnDxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,iCAAiC;QACjC,IAAI,CAAC,OAAO,GAAG;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,IAAI,CAAC,OAAO;aAC1B;SACF,CAAC;IACJ,CAAC;CA0CF;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;;;;OAIG;IACH,YAAY,QAAgB,EAAE,OAAe;QAa7C;;;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;QAjE5C,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,GAAG;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,IAAI,CAAC,OAAO;aAC1B;SACF,CAAC;IACJ,CAAC;CAwDF;AAED,kBAAe,aAAa,CAAC"}