ts-mailcow-api 0.6.2 → 0.8.1

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/mailbox-endpoint.d.ts

@@ -1,13 +1,58 @@
-import { ACLEditRequest, MailboxDeleteRequest, MailboxEditRequest, MailboxPostRequest, MailboxResponse, MailcowResponse, PushoverEditRequest, QuarantaineEditRequest, SpamScoreEditRequest } from '../types';
+import { ACLEditRequest, MailboxDeleteRequest, MailboxEditRequest, MailboxPostRequest, Mailbox, MailcowResponse, PushoverEditRequest, QuarantaineEditRequest, SpamScoreEditRequest } from '../types';
 import MailcowClient from '../index';
-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>;
-    get(mailbox?: string): Promise<MailboxResponse[]>;
+    /**
+     * 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>;
-    getActiveUserSieve(username: string): Promise<string[]>;
-};
+    /**
+     * 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,18 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-function MailboxEndpoints(bind) {
+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.domains);
+            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 bind.requestFactory.get(`/api/v1/get/mailbox/${mailbox}`);
+            return request_factory_1.wrapPromiseToArray(bind.requestFactory.get(`/api/v1/get/mailbox/${mailbox}`));
         },
         editPushover(payload) {
             return bind.requestFactory.post('/api/v1/edit/pushover', payload);
@@ -26,10 +33,10 @@ function MailboxEndpoints(bind) {
         editUserACL(payload) {
             return bind.requestFactory.post('/api/v1/edit/user-acl', payload);
         },
-        getActiveUserSieve(username) {
-            return bind.requestFactory.get(`/api/v1/get/active-user-sieve/${username}`);
+        getActiveUserSieve(mailbox) {
+            return bind.requestFactory.get(`/api/v1/get/active-user-sieve/${mailbox}`);
         }
     };
 }
-exports.default = MailboxEndpoints;
+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":";;AAaA,SAAwB,gBAAgB,CAAC,IAAmB;IAC1D,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,OAAO,CAChB,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,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,uBAAwB,OAAQ,EAAE,CACnC,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,QAAgB;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAkC,QAAS,EAAE,CAC9C,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA/DD,mCA+DC"}
+{"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"}

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

@@ -0,0 +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;

package/dist/Endpoints/syncjob-endpoints.js

@@ -0,0 +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;
+//# sourceMappingURL=syncjob-endpoints.js.map

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

@@ -0,0 +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,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

@@ -1,8 +1,15 @@
 /**
  * @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
@@ -16,39 +23,63 @@ declare class MailcowClient {
      * The API key of the Mailcow API.
      */
     readonly API_KEY: string;
-    HEADERS: {};
+    /**
+     * 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.
      */
     constructor(BASE_URL: string, API_KEY: string);
+    /**
+     * Factory method pattern for creating HTTP requests.
+     * @internal
+     */
     requestFactory: RequestFactory;
     /**
      * All endpoints related to Aliases.
+     * See {@link AliasEndpoints}
+     * @external
      */
     aliases: AliasEndpoints;
-    domains: {
-        create(payload: import("./types").DomainPostRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        delete(payload: import("./types").DomainDeleteRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        edit(payload: import("./types").DomainEditRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        get(domain?: string): Promise<import("./types").DomainResponse | import("./types").DomainResponse[]>;
-    };
-    spamPolicy: {
-        create(payload: import("./types").SpamPolicyPostRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        delete(payload: import("./types").SpamPolicyDeleteRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        get(payload: import("./types").SpamPolicyGetRequest): Promise<import("./types").SpamPolicyResponse[]>;
-    };
-    mailbox: {
-        create(payload: import("./types").MailboxPostRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        delete(payload: import("./types").MailboxDeleteRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        edit(payload: import("./types").MailboxEditRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        get(mailbox?: string): Promise<import("./types").MailboxResponse[]>;
-        editPushover(payload: import("./types").PushoverEditRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        editQuarantine(payload: import("./types").QuarantaineEditRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        editSpamScore(payload: import("./types").SpamScoreEditRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        editUserACL(payload: import("./types").ACLEditRequest): Promise<import("./types").MailcowResponse<import("./types").BaseResponse>>;
-        getActiveUserSieve(username: string): Promise<string[]>;
-    };
+    /**
+     * 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

@@ -8,6 +8,9 @@ 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
@@ -19,15 +22,54 @@ class MailcowClient {
      * @param API_KEY  - The API key of the Mailcow API.
      */
     constructor(BASE_URL, API_KEY) {
+        /**
+         * 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);
-        this.domains = domain_endpoints_1.default(this);
-        this.spamPolicy = antispam_endpoints_1.default(this);
-        this.mailbox = mailbox_endpoint_1.default(this);
-        this.BASE_URL = BASE_URL;
+        /**
+         * 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 = {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAGH,mEAA2D;AAC3D,uEAA+D;AAC/D,mEAA4D;AAC5D,uDAA+C;AAC/C,iEAA6E;AAE7E;;;GAGG;AACH,MAAM,aAAa;IAajB;;;;OAIG;IACH,YAAY,QAAgB,EAAE,OAAe;QAatC,mBAAc,GAAG,IAAI,yBAAc,CAAC,IAAI,CAAC,CAAA;QAEhD;;WAEG;QACI,YAAO,GAAmB,gCAAc,CAAC,IAAI,CAAC,CAAA;QAE9C,YAAO,GAAG,0BAAe,CAAC,IAAI,CAAC,CAAA;QAE/B,eAAU,GAAG,4BAAiB,CAAC,IAAI,CAAC,CAAA;QAEpC,YAAO,GAAG,0BAAgB,CAAC,IAAI,CAAC,CAAA;QAvBrC,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;SACoB,CAAC;IAC1B,CAAC;CAcF;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"}

package/dist/request-factory.d.ts

@@ -1,5 +1,10 @@
 import { Payload } from './types';
 import MailcowClient from './index';
+/**
+ * Function that wraps T | T[] to T[]
+ * @internal
+ * @param promise - The promise of which the output to wrap.
+ */
 export declare function wrapPromiseToArray<T>(promise: Promise<T | T[]>): Promise<T[]>;
 /**
  * Factory method patterns for creating Axios Requests.

package/dist/request-factory.js

@@ -12,9 +12,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.wrapPromiseToArray = void 0;
 const axios_1 = require("axios");
 const types_1 = require("./types");
+/**
+ * Ensures output is an array.
+ * @param item
+ * @internal
+ */
 function wrapToArray(item) {
     return Array.isArray(item) ? item : [item];
 }
+/**
+ * Function that wraps T | T[] to T[]
+ * @internal
+ * @param promise - The promise of which the output to wrap.
+ */
 function wrapPromiseToArray(promise) {
     return new Promise((resolve, reject) => {
         promise

package/dist/request-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-factory.js","sourceRoot":"","sources":["../src/request-factory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAyD;AACzD,mCAA0E;AAG1E,SAAS,WAAW,CAAI,IAAa;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED,SAAgB,kBAAkB,CAAI,OAAuB;IAC3D,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,OAAO;aACJ,IAAI,CAAC,CAAC,GAAY,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;aACjD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAND,gDAMC;AAED;;;GAGG;AACH,MAAqB,cAAc;IAGjC,YAAY,GAAkB;QAC5B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACG,IAAI,CAAI,KAAa,EAAE,OAAgB;;YAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,eAAK;qBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;oBAC3D,YAAY;qBACX,IAAI,CAAC,CAAC,GAAqB,EAAE,EAAE;oBAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACpB,CAAC,CAAC;oBACF,WAAW;qBACV,KAAK,CAAC,CAAC,CAAmC,EAAE,EAAE;oBAC7C,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAChC,MAAM,CAAC,IAAI,wBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpC,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,GAAG,CAAI,KAAa;;YACxB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,eAAK;qBACF,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;oBACjD,YAAY;qBACX,IAAI,CAAC,CAAC,GAAqB,EAAE,EAAE;oBAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACpB,CAAC,CAAC;oBACF,WAAW;qBACV,KAAK,CAAC,CAAC,CAAmC,EAAE,EAAE;oBAC7C,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAChC,MAAM,CAAC,IAAI,wBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpC,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA/CD,iCA+CC"}
+{"version":3,"file":"request-factory.js","sourceRoot":"","sources":["../src/request-factory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAyD;AACzD,mCAA0E;AAG1E;;;;GAIG;AACH,SAAS,WAAW,CAAI,IAAa;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAI,OAAuB;IAC3D,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,OAAO;aACJ,IAAI,CAAC,CAAC,GAAY,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;aACjD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAND,gDAMC;AAED;;;GAGG;AACH,MAAqB,cAAc;IAGjC,YAAY,GAAkB;QAC5B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACG,IAAI,CAAI,KAAa,EAAE,OAAgB;;YAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,eAAK;qBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;oBAC3D,YAAY;qBACX,IAAI,CAAC,CAAC,GAAqB,EAAE,EAAE;oBAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACpB,CAAC,CAAC;oBACF,WAAW;qBACV,KAAK,CAAC,CAAC,CAAmC,EAAE,EAAE;oBAC7C,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAChC,MAAM,CAAC,IAAI,wBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpC,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,GAAG,CAAI,KAAa;;YACxB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,eAAK;qBACF,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;oBACjD,YAAY;qBACX,IAAI,CAAC,CAAC,GAAqB,EAAE,EAAE;oBAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACpB,CAAC,CAAC;oBACF,WAAW;qBACV,KAAK,CAAC,CAAC,CAAmC,EAAE,EAAE;oBAC7C,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAChC,MAAM,CAAC,IAAI,wBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpC,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA/CD,iCA+CC"}