spitfirepm 23.9600.14 → 23.9600.15

package/README.md

@@ -25,6 +25,7 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
+23.9600.15  - Improves ConfigController
 23.9600.13  - ARR cleanup
 23.9600.12  - ARR endpoints
 23.9600.11  - Adds Admin and Manage Tool Data Models and Endpoints

package/dist/SwaggerClients.d.ts

@@ -1228,6 +1228,14 @@ export declare class ConfigClient extends APIClientBase {
     private deleteEventSubscriptionsWithCallbacks;
     private processDeleteEventSubscriptionsWithCallbacks;
     protected processDeleteEventSubscriptions(xhr: any): number | null;
+    /**
+     * Returns a named dashboard tool menu
+     * @param menuId The DropDownMenu name, e.g. ManagerToolMenu or AdminToolMenu
+     */
+    getToolsMenu(menuId: string | null): Promise<MenuAction[] | null>;
+    private getToolsMenuWithCallbacks;
+    private processGetToolsMenuWithCallbacks;
+    protected processGetToolsMenu(xhr: any): MenuAction[] | null | null;
     /**
      * Returns the Manage dashboard tool menu
      */
@@ -1390,6 +1398,31 @@ export declare class ConfigClient extends APIClientBase {
     private deleteScopedCodeSetValuesWithCallbacks;
     private processDeleteScopedCodeSetValuesWithCallbacks;
     protected processDeleteScopedCodeSetValues(xhr: any): number | null;
+    /**
+     * Returns the current user's settings
+     */
+    getUserSettings(): Promise<{
+        [key: string]: any;
+    } | null>;
+    private getUserSettingsWithCallbacks;
+    private processGetUserSettingsWithCallbacks;
+    protected processGetUserSettings(xhr: any): {
+        [key: string]: any;
+    } | null | null;
+    /**
+     * Updates the current user's settings
+     * @param settings Settings to merge
+     */
+    patchUserSettings(settings: {
+        [key: string]: any;
+    }): Promise<{
+        [key: string]: any;
+    } | null>;
+    private patchUserSettingsWithCallbacks;
+    private processPatchUserSettingsWithCallbacks;
+    protected processPatchUserSettings(xhr: any): {
+        [key: string]: any;
+    } | null | null;
     /**
      * Returns the list of workflow scripts
      */
@@ -1469,14 +1502,6 @@ export declare class DocumentToolsClient extends APIClientBase {
     beforeSend: any;
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(baseUrl?: string);
-    /**
-     * Returns the header Of the specified document, including a Document Session Key
-     * @param id Document Key
-     */
-    getDocHeader(id: string): Promise<DocMasterDetail | null>;
-    private getDocHeaderWithCallbacks;
-    private processGetDocHeaderWithCallbacks;
-    protected processGetDocHeader(xhr: any): DocMasterDetail | null | null;
     /**
      * Deletes the specified document
      * @param id Document Key
@@ -1494,6 +1519,14 @@ export declare class DocumentToolsClient extends APIClientBase {
     private updateDocHeaderWithCallbacks;
     private processUpdateDocHeaderWithCallbacks;
     protected processUpdateDocHeader(xhr: any): any | null;
+    /**
+     * Returns the header Of the specified document, including a Document Session Key
+     * @param id Document Key
+     */
+    getDocHeader(id: string): Promise<DocMasterDetail | null>;
+    private getDocHeaderWithCallbacks;
+    private processGetDocHeaderWithCallbacks;
+    protected processGetDocHeader(xhr: any): DocMasterDetail | null | null;
     /**
      * Updates a Single field On the header Of the specified document
      * @param id Document Key

package/dist/SwaggerClients.js

@@ -11203,6 +11203,79 @@ class ConfigClient extends APIClientBase_1.APIClientBase {
         }
         return null;
     }
+    /**
+     * Returns a named dashboard tool menu
+     * @param menuId The DropDownMenu name, e.g. ManagerToolMenu or AdminToolMenu
+     */
+    getToolsMenu(menuId) {
+        return new Promise((resolve, reject) => {
+            this.getToolsMenuWithCallbacks(menuId, (result) => resolve(result), (exception, _reason) => reject(exception));
+        });
+    }
+    getToolsMenuWithCallbacks(menuId, onSuccess, onFail) {
+        let url_ = this.baseUrl + "/api/configuration/list-tools/{menuId}";
+        if (menuId === undefined || menuId === null)
+            throw new globalThis.Error("The parameter 'menuId' must be defined.");
+        url_ = url_.replace("{menuId}", encodeURIComponent("" + menuId));
+        url_ = url_.replace(/[?&]$/, "");
+        jQuery.ajax({
+            url: url_,
+            beforeSend: this.beforeSend,
+            type: "get",
+            dataType: "text",
+            headers: {
+                "Accept": "application/json"
+            }
+        }).done((_data, _textStatus, xhr) => {
+            this.processGetToolsMenuWithCallbacks(url_, xhr, onSuccess, onFail);
+        }).fail((xhr) => {
+            this.processGetToolsMenuWithCallbacks(url_, xhr, onSuccess, onFail);
+        });
+    }
+    processGetToolsMenuWithCallbacks(_url, xhr, onSuccess, onFail) {
+        try {
+            let result = this.transformResult(_url, xhr, (xhr) => this.processGetToolsMenu(xhr));
+            if (onSuccess !== undefined)
+                onSuccess(result);
+        }
+        catch (e) {
+            if (onFail !== undefined)
+                onFail(e, "http_service_exception");
+        }
+    }
+    processGetToolsMenu(xhr) {
+        const status = xhr.status;
+        let _headers = {};
+        if (status === 200) {
+            const _responseText = xhr.responseText;
+            let result200 = null;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return result200;
+        }
+        else if (status === 401) {
+            const _responseText = xhr.responseText;
+            let result401 = null;
+            result401 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Not currently authenticated", status, _responseText, _headers, result401);
+        }
+        else if (status === 404) {
+            const _responseText = xhr.responseText;
+            let result404 = null;
+            result404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("No such menu, or the menu resolved to no tools", status, _responseText, _headers, result404);
+        }
+        else if (status === 500) {
+            const _responseText = xhr.responseText;
+            let result500 = null;
+            result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Internal failure; see response", status, _responseText, _headers, result500);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = xhr.responseText;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return null;
+    }
     /**
      * Returns the Manage dashboard tool menu
      */
@@ -12916,6 +12989,142 @@ class ConfigClient extends APIClientBase_1.APIClientBase {
         }
         return null;
     }
+    /**
+     * Returns the current user's settings
+     */
+    getUserSettings() {
+        return new Promise((resolve, reject) => {
+            this.getUserSettingsWithCallbacks((result) => resolve(result), (exception, _reason) => reject(exception));
+        });
+    }
+    getUserSettingsWithCallbacks(onSuccess, onFail) {
+        let url_ = this.baseUrl + "/api/configuration/user-settings";
+        url_ = url_.replace(/[?&]$/, "");
+        jQuery.ajax({
+            url: url_,
+            beforeSend: this.beforeSend,
+            type: "get",
+            dataType: "text",
+            headers: {
+                "Accept": "application/json"
+            }
+        }).done((_data, _textStatus, xhr) => {
+            this.processGetUserSettingsWithCallbacks(url_, xhr, onSuccess, onFail);
+        }).fail((xhr) => {
+            this.processGetUserSettingsWithCallbacks(url_, xhr, onSuccess, onFail);
+        });
+    }
+    processGetUserSettingsWithCallbacks(_url, xhr, onSuccess, onFail) {
+        try {
+            let result = this.transformResult(_url, xhr, (xhr) => this.processGetUserSettings(xhr));
+            if (onSuccess !== undefined)
+                onSuccess(result);
+        }
+        catch (e) {
+            if (onFail !== undefined)
+                onFail(e, "http_service_exception");
+        }
+    }
+    processGetUserSettings(xhr) {
+        const status = xhr.status;
+        let _headers = {};
+        if (status === 200) {
+            const _responseText = xhr.responseText;
+            let result200 = null;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return result200;
+        }
+        else if (status === 401) {
+            const _responseText = xhr.responseText;
+            let result401 = null;
+            result401 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Not currently authenticated", status, _responseText, _headers, result401);
+        }
+        else if (status === 500) {
+            const _responseText = xhr.responseText;
+            let result500 = null;
+            result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Internal failure; see response", status, _responseText, _headers, result500);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = xhr.responseText;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return null;
+    }
+    /**
+     * Updates the current user's settings
+     * @param settings Settings to merge
+     */
+    patchUserSettings(settings) {
+        return new Promise((resolve, reject) => {
+            this.patchUserSettingsWithCallbacks(settings, (result) => resolve(result), (exception, _reason) => reject(exception));
+        });
+    }
+    patchUserSettingsWithCallbacks(settings, onSuccess, onFail) {
+        let url_ = this.baseUrl + "/api/configuration/user-settings";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(settings);
+        jQuery.ajax({
+            url: url_,
+            beforeSend: this.beforeSend,
+            type: "patch",
+            data: content_,
+            dataType: "text",
+            headers: {
+                "Content-Type": "application/json",
+                "Accept": "application/json"
+            }
+        }).done((_data, _textStatus, xhr) => {
+            this.processPatchUserSettingsWithCallbacks(url_, xhr, onSuccess, onFail);
+        }).fail((xhr) => {
+            this.processPatchUserSettingsWithCallbacks(url_, xhr, onSuccess, onFail);
+        });
+    }
+    processPatchUserSettingsWithCallbacks(_url, xhr, onSuccess, onFail) {
+        try {
+            let result = this.transformResult(_url, xhr, (xhr) => this.processPatchUserSettings(xhr));
+            if (onSuccess !== undefined)
+                onSuccess(result);
+        }
+        catch (e) {
+            if (onFail !== undefined)
+                onFail(e, "http_service_exception");
+        }
+    }
+    processPatchUserSettings(xhr) {
+        const status = xhr.status;
+        let _headers = {};
+        if (status === 200) {
+            const _responseText = xhr.responseText;
+            let result200 = null;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return result200;
+        }
+        else if (status === 400) {
+            const _responseText = xhr.responseText;
+            let result400 = null;
+            result400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Request malformed", status, _responseText, _headers, result400);
+        }
+        else if (status === 401) {
+            const _responseText = xhr.responseText;
+            let result401 = null;
+            result401 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Not currently authenticated", status, _responseText, _headers, result401);
+        }
+        else if (status === 500) {
+            const _responseText = xhr.responseText;
+            let result500 = null;
+            result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Internal failure; see response", status, _responseText, _headers, result500);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = xhr.responseText;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return null;
+    }
     /**
      * Returns the list of workflow scripts
      */
@@ -13568,15 +13777,15 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
     }
     /**
-     * Returns the header Of the specified document, including a Document Session Key
+     * Deletes the specified document
      * @param id Document Key
      */
-    getDocHeader(id) {
+    deleteDocHeader(id) {
         return new Promise((resolve, reject) => {
-            this.getDocHeaderWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
+            this.deleteDocHeaderWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
         });
     }
-    getDocHeaderWithCallbacks(id, onSuccess, onFail) {
+    deleteDocHeaderWithCallbacks(id, onSuccess, onFail) {
         let url_ = this.baseUrl + "/api/document/{id}";
         if (id === undefined || id === null)
             throw new globalThis.Error("The parameter 'id' must be defined.");
@@ -13585,20 +13794,20 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         jQuery.ajax({
             url: url_,
             beforeSend: this.beforeSend,
-            type: "get",
+            type: "delete",
             dataType: "text",
             headers: {
-                "Accept": "application/json"
+                "Accept": "application/octet-stream"
             }
         }).done((_data, _textStatus, xhr) => {
-            this.processGetDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processDeleteDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
         }).fail((xhr) => {
-            this.processGetDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processDeleteDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
         });
     }
-    processGetDocHeaderWithCallbacks(_url, xhr, onSuccess, onFail) {
+    processDeleteDocHeaderWithCallbacks(_url, xhr, onSuccess, onFail) {
         try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processGetDocHeader(xhr));
+            let result = this.transformResult(_url, xhr, (xhr) => this.processDeleteDocHeader(xhr));
             if (onSuccess !== undefined)
                 onSuccess(result);
         }
@@ -13607,10 +13816,10 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 onFail(e, "http_service_exception");
         }
     }
-    processGetDocHeader(xhr) {
+    processDeleteDocHeader(xhr) {
         const status = xhr.status;
         let _headers = {};
-        if (status === 200) {
+        if (status === 200 || status === 206) {
             const _responseText = xhr.responseText;
             let result200 = null;
             result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
@@ -13626,7 +13835,19 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
             const _responseText = xhr.responseText;
             let result404 = null;
             result404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Document Not found, Or Not accessible", status, _responseText, _headers, result404);
+            return throwException("Document not found, or not accessible", status, _responseText, _headers, result404);
+        }
+        else if (status === 406) {
+            const _responseText = xhr.responseText;
+            let result406 = null;
+            result406 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Not acceptable", status, _responseText, _headers, result406);
+        }
+        else if (status === 409) {
+            const _responseText = xhr.responseText;
+            let result409 = null;
+            result409 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Could Not persist the delete", status, _responseText, _headers, result409);
         }
         else if (status === 500) {
             const _responseText = xhr.responseText;
@@ -13641,37 +13862,41 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Deletes the specified document
+     * Updates the header On the specified document
      * @param id Document Key
+     * @param updatedData Replacement data
      */
-    deleteDocHeader(id) {
+    updateDocHeader(id, updatedData) {
         return new Promise((resolve, reject) => {
-            this.deleteDocHeaderWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
+            this.updateDocHeaderWithCallbacks(id, updatedData, (result) => resolve(result), (exception, _reason) => reject(exception));
         });
     }
-    deleteDocHeaderWithCallbacks(id, onSuccess, onFail) {
+    updateDocHeaderWithCallbacks(id, updatedData, onSuccess, onFail) {
         let url_ = this.baseUrl + "/api/document/{id}";
         if (id === undefined || id === null)
             throw new globalThis.Error("The parameter 'id' must be defined.");
         url_ = url_.replace("{id}", encodeURIComponent("" + id));
         url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(updatedData);
         jQuery.ajax({
             url: url_,
             beforeSend: this.beforeSend,
-            type: "delete",
+            type: "put",
+            data: content_,
             dataType: "text",
             headers: {
+                "Content-Type": "application/json",
                 "Accept": "application/octet-stream"
             }
         }).done((_data, _textStatus, xhr) => {
-            this.processDeleteDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processUpdateDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
         }).fail((xhr) => {
-            this.processDeleteDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processUpdateDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
         });
     }
-    processDeleteDocHeaderWithCallbacks(_url, xhr, onSuccess, onFail) {
+    processUpdateDocHeaderWithCallbacks(_url, xhr, onSuccess, onFail) {
         try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processDeleteDocHeader(xhr));
+            let result = this.transformResult(_url, xhr, (xhr) => this.processUpdateDocHeader(xhr));
             if (onSuccess !== undefined)
                 onSuccess(result);
         }
@@ -13680,7 +13905,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 onFail(e, "http_service_exception");
         }
     }
-    processDeleteDocHeader(xhr) {
+    processUpdateDocHeader(xhr) {
         const status = xhr.status;
         let _headers = {};
         if (status === 200 || status === 206) {
@@ -13699,19 +13924,19 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
             const _responseText = xhr.responseText;
             let result404 = null;
             result404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Document not found, or not accessible", status, _responseText, _headers, result404);
+            return throwException("Document Not found, Or Not accessible", status, _responseText, _headers, result404);
         }
         else if (status === 406) {
             const _responseText = xhr.responseText;
             let result406 = null;
             result406 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Not acceptable", status, _responseText, _headers, result406);
+            return throwException("Document number cannot be changed by this method", status, _responseText, _headers, result406);
         }
         else if (status === 409) {
             const _responseText = xhr.responseText;
             let result409 = null;
             result409 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Could Not persist the delete", status, _responseText, _headers, result409);
+            return throwException("Could Not persist the update", status, _responseText, _headers, result409);
         }
         else if (status === 500) {
             const _responseText = xhr.responseText;
@@ -13726,41 +13951,37 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Updates the header On the specified document
+     * Returns the header Of the specified document, including a Document Session Key
      * @param id Document Key
-     * @param updatedData Replacement data
      */
-    updateDocHeader(id, updatedData) {
+    getDocHeader(id) {
         return new Promise((resolve, reject) => {
-            this.updateDocHeaderWithCallbacks(id, updatedData, (result) => resolve(result), (exception, _reason) => reject(exception));
+            this.getDocHeaderWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
         });
     }
-    updateDocHeaderWithCallbacks(id, updatedData, onSuccess, onFail) {
+    getDocHeaderWithCallbacks(id, onSuccess, onFail) {
         let url_ = this.baseUrl + "/api/document/{id}";
         if (id === undefined || id === null)
             throw new globalThis.Error("The parameter 'id' must be defined.");
         url_ = url_.replace("{id}", encodeURIComponent("" + id));
         url_ = url_.replace(/[?&]$/, "");
-        const content_ = JSON.stringify(updatedData);
         jQuery.ajax({
             url: url_,
             beforeSend: this.beforeSend,
-            type: "put",
-            data: content_,
+            type: "get",
             dataType: "text",
             headers: {
-                "Content-Type": "application/json",
-                "Accept": "application/octet-stream"
+                "Accept": "application/json"
             }
         }).done((_data, _textStatus, xhr) => {
-            this.processUpdateDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processGetDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
         }).fail((xhr) => {
-            this.processUpdateDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processGetDocHeaderWithCallbacks(url_, xhr, onSuccess, onFail);
         });
     }
-    processUpdateDocHeaderWithCallbacks(_url, xhr, onSuccess, onFail) {
+    processGetDocHeaderWithCallbacks(_url, xhr, onSuccess, onFail) {
         try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processUpdateDocHeader(xhr));
+            let result = this.transformResult(_url, xhr, (xhr) => this.processGetDocHeader(xhr));
             if (onSuccess !== undefined)
                 onSuccess(result);
         }
@@ -13769,10 +13990,10 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 onFail(e, "http_service_exception");
         }
     }
-    processUpdateDocHeader(xhr) {
+    processGetDocHeader(xhr) {
         const status = xhr.status;
         let _headers = {};
-        if (status === 200 || status === 206) {
+        if (status === 200) {
             const _responseText = xhr.responseText;
             let result200 = null;
             result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
@@ -13790,18 +14011,6 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
             result404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
             return throwException("Document Not found, Or Not accessible", status, _responseText, _headers, result404);
         }
-        else if (status === 406) {
-            const _responseText = xhr.responseText;
-            let result406 = null;
-            result406 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Document number cannot be changed by this method", status, _responseText, _headers, result406);
-        }
-        else if (status === 409) {
-            const _responseText = xhr.responseText;
-            let result409 = null;
-            result409 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Could Not persist the update", status, _responseText, _headers, result409);
-        }
         else if (status === 500) {
             const _responseText = xhr.responseText;
             let result500 = null;