ts-mailcow-api 0.8.0 → 0.8.3

package/dist/index.d.ts

@@ -32,8 +32,9 @@ declare class MailcowClient {
      * 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.
+     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
      */
-    constructor(BASE_URL: string, API_KEY: string);
+    constructor(BASE_URL: string, API_KEY: string, EXTRA_AXIOS_CONFIG: AxiosRequestConfig);
     /**
      * Factory method pattern for creating HTTP requests.
      * @internal

package/dist/index.js

@@ -20,8 +20,9 @@ class MailcowClient {
      * 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.
+     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
      */
-    constructor(BASE_URL, API_KEY) {
+    constructor(BASE_URL, API_KEY, EXTRA_AXIOS_CONFIG) {
         /**
          * Factory method pattern for creating HTTP requests.
          * @internal
@@ -69,15 +70,13 @@ class MailcowClient {
          * @external
          */
         this.logs = log_endpoints_1.logEndpoints(this);
-        this.BASE_URL = BASE_URL;
+        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 = {
-            headers: {
+        this.HEADERS = Object.assign({ headers: {
                 'Content-Type': 'application/json',
                 'X-API-Key': this.API_KEY
-            }
-        };
+            } }, EXTRA_AXIOS_CONFIG);
     }
 }
 exports.default = MailcowClient;

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;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;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;CAwDF;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;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAe,EAAE,kBAAsC;QAcrF;;;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;QAlE5C,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,mBACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,IAAI,CAAC,OAAO;aAC1B,IACE,kBAAkB,CACtB,CAAC;IACJ,CAAC;CAwDF;AAED,kBAAe,aAAa,CAAC"}

package/dist/types.d.ts

@@ -296,9 +296,9 @@ export interface SpamPolicy {
  */
 export interface BaseMailboxAttributes {
     /**
-     * Boolean if the mailbox is active.
+     * Integer representing if the mailbox is active (allows for custom states).
      */
-    active: boolean;
+    active: number;
     /**
      * Boolean if the user is forced to update their password on login.
      */

package/package.json

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

package/src/index.ts

@@ -37,9 +37,10 @@ class MailcowClient {
    * 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.
+   * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
    */
-  constructor(BASE_URL: string, API_KEY: string) {
-    this.BASE_URL = BASE_URL;
+  constructor(BASE_URL: string, API_KEY: string, EXTRA_AXIOS_CONFIG: AxiosRequestConfig) {
+    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.
@@ -47,7 +48,8 @@ class MailcowClient {
       headers: {
         'Content-Type': 'application/json',
         'X-API-Key': this.API_KEY
-      }
+      },
+      ...EXTRA_AXIOS_CONFIG
     };
   }