spitfirepm 23.9700.7 → 23.9700.8

package/README.md

@@ -25,6 +25,7 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
+23.9700.8   - Improved ContactClient endpoints
 23.9700.7   - GetDV method clarifications
 23.9700.6   - Audit History Model enhanced
 23.9700.5   - Lookup Editor Endpoints

package/dist/SwaggerClients.d.ts

@@ -1310,7 +1310,7 @@ export declare class ConfigClient extends APIClientBase {
     private processTestLookupResultWithCallbacks;
     protected processTestLookupResult(xhr: any): LookupTestResult | null | null;
     /**
-     * Returns the Lookups (pickers)
+     * Returns the Lookups (pickers).  Users without LookupEditor permission only see 'Agent' lookups.
      */
     getLookups(): Promise<Lookup[] | null>;
     private getLookupsWithCallbacks;
@@ -1342,7 +1342,7 @@ export declare class ConfigClient extends APIClientBase {
     private processCopyLookupWithCallbacks;
     protected processCopyLookup(xhr: any): Lookup | null | null;
     /**
-     * Returns the fields of one Lookup
+     * Returns the fields of one Lookup.  Non LookupEditor users only see PredicateMode=I.
      * @param lookupKey Lookup key
      */
     getLookupFields(lookupKey: string): Promise<LookupField[] | null>;
@@ -1685,8 +1685,8 @@ export declare class DocumentToolsClient extends APIClientBase {
      * @param id Document Key (use empty for auto assign)
      * @param typeKey Type
      * @param forProject (optional) Project
-     * @param forParent (optional) Parent Doc Key (NextDocFlow rules apply; See https://support.spitfirepm.com/kba-01517/)
-     * @param forBatch (optional) Batch/Subcontract
+     * @param forParent (optional) Parent Doc Key (NextDocFlow rules apply; See https://support.spitfirepm.com/kba-01517/).  When the parent is a commitment, its subcontract number is used and its lines are brought in
+     * @param forBatch (optional) Batch/Subcontract.  Naming a commitment here brings in its lines, same as forParent
      * @param forSourceContact (optional) Source Contact
      */
     createDocument(id: string, typeKey: string, forProject?: string | null | undefined, forParent?: string | null | undefined, forBatch?: string | null | undefined, forSourceContact?: string | null | undefined): Promise<string>;
@@ -1751,6 +1751,15 @@ export declare class DocumentToolsClient extends APIClientBase {
     private patchDocAddressWithCallbacks;
     private processPatchDocAddressWithCallbacks;
     protected processPatchDocAddress(xhr: any): string | null;
+    /**
+     * Inserts an attachment on the specified document, optionally from a template
+     * @param id Document Key
+     * @param newData New attachment data. To copy a template use DocKey:TemplateKey
+     */
+    addDocAttachments(id: string, newData: DocAttachment[]): Promise<DocAttachment | null>;
+    private addDocAttachmentsWithCallbacks;
+    private processAddDocAttachmentsWithCallbacks;
+    protected processAddDocAttachments(xhr: any): DocAttachment | null | null;
     /**
      * Returns the attachments for the specified document
      * @param id Document Key
@@ -1780,15 +1789,6 @@ export declare class DocumentToolsClient extends APIClientBase {
     private updateDocAttachmentsWithCallbacks;
     private processUpdateDocAttachmentsWithCallbacks;
     protected processUpdateDocAttachments(xhr: any): string | null;
-    /**
-     * Inserts an attachment on the specified document, optionally from a template
-     * @param id Document Key
-     * @param newData New attachment data. To copy a template use DocKey:TemplateKey
-     */
-    addDocAttachments(id: string, newData: DocAttachment[]): Promise<DocAttachment | null>;
-    private addDocAttachmentsWithCallbacks;
-    private processAddDocAttachmentsWithCallbacks;
-    protected processAddDocAttachments(xhr: any): DocAttachment | null | null;
     /**
      * Creates a PDF from the Assembled Attachments specified on this document; returns a task key
      * @param id Document Key
@@ -1948,7 +1948,7 @@ export declare class DocumentToolsClient extends APIClientBase {
     private processGetChangedItemsWithCallbacks;
     protected processGetChangedItems(xhr: any): DataDifferential | null;
     /**
-     * Returns the comments for the specified document
+     * Returns the comments for the specified document, most recent first.
      * @param id Document Key
      */
     getDocComments(id: string): Promise<Comment[] | null>;
@@ -1976,7 +1976,7 @@ export declare class DocumentToolsClient extends APIClientBase {
     private processUpdateDocCommentsWithCallbacks;
     protected processUpdateDocComments(xhr: any): string | null;
     /**
-     * Inserts Comments on the specified document
+     * Inserts Comments on the specified document.  Typically TopicKey=DocRevKey because comments are associated with the Doc Revision.  You can specify the empty GUID for TopicKey and/or FromUser, the correct defaults will be supplied (the current Revision and the current user). Other values for TopicKey must resolve to this document (for example, a prior revision comment). Any value for created more than 5 days ago stamps the comment with the server time.  FromUser is set automatically.
      * @param id Document Key
      * @param newData New comment data
      */
@@ -4710,6 +4710,8 @@ export interface ContactSummary {
     Company?: string | undefined;
     /** For Vendors, indicate related CSI  */
     CSIList?: string | undefined;
+    /** Readonly.  Specifies when this user last logged in.  Kept for inactive and former users. */
+    LastLogin?: Date;
     /** When false, this row is ignored and ineffective */
     Active?: boolean;
     /** When true, there are no references to this contact */

package/dist/SwaggerClients.js

@@ -12003,7 +12003,7 @@ class ConfigClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Returns the Lookups (pickers)
+     * Returns the Lookups (pickers).  Users without LookupEditor permission only see 'Agent' lookups.
      */
     getLookups() {
         return new Promise((resolve, reject) => {
@@ -12336,7 +12336,7 @@ class ConfigClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Returns the fields of one Lookup
+     * Returns the fields of one Lookup.  Non LookupEditor users only see PredicateMode=I.
      * @param lookupKey Lookup key
      */
     getLookupFields(lookupKey) {
@@ -14913,6 +14913,12 @@ class ContactClient extends APIClientBase_1.APIClientBase {
             result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
             return throwException("Not allowed", status, _responseText, _headers, result403);
         }
+        else if (status === 500) {
+            const _responseText = xhr.responseText;
+            let result500 = null;
+            result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Failed", status, _responseText, _headers, result500);
+        }
         else if (status !== 200 && status !== 204) {
             const _responseText = xhr.responseText;
             return throwException("An unexpected server error occurred.", status, _responseText, _headers);
@@ -15066,6 +15072,12 @@ class ContactClient extends APIClientBase_1.APIClientBase {
             result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
             return throwException("Not allowed", status, _responseText, _headers, result403);
         }
+        else if (status === 500) {
+            const _responseText = xhr.responseText;
+            let result500 = null;
+            result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Failed", status, _responseText, _headers, result500);
+        }
         else if (status !== 200 && status !== 204) {
             const _responseText = xhr.responseText;
             return throwException("An unexpected server error occurred.", status, _responseText, _headers);
@@ -15510,8 +15522,8 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
      * @param id Document Key (use empty for auto assign)
      * @param typeKey Type
      * @param forProject (optional) Project
-     * @param forParent (optional) Parent Doc Key (NextDocFlow rules apply; See https://support.spitfirepm.com/kba-01517/)
-     * @param forBatch (optional) Batch/Subcontract
+     * @param forParent (optional) Parent Doc Key (NextDocFlow rules apply; See https://support.spitfirepm.com/kba-01517/).  When the parent is a commitment, its subcontract number is used and its lines are brought in
+     * @param forBatch (optional) Batch/Subcontract.  Naming a commitment here brings in its lines, same as forParent
      * @param forSourceContact (optional) Source Contact
      */
     createDocument(id, typeKey, forProject, forParent, forBatch, forSourceContact) {
@@ -16118,38 +16130,41 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Returns the attachments for the specified document
+     * Inserts an attachment on the specified document, optionally from a template
      * @param id Document Key
-     * @return No changes
+     * @param newData New attachment data. To copy a template use DocKey:TemplateKey
      */
-    getDocAttachments(id) {
+    addDocAttachments(id, newData) {
         return new Promise((resolve, reject) => {
-            this.getDocAttachmentsWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
+            this.addDocAttachmentsWithCallbacks(id, newData, (result) => resolve(result), (exception, _reason) => reject(exception));
         });
     }
-    getDocAttachmentsWithCallbacks(id, onSuccess, onFail) {
+    addDocAttachmentsWithCallbacks(id, newData, onSuccess, onFail) {
         let url_ = this.baseUrl + "/api/document/{id}/attachments";
         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(newData);
         jQuery.ajax({
             url: url_,
             beforeSend: this.beforeSend,
-            type: "get",
+            type: "post",
+            data: content_,
             dataType: "text",
             headers: {
+                "Content-Type": "application/json",
                 "Accept": "application/json"
             }
         }).done((_data, _textStatus, xhr) => {
-            this.processGetDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processAddDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         }).fail((xhr) => {
-            this.processGetDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processAddDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         });
     }
-    processGetDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
+    processAddDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
         try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processGetDocAttachments(xhr));
+            let result = this.transformResult(_url, xhr, (xhr) => this.processAddDocAttachments(xhr));
             if (onSuccess !== undefined)
                 onSuccess(result);
         }
@@ -16158,14 +16173,20 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 onFail(e, "http_service_exception");
         }
     }
-    processGetDocAttachments(xhr) {
+    processAddDocAttachments(xhr) {
         const status = xhr.status;
         let _headers = {};
-        if (status === 204) {
+        if (status === 200) {
             const _responseText = xhr.responseText;
-            let result204 = null;
-            result204 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return result204;
+            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("Missing or invalid data", status, _responseText, _headers, result400);
         }
         else if (status === 403) {
             const _responseText = xhr.responseText;
@@ -16189,7 +16210,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
             const _responseText = xhr.responseText;
             let result409 = null;
             result409 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Could not persist the document", status, _responseText, _headers, result409);
+            return throwException("Could not persist the insert", status, _responseText, _headers, result409);
         }
         else if (status === 500) {
             const _responseText = xhr.responseText;
@@ -16204,42 +16225,38 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Removes the specified attachment from the specified document
+     * Returns the attachments for the specified document
      * @param id Document Key
-     * @param attachKeys Doc Attachment Keys
-     * @return Specified addresses not found
+     * @return No changes
      */
-    deleteDocAttachments(id, attachKeys) {
+    getDocAttachments(id) {
         return new Promise((resolve, reject) => {
-            this.deleteDocAttachmentsWithCallbacks(id, attachKeys, (result) => resolve(result), (exception, _reason) => reject(exception));
+            this.getDocAttachmentsWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
         });
     }
-    deleteDocAttachmentsWithCallbacks(id, attachKeys, onSuccess, onFail) {
+    getDocAttachmentsWithCallbacks(id, onSuccess, onFail) {
         let url_ = this.baseUrl + "/api/document/{id}/attachments";
         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(attachKeys);
         jQuery.ajax({
             url: url_,
             beforeSend: this.beforeSend,
-            type: "delete",
-            data: content_,
+            type: "get",
             dataType: "text",
             headers: {
-                "Content-Type": "application/json",
                 "Accept": "application/json"
             }
         }).done((_data, _textStatus, xhr) => {
-            this.processDeleteDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processGetDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         }).fail((xhr) => {
-            this.processDeleteDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processGetDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         });
     }
-    processDeleteDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
+    processGetDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
         try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processDeleteDocAttachments(xhr));
+            let result = this.transformResult(_url, xhr, (xhr) => this.processGetDocAttachments(xhr));
             if (onSuccess !== undefined)
                 onSuccess(result);
         }
@@ -16248,7 +16265,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 onFail(e, "http_service_exception");
         }
     }
-    processDeleteDocAttachments(xhr) {
+    processGetDocAttachments(xhr) {
         const status = xhr.status;
         let _headers = {};
         if (status === 204) {
@@ -16279,7 +16296,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
             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 document", status, _responseText, _headers, result409);
         }
         else if (status === 500) {
             const _responseText = xhr.responseText;
@@ -16294,27 +16311,27 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Updates an attachment on the specified document
+     * Removes the specified attachment from the specified document
      * @param id Document Key
-     * @param updatedData Replacement attachment data
-     * @return Specified attachment not found
+     * @param attachKeys Doc Attachment Keys
+     * @return Specified addresses not found
      */
-    updateDocAttachments(id, updatedData) {
+    deleteDocAttachments(id, attachKeys) {
         return new Promise((resolve, reject) => {
-            this.updateDocAttachmentsWithCallbacks(id, updatedData, (result) => resolve(result), (exception, _reason) => reject(exception));
+            this.deleteDocAttachmentsWithCallbacks(id, attachKeys, (result) => resolve(result), (exception, _reason) => reject(exception));
         });
     }
-    updateDocAttachmentsWithCallbacks(id, updatedData, onSuccess, onFail) {
+    deleteDocAttachmentsWithCallbacks(id, attachKeys, onSuccess, onFail) {
         let url_ = this.baseUrl + "/api/document/{id}/attachments";
         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);
+        const content_ = JSON.stringify(attachKeys);
         jQuery.ajax({
             url: url_,
             beforeSend: this.beforeSend,
-            type: "put",
+            type: "delete",
             data: content_,
             dataType: "text",
             headers: {
@@ -16322,14 +16339,14 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 "Accept": "application/json"
             }
         }).done((_data, _textStatus, xhr) => {
-            this.processUpdateDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processDeleteDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         }).fail((xhr) => {
-            this.processUpdateDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processDeleteDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         });
     }
-    processUpdateDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
+    processDeleteDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
         try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processUpdateDocAttachments(xhr));
+            let result = this.transformResult(_url, xhr, (xhr) => this.processDeleteDocAttachments(xhr));
             if (onSuccess !== undefined)
                 onSuccess(result);
         }
@@ -16338,7 +16355,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 onFail(e, "http_service_exception");
         }
     }
-    processUpdateDocAttachments(xhr) {
+    processDeleteDocAttachments(xhr) {
         const status = xhr.status;
         let _headers = {};
         if (status === 204) {
@@ -16359,11 +16376,17 @@ 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("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 update", status, _responseText, _headers, result409);
+            return throwException("Could not persist the delete", status, _responseText, _headers, result409);
         }
         else if (status === 500) {
             const _responseText = xhr.responseText;
@@ -16378,26 +16401,27 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Inserts an attachment on the specified document, optionally from a template
+     * Updates an attachment on the specified document
      * @param id Document Key
-     * @param newData New attachment data. To copy a template use DocKey:TemplateKey
+     * @param updatedData Replacement attachment data
+     * @return Specified attachment not found
      */
-    addDocAttachments(id, newData) {
+    updateDocAttachments(id, updatedData) {
         return new Promise((resolve, reject) => {
-            this.addDocAttachmentsWithCallbacks(id, newData, (result) => resolve(result), (exception, _reason) => reject(exception));
+            this.updateDocAttachmentsWithCallbacks(id, updatedData, (result) => resolve(result), (exception, _reason) => reject(exception));
         });
     }
-    addDocAttachmentsWithCallbacks(id, newData, onSuccess, onFail) {
+    updateDocAttachmentsWithCallbacks(id, updatedData, onSuccess, onFail) {
         let url_ = this.baseUrl + "/api/document/{id}/attachments";
         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(newData);
+        const content_ = JSON.stringify(updatedData);
         jQuery.ajax({
             url: url_,
             beforeSend: this.beforeSend,
-            type: "post",
+            type: "put",
             data: content_,
             dataType: "text",
             headers: {
@@ -16405,14 +16429,14 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 "Accept": "application/json"
             }
         }).done((_data, _textStatus, xhr) => {
-            this.processAddDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processUpdateDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         }).fail((xhr) => {
-            this.processAddDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
+            this.processUpdateDocAttachmentsWithCallbacks(url_, xhr, onSuccess, onFail);
         });
     }
-    processAddDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
+    processUpdateDocAttachmentsWithCallbacks(_url, xhr, onSuccess, onFail) {
         try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processAddDocAttachments(xhr));
+            let result = this.transformResult(_url, xhr, (xhr) => this.processUpdateDocAttachments(xhr));
             if (onSuccess !== undefined)
                 onSuccess(result);
         }
@@ -16421,20 +16445,14 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
                 onFail(e, "http_service_exception");
         }
     }
-    processAddDocAttachments(xhr) {
+    processUpdateDocAttachments(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) {
+        if (status === 204) {
             const _responseText = xhr.responseText;
-            let result400 = null;
-            result400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Missing or invalid data", status, _responseText, _headers, result400);
+            let result204 = null;
+            result204 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return result204;
         }
         else if (status === 403) {
             const _responseText = xhr.responseText;
@@ -16448,17 +16466,11 @@ 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("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 insert", status, _responseText, _headers, result409);
+            return throwException("Could not persist the update", status, _responseText, _headers, result409);
         }
         else if (status === 500) {
             const _responseText = xhr.responseText;
@@ -17889,7 +17901,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Returns the comments for the specified document
+     * Returns the comments for the specified document, most recent first.
      * @param id Document Key
      */
     getDocComments(id) {
@@ -18118,7 +18130,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Inserts Comments on the specified document
+     * Inserts Comments on the specified document.  Typically TopicKey=DocRevKey because comments are associated with the Doc Revision.  You can specify the empty GUID for TopicKey and/or FromUser, the correct defaults will be supplied (the current Revision and the current user). Other values for TopicKey must resolve to this document (for example, a prior revision comment). Any value for created more than 5 days ago stamps the comment with the server time.  FromUser is set automatically.
      * @param id Document Key
      * @param newData New comment data
      */