spitfirepm 23.9700.1 → 23.9700.2

package/README.md

@@ -25,6 +25,7 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
+23.9700.2   - ProcessDocumentType DataModel enriched
 23.9700.1   - GatherDependsOnValues() improved
 23.9600.18  - Project Program
 23.9600.17  - Improves Analytics opt out

package/dist/SwaggerClients.d.ts

@@ -1510,15 +1510,6 @@ export declare class DocumentToolsClient extends APIClientBase {
     beforeSend: any;
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(baseUrl?: string);
-    /**
-     * Updates the header On the specified document
-     * @param id Document Key
-     * @param updatedData Replacement data
-     */
-    updateDocHeader(id: string, updatedData: DocMasterDetail): Promise<any>;
-    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
@@ -1535,6 +1526,15 @@ export declare class DocumentToolsClient extends APIClientBase {
     private deleteDocHeaderWithCallbacks;
     private processDeleteDocHeaderWithCallbacks;
     protected processDeleteDocHeader(xhr: any): any | null;
+    /**
+     * Updates the header On the specified document
+     * @param id Document Key
+     * @param updatedData Replacement data
+     */
+    updateDocHeader(id: string, updatedData: DocMasterDetail): Promise<any>;
+    private updateDocHeaderWithCallbacks;
+    private processUpdateDocHeaderWithCallbacks;
+    protected processUpdateDocHeader(xhr: any): any | null;
     /**
      * Updates a Single field On the header Of the specified document
      * @param id Document Key
@@ -2725,7 +2725,7 @@ export declare class ProjectToolsClient extends APIClientBase {
     /**
      * Returns programs in which the specified project is listed
      * @param projectID Full Project ID
-     * @param programList list of programs
+     * @param programList list of programs by ProgramKey, PgmPjtMapKey or Program ID
      */
     removeProjectPrograms(projectID: string | null, programList: string[]): Promise<ProjectPrograms[] | null>;
     private removeProjectProgramsWithCallbacks;
@@ -6612,10 +6612,19 @@ export interface ProcessDocumentType {
     MobileDashboard?: boolean;
     /** When True, shown on project dashboards */
     ProjectDashboard?: boolean;
-    /** When True, can create from project dashboard */
-    NewFromDashboard?: boolean;
+    /** When True, tracks compliance */
+    CheckCompliance?: boolean;
+    /** When True, can be sync'd to cloud storage (other rules apply)   */
+    CloudSync?: boolean;
     /** When True, is created from a parent document */
     CreateFromParent?: boolean;
+    /** When True, Document Numbers are sequenced across projects (PO,Work Posted, etc)
+When False, numbers start over on every project (See DocNumbering | StartDocNumber) */
+    CrossProjectNumbering?: boolean;
+    /** When True, can create from project dashboard */
+    NewFromDashboard?: boolean;
+    /** When True, Project is an optional field (Rare) */
+    ProjectIsOptional?: boolean;
     /** When True, uses an item register */
     UseItemRegister?: boolean;
     /** When True, is Site Active */

package/dist/SwaggerClients.js

@@ -13844,41 +13844,37 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
     }
     /**
-     * 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);
         }
@@ -13887,10 +13883,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);
@@ -13908,18 +13904,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;
@@ -13933,15 +13917,15 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * 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.");
@@ -13950,20 +13934,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);
         }
@@ -13972,10 +13956,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);
@@ -13991,7 +13975,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;
@@ -14006,37 +14002,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);
         }
@@ -14045,7 +14045,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) {
@@ -14064,19 +14064,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;
@@ -24719,7 +24719,7 @@ class ProjectToolsClient extends APIClientBase_1.APIClientBase {
     /**
      * Returns programs in which the specified project is listed
      * @param projectID Full Project ID
-     * @param programList list of programs
+     * @param programList list of programs by ProgramKey, PgmPjtMapKey or Program ID
      */
     removeProjectPrograms(projectID, programList) {
         return new Promise((resolve, reject) => {