ts-mailcow-api 0.6.2 → 0.8.1

package/dist/types.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MailcowException = void 0;
+/**
+ * Error class used for exception handling.
+ */
 class MailcowException extends Error {
 }
 exports.MailcowException = MailcowException;

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAyRA,MAAa,gBAAiB,SAAQ,KAAK;CAE1C;AAFD,4CAEC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAi1CA;;GAEG;AACH,MAAa,gBAAiB,SAAQ,KAAK;CAK1C;AALD,4CAKC"}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "ts-mailcow-api",
-  "version": "0.6.2",
+  "version": "0.8.1",
   "description": "TypeScript wrapper for the mailcow API.",
   "scripts": {
     "test": "ts-mocha ./test/**/*.test.ts",
-    "lint": "eslint --fix --ext .ts ./src/",
+    "lint": "eslint --fix ./src/**/*.ts",
+    "quick": "ts-node ./src/custom.ts",
     "docs": "typedoc",
     "build": "tsc",
     "prepare": "tsc",

package/src/Endpoints/alias-endpoints.ts

@@ -2,48 +2,52 @@ import {
   Alias,
   AliasDeleteRequest,
   AliasPostRequest,
-  AliasUpdateRequest,
+  AliasEditRequest,
   MailcowResponse
 } from '../types';
 import MailcowClient from '../index';
 import { wrapPromiseToArray } from '../request-factory';
 
+/**
+ * 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 function aliasEndpoints(bind: MailcowClient): AliasEndpoints {
   return {
     get(id = 'all'): Promise<Alias[]> {
       return wrapPromiseToArray<Alias>(
-        bind.requestFactory.get<Alias[] | Alias>(
-          `/api/v1/get/alias/${ id }`
-        ));
+        bind.requestFactory.get<Alias[] | Alias>(`/api/v1/get/alias/${id}`)
+      );
     },
     create: (payload: AliasPostRequest): Promise<MailcowResponse> => {
       return bind.requestFactory.post<MailcowResponse>(
@@ -51,7 +55,7 @@ export function aliasEndpoints(bind: MailcowClient): AliasEndpoints {
         payload
       );
     },
-    update: (payload: AliasUpdateRequest): Promise<MailcowResponse> => {
+    edit: (payload: AliasEditRequest): Promise<MailcowResponse> => {
       return bind.requestFactory.post<MailcowResponse>(
         '/api/v1/edit/alias',
         payload

package/src/Endpoints/antispam-endpoints.ts

@@ -3,11 +3,40 @@ import {
   SpamPolicyPostRequest,
   MailcowResponse,
   SpamPolicyGetRequest,
-  SpamPolicyResponse
+  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>
+}
+
+
+/**
+ * Binder function between the MailcowClient class and the AntiSpamEndpoints
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+export function antiSpamEndpoints(bind: MailcowClient): AntiSpamEndpoints {
   return {
     create(payload: SpamPolicyPostRequest): Promise<MailcowResponse> {
       return bind.requestFactory.post<MailcowResponse>(
@@ -21,8 +50,8 @@ export default function AntiSpamEndpoints(bind: MailcowClient) {
         payload.prefid,
       );
     },
-    get(payload: SpamPolicyGetRequest): Promise<SpamPolicyResponse[]> {
-      return bind.requestFactory.get<SpamPolicyResponse[]>(
+    get(payload: SpamPolicyGetRequest): Promise<SpamPolicy[]> {
+      return bind.requestFactory.get<SpamPolicy[]>(
         `/api/v1/get/policy_${ payload.type }_domain/${ payload.domain }`,
       );
     }

package/src/Endpoints/domain-endpoints.ts

@@ -1,33 +1,73 @@
-import { DomainDeleteRequest, DomainEditRequest, DomainPostRequest, DomainResponse, MailcowResponse } from '../types';
+import {
+  DomainDeleteRequest,
+  DomainEditRequest,
+  DomainPostRequest,
+  Domain,
+  MailcowResponse
+} from '../types';
 import MailcowClient from '../index';
+import { wrapPromiseToArray } from '../request-factory';
 
-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>;
+}
+
+/**
+ * Binder function between the MailcowClient class and the DomainEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+export function domainEndpoints(bind: MailcowClient): DomainEndpoints {
   return {
+    get(domain: string = 'all'): Promise<Domain[]> {
+      return wrapPromiseToArray<Domain>(
+        bind.requestFactory.get<Domain | Domain[]>(
+          `/api/v1/get/domain/${ domain }`
+        )
+      );
+    },
     create(payload: DomainPostRequest): Promise<MailcowResponse> {
       return bind.requestFactory.post<MailcowResponse>(
         '/api/v1/add/domain',
         payload
       );
     },
-
     delete(payload: DomainDeleteRequest): Promise<MailcowResponse> {
       return bind.requestFactory.post<MailcowResponse>(
         '/api/v1/delete/domain',
         payload.domains
       );
     },
-
     edit(payload: DomainEditRequest): Promise<MailcowResponse> {
       return bind.requestFactory.post<MailcowResponse>(
         '/api/v1/edit/domain',
         payload
       );
-    },
-
-    get(domain: string = 'all'): Promise<DomainResponse | DomainResponse[]> {
-      return bind.requestFactory.get<DomainResponse>(
-        `/api/v1/get/domain/${ domain }`
-      );
     }
   };
 }

package/src/Endpoints/forwarding-endpoints.ts

@@ -0,0 +1,51 @@
+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 function forwardingEndpoints(bind: MailcowClient): ForwardingEndpoints {
+  return {
+    delete(payload: ForwardingDeleteRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/delete/fwdhost',
+        payload.items
+      );
+    },
+    create(payload: ForwardingCreateRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/add/fwdhost',
+        payload
+      );
+    },
+    getAll(): Promise<ForwardingHost[]> {
+      return bind.requestFactory.get<ForwardingHost[]>(
+        '/api/v1/get/fwdhost/all'
+      );
+    }
+  };
+}

package/src/Endpoints/log-endpoints.ts

@@ -0,0 +1,130 @@
+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 function logEndpoints(bind: MailcowClient): LogEndpoints {
+  return {
+    acme(count: number): Promise<ACMELog[]> {
+      return bind.requestFactory.get<ACMELog[]>(
+        `/api/v1/get/logs/acme/${count}`
+      );
+    },
+    api(count: number): Promise<APILog[]> {
+      return bind.requestFactory.get<APILog[]>(
+        `/api/v1/get/logs/api/${count}`
+      );
+    },
+    autodiscover(count: number): Promise<ADLog[]> {
+      return bind.requestFactory.get<ADLog[]>(
+        `/api/v1/get/logs/autodiscover/${count}`
+      );
+    },
+    dovecot(count: number): Promise<DCLog[]> {
+      return bind.requestFactory.get<DCLog[]>(
+        `/api/v1/get/logs/dovecot/${count}`
+      );
+    },
+    netfilter(count: number): Promise<NFLog[]> {
+      return bind.requestFactory.get<NFLog[]>(
+        `/api/v1/get/logs/netfilter/${count}`
+      );
+    },
+    postfix(count: number): Promise<PFLog[]> {
+      return bind.requestFactory.get<PFLog[]>(
+        `/api/v1/get/logs/postfix/${count}`
+      );
+    },
+    ratelimited(count: number): Promise<RLLog[]> {
+      return bind.requestFactory.get<RLLog[]>(
+        `/api/v1/get/logs/ratelimited/${count}`
+      );
+    },
+    rspamd(count: number): Promise<RSLog[]> {
+      return bind.requestFactory.get<RSLog[]>(
+        `/api/v1/get/logs/rspamd-history/${count}`
+      );
+    },
+    sogo(count: number): Promise<SGLog[]> {
+      return bind.requestFactory.get<SGLog[]>(
+        `/api/v1/get/logs/sogo/${count}`
+      );
+    },
+    watchdog(count: number): Promise<WDLog[]> {
+      return bind.requestFactory.get<WDLog[]>(
+        `/api/v1/get/logs/watchdog/${count}`
+      );
+    }
+  };
+}

package/src/Endpoints/mailbox-endpoint.ts

@@ -3,15 +3,80 @@ import {
   MailboxDeleteRequest,
   MailboxEditRequest,
   MailboxPostRequest,
-  MailboxResponse,
+  Mailbox,
   MailcowResponse,
   PushoverEditRequest,
   QuarantaineEditRequest,
   SpamScoreEditRequest
 } from '../types';
 import MailcowClient from '../index';
+import { wrapPromiseToArray } from '../request-factory';
 
-export default function MailboxEndpoints(bind: MailcowClient) {
+/**
+ * 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 function mailboxEndpoints(bind: MailcowClient): MailboxEndpoints {
   return {
     create(payload: MailboxPostRequest): Promise<MailcowResponse> {
       return bind.requestFactory.post<MailcowResponse>(
@@ -23,7 +88,7 @@ export default function MailboxEndpoints(bind: MailcowClient) {
     delete(payload: MailboxDeleteRequest): Promise<MailcowResponse> {
       return bind.requestFactory.post<MailcowResponse>(
         '/api/v1/delete/mailbox',
-        payload.domains
+        payload.mailboxes
       );
     },
 
@@ -34,9 +99,10 @@ export default function MailboxEndpoints(bind: MailcowClient) {
       );
     },
 
-    get(mailbox: string = 'all'): Promise<MailboxResponse[]> {
-      return bind.requestFactory.get<MailboxResponse[]>(
-        `/api/v1/get/mailbox/${ mailbox }`
+    get(mailbox: string = 'all'): Promise<Mailbox[]> {
+      return wrapPromiseToArray<Mailbox>(
+        bind.requestFactory.get<Mailbox[] | Mailbox>(
+          `/api/v1/get/mailbox/${ mailbox }`)
       );
     },
 
@@ -68,9 +134,9 @@ export default function MailboxEndpoints(bind: MailcowClient) {
       );
     },
 
-    getActiveUserSieve(username: string): Promise<string[]> {
+    getActiveUserSieve(mailbox: string): Promise<string[]> {
       return bind.requestFactory.get<string[]>(
-        `/api/v1/get/active-user-sieve/${ username }`
+        `/api/v1/get/active-user-sieve/${ mailbox }`
       );
     }
   };

package/src/Endpoints/syncjob-endpoints.ts

@@ -0,0 +1,55 @@
+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 function syncjobEndpoints(bind: MailcowClient): SyncjobEndpoints {
+  return {
+    getAll(): Promise<Syncjob[]> {
+      return bind.requestFactory.get<Syncjob[]>(
+        '/api/v1/get/syncjobs/all/no_log'
+      );
+    },
+    create(payload: SyncjobPostRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/add/syncjob',
+        payload
+      );
+    },
+    edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/edit/syncjob',
+        payload
+      );
+    },
+    delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/delete/syncjob',
+        payload.items
+      );
+    }
+  };
+}