spitfirepm/dist/SwaggerClients.d.ts

Client API Tools for Spitfire Project Management

import { APIClientBase } from './APIClientBase';
export declare class DocumentToolsClient extends APIClientBase {
    baseUrl: string;
    beforeSend: any;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(baseUrl?: string);
    /**
     * Deletes the compliance on the specified document
     * @param id Document Key
     * @param complianceKeys Compliance Item Keys
     * @return Specified addresses not found
     */
    deleteDocCompliance(id: string, complianceKeys: string[]): Promise<string>;
    private deleteDocComplianceWithCallbacks;
    private processDeleteDocComplianceWithCallbacks;
    protected processDeleteDocCompliance(xhr: any): string | null;
    /**
     * Updates the compliance on the specified document
     * @param id Document Key
     * @param updatedData Replacement compliance data
     * @return Specified compliance not found
     */
    updateDocCompliance(id: string, updatedData: DocCompliance): Promise<string>;
    private updateDocComplianceWithCallbacks;
    private processUpdateDocComplianceWithCallbacks;
    protected processUpdateDocCompliance(xhr: any): string | null;
    /**
     * Inserts compliance on the specified document
     * @param id Document Key
     * @param newData New compliance data
     */
    addDocCompliance(id: string, newData: DocCompliance): Promise<DocCompliance | null>;
    private addDocComplianceWithCallbacks;
    private processAddDocComplianceWithCallbacks;
    protected processAddDocCompliance(xhr: any): DocCompliance | null | null;
    /**
     * Returns the compliance for the specified document
     * @param id Document Key
     */
    getDocCompliance(id: string): Promise<DocCompliance[] | null>;
    private getDocComplianceWithCallbacks;
    private processGetDocComplianceWithCallbacks;
    protected processGetDocCompliance(xhr: any): DocCompliance[] | null | null;
    /**
     * Returns the meeting attendees for the specified document
     * @param id Document Key
     */
    getDocAttendees(id: string): Promise<DocMeetingAttendee[] | null>;
    private getDocAttendeesWithCallbacks;
    private processGetDocAttendeesWithCallbacks;
    protected processGetDocAttendees(xhr: any): DocMeetingAttendee[] | null | null;
    /**
     * Deletes the attendees on the specified document
     * @param id Document Key
     * @param attendeeKeys Attendee Keys
     * @return Specified addresses not found
     */
    deleteDocAttendee(id: string, attendeeKeys: string[]): Promise<string>;
    private deleteDocAttendeeWithCallbacks;
    private processDeleteDocAttendeeWithCallbacks;
    protected processDeleteDocAttendee(xhr: any): string | null;
    /**
     * Updates the attendees on the specified document
     * @param id Document Key
     * @param updatedData Replacement attendee data
     * @return Specified attendee not found
     */
    updateDocAttendee(id: string, updatedData: DocMeetingAttendee): Promise<string>;
    private updateDocAttendeeWithCallbacks;
    private processUpdateDocAttendeeWithCallbacks;
    protected processUpdateDocAttendee(xhr: any): string | null;
    /**
     * Inserts attendees on the specified document
     * @param id Document Key
     * @param newData New attendee data
     */
    addDocAttendee(id: string, newData: DocMeetingAttendee): Promise<DocMeetingAttendee | null>;
    private addDocAttendeeWithCallbacks;
    private processAddDocAttendeeWithCallbacks;
    protected processAddDocAttendee(xhr: any): DocMeetingAttendee | null | null;
    /**
     * Returns the attributes for the specified document
     * @param id Document Key
     */
    getDocAttributes(id: string): Promise<DocAttribute[] | null>;
    private getDocAttributesWithCallbacks;
    private processGetDocAttributesWithCallbacks;
    protected processGetDocAttributes(xhr: any): DocAttribute[] | null | null;
    /**
     * Deletes the attributes on the specified document
     * @param id Document Key
     * @param attributeKeys Attribute Keys
     * @return Specified addresses not found
     */
    deleteDocAttributes(id: string, attributeKeys: string[]): Promise<string>;
    private deleteDocAttributesWithCallbacks;
    private processDeleteDocAttributesWithCallbacks;
    protected processDeleteDocAttributes(xhr: any): string | null;
    /**
     * Updates the attributes on the specified document
     * @param id Document Key
     * @param updatedData Replacement attribute data
     * @return Specified attribute not found
     */
    updateDocAttributes(id: string, updatedData: DocAttribute): Promise<string>;
    private updateDocAttributesWithCallbacks;
    private processUpdateDocAttributesWithCallbacks;
    protected processUpdateDocAttributes(xhr: any): string | null;
    /**
     * Inserts attributes on the specified document
     * @param id Document Key
     * @param newData New attribute data
     */
    addDocAttributes(id: string, newData: DocAttribute[]): Promise<DocAttribute | null>;
    private addDocAttributesWithCallbacks;
    private processAddDocAttributesWithCallbacks;
    protected processAddDocAttributes(xhr: any): DocAttribute | null | null;
    /**
     * Returns the links for the specified document
     * @param id Document Key
     */
    getDocLinks(id: string): Promise<DocAttachment[] | null>;
    private getDocLinksWithCallbacks;
    private processGetDocLinksWithCallbacks;
    protected processGetDocLinks(xhr: any): DocAttachment[] | null | null;
    /**
     * Deletes the attachment on the specified document
     * @param id Document Key
     * @param linkKeys Doc Link Key(s)
     * @return Specified addresses not found
     */
    deleteDocLinks(id: string, linkKeys: string[]): Promise<string>;
    private deleteDocLinksWithCallbacks;
    private processDeleteDocLinksWithCallbacks;
    protected processDeleteDocLinks(xhr: any): string | null;
    /**
     * NO!  Create the Doc and Link the docs!
     * @param id Document Key
     * @param newData New link data
     */
    addDocLink(id: string, newData: DocAttachment): Promise<DocAttachment | null>;
    private addDocLinkWithCallbacks;
    private processAddDocLinkWithCallbacks;
    protected processAddDocLink(xhr: any): DocAttachment | null | null;
    /**
     * Returns the comments for the specified document
     * @param id Document Key
     */
    getDocComments(id: string): Promise<Comment[] | null>;
    private getDocCommentsWithCallbacks;
    private processGetDocCommentsWithCallbacks;
    protected processGetDocComments(xhr: any): Comment[] | null | null;
    /**
     * Deletes the comments on the specified document
     * @param id Document Key
     * @param commentKeys Comment Keys
     * @return Specified addresses not found
     */
    deleteDocComments(id: string, commentKeys: string[]): Promise<string>;
    private deleteDocCommentsWithCallbacks;
    private processDeleteDocCommentsWithCallbacks;
    protected processDeleteDocComments(xhr: any): string | null;
    /**
     * Updates the comments on the specified document
     * @param id Document Key
     * @param updatedData Replacement comment data
     * @return Specified comments not found
     */
    updateDocComments(id: string, updatedData: Comment): Promise<string>;
    private updateDocCommentsWithCallbacks;
    private processUpdateDocCommentsWithCallbacks;
    protected processUpdateDocComments(xhr: any): string | null;
    /**
     * Inserts Comments on the specified document
     * @param id Document Key
     * @param newData New comment data
     */
    addDocComments(id: string, newData: Comment[]): Promise<Comment | null>;
    private addDocCommentsWithCallbacks;
    private processAddDocCommentsWithCallbacks;
    protected processAddDocComments(xhr: any): Comment | null | null;
    /**
     * Returns the item comments for the specified document
     * @param id Document Key
     * @param itemId Item Key
     */
    getDocItemComments(id: string, itemId: string): Promise<DocItemComment[] | null>;
    private getDocItemCommentsWithCallbacks;
    private processGetDocItemCommentsWithCallbacks;
    protected processGetDocItemComments(xhr: any): DocItemComment[] | null | null;
    /**
     * Returns list of tabs
     * @param id Document Key
     */
    getDocTabs(id: string): Promise<TabStripDetails[] | null>;
    private getDocTabsWithCallbacks;
    private processGetDocTabsWithCallbacks;
    protected processGetDocTabs(xhr: any): TabStripDetails[] | null | null;
    /**
     * Runs the specified ATC script; no automatic save is implied (the script can save).  Result is OK or log.
     * @param id Document Key
     * @param scriptName Name of Script
     */
    runDocWorkflow(id: string, scriptName: string | null): Promise<string | null>;
    private runDocWorkflowWithCallbacks;
    private processRunDocWorkflowWithCallbacks;
    protected processRunDocWorkflow(xhr: any): string | null | null;
    /**
     * Returns the ATC Workflow log for the current document session
     * @param id Document Key
     */
    getDocWorkflowLog(id: string): Promise<string | null>;
    private getDocWorkflowLogWithCallbacks;
    private processGetDocWorkflowLogWithCallbacks;
    protected processGetDocWorkflowLog(xhr: any): string | null | null;
    /**
     * Returns one or all Access Control entries for the current document session
     * @param id Document Key
     * @param type (optional) Access Type (eg DocOwner)
     */
    getDocAccessControl(id: string, type?: string | null | undefined): Promise<DocAccessControl[] | null>;
    private getDocAccessControlWithCallbacks;
    private processGetDocAccessControlWithCallbacks;
    protected processGetDocAccessControl(xhr: any): DocAccessControl[] | null | null;
    /**
     * Returns the Document Session Key
     * @param id Document Key
     * @param freshenData (optional) Reloads document when true
     */
    getDocSession(id: string, freshenData?: boolean | undefined): Promise<string | null>;
    private getDocSessionWithCallbacks;
    private processGetDocSessionWithCallbacks;
    protected processGetDocSession(xhr: any): string | null | null;
    /**
     * Ends the Document Session
     * @param id Document Key
     * @param sessionID cache key or session
     */
    endDocSession(id: string, sessionID: string | null): Promise<HttpStatusCode>;
    private endDocSessionWithCallbacks;
    private processEndDocSessionWithCallbacks;
    protected processEndDocSession(xhr: any): HttpStatusCode | null;
    /**
     * Returns the current Document state (approved, etc)
     * @param id Document Key
     */
    getDocState(id: string): Promise<DocumentState | null>;
    private getDocStateWithCallbacks;
    private processGetDocStateWithCallbacks;
    protected processGetDocState(xhr: any): DocumentState | null | null;
    /**
     * Given the specified session exists for the current user, associates the Document and Session Key
     * @param id Document Key
     * @param sessionID session id
     */
    patchDocSession(id: string, sessionID: string | null): Promise<HttpStatusCode>;
    private patchDocSessionWithCallbacks;
    private processPatchDocSessionWithCallbacks;
    protected processPatchDocSession(xhr: any): HttpStatusCode | null;
    /**
     * Modifies the current exclusivity of this document session
     * @param id Document Key
     * @param requestedMode First letter is enough: Default is Doc Session (aka Automatic; D or A), User Session (U), Released (becomes shared, R or 0), Manual (requires permission, M or number of hours)
     * @param forHours Duration, required for Manual
     */
    patchExclusivity(id: string, requestedMode: string | null, forHours: number): Promise<HttpStatusCode>;
    private patchExclusivityWithCallbacks;
    private processPatchExclusivityWithCallbacks;
    protected processPatchExclusivity(xhr: any): HttpStatusCode | null;
    /**
     * Modifies data in this document session
     * @param id Document Key
     * @param changes collection of changes
     * @param pds (optional) when included specified PDS key
     * @param releaseSession (optional) when included and true releases document
     */
    patchDocData(id: string, changes: DocFieldChange[], pds?: string | null | undefined, releaseSession?: boolean | undefined): Promise<{
        [key: string]: number;
    } | null>;
    private patchDocDataWithCallbacks;
    private processPatchDocDataWithCallbacks;
    protected processPatchDocData(xhr: any): {
        [key: string]: number;
    } | null | null;
    /**
     * Given the document Is in an appropriate state, change the document number
     * @param id Document Key
     * @param newNumber New Document Number
     */
    patchDocNumber(id: string, newNumber: string | null): Promise<HttpStatusCode>;
    private patchDocNumberWithCallbacks;
    private processPatchDocNumberWithCallbacks;
    protected processPatchDocNumber(xhr: any): HttpStatusCode | null;
    /**
     * Copies the specified document; returns a single guid for one of 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
     * @param withAttachments (optional) optional - should attachments be copied (0=no,1=copy Or .net filter; default Is no
     * @param withRoute (optional) Optional - how route should be handled (0=no,1=copy,Or predefined route name
     * @param withLink (optional) Optional - include link to source
     * @param withDue (optional) Optional - specific New due date, default Is tomorrow
     * @param withCopies (optional) Optional - number of copies, default Is one
     * @param withRecur (optional) Optional - due interval between copies (NA-none;DDaily;WWeekly, see Code Set [Recur])
     */
    postDocFrom(id: string, destinationProject?: string | null | undefined, withItems?: string | null | undefined, withAttachments?: string | null | undefined, withRoute?: string | null | undefined, withLink?: boolean | undefined, withDue?: Date | undefined, withCopies?: number | undefined, withRecur?: string | null | undefined): Promise<string[] | null>;
    private postDocFromWithCallbacks;
    private processPostDocFromWithCallbacks;
    protected processPostDocFrom(xhr: any): string[] | null | 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;
    /**
     * Deletes the specified document
     * @param id Document Key
     */
    deleteDocHeader(id: string): Promise<any>;
    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;
    /**
     * Export document
     * @param id Document Key
     * @param flavor Export mode
     */
    getDocExport(id: string, flavor: string | null): Promise<string[] | null>;
    private getDocExportWithCallbacks;
    private processGetDocExportWithCallbacks;
    protected processGetDocExport(xhr: any): string[] | null | null;
    /**
     * Returns the header Of the specified document revision, including a Document Session Key
     * @param id Document Key
     * @param revKey Revision Key
     */
    getDocHeaderRevision(id: string, revKey: string): Promise<DocMasterDetail | null>;
    private getDocHeaderRevisionWithCallbacks;
    private processGetDocHeaderRevisionWithCallbacks;
    protected processGetDocHeaderRevision(xhr: any): DocMasterDetail | null | null;
    /**
     * Updates a Single field On the header Of the specified document
     * @param id Document Key
     * @param fieldName Field Name
     * @param newValue Replacement data
     */
    patchDocHeader(id: string, fieldName: string | null, newValue: string): Promise<{
        [key: string]: number;
    } | null>;
    private patchDocHeaderWithCallbacks;
    private processPatchDocHeaderWithCallbacks;
    protected processPatchDocHeader(xhr: any): {
        [key: string]: number;
    } | null | null;
    /**
     * Creates a New document using the Create Next rules
     * @param id Source Document Key
     */
    createNextDocument(id: string): Promise<string>;
    private createNextDocumentWithCallbacks;
    private processCreateNextDocumentWithCallbacks;
    protected processCreateNextDocument(xhr: any): string | null;
    /**
     * 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 forBatch (optional) Batch/Subcontract
     */
    createDocument(id: string, typeKey: string, forProject?: string | null | undefined, forParent?: string | null | undefined, forBatch?: string | null | undefined): Promise<string>;
    private createDocumentWithCallbacks;
    private processCreateDocumentWithCallbacks;
    protected processCreateDocument(xhr: any): string | null;
    /**
     * Creates a New revision of the specified document
     * @param id Source Document Key
     */
    createNextRevision(id: string): Promise<boolean>;
    private createNextRevisionWithCallbacks;
    private processCreateNextRevisionWithCallbacks;
    protected processCreateNextRevision(xhr: any): boolean | null;
    /**
     * Reverses posting of the specified document
     * @param id Source Document Key
     */
    reversePosting(id: string): Promise<string | null>;
    private reversePostingWithCallbacks;
    private processReversePostingWithCallbacks;
    protected processReversePosting(xhr: any): string | null | null;
    /**
     * Returns the items of the specified document (current revision)
     * @param id Document Key
     */
    getDocItems(id: string): Promise<DocItem[] | null>;
    private getDocItemsWithCallbacks;
    private processGetDocItemsWithCallbacks;
    protected processGetDocItems(xhr: any): DocItem[] | null | null;
    /**
     * Deletes item(s) on the specified document that match the specified item key(s).
     * @param id Document Key
     * @param itemKeys Doc Item Key(s)
     * @return Specified addresses not found
     */
    deleteDocItems(id: string, itemKeys: string[]): Promise<string>;
    private deleteDocItemsWithCallbacks;
    private processDeleteDocItemsWithCallbacks;
    protected processDeleteDocItems(xhr: any): string | null;
    /**
     * Updates the item on the specified document
     * @param id Document Key
     * @param updatedData Replacement item data
     * @return Specified item not found
     */
    updateDocItems(id: string, updatedData: DocItem): Promise<string>;
    private updateDocItemsWithCallbacks;
    private processUpdateDocItemsWithCallbacks;
    protected processUpdateDocItems(xhr: any): string | null;
    /**
     * Inserts items on the specified document, returns the final
     * @param id Document Key
     * @param newData New item data
     * @param sourceId (optional) Optional Like Source Item
     */
    addDocItems(id: string, newData: DocItem[], sourceId?: string | null | undefined): Promise<DocItem | null>;
    private addDocItemsWithCallbacks;
    private processAddDocItemsWithCallbacks;
    protected processAddDocItems(xhr: any): DocItem | null | null;
    /**
     * Returns the items for the specified document that have changed
     * @param id Document Key
     * @param lastStamp If the server data matches this number, then the data has not changed, pass 0 for always get, 1 for always (with optional refresh)
     * @param reloadOnMatch When TRUE and the stamp matches, then refresh from SQL
     * @param dataSummary KVP of current row keys and eTags
     * @return OK
     */
    getChangedItems(id: string, lastStamp: number, reloadOnMatch: boolean, dataSummary: CurrentDataSummary[]): Promise<DataDifferential>;
    private getChangedItemsWithCallbacks;
    private processGetChangedItemsWithCallbacks;
    protected processGetChangedItems(xhr: any): DataDifferential | null;
    /**
     * Deletes all items on the specified document
     * @param id Document Key
     * @return Specified addresses not found
     */
    deleteAllDocItems(id: string): Promise<string>;
    private deleteAllDocItemsWithCallbacks;
    private processDeleteAllDocItemsWithCallbacks;
    protected processDeleteAllDocItems(xhr: any): string | null;
    /**
     * Deletes the item with the specified key
     * @param itemKey Doc Item Key
     * @param crossDocDelete (optional) Even if multiple references?
     * @return Specified item not found
     */
    deleteDocItemByKey(itemKey: string, crossDocDelete?: boolean | undefined): Promise<string>;
    private deleteDocItemByKeyWithCallbacks;
    private processDeleteDocItemByKeyWithCallbacks;
    protected processDeleteDocItemByKey(xhr: any): string | null;
    /**
     * Inserts item on the specified document
     * @param id Document Key
     * @param newData New item data
     * @param sourceId (optional) Optional Like Source Item
     */
    addSingleDocItem(id: string, newData: DocItem, sourceId?: string | null | undefined): Promise<DocItem | null>;
    private addSingleDocItemWithCallbacks;
    private processAddSingleDocItemWithCallbacks;
    protected processAddSingleDocItem(xhr: any): DocItem | null | null;
    /**
     * Inserts items on the specified document, optionally all copied from the same source
     * @param id Document Key
     * @param newItems How Many
     * @param sourceId (optional) Optional Like Source Item
     */
    addManyItems(id: string, newItems: number, sourceId?: string | null | undefined): Promise<string[] | null>;
    private addManyItemsWithCallbacks;
    private processAddManyItemsWithCallbacks;
    protected processAddManyItems(xhr: any): string[] | null | null;
    /**
     * Inserts a special purpose item on the specified document
     * @param id Document Key
     * @param itemType Item Type (TAX or FREIGHT
     */
    addSpecialItem(id: string, itemType: string | null): Promise<DocItem | null>;
    private addSpecialItemWithCallbacks;
    private processAddSpecialItemWithCallbacks;
    protected processAddSpecialItem(xhr: any): DocItem | null | null;
    /**
     * Returns the Project Details based on the specified document.  Update using PatchDocData
     * @param id Document Key
     */
    getDocProjectSetup(id: string): Promise<ProjectAbstract | null>;
    private getDocProjectSetupWithCallbacks;
    private processGetDocProjectSetupWithCallbacks;
    protected processGetDocProjectSetup(xhr: any): ProjectAbstract | null | null;
    /**
     * Returns the route on the specified document
     * @param id Document Key
     */
    getDocRoute(id: string): Promise<DocRoute[] | null>;
    private getDocRouteWithCallbacks;
    private processGetDocRouteWithCallbacks;
    protected processGetDocRoute(xhr: any): DocRoute[] | null | null;
    /**
     * Deletes the route on the specified document
     * @param id Document Key
     * @param routeKeys Route Key(s)
     * @return Specified route not found
     */
    deleteDocRoute(id: string, routeKeys: string[]): Promise<string>;
    private deleteDocRouteWithCallbacks;
    private processDeleteDocRouteWithCallbacks;
    protected processDeleteDocRoute(xhr: any): string | null;
    /**
     * Updates a route entry on the specified document
     * @param id Document Key
     * @param updatedRoute Replacement Route
     * @return Specified route not found
     */
    updateDocRoute(id: string, updatedRoute: DocRoute): Promise<string>;
    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
     * @param routeKey Route Key
     * @param fieldName Field Name
     * @param newValue Replacement Value
     * @return Specified route not found
     */
    patchDocRoute(id: string, routeKey: string, fieldName: string | null, newValue: string | null): Promise<string>;
    private patchDocRouteWithCallbacks;
    private processPatchDocRouteWithCallbacks;
    protected processPatchDocRoute(xhr: any): string | null;
    /**
     * Updates the item numbers on the specified document
     * @param id Document Key
     * @param dataSummary KVP of current row keys and eTags
     * @return Specified route not found
     */
    renumberItems(id: string, dataSummary: CurrentDataSummary[]): Promise<string>;
    private renumberItemsWithCallbacks;
    private processRenumberItemsWithCallbacks;
    protected processRenumberItems(xhr: any): string | null;
    /**
     * Updates the route on the specified document by applying actions such as EndRoute, or APPEND or RESET.  Multiple actions can be separated by semicolons.  Append and RESET can be followed by a route name or AUTO.
     * @param id Document Key
     * @param effectList Route Effects: EndRoute;(APPEND | RESET) auto or key or name;CCToLast;NoChange
     * @return Specified route not found
     */
    applyDocRoute(id: string, effectList: string | null): Promise<string>;
    private applyDocRouteWithCallbacks;
    private processApplyDocRouteWithCallbacks;
    protected processApplyDocRoute(xhr: any): string | null;
    /**
     * Sets a specific route on the specified document to 'no action'
     * @param id Document Key
     * @param routeId Replacement Route
     * @return Specified route not found
     */
    docRouteScrap(id: string, routeId: string): Promise<string>;
    private docRouteScrapWithCallbacks;
    private processDocRouteScrapWithCallbacks;
    protected processDocRouteScrap(xhr: any): string | null;
    /**
     * Recalculates the content included for the specific route on the specified document
     * @param id Document Key
     * @param routeId Replacement Route
     * @return Specified route not found
     */
    docRouteResetContent(id: string, routeId: string): Promise<string>;
    private docRouteResetContentWithCallbacks;
    private processDocRouteResetContentWithCallbacks;
    protected processDocRouteResetContent(xhr: any): string | null;
    /**
     * Asks ATC service to performs any route actions (emails or workflows etc) for the current document route
     * @param id Document Key
     * @return Specified route not found
     */
    docRoutePerformActions(id: string): Promise<string>;
    private docRoutePerformActionsWithCallbacks;
    private processDocRoutePerformActionsWithCallbacks;
    protected processDocRoutePerformActions(xhr: any): string | null;
    /**
     * Returns the dates for the specified document
     * @param id Document Key
     */
    getDocDates(id: string): Promise<DocDate[] | null>;
    private getDocDatesWithCallbacks;
    private processGetDocDatesWithCallbacks;
    protected processGetDocDates(xhr: any): DocDate[] | null | null;
    /**
     * Deletes a specific date from the specified document
     * @param id Document Key
     * @param dateRowKeys Doc Dates Row Keys
     * @return Specified addresses not found
     */
    deleteDocDates(id: string, dateRowKeys: string[]): Promise<string>;
    private deleteDocDatesWithCallbacks;
    private processDeleteDocDatesWithCallbacks;
    protected processDeleteDocDates(xhr: any): string | null;
    /**
     * Updates the dates on the specified document
     * @param id Document Key
     * @param updatedData Replacement date data
     * @return Specified dates not found
     */
    updateDocDates(id: string, updatedData: DocDate): Promise<string>;
    private updateDocDatesWithCallbacks;
    private processUpdateDocDatesWithCallbacks;
    protected processUpdateDocDates(xhr: any): string | null;
    /**
     * Inserts dates on the specified document
     * @param id Document Key
     * @param newData New date data
     */
    addDocDate(id: string, newData: DocDate): Promise<DocDate | null>;
    private addDocDateWithCallbacks;
    private processAddDocDateWithCallbacks;
    protected processAddDocDate(xhr: any): DocDate | null | null;
    /**
     * Returns the addresses for the specified document
     * @param id Document Key
     */
    getDocAddresses(id: string): Promise<DocAddress[] | null>;
    private getDocAddressesWithCallbacks;
    private processGetDocAddressesWithCallbacks;
    protected processGetDocAddresses(xhr: any): DocAddress[] | null | null;
    /**
     * Deletes the addresses on the specified document
     * @param id Document Key
     * @param addressKeys Address Keys
     * @return Specified addresses not found
     */
    deleteDocAddress(id: string, addressKeys: string[]): Promise<string>;
    private deleteDocAddressWithCallbacks;
    private processDeleteDocAddressWithCallbacks;
    protected processDeleteDocAddress(xhr: any): string | null;
    /**
     * Updates the addresses on the specified document
     * @param id Document Key
     * @param updatedData Replacement address data
     * @return Specified addresses not found
     */
    updateDocAddress(id: string, updatedData: DocAddress): Promise<string>;
    private updateDocAddressWithCallbacks;
    private processUpdateDocAddressWithCallbacks;
    protected processUpdateDocAddress(xhr: any): string | null;
    /**
     * Updates the route on the specified document
     * @param id Document Key
     * @param key Address Key
     * @param fieldName Field Name
     * @param newValue Replacement Value
     * @return Specified route not found
     */
    patchDocAddress(id: string, key: string, fieldName: string | null, newValue: string | null): Promise<string>;
    private patchDocAddressWithCallbacks;
    private processPatchDocAddressWithCallbacks;
    protected processPatchDocAddress(xhr: any): string | null;
    /**
     * Inserts addresses on the specified document
     * @param id Document Key
     * @param newData New address data
     */
    addDocAddress(id: string, newData: DocAddress): Promise<DocAddress | null>;
    private addDocAddressWithCallbacks;
    private processAddDocAddressWithCallbacks;
    protected processAddDocAddress(xhr: any): DocAddress | null | null;
    /**
     * Returns the attachments for the specified document
     * @param id Document Key
     * @return No changes
     */
    getDocAttachments(id: string): Promise<string>;
    private getDocAttachmentsWithCallbacks;
    private processGetDocAttachmentsWithCallbacks;
    protected processGetDocAttachments(xhr: any): string | null;
    /**
     * Removes the specified attachment from the specified document
     * @param id Document Key
     * @param attachKeys Doc Attachment Keys
     * @return Specified addresses not found
     */
    deleteDocAttachments(id: string, attachKeys: string[]): Promise<string>;
    private deleteDocAttachmentsWithCallbacks;
    private processDeleteDocAttachmentsWithCallbacks;
    protected processDeleteDocAttachments(xhr: any): string | null;
    /**
     * Updates an attachment on the specified document
     * @param id Document Key
     * @param updatedData Replacement attachment data
     * @return Specified attachment not found
     */
    updateDocAttachments(id: string, updatedData: DocAttachment): Promise<string>;
    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;
    /**
     * Returns the attachments for the specified document that have changed
     * @param id Document Key
     * @param lastStamp If the server data matches this number the data has not changed, pass 0 for always get, 1 for always (with optional refresh)
     * @param reloadOnMatch When TRUE and the stamp matches, then refresh from SQL
     * @param dataSummary KVP of current row keys and eTags
     * @return OK
     */
    getChangedAttachments(id: string, lastStamp: number, reloadOnMatch: boolean, dataSummary: CurrentDataSummary[]): Promise<DataDifferential>;
    private getChangedAttachmentsWithCallbacks;
    private processGetChangedAttachmentsWithCallbacks;
    protected processGetChangedAttachments(xhr: any): DataDifferential | null;
    /**
     * Updates the specified document from data in the specified attachment using the VXL engine; returns a task key
     * @param id Document Key
     * @param fileKey File Key (must be an Excel file)
     * @return OK
     */
    postVXLContent(id: string, fileKey: string): Promise<string>;
    private postVXLContentWithCallbacks;
    private processPostVXLContentWithCallbacks;
    protected processPostVXLContent(xhr: any): string | null;
    /**
     * Creates a PDF from the Assembled Attachments specified on this document; returns a task key
     * @param id Document Key
     * @param disposition Disposition (PDF)
     * @return OK
     */
    postAssembledContent(id: string, disposition: string | null): Promise<string>;
    private postAssembledContentWithCallbacks;
    private processPostAssembledContentWithCallbacks;
    protected processPostAssembledContent(xhr: any): string | null;
    /**
     * Returns actual or previewed content routed to a specific part; returns a task key
     * @param id Document Key
     * @param routeId Specific Route Key
     * @param disposition Disposition (DownloadContent | DownloadPreview | ViewRouteEML)
     * @return OK
     */
    postRouteContent(id: string, routeId: string, disposition: string | null): Promise<string>;
    private postRouteContentWithCallbacks;
    private processPostRouteContentWithCallbacks;
    protected processPostRouteContent(xhr: any): string | null;
    /**
     * Copies an attachment on the specified document
     * @param id Document Key
     * @param fileKey file Key
     * @param newName New attachment data
     */
    branchFile(id: string, fileKey: string, newName: string | null): Promise<DocAttachment | null>;
    private branchFileWithCallbacks;
    private processBranchFileWithCallbacks;
    protected processBranchFile(xhr: any): DocAttachment | null | null;
    /**
     * Joins (histories) of two attachments into a single combined target on the specified document
     * @param id Document Key
     * @param fileKey source file Key, dissolved
     * @param targetKey target file Key, absorbs source file
     */
    joinFiles(id: string, fileKey: string, targetKey: string): Promise<DocAttachment | null>;
    private joinFilesWithCallbacks;
    private processJoinFilesWithCallbacks;
    protected processJoinFiles(xhr: any): DocAttachment | null | null;
    /**
     * Links an attachment on the specified document to another document
     * @param id Document Key
     * @param attachmentKey source file Key
     * @param targetKey target document Key
     * @param move (optional) move
     */
    moveAttachment(id: string, attachmentKey: string, targetKey: string, move?: boolean | undefined): Promise<boolean>;
    private moveAttachmentWithCallbacks;
    private processMoveAttachmentWithCallbacks;
    protected processMoveAttachment(xhr: any): boolean | null;
    /**
     * Returns the inclusions for the specified document
     * @param id Document Key
     */
    getDocInclusions(id: string): Promise<DocInclusion[] | null>;
    private getDocInclusionsWithCallbacks;
    private processGetDocInclusionsWithCallbacks;
    protected processGetDocInclusions(xhr: any): DocInclusion[] | null | null;
    /**
     * Deletes the inclusions on the specified document
     * @param id Document Key
     * @param inclusionKeys Inclusion Keys
     * @return Specified inclusion not found
     */
    deleteDocInclusions(id: string, inclusionKeys: string[]): Promise<string>;
    private deleteDocInclusionsWithCallbacks;
    private processDeleteDocInclusionsWithCallbacks;
    protected processDeleteDocInclusions(xhr: any): string | null;
    /**
     * Updates the inclusions on the specified document
     * @param id Document Key
     * @param updatedData Replacement inclusion(exclusion) data
     * @return Specified inclusion not found
     */
    updateDocInclusions(id: string, updatedData: DocInclusion): Promise<string>;
    private updateDocInclusionsWithCallbacks;
    private processUpdateDocInclusionsWithCallbacks;
    protected processUpdateDocInclusions(xhr: any): string | null;
    /**
     * Inserts an inclusions on the specified document
     * @param id Document Key
     * @param newData New inclusion(exclusion) data
     */
    addDocInclusions(id: string, newData: DocInclusion[]): Promise<DocInclusion | null>;
    private addDocInclusionsWithCallbacks;
    private processAddDocInclusionsWithCallbacks;
    protected processAddDocInclusions(xhr: any): DocInclusion | null | null;
    /**
     * Information about copyability of the specified document
     * @param id Document Key
     */
    getDialogPreCopyThisDoc(id: string): Promise<MenuAction | null>;
    private getDialogPreCopyThisDocWithCallbacks;
    private processGetDialogPreCopyThisDocWithCallbacks;
    protected processGetDialogPreCopyThisDoc(xhr: any): MenuAction | null | null;
    /**
     * Information about address types for the specified document
     * @param id Document Key
     */
    getDialogAddresses(id: string): Promise<MenuAction | null>;
    private getDialogAddressesWithCallbacks;
    private processGetDialogAddressesWithCallbacks;
    protected processGetDialogAddresses(xhr: any): MenuAction | null | null;
    /**
     * Information about attribute types for the specified document
     * @param id Document Key
     */
    getDialogAttributeTypes(id: string): Promise<MenuAction | null>;
    private getDialogAttributeTypesWithCallbacks;
    private processGetDialogAttributeTypesWithCallbacks;
    protected processGetDialogAttributeTypes(xhr: any): MenuAction | null | null;
    /**
     * Information about date types for the specified document
     * @param id Document Key
     */
    getDialogDates(id: string): Promise<MenuAction | null>;
    private getDialogDatesWithCallbacks;
    private processGetDialogDatesWithCallbacks;
    protected processGetDialogDates(xhr: any): MenuAction | null | null;
    /**
     * Information about compliance types for the specified document
     * @param id Document Key
     */
    getDialogComplianceTypes(id: string): Promise<MenuAction | null>;
    private getDialogComplianceTypesWithCallbacks;
    private processGetDialogComplianceTypesWithCallbacks;
    protected processGetDialogComplianceTypes(xhr: any): MenuAction | null | null;
    /**
     * Information about inclusion types for the specified document
     * @param id Document Key
     */
    getDialogInclusionTypes(id: string): Promise<MenuAction | null>;
    private getDialogInclusionTypesWithCallbacks;
    private processGetDialogInclusionTypesWithCallbacks;
    protected processGetDialogInclusionTypes(xhr: any): MenuAction | null | null;
    /**
     * Information about templates for the specified document
     * @param id Document Key
     */
    getDialogTemplates(id: string): Promise<MenuAction | null>;
    private getDialogTemplatesWithCallbacks;
    private processGetDialogTemplatesWithCallbacks;
    protected processGetDialogTemplates(xhr: any): MenuAction | null | null;
    /**
     * Information about attach actions for the specified document
     * @param id Document Key
     */
    getDialogAttachables(id: string): Promise<MenuAction[] | null>;
    private getDialogAttachablesWithCallbacks;
    private processGetDialogAttachablesWithCallbacks;
    protected processGetDialogAttachables(xhr: any): MenuAction[] | null | null;
    /**
     * Information about route actions for the specified document
     * @param id Document Key
     * @param action (optional) (Optional) Action [build|apply|quickadd|all]
     */
    getDialogRoutables(id: string, action?: string | null | undefined): Promise<MenuAction[] | null>;
    private getDialogRoutablesWithCallbacks;
    private processGetDialogRoutablesWithCallbacks;
    protected processGetDialogRoutables(xhr: any): MenuAction[] | null | null;
    /**
     * Information about item actions for the specified document
     * @param id Document Key
     * @param action (optional) (Optional) Action [renumber|deleteAll|all]
     */
    getDialogItemActions(id: string, action?: string | null | undefined): Promise<MenuAction[] | null>;
    private getDialogItemActionsWithCallbacks;
    private processGetDialogItemActionsWithCallbacks;
    protected processGetDialogItemActions(xhr: any): MenuAction[] | null | null;
    /**
     * Information about exclusivity actions for the specified document
     * @param id Document Key
     * @param action (optional) (Optional) Action [HoldAuto,Hold24,Hold,HoldManual,HoldNone,HoldRoute,HoldInfo]
     */
    getDialogExclusivity(id: string, action?: string | null | undefined): Promise<MenuAction[] | null>;
    private getDialogExclusivityWithCallbacks;
    private processGetDialogExclusivityWithCallbacks;
    protected processGetDialogExclusivity(xhr: any): MenuAction[] | null | null;
    /**
     * Information about actions for the specified document
     * @param id Document Key
     * @param action (optional) (Optional) Action [all]
     */
    getDialogAbstract(id: string, action?: string | null | undefined): Promise<MenuAction[] | null>;
    private getDialogAbstractWithCallbacks;
    private processGetDialogAbstractWithCallbacks;
    protected processGetDialogAbstract(xhr: any): MenuAction[] | null | null;
}
export declare class CatalogClient extends APIClientBase {
    baseUrl: string;
    beforeSend: any;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(baseUrl?: string);
    /**
     * Returns a list of files or documents in the specified location
     * @param folderDesignation Catalog Folder ID (GUID or root)
     * @param catalogFilters Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used: UserKey, FileKey, DocMasterKey (attached to), MaxItems, TimeoutFactor
     */
    getFolderContents(folderDesignation: string | null, catalogFilters: QueryFilters): Promise<FileInformation[] | null>;
    private getFolderContentsWithCallbacks;
    private processGetFolderContentsWithCallbacks;
    protected processGetFolderContents(xhr: any): FileInformation[] | null | null;
    /**
     * Returns settings for a preset search
     * @param setID Set ID
     */
    getPresetSearch(setID: string | null): Promise<CatalogPreset | null>;
    private getPresetSearchWithCallbacks;
    private processGetPresetSearchWithCallbacks;
    protected processGetPresetSearch(xhr: any): CatalogPreset | null | null;
    /**
     * Returns a list of files and folders that match the criteria
     * @param folderDesignation Catalog Folder ID (GUID or ROOT)
     * @param catalogFilters Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used: UserKey, FileKey, DocMasterKey (attached to), MaxItems, TimeoutFactor
     */
    searchContents(folderDesignation: string | null, catalogFilters: QueryFilters): Promise<FileInformation[] | null>;
    private searchContentsWithCallbacks;
    private processSearchContentsWithCallbacks;
    protected processSearchContents(xhr: any): FileInformation[] | null | null;
    /**
     * Returns changes to the list of files and folders that match the criteria
     * @param folderDesignation Catalog Folder ID (GUID or ROOT)
     * @param catalogFilters ClientDataSummary (of FileKey and eTags) and Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used: UserKey, FileKey, DocMasterKey (attached to), MaxItems, TimeoutFactor
     */
    getChangedSearchContents(folderDesignation: string | null, catalogFilters: QueryFilters): Promise<DataDifferential | null>;
    private getChangedSearchContentsWithCallbacks;
    private processGetChangedSearchContentsWithCallbacks;
    protected processGetChangedSearchContents(xhr: any): DataDifferential | null | null;
    /**
     * Returns a list of files in the specified location
     * @param folderDesignation Catalog Folder ID (GUID or root)
     * @param catalogFilters ClientDataSummary (of FileKey and eTags) and Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used: UserKey, FileKey, DocMasterKey (attached to), MaxItems, TimeoutFactor
     */
    getChangedFolderContents(folderDesignation: string | null, catalogFilters: QueryFilters): Promise<DataDifferential | null>;
    private getChangedFolderContentsWithCallbacks;
    private processGetChangedFolderContentsWithCallbacks;
    protected processGetChangedFolderContents(xhr: any): DataDifferential | null | null;
    /**
     * Returns the tree Of folders
     */
    getFolderTree(): Promise<FileInformation[] | null>;
    private getFolderTreeWithCallbacks;
    private processGetFolderTreeWithCallbacks;
    protected processGetFolderTree(xhr: any): FileInformation[] | null | null;
    /**
     * Returns the fake utilization stats
     */
    getStats(): Promise<{
        [key: string]: any;
    } | null>;
    private getStatsWithCallbacks;
    private processGetStatsWithCallbacks;
    protected processGetStats(xhr: any): {
        [key: string]: any;
    } | null | null;
    /**
     * Returns the name Of the root folder
     */
    getRootFolderName(): Promise<any>;
    private getRootFolderNameWithCallbacks;
    private processGetRootFolderNameWithCallbacks;
    protected processGetRootFolderName(xhr: any): any | null;
    /**
     * Returns URI for appropriate icon
     * @param fileType File type such As PDF, DOCX, etc
     * @param iconSize (optional) 16,20,24,32 etc; small(20); big(32)
     */
    getIconForType(fileType: string | null, iconSize?: string | null | undefined): Promise<any>;
    private getIconForTypeWithCallbacks;
    private processGetIconForTypeWithCallbacks;
    protected processGetIconForType(xhr: any): any | null;
    /**
     * Returns URI for appropriate icon for each file type
     * @param iconSize (optional) 16,20,24,32 etc; small(20); big(32)
     * @param eTag (optional) Returns nothing if eTag matches supplied eTag
     */
    getIconListByType(iconSize?: string | null | undefined, eTag?: string | null | undefined): Promise<any>;
    private getIconListByTypeWithCallbacks;
    private processGetIconListByTypeWithCallbacks;
    protected processGetIconListByType(xhr: any): any | null;
    /**
     * Returns the meta data For a specific file utilization stats
     * @param fileKey Catalog File Key
     */
    getMeta(fileKey: string): Promise<FileInformation | null>;
    private getMetaWithCallbacks;
    private processGetMetaWithCallbacks;
    protected processGetMeta(xhr: any): FileInformation | null | null;
    /**
     * Returns a list Of folders In the specified location
     * @param folderDesignation Catalog Folder ID (GUID Or root)
     */
    getFolderChildren(folderDesignation: string | null): Promise<FileInformation[] | null>;
    private getFolderChildrenWithCallbacks;
    private processGetFolderChildrenWithCallbacks;
    protected processGetFolderChildren(xhr: any): FileInformation[] | null | null;
    /**
     * Returns a history Of access To t