Added documentation.

Author: JustSamuel

package.json

@@ -4,7 +4,7 @@
   "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",
     "docs": "typedoc",
     "build": "tsc",
     "prepare": "tsc",

src/Endpoints/alias-endpoints.ts

@@ -2,56 +2,60 @@ 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>(
         '/api/v1/add/alias',
         payload
       );
     },
-    update: (payload: AliasUpdateRequest): Promise<MailcowResponse> => {
+    edit: (payload: AliasEditRequest): Promise<MailcowResponse> => {
       return bind.requestFactory.post<MailcowResponse>(
         '/api/v1/edit/alias',
         payload

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 }`,
       );
     }

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 }`
-      );
     }
   };
 }

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 }`
       );
     }
   };