spitfirepm 23.9700.4 → 23.9700.6

package/README.md

@@ -25,7 +25,8 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
-23.9700.4   - Lookup Editor Endpoints
+23.9700.6   - Audit History Model enhanced
+23.9700.5   - Lookup Editor Endpoints
 23.9700.2   - ProcessDocumentType DataModel enriched
 23.9700.1   - GatherDependsOnValues() improved
 23.9600.18  - Project Program

package/dist/SwaggerClients.d.ts

@@ -240,7 +240,7 @@ export declare class LookupClient extends APIClientBase {
     /**
      * Returns list of prior values for this field
      * @param dataMember Name of table
-     * @param dataField Name of field
+     * @param dataField Name of field; use zero for all fields
      * @param rowKey PK identifier of specific record
      * @param sinceWhen (optional) Optional date since when data should be returned
      */
@@ -560,6 +560,14 @@ export declare class CatalogClient extends APIClientBase {
     private deleteFileWithCallbacks;
     private processDeleteFileWithCallbacks;
     protected processDeleteFile(xhr: any): any | null;
+    /**
+     * Returns a site helper script, stylesheet or image held in the catalog
+     * @param assetPath Path below /zPublicHTML, eg js/XTSDocHelper.js
+     */
+    getPublicAsset(assetPath: string | null): Promise<any>;
+    private getPublicAssetWithCallbacks;
+    private processGetPublicAssetWithCallbacks;
+    protected processGetPublicAsset(xhr: any): any | null;
     /**
      * Returns a background task ID and initiates a task to build a PDF of all documents enumerated in the exportRequest
      * @param exportRequest Specifics for export requested
@@ -1245,7 +1253,7 @@ export declare class ConfigClient extends APIClientBase {
     private processGetToolsMenuWithCallbacks;
     protected processGetToolsMenu(xhr: any): MenuAction[] | null | null;
     /**
-     * Returns the Lookup Results (DVs)
+     * Returns the Lookup Results (DVs), each with its parameter slots
      */
     getLookupResults(): Promise<LookupResult[] | null>;
     private getLookupResultsWithCallbacks;
@@ -1259,6 +1267,23 @@ export declare class ConfigClient extends APIClientBase {
     private patchLookupResultWithCallbacks;
     private processPatchLookupResultWithCallbacks;
     protected processPatchLookupResult(xhr: any): LookupResult | null | null;
+    /**
+     * Deactivates one Lookup Result and its parameter slots
+     * @param lookupResultKey Lookup Result key
+     */
+    deleteLookupResult(lookupResultKey: string): Promise<number>;
+    private deleteLookupResultWithCallbacks;
+    private processDeleteLookupResultWithCallbacks;
+    protected processDeleteLookupResult(xhr: any): number | null;
+    /**
+     * Copies one Lookup Result and all of its parameter slots
+     * @param lookupResultKey Lookup Result to copy
+     * @param newName (optional) Name for the copy. Omit to have one generated
+     */
+    copyLookupResult(lookupResultKey: string, newName?: string | null | undefined): Promise<LookupResult | null>;
+    private copyLookupResultWithCallbacks;
+    private processCopyLookupResultWithCallbacks;
+    protected processCopyLookupResult(xhr: any): LookupResult | null | null;
     /**
      * Returns the parameter slots of one Lookup Result
      * @param lookupResultKey Lookup Result key
@@ -1299,6 +1324,23 @@ export declare class ConfigClient extends APIClientBase {
     private patchLookupWithCallbacks;
     private processPatchLookupWithCallbacks;
     protected processPatchLookup(xhr: any): Lookup | null | null;
+    /**
+     * Deactivates one Lookup and its fields
+     * @param lookupKey Lookup key
+     */
+    deleteLookup(lookupKey: string): Promise<number>;
+    private deleteLookupWithCallbacks;
+    private processDeleteLookupWithCallbacks;
+    protected processDeleteLookup(xhr: any): number | null;
+    /**
+     * Copies one Lookup and all of its field rows
+     * @param lookupKey Lookup to copy
+     * @param newName (optional) Name for the copy. Omit to have one generated
+     */
+    copyLookup(lookupKey: string, newName?: string | null | undefined): Promise<Lookup | null>;
+    private copyLookupWithCallbacks;
+    private processCopyLookupWithCallbacks;
+    protected processCopyLookup(xhr: any): Lookup | null | null;
     /**
      * Returns the fields of one Lookup
      * @param lookupKey Lookup key
@@ -1316,6 +1358,14 @@ export declare class ConfigClient extends APIClientBase {
     private putLookupFieldsWithCallbacks;
     private processPutLookupFieldsWithCallbacks;
     protected processPutLookupFields(xhr: any): LookupField[] | null | null;
+    /**
+     * Runs a Lookup's Data Query against supplied values, returning the row count AND the SQL
+     * @param valueFor Type-ahead text, plus any depends-on values
+     */
+    testLookup(valueFor: DVRequest): Promise<LookupTestResult | null>;
+    private testLookupWithCallbacks;
+    private processTestLookupWithCallbacks;
+    protected processTestLookup(xhr: any): LookupTestResult | null | null;
     /**
      * Returns the Manage dashboard tool menu
      */
@@ -1631,11 +1681,11 @@ export declare class DocumentToolsClient extends APIClientBase {
     private processGetDocHeaderRevisionWithCallbacks;
     protected processGetDocHeaderRevision(xhr: any): DocMasterDetail | null | null;
     /**
-     * Creates a New document
+     * Creates a New document.  ,
      * @param id Document Key (use empty for auto assign)
      * @param typeKey Type
      * @param forProject (optional) Project
-     * @param forParent (optional) Parent Doc Key
+     * @param forParent (optional) Parent Doc Key (NextDocFlow rules apply; See https://support.spitfirepm.com/kba-01517/)
      * @param forBatch (optional) Batch/Subcontract
      * @param forSourceContact (optional) Source Contact
      */
@@ -2326,6 +2376,15 @@ 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
@@ -2354,15 +2413,6 @@ 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
@@ -2530,7 +2580,7 @@ export declare class DocumentToolsClient extends APIClientBase {
     private processDeleteDocItemByKeyWithCallbacks;
     protected processDeleteDocItemByKey(xhr: any): string | null;
     /**
-     * Copies the specified document; returns a list of GUIDs for the created documents
+     * Copies the specified document, applying DocCopyConfig rules; returns a list of GUIDs for the created documents
      * @param id Document Key
      * @param destinationProject (optional) optional - target project; if Not specified, same project
      * @param withItems (optional) optional - should items be copied
@@ -3346,7 +3396,7 @@ export declare class SystemClient extends APIClientBase {
         [key: string]: any;
     } | null | null;
     /**
-     * Reloads site configuration and settings
+     * Reloads site configuration and settings on all peers in a farm
      */
     reloadSiteConfiguration(): Promise<string | null>;
     private reloadSiteConfigurationWithCallbacks;
@@ -3640,25 +3690,21 @@ export declare class XTSClient extends APIClientBase {
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(baseUrl?: string);
     /**
-     * Requests the document be requeued for cloud sync
+     * Requests the document's cloud folder be requeued for an inbound scan
      * @param fileKey (optional)
-     * @return Request enqueued
+     * @return Scan queued - XTSCloudRequeue reported Updated
      */
     cloudSyncDocPUT(id: string, fileKey?: string | null | undefined): Promise<string>;
     private cloudSyncDocPUTWithCallbacks;
     private processCloudSyncDocPUTWithCallbacks;
     protected processCloudSyncDocPUT(xhr: any): string | null;
     /**
-     * Requests information about the document related to cloud storage
+     * Returns cloud storage information for a document's published folder
      */
-    cloudSyncDocGET(id: string): Promise<{
-        [key: string]: any;
-    } | null>;
+    cloudSyncDocGET(id: string): Promise<CloudFolderInfo | null>;
     private cloudSyncDocGETWithCallbacks;
     private processCloudSyncDocGETWithCallbacks;
-    protected processCloudSyncDocGET(xhr: any): {
-        [key: string]: any;
-    } | null | null;
+    protected processCloudSyncDocGET(xhr: any): CloudFolderInfo | null | null;
     /**
      * Requests all compliance items that have changed since the last key map update
      */
@@ -4171,6 +4217,14 @@ export interface CloudChange {
     removed?: boolean;
     WhenModified?: Date;
 }
+export interface CloudFolderInfo {
+    KMK?: string;
+    path?: string | undefined;
+    id?: string | undefined;
+    scanned?: string | undefined;
+    url?: string | undefined;
+    error?: string | undefined;
+}
 /** A single cloud-storage definition.  Mirrors the CloudStore table in LVData.xsd; consumed by the System Admin Dashboard Cloud Storage tool.  The Have*Secret flags report whether a secret is on file without exposing it. */
 export interface CloudStore {
     /** Row key (xsfCldStore) */
@@ -6095,11 +6149,17 @@ export interface FieldAudit {
     /** when the change was persisted */
     ChangeWhen?: Date;
     /** string representation of the prior field value */
-    PriorValue?: any | undefined;
+    PriorValue?: string | undefined;
     /** string representation of the new field value */
     NewValue?: string | undefined;
     /** user that made the change */
     ByUser?: string | undefined;
+    /** The column that was changed in table.field format */
+    ColName?: string | undefined;
+    /** When true, this entry was inferred by a gap */
+    IsInferred?: boolean;
+    /** When true, this value is a guid  */
+    IsGuid?: boolean;
     /** eTag */
     ETag?: string | undefined;
 }