ts-mailcow-api 0.6.2 → 0.8.1

package/README.md

@@ -1,147 +1,147 @@
-# TypeScript wrapper for the mailcow API.
-
-Provides typing and a easy to use interface for the [Mailcow API](https://mailcow.docs.apiary.io/#).
-## Usage
-Create a new wrapper using the base url and API_KEY.
-```ts
-import MailCowClient from "./index";
-
-// Create MailCowClient based on BASE_URL and API_KEY
-const mcc = new MailCowClient("https://demo.mailcow.email/api/v1", "390448-22B69F-FA37D9-19701B-6F033F");
-```
-Then you can use the created wrapper for promised-based API calls according to the Mailcow API specification.
-```ts
-// Get all the mailboxes available.
-mcc.mailbox.get().then((e) => {
-    // Print all mailboxes.
-    console.log(JSON.stringify(e, null, 4));
-}).catch(e => {
-    // Error handling.
-    console.log(e)
-})
-```
-
-## API implementation progress
-### Domains
-- [x] Create domain
-- [x] Delete domain
-- [x] Update domain
-- [x] Get domain
-
-### Domain antispam policies
-- [x] Create domain policy
-- [x] Delete domain policy
-- [x] List blacklist/whitelist domain policy
-
-### Mailboxes
-- [x] Create mailbox
-- [x] Delete mailbox
-- [x] Update mailbox
-- [x] Update Pushover settings
-- [x] Quarantine Notifications
-- [x] Update mailbox ACL
-- [x] Get mailboxes
-- [x] Edit mailbox spam filter score
-- [x] Get Active User Sieve
-
-### Aliases
-- [x] Create alias
-- [x] Delete alias
-- [x] Update alias
-- [x] Get aliases
-
-### Sync Jobs
-- [ ] Create sync job
-- [ ] Delete sync job
-- [ ] Update sync job
-- [ ] Get sync jobs
-
-### Forwarding Hosts
-- [ ] Add Forward Host
-- [ ] Delete Forward Host
-- [ ] 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
-
-### Queue Manager
-- [ ] Delete Queue
-- [ ] Flush Queue
-- [ ] Get Queue
-
-### Quarantine
-- [ ] Delete mails in Quarantaine
-- [ ] Get mails in Quarantaine
-
-### Fail2Ban
-- [ ] Edit Fail2Ban
-- [ ] Get Fail2Ban Config
-
-### DKIM
-- [ ] Generate DKIM key
-- [ ] Duplicate DKIM key
-- [ ] Delete DKIM key
-- [ ] Get DKIM key
-
-### Domain Admin
-- [ ] Create Domain Admin user
-- [ ] Edit Domain Admin ACL
-- [ ] Edit Domain Admin user
-- [ ] Delete Domain Admin
-- [ ] Get Domain Admins
-
-### Address Rewriting
-- [ ] Create BCC Map
-- [ ] Create Recipient Map
-- [ ] Delete BCC Map
-- [ ] Delete Recipient Map
-- [ ] Get BCC Map
-- [ ] Get Recipient Map
-
-### Outgoing TLS Policy Map Overrides
-- [ ] Create TLS Policy Map
-- [ ] Delete TLS Policy Map
-- [ ] Get TLS Policy Map
-
-### oAuth Clients
-- [ ] Create oAuth client
-- [ ] Delete oAuth client
-- [ ] Get oAuth Clients
-
-### Routing
-- [ ] Create Sender-Dependent Transports
-- [ ] Create Transport Maps
-- [ ] Delete Sender-Dependent Transports
-- [ ] Delete Transport Maps
-- [ ] Get Sender-Dependent Transports
-- [ ] Get Transport Maps
-
-### Resources
-- [ ] Create Resources
-- [ ] Delete Resources
-- [ ] Get Resources
-
-### App Passwords
-- [ ] Create App Passwords
-- [ ] Delete App Passwords
-- [ ] Get App Passwords
-
-### Status
-- [ ] Get container status
-- [ ] Get solr status
-- [ ] Get vmail status
-
-### Ratelimits
-- [ ] Get mailbox ratelimits
-- [ ] Get domain ratelimits
-- [ ] Edit domain ratelimits
-- [ ] Edit mailbox ratelimits
+# TypeScript wrapper for the mailcow API.
+
+Provides typing and a easy to use interface for the [Mailcow API](https://mailcow.docs.apiary.io/#).
+## Usage
+Create a new wrapper using the base url and API_KEY.
+```ts
+import MailCowClient from "./index";
+
+// Create MailCowClient based on BASE_URL and API_KEY
+const mcc = new MailCowClient("https://demo.mailcow.email/", "390448-22B69F-FA37D9-19701B-6F033F");
+```
+Then you can use the created wrapper for promised-based API calls according to the Mailcow API specification.
+```ts
+// Get all the mailboxes available.
+mcc.mailbox.get().then((e) => {
+    // Print all mailboxes.
+    console.log(JSON.stringify(e, null, 4));
+}).catch(e => {
+    // Error handling.
+    console.log(e)
+})
+```
+
+## API implementation progress
+### Domains
+- [x] Create domain
+- [x] Delete domain
+- [x] Update domain
+- [x] Get domain
+
+### Domain antispam policies
+- [x] Create domain policy
+- [x] Delete domain policy
+- [x] List blacklist/whitelist domain policy
+
+### Mailboxes
+- [x] Create mailbox
+- [x] Delete mailbox
+- [x] Update mailbox
+- [x] Update Pushover settings
+- [x] Quarantine Notifications
+- [x] Update mailbox ACL
+- [x] Get mailboxes
+- [x] Edit mailbox spam filter score
+- [x] Get Active User Sieve
+
+### Aliases
+- [x] Create alias
+- [x] Delete alias
+- [x] Update alias
+- [x] Get aliases
+
+### Sync Jobs
+- [x] Create sync job
+- [x] Delete sync job
+- [x] Update sync job
+- [x] Get sync jobs
+
+### Forwarding Hosts
+- [x] Add Forward Host
+- [x] Delete Forward Host
+- [x] Get Forwarding Hosts
+
+### 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
+- [ ] Flush Queue
+- [ ] Get Queue
+
+### Quarantine
+- [ ] Delete mails in Quarantaine
+- [ ] Get mails in Quarantaine
+
+### Fail2Ban
+- [ ] Edit Fail2Ban
+- [ ] Get Fail2Ban Config
+
+### DKIM
+- [ ] Generate DKIM key
+- [ ] Duplicate DKIM key
+- [ ] Delete DKIM key
+- [ ] Get DKIM key
+
+### Domain Admin
+- [ ] Create Domain Admin user
+- [ ] Edit Domain Admin ACL
+- [ ] Edit Domain Admin user
+- [ ] Delete Domain Admin
+- [ ] Get Domain Admins
+
+### Address Rewriting
+- [ ] Create BCC Map
+- [ ] Create Recipient Map
+- [ ] Delete BCC Map
+- [ ] Delete Recipient Map
+- [ ] Get BCC Map
+- [ ] Get Recipient Map
+
+### Outgoing TLS Policy Map Overrides
+- [ ] Create TLS Policy Map
+- [ ] Delete TLS Policy Map
+- [ ] Get TLS Policy Map
+
+### oAuth Clients
+- [ ] Create oAuth client
+- [ ] Delete oAuth client
+- [ ] Get oAuth Clients
+
+### Routing
+- [ ] Create Sender-Dependent Transports
+- [ ] Create Transport Maps
+- [ ] Delete Sender-Dependent Transports
+- [ ] Delete Transport Maps
+- [ ] Get Sender-Dependent Transports
+- [ ] Get Transport Maps
+
+### Resources
+- [ ] Create Resources
+- [ ] Delete Resources
+- [ ] Get Resources
+
+### App Passwords
+- [ ] Create App Passwords
+- [ ] Delete App Passwords
+- [ ] Get App Passwords
+
+### Status
+- [ ] Get container status
+- [ ] Get solr status
+- [ ] Get vmail status
+
+### Ratelimits
+- [ ] Get mailbox ratelimits
+- [ ] Get domain ratelimits
+- [ ] Edit domain ratelimits
+- [ ] Edit mailbox ratelimits

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

@@ -1,30 +1,33 @@
-import { Alias, AliasDeleteRequest, AliasPostRequest, AliasUpdateRequest, MailcowResponse } from '../types';
+import { Alias, AliasDeleteRequest, AliasPostRequest, AliasEditRequest, MailcowResponse } from '../types';
 import MailcowClient from '../index';
+/**
+ * Interface for all Alias endpoints.
+ */
 export interface AliasEndpoints {
     /**
      * Endpoint for getting mailbox aliases in the system.
      * @param id - The id of the alias you want to get. Use 'all' to retrieve all aliases in the system.
-     *
-     * @example Get all aliases:
-     * ```typescript
-     * mcc.aliases.get('all').then((res) => { console.log(res); });
-     * ```
-     * @example Get a single alias:
-     * ```typescript
-     * mcc.aliases.get(8).then((res) => { console.log(res); });
-     * ```
      */
-    get: (id?: number | 'all') => Promise<Alias[]>;
+    get(id?: number | 'all'): Promise<Alias[]>;
     /**
      * Endpoint for creating mailbox aliases.
-     * @param payload - View {@link AliasAttributes} for payload parameters.
+     * @param payload - The creation payload.
      */
-    create: (payload: AliasPostRequest) => Promise<MailcowResponse>;
+    create(payload: AliasPostRequest): Promise<MailcowResponse>;
     /**
-     * Update for editing a mailbox alias.
-     * @param payload -
+     * Endpoint for editing a mailbox alias.
+     * @param payload - The edit payload.
      */
-    update: (payload: AliasUpdateRequest) => Promise<MailcowResponse>;
-    delete: (payload: AliasDeleteRequest) => Promise<MailcowResponse>;
+    edit(payload: AliasEditRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for deleting a mailbox alias.
+     * @param payload - The deletion payload.
+     */
+    delete(payload: AliasDeleteRequest): Promise<MailcowResponse>;
 }
+/**
+ * Binder function between the MailcowClient class and the AliasEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
 export declare function aliasEndpoints(bind: MailcowClient): AliasEndpoints;

package/dist/Endpoints/alias-endpoints.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.aliasEndpoints = void 0;
 const request_factory_1 = require("../request-factory");
+/**
+ * Binder function between the MailcowClient class and the AliasEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
 function aliasEndpoints(bind) {
     return {
         get(id = 'all') {
@@ -10,7 +15,7 @@ function aliasEndpoints(bind) {
         create: (payload) => {
             return bind.requestFactory.post('/api/v1/add/alias', payload);
         },
-        update: (payload) => {
+        edit: (payload) => {
             return bind.requestFactory.post('/api/v1/edit/alias', payload);
         },
         delete: (payload) => {

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

@@ -1 +1 @@
-{"version":3,"file":"alias-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/alias-endpoints.ts"],"names":[],"mappings":";;;AAQA,wDAAwD;AA+BxD,SAAgB,cAAc,CAAC,IAAmB;IAChD,OAAO;QACL,GAAG,CAAC,EAAE,GAAG,KAAK;YACZ,OAAO,oCAAkB,CACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,qBAAsB,EAAG,EAAE,CAC5B,CAAC,CAAC;QACP,CAAC;QACD,MAAM,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,mBAAmB,EACnB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,OAA2B,EAA4B,EAAE;YAChE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,oBAAoB,EACpB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,OAA2B,EAA4B,EAAE;YAChE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CAAC,KAAK,CACd,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA3BD,wCA2BC"}
+{"version":3,"file":"alias-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/alias-endpoints.ts"],"names":[],"mappings":";;;AAQA,wDAAwD;AA+BxD;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAmB;IAChD,OAAO;QACL,GAAG,CAAC,EAAE,GAAG,KAAK;YACZ,OAAO,oCAAkB,CACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAkB,qBAAqB,EAAE,EAAE,CAAC,CACpE,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,mBAAmB,EACnB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,oBAAoB,EACpB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,OAA2B,EAA4B,EAAE;YAChE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CAAC,KAAK,CACd,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA1BD,wCA0BC"}

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

@@ -1,7 +1,28 @@
-import { SpamPolicyDeleteRequest, SpamPolicyPostRequest, MailcowResponse, SpamPolicyGetRequest, SpamPolicyResponse } from '../types';
+import { SpamPolicyDeleteRequest, SpamPolicyPostRequest, MailcowResponse, SpamPolicyGetRequest, SpamPolicy } from '../types';
 import MailcowClient from '../index';
-export default function AntiSpamEndpoints(bind: MailcowClient): {
+/**
+ * Interface for all antispam policies.
+ */
+export interface AntiSpamEndpoints {
+    /**
+     * Endpoint for getting antispam policies.
+     * @param payload - The get payload.
+     */
+    get(payload: SpamPolicyGetRequest): Promise<SpamPolicy[]>;
+    /**
+     * Endpoint for creating antispam policies.
+     * @param payload - The creation payload.
+     */
     create(payload: SpamPolicyPostRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for deleting antispam policies.
+     * @param payload - The deletion payload.
+     */
     delete(payload: SpamPolicyDeleteRequest): Promise<MailcowResponse>;
-    get(payload: SpamPolicyGetRequest): Promise<SpamPolicyResponse[]>;
-};
+}
+/**
+ * Binder function between the MailcowClient class and the AntiSpamEndpoints
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+export declare function antiSpamEndpoints(bind: MailcowClient): AntiSpamEndpoints;

package/dist/Endpoints/antispam-endpoints.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-function AntiSpamEndpoints(bind) {
+exports.antiSpamEndpoints = void 0;
+/**
+ * Binder function between the MailcowClient class and the AntiSpamEndpoints
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+function antiSpamEndpoints(bind) {
     return {
         create(payload) {
             return bind.requestFactory.post('/api/v1/add/domain-policy', payload);
@@ -13,5 +19,5 @@ function AntiSpamEndpoints(bind) {
         }
     };
 }
-exports.default = AntiSpamEndpoints;
+exports.antiSpamEndpoints = antiSpamEndpoints;
 //# sourceMappingURL=antispam-endpoints.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"antispam-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/antispam-endpoints.ts"],"names":[],"mappings":";;AASA,SAAwB,iBAAiB,CAAC,IAAmB;IAC3D,OAAO;QACL,MAAM,CAAC,OAA8B;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,2BAA2B,EAC3B,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,8BAA8B,EAC9B,OAAO,CAAC,MAAM,CACf,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,OAA6B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,sBAAuB,OAAO,CAAC,IAAK,WAAY,OAAO,CAAC,MAAO,EAAE,CAClE,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AApBD,oCAoBC"}
+{"version":3,"file":"antispam-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/antispam-endpoints.ts"],"names":[],"mappings":";;;AAiCA;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,IAAmB;IACnD,OAAO;QACL,MAAM,CAAC,OAA8B;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,2BAA2B,EAC3B,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,8BAA8B,EAC9B,OAAO,CAAC,MAAM,CACf,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,OAA6B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,sBAAuB,OAAO,CAAC,IAAK,WAAY,OAAO,CAAC,MAAO,EAAE,CAClE,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AApBD,8CAoBC"}

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

@@ -1,8 +1,33 @@
-import { DomainDeleteRequest, DomainEditRequest, DomainPostRequest, DomainResponse, MailcowResponse } from '../types';
+import { DomainDeleteRequest, DomainEditRequest, DomainPostRequest, Domain, MailcowResponse } from '../types';
 import MailcowClient from '../index';
-export default function DomainEndpoints(bind: MailcowClient): {
+/**
+ * Interface for all Domain endpoints.
+ */
+export interface DomainEndpoints {
+    /**
+     * Endpoint for getting domains.
+     * @param domain - Name of the domain to get.
+     */
+    get(domain: string): Promise<Domain[]>;
+    /**
+     * Endpoint for creating domains.
+     * @param payload - The creation payload.
+     */
     create(payload: DomainPostRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for deleting a domain.
+     * @param payload - The deletion payload.
+     */
     delete(payload: DomainDeleteRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for editing a domain.
+     * @param payload - The edit payload.
+     */
     edit(payload: DomainEditRequest): Promise<MailcowResponse>;
-    get(domain?: string): Promise<DomainResponse | DomainResponse[]>;
-};
+}
+/**
+ * Binder function between the MailcowClient class and the DomainEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+export declare function domainEndpoints(bind: MailcowClient): DomainEndpoints;

package/dist/Endpoints/domain-endpoints.js

@@ -1,7 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-function DomainEndpoints(bind) {
+exports.domainEndpoints = void 0;
+const request_factory_1 = require("../request-factory");
+/**
+ * Binder function between the MailcowClient class and the DomainEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+function domainEndpoints(bind) {
     return {
+        get(domain = 'all') {
+            return request_factory_1.wrapPromiseToArray(bind.requestFactory.get(`/api/v1/get/domain/${domain}`));
+        },
         create(payload) {
             return bind.requestFactory.post('/api/v1/add/domain', payload);
         },
@@ -10,11 +20,8 @@ function DomainEndpoints(bind) {
         },
         edit(payload) {
             return bind.requestFactory.post('/api/v1/edit/domain', payload);
-        },
-        get(domain = 'all') {
-            return bind.requestFactory.get(`/api/v1/get/domain/${domain}`);
         }
     };
 }
-exports.default = DomainEndpoints;
+exports.domainEndpoints = domainEndpoints;
 //# sourceMappingURL=domain-endpoints.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"domain-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/domain-endpoints.ts"],"names":[],"mappings":";;AAGA,SAAwB,eAAe,CAAC,IAAmB;IACzD,OAAO;QACL,MAAM,CAAC,OAA0B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,oBAAoB,EACpB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,OAA4B;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CAAC,OAAO,CAChB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAA0B;YAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,GAAG,CAAC,SAAiB,KAAK;YACxB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,sBAAuB,MAAO,EAAE,CACjC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA7BD,kCA6BC"}
+{"version":3,"file":"domain-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/domain-endpoints.ts"],"names":[],"mappings":";;;AAQA,wDAAwD;AA+BxD;;;;GAIG;AACH,SAAgB,eAAe,CAAC,IAAmB;IACjD,OAAO;QACL,GAAG,CAAC,SAAiB,KAAK;YACxB,OAAO,oCAAkB,CACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,sBAAuB,MAAO,EAAE,CACjC,CACF,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA0B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,oBAAoB,EACpB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA4B;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CAAC,OAAO,CAChB,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAA0B;YAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA5BD,0CA4BC"}

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