spitfirepm 23.9700.6 → 23.9700.8

package/README.md

@@ -25,6 +25,8 @@ 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
 23.9700.2   - ProcessDocumentType DataModel enriched

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
      */
@@ -2376,15 +2376,6 @@ export declare class DocumentToolsClient extends APIClientBase {
     private createNextRevisionWithCallbacks;
     private processCreateNextRevisionWithCallbacks;
     protected processCreateNextRevision(xhr: any): boolean | null;
-    /**
-     * Inserts a single route on the specified document
-     * @param id Document Key
-     * @param newRoute Route (DocRoute object)
-     */
-    addDocRoute(id: string, newRoute: DocRoute): Promise<DocRoute | null>;
-    private addDocRouteWithCallbacks;
-    private processAddDocRouteWithCallbacks;
-    protected processAddDocRoute(xhr: any): DocRoute | null | null;
     /**
      * Returns the route on the specified document
      * @param id Document Key
@@ -2413,6 +2404,15 @@ export declare class DocumentToolsClient extends APIClientBase {
     private updateDocRouteWithCallbacks;
     private processUpdateDocRouteWithCallbacks;
     protected processUpdateDocRoute(xhr: any): string | null;
+    /**
+     * Inserts a single route on the specified document
+     * @param id Document Key
+     * @param newRoute Route (DocRoute object)
+     */
+    addDocRoute(id: string, newRoute: DocRoute): Promise<DocRoute | null>;
+    private addDocRouteWithCallbacks;
+    private processAddDocRouteWithCallbacks;
+    protected processAddDocRoute(xhr: any): DocRoute | null | null;
     /**
      * Updates the specified field on the specified route on the specified document.  See also PatchDoc
      * @param id Document Key
@@ -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 */