spitfirepm

import { APIClientBase } from './APIClientBase'; export declare class AccountClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Authenticates a session and generates a FormsAuthenticationTicket and cookie */ postLogin(credentials: SiteLogin): Promise<string | null>; private postLoginWithCallbacks; private processPostLoginWithCallbacks; protected processPostLogin(xhr: any): string | null | null; /** * Returns general information about the Authenticated user */ getUserData(): Promise<CurrentUser | null>; private getUserDataWithCallbacks; private processGetUserDataWithCallbacks; protected processGetUserData(xhr: any): CurrentUser | null | null; /** * Returns authorization flags for specified demand if they match or exceed the request * @param demand Demand Context */ getAccessAllows(demand: PermissionContext): Promise<PermissionFlags>; private getAccessAllowsWithCallbacks; private processGetAccessAllowsWithCallbacks; protected processGetAccessAllows(xhr: any): PermissionFlags | null; /** * Mint a short-lived download-ticket cookie * @return Download ticket cookie set */ postDownloadSession(): Promise<string>; private postDownloadSessionWithCallbacks; private processPostDownloadSessionWithCallbacks; protected processPostDownloadSession(xhr: any): string | null; /** * Sets the per-account anonymous feature-tracking preference * @param enabled True to allow anonymous feature tracking, False to opt out */ setFeatureTracking(enabled: boolean): Promise<boolean>; private setFeatureTrackingWithCallbacks; private processSetFeatureTrackingWithCallbacks; protected processSetFeatureTracking(xhr: any): boolean | null; /** * Digest an identity from an Google token * @param subId google nonvolatile id * @param nonce nonce * @param token token */ shareGoogleAuth(subId: string | null, nonce: string, token: any): Promise<string | null>; private shareGoogleAuthWithCallbacks; private processShareGoogleAuthWithCallbacks; protected processShareGoogleAuth(xhr: any): string | null | null; /** * Ends this session */ getEndOfSession(): Promise<boolean>; private getEndOfSessionWithCallbacks; private processGetEndOfSessionWithCallbacks; protected processGetEndOfSession(xhr: any): boolean | null; /** * Digest an identity from an MSAL token * @param entraID full oid.tid * @param nonce nonce * @param token token */ shareMSALAuth(entraID: string | null, nonce: string, token: any): Promise<string | null>; private shareMSALAuthWithCallbacks; private processShareMSALAuthWithCallbacks; protected processShareMSALAuth(xhr: any): string | null | null; /** * Returns information about password composition */ getPasswordOptions(): Promise<PasswordConfiguredOptions | null>; private getPasswordOptionsWithCallbacks; private processGetPasswordOptionsWithCallbacks; protected processGetPasswordOptions(xhr: any): PasswordConfiguredOptions | null | null; /** * Returns true */ hasSession(): Promise<boolean>; private hasSessionWithCallbacks; private processHasSessionWithCallbacks; protected processHasSession(xhr: any): boolean | null; } export declare class ActionItemsClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns action items for specified User * @param forUserKey User Key (for proxy) or 00000000-0000-0000-0000-000000000000 for self */ getUserActionItems(forUserKey: string): Promise<UserActionItem[] | null>; private getUserActionItemsWithCallbacks; private processGetUserActionItemsWithCallbacks; protected processGetUserActionItems(xhr: any): UserActionItem[] | null | null; /** * Returns an action item for the specified User * @param userID User Key or 1 for self * @param dtk Document Type * @param routeID Route ID (GUID) * @param projectLike Project ID or mask * @param titleLike (optional) Title Like (max 50) */ getRouteActionInfo(userID: string | null, dtk: string, routeID: string, projectLike: string | null, titleLike?: string | null | undefined): Promise<RouteActionInfo | null>; private getRouteActionInfoWithCallbacks; private processGetRouteActionInfoWithCallbacks; protected processGetRouteActionInfo(xhr: any): RouteActionInfo | null | null; /** * Updates an action item for the specified User * @param userID User Key or 1 for self * @param routeID Route ID (guid) * @param actionData action patch data * @param actionMode (optional) Mode is id,match,every */ patchUserActionItems(userID: string | null, routeID: string, actionData: RouteActionData, actionMode?: string | null | undefined): Promise<HttpStatusCode>; private patchUserActionItemsWithCallbacks; private processPatchUserActionItemsWithCallbacks; protected processPatchUserActionItems(xhr: any): HttpStatusCode | null; /** * Returns documents data that has changed * @param forUserKey User Key (for proxy) or 00000000-0000-0000-0000-000000000000 for self * @param dataSummary KVP of current row keys (RouteID) and eTags */ getChangedActionItems(forUserKey: string, dataSummary: CurrentDataSummary[]): Promise<DataDifferential | null>; private getChangedActionItemsWithCallbacks; private processGetChangedActionItemsWithCallbacks; protected processGetChangedActionItems(xhr: any): DataDifferential | null | null; /** * Returns action items that match filters ProjectLike, TitleLike, ForDocType, FromDate, ThruDate, NewOnly */ getMatchingUserActionItems(usingFilters: QueryFilters): Promise<UserActionItem[] | null>; private getMatchingUserActionItemsWithCallbacks; private processGetMatchingUserActionItemsWithCallbacks; protected processGetMatchingUserActionItems(xhr: any): UserActionItem[] | null | null; } export declare class AlertsClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns alert items for a specified user * @param forUserKey User Key (for proxy) or 00000000-0000-0000-0000-000000000000 for self */ getUserAlertList(forUserKey: string): Promise<UserAlert[] | null>; private getUserAlertListWithCallbacks; private processGetUserAlertListWithCallbacks; protected processGetUserAlertList(xhr: any): UserAlert[] | null | null; /** * Creates And stores an alert * @param theAlert Model With New alert. Specify AlertText, Description. UserKey, DocMasterKey, Project, Source, SourceKey And Info1 are Optional; */ createAlert(theAlert: UserAlert): Promise<HttpStatusCode>; private createAlertWithCallbacks; private processCreateAlertWithCallbacks; protected processCreateAlert(xhr: any): HttpStatusCode | null; /** * Returns changed alert items for a specified user * @param forUserKey User Key (for proxy) or 00000000-0000-0000-0000-000000000000 for self * @param dataSummary KVP of current row keys (AlertKey) and eTags */ getUserAlertChangeList(forUserKey: string, dataSummary: CurrentDataSummary[]): Promise<DataDifferential | null>; private getUserAlertChangeListWithCallbacks; private processGetUserAlertChangeListWithCallbacks; protected processGetUserAlertChangeList(xhr: any): DataDifferential | null | null; /** * Removes a specific alert item For the specified user * @param id Alert Key * @param forUserKey (optional) User Key (For proxy) Or 00000000-0000-0000-0000-000000000000 For self */ deleteAlert(id: string | null, forUserKey?: string | undefined): Promise<HttpStatusCode>; private deleteAlertWithCallbacks; private processDeleteAlertWithCallbacks; protected processDeleteAlert(xhr: any): HttpStatusCode | null; /** * Removes all alert item For the specified user * @param forUserKey (optional) User Key (For proxy) Or 00000000-0000-0000-0000-000000000000 For self */ deleteAllAlerts(forUserKey?: string | undefined): Promise<HttpStatusCode>; private deleteAllAlertsWithCallbacks; private processDeleteAllAlertsWithCallbacks; protected processDeleteAllAlerts(xhr: any): HttpStatusCode | null; } export declare class LookupClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns list of alerts that are recorded about the specified source key * @param key PK identifier of specific source key */ getAlertsForSourceKey(key: string): Promise<{ [key: string]: any; }[] | null>; private getAlertsForSourceKeyWithCallbacks; private processGetAlertsForSourceKeyWithCallbacks; protected processGetAlertsForSourceKey(xhr: any): { [key: string]: any; }[] | null | null; /** * Returns list of choices for a specified context * @param setName Name of Code Set * @param forDocType Document / Process Context for choices, use 1 for default */ getCodeChoices(setName: string | null, forDocType: string | null): Promise<CodeChoice[] | null>; private getCodeChoicesWithCallbacks; private processGetCodeChoicesWithCallbacks; protected processGetCodeChoices(xhr: any): CodeChoice[] | null | null; /** * Returns list of comments on a topic. See also DocumentToolsController * @param topicKey Topic Key (complianceItemKey, ContactKey, etc) */ getComments(topicKey: string): Promise<Comment[] | null>; private getCommentsWithCallbacks; private processGetCommentsWithCallbacks; protected processGetComments(xhr: any): Comment[] | null | null; /** * Adds a comments onto a topic. See also DocumentToolsController * @param topicKey Topic Key (complianceItemKey, ContactKey, etc) * @param newData new comment */ addComment(topicKey: string, newData: Comment): Promise<Comment | null>; private addCommentWithCallbacks; private processAddCommentWithCallbacks; protected processAddComment(xhr: any): Comment | null | null; /** * Removes the specified comment * @param topicKey Topic Key (complianceItemKey, ContactKey, etc) * @param removeKey Remove key */ deleteComment(topicKey: string, removeKey: string): Promise<any>; private deleteCommentWithCallbacks; private processDeleteCommentWithCallbacks; protected processDeleteComment(xhr: any): any | null; /** * Returns list of prior values for this field * @param dataMember Name of table * @param dataField Name of field * @param rowKey PK identifier of specific record * @param sinceWhen (optional) Optional date since when data should be returned */ getFieldHistory(dataMember: string | null, dataField: string | null, rowKey: string, sinceWhen?: Date | undefined): Promise<FieldAudit[] | null>; private getFieldHistoryWithCallbacks; private processGetFieldHistoryWithCallbacks; protected processGetFieldHistory(xhr: any): FieldAudit[] | null | null; /** * Returns list of suggestions for a specified context * @param lookupName Name of Lookup * @param dataContext Context for Suggestions, use 1 for default * @param filterValues Optional nvp list of filter and dependsOn values */ getLookupResultAll(lookupName: string | null, dataContext: string | null, filterValues: QueryFilters): Promise<{ [key: string]: any; }[] | null>; private getLookupResultAllWithCallbacks; private processGetLookupResultAllWithCallbacks; protected processGetLookupResultAll(xhr: any): { [key: string]: any; }[] | null | null; /** * Returns result of query given specified context * @param dataContext Data Set ID or 1 * @param queryContext ProjectLike (or 0 for none; 1 for from context; or specific); depends1-4 * @param id (optional) GUID key or 0 for none; 1 for from context * @param dtk (optional) GUID process type or omit or 0 for none; 1 from context */ getQueryResultWithContext(queryName: string | null, dataContext: string | null, queryContext: QueryFilters, id?: string | null | undefined, dtk?: string | null | undefined): Promise<{ [key: string]: any; }[] | null>; private getQueryResultWithContextWithCallbacks; private processGetQueryResultWithContextWithCallbacks; protected processGetQueryResultWithContext(xhr: any): { [key: string]: any; }[] | null | null; /** * Returns result of query given specified context * @param dataContext Data Set ID or 1 * @param project Project ID (or 0 for none; 1 for from context) * @param id GUID key or 0 for none; 1 for from context * @param dtk (optional) GUID process type or omit or 0 for none; 1 from context * @param depends1 (optional) optional additional context for query. Use 'empty' forces an empty value * @param depends2 (optional) Optional additional context for query * @param depends3 (optional) Optional additional context for query * @param depends4 (optional) Optional additional context for query */ getQueryResult(queryName: string | null, dataContext: string | null, project: string | null, id: string | null, dtk?: string | null | undefined, depends1?: string | null | undefined, depends2?: string | null | undefined, depends3?: string | null | undefined, depends4?: string | null | undefined): Promise<{ [key: string]: any; }[] | null>; private getQueryResultWithCallbacks; private processGetQueryResultWithCallbacks; protected processGetQueryResult(xhr: any): { [key: string]: any; }[] | null | null; /** * Returns default value for the requested segment of a flex key mask * @param maskName EG PROJECT or TASK * @param sn segment number (1 to 6) * @param seed (optional) seed value * @param target (optional) target (eg docno, Project, WBC) * @param forDTK (optional) for DTK (required for docno target * @param forProject (optional) for project (required for WBC and some doc types */ getNextSegmentValue(maskName: string | null, sn: number, seed?: string | null | undefined, target?: string | null | undefined, forDTK?: string | null | undefined, forProject?: string | null | undefined): Promise<string | null>; private getNextSegmentValueWithCallbacks; private processGetNextSegmentValueWithCallbacks; protected processGetNextSegmentValue(xhr: any): string | null | null; /** * Returns list of suggestions for a specified context * @param lookupName Name of Lookup * @param dataContext Context for Suggestions, use 1 for default * @param term (optional) Optional Partial match term to filter suggestions * @param limit (optional) Optional Limit to result count; default is 20; use -1 for all */ getSuggestionsAll(lookupName: string | null, dataContext: string | null, term?: string | null | undefined, limit?: number | undefined): Promise<Suggestion[] | null>; private getSuggestionsAllWithCallbacks; private processGetSuggestionsAllWithCallbacks; protected processGetSuggestionsAll(xhr: any): Suggestion[] | null | null; /** * Returns list of suggestions for a specified context * @param lookupName Name of Lookup * @param dataContext Context for Suggestions, use 1 for default * @param depends1 Optional context for Suggestions * @param term (optional) Optional Partial match term to filter suggestions * @param limit (optional) Optional Limit to result count; default is 20; use -1 for all */ getSuggestions(lookupName: string | null, dataContext: string | null, depends1: string | null, term?: string | null | undefined, limit?: number | undefined): Promise<Suggestion[] | null>; private getSuggestionsWithCallbacks; private processGetSuggestionsWithCallbacks; protected processGetSuggestions(xhr: any): Suggestion[] | null | null; /** * Returns list of suggestions for a specified context * @param lookupName Name of Lookup * @param dataContext Context for Suggestions, use 1 for default * @param depends1 Optional context for Suggestions * @param depends2 Optional context for Suggestions * @param depends3 Optional context for Suggestions * @param depends4 Optional context for Suggestions * @param term (optional) Optional Partial match term to filter suggestions * @param limit (optional) Optional Limit to result count; default is 20; use -1 for all */ getSuggestions2(lookupName: string | null, dataContext: string | null, depends1: string | null, depends2: string | null, depends3: string | null, depends4: string | null, term?: string | null | undefined, limit?: number | undefined): Promise<Suggestion[] | null>; private getSuggestions2WithCallbacks; private processGetSuggestions2WithCallbacks; protected processGetSuggestions2(xhr: any): Suggestion[] | null | null; /** * Returns list of suggestions for a specified context * @param lookupName Name of Lookup * @param sessionContext Session Context for Suggestions, use 1 for default * @param searchContext Search Context for Suggestions (depends on list, seed, limit) */ getSuggestionsWithContext(lookupName: string | null, sessionContext: string | null, searchContext: QueryFilters): Promise<Suggestion[] | null>; private getSuggestionsWithContextWithCallbacks; private processGetSuggestionsWithContextWithCallbacks; protected processGetSuggestionsWithContext(xhr: any): Suggestion[] | null | null; /** * Returns a single viewable/printable value matching the request. Use 'empty' to include a blank depends-on value. * @param displayName Name of Display Rule * @param valueFor Value to be described {MatchingSeed:'pv',DependsOn:['1','2','3','4']} * @param dataContext (optional) Context for Suggestions, use 1 for default */ getDisplayableValue(displayName: string | null, valueFor: DVRequest, dataContext?: string | null | undefined): Promise<string | null>; private getDisplayableValueWithCallbacks; private processGetDisplayableValueWithCallbacks; protected processGetDisplayableValue(xhr: any): string | null | null; /** * Flushes viewable/printable value from cache forcing refresh on next request * @param displayName Name of Display Rule * @param valueFor Value to be re-described {MatchingSeed:'pv',DependsOn:['1','2','3','4']} * @param dataContext (optional) Context, use 1 for default */ removeDisplayableValue(displayName: string | null, valueFor: DVRequest, dataContext?: string | null | undefined): Promise<boolean>; private removeDisplayableValueWithCallbacks; private processRemoveDisplayableValueWithCallbacks; protected processRemoveDisplayableValue(xhr: any): boolean | null; /** * Returns set of viewable/printable values * @param dvRequests List of requests */ getDisplayValueCollection(dvRequests: DVRequest[]): Promise<Suggestion[] | null>; private getDisplayValueCollectionWithCallbacks; private processGetDisplayValueCollectionWithCallbacks; protected processGetDisplayValueCollection(xhr: any): Suggestion[] | null | null; } export declare class ARRClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Queue the routed-content download package build * @param data download request {RouteID} */ getContent(data: ArrResponseData): Promise<string>; private getContentWithCallbacks; private processGetContentWithCallbacks; protected processGetContent(xhr: any): string | null; /** * Open a route-response link * @param request open request {StepKey, RouteID} */ openRoute(request: ArrOpenRequest): Promise<ArrOpenResult | null>; private openRouteWithCallbacks; private processOpenRouteWithCallbacks; protected processOpenRoute(xhr: any): ArrOpenResult | null | null; /** * Record a route response * @param data response data */ recordResponse(data: ArrResponseData): Promise<ArrResponseResult | null>; private recordResponseWithCallbacks; private processRecordResponseWithCallbacks; protected processRecordResponse(xhr: any): ArrResponseResult | null | null; } export declare class CatalogClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Releases a resource, usually a PDF of a report or export * @param fileKey Catalog File Key * @param location Specifies where to look for the specified key. Use CRT, RS * @return Request processed */ disposeFile(fileKey: string, location: string | null): Promise<string>; private disposeFileWithCallbacks; private processDisposeFileWithCallbacks; protected processDisposeFile(xhr: any): string | null; /** * Attaches a resource file to specified document * @param fileKey Catalog File Key * @param location Specifies where to look for the specified key. Use CK, CRT, RS * @param targetDMK Specifies the target document key */ catalogAndAttach(fileKey: string, location: string | null, targetDMK: string): Promise<string | null>; private catalogAndAttachWithCallbacks; private processCatalogAndAttachWithCallbacks; protected processCatalogAndAttach(xhr: any): string | null | null; /** * Sends a resource file To the current user via email * @param fileKey Catalog File Key * @param location Specifies where To look For the specified key. Use CK, CRT, RS * @param refDMK (optional) Specifies the related document key */ sendFile(fileKey: string, location: string | null, refDMK?: string | null | undefined): Promise<string | null>; private sendFileWithCallbacks; private processSendFileWithCallbacks; protected processSendFile(xhr: any): string | null | null; /** * Returns a history Of access To the specified ID * @param fileKey Catalog File Key */ getCatalogAccessHistory(fileKey: string): Promise<FileAccessHistory[] | null>; private getCatalogAccessHistoryWithCallbacks; private processGetCatalogAccessHistoryWithCallbacks; protected processGetCatalogAccessHistory(xhr: any): FileAccessHistory[] | null | null; /** * Gets share state Of file (check In/out, lock, etc * @param fileKey Catalog File Key */ getFileAccessControl(fileKey: string): Promise<FileInformation | null>; private getFileAccessControlWithCallbacks; private processGetFileAccessControlWithCallbacks; protected processGetFileAccessControl(xhr: any): FileInformation | null | null; /** * Changes share state Of file (check In/out, lock, etc * @param fileKey Catalog File Key * @param newStatus New Status O(ut);L(ock);U(nlock);I(n);X(cancel);SYS * @param expires (optional) When a checkout Or lock expires */ updateFileAccess(fileKey: string, newStatus: string | null, expires?: Date | undefined): Promise<boolean>; private updateFileAccessWithCallbacks; private processUpdateFileAccessWithCallbacks; protected processUpdateFileAccess(xhr: any): boolean | null; /** * Creates a copy Of the specified file * @param fileKey Catalog File Key */ copyFile(fileKey: string): Promise<FileVersion | null>; private copyFileWithCallbacks; private processCopyFileWithCallbacks; protected processCopyFile(xhr: any): FileVersion | null | null; /** * Returns a redirect To load Or download the requested file * @param fileKey Catalog File Key * @param fileRev (optional) Specific Revision * @param withContentDisposition (optional) True For download (content-disposition), False For plain */ getFile(fileKey: string, fileRev?: number | undefined, withContentDisposition?: boolean | undefined): Promise<RedirectResult | null>; private getFileWithCallbacks; private processGetFileWithCallbacks; protected processGetFile(xhr: any): RedirectResult | null | null; /** * Returns a URI to load Or download the requested file * @param fileKey Catalog File Key * @param fileRev (optional) Specific Revision * @param withContentDisposition (optional) True For download (content-disposition), False For plain */ getFileURL(fileKey: string, fileRev?: number | undefined, withContentDisposition?: boolean | undefined): Promise<string | null>; private getFileURLWithCallbacks; private processGetFileURLWithCallbacks; protected processGetFileURL(xhr: any): string | null | 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 redirect To load Or download the requested file * @param fileKey Catalog File Key * @param width Width * @param height Height; either width or height can be zero for a proportional aspect ratio * @param fileRev (optional) Specific Revision */ getFilePreview(fileKey: string, width: number, height: number, fileRev?: number | undefined): Promise<RedirectResult | null>; private getFilePreviewWithCallbacks; private processGetFilePreviewWithCallbacks; protected processGetFilePreview(xhr: any): RedirectResult | null | null; /** * Returns a URI to download the requested file preview * @param fileKey Catalog File Key * @param width Width * @param height Height; either width or height can be zero for a proportional aspect ratio * @param fileRev (optional) Specific Revision */ getFilePreviewURL(fileKey: string, width: number, height: number, fileRev?: number | undefined): Promise<string | null>; private getFilePreviewURLWithCallbacks; private processGetFilePreviewURLWithCallbacks; protected processGetFilePreviewURL(xhr: any): string | null | null; /** * Returns key to a document intended to route this file for approvals * @param fileKey Catalog File Key */ getFileRouter(fileKey: string): Promise<string>; private getFileRouterWithCallbacks; private processGetFileRouterWithCallbacks; protected processGetFileRouter(xhr: any): string | null; /** * Returns a list Of versions For the specified ID; see also Meta info * @param fileKey Catalog File Key */ getCatalogVersions(fileKey: string): Promise<FileVersion[] | null>; private getCatalogVersionsWithCallbacks; private processGetCatalogVersionsWithCallbacks; protected processGetCatalogVersions(xhr: any): FileVersion[] | null | null; /** * Deletes the specified file * @param iD Catalog File Key * @param fileRev (optional) Specific Revision or zero (default) to delete the file */ deleteFile(iD: string, fileRev?: number | undefined): Promise<any>; private deleteFileWithCallbacks; private processDeleteFileWithCallbacks; protected processDeleteFile(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 */ postDocInfoExport(exportRequest: ExportRequest): Promise<string>; private postDocInfoExportWithCallbacks; private processPostDocInfoExportWithCallbacks; protected processPostDocInfoExport(xhr: any): string | null; /** * Returns a CRT Task key * @param fileKeyList Catalog File Keys * @param format (optional) zip * @param summary (optional) When true, sends Summary email */ downloadFiles(fileKeyList: string[], format?: string | null | undefined, summary?: boolean | undefined): Promise<string>; private downloadFilesWithCallbacks; private processDownloadFilesWithCallbacks; protected processDownloadFiles(xhr: any): string | null; /** * Returns a CRT Task key * @param exportRequest Export Parameters, optional target file name and fileKey collection in WhichRows[].RowKey * @param summary (optional) When true, sends Summary email */ downloadZip(exportRequest: ExportRequest, summary?: boolean | undefined): Promise<string>; private downloadZipWithCallbacks; private processDownloadZipWithCallbacks; protected processDownloadZip(xhr: any): string | null; /** * Creates a New empty file * @param fileKey Parent Folder Key * @param fileName Parent Folder Key */ addFileToFolder(fileKey: string, fileName: string | null): Promise<FileInformation | null>; private addFileToFolderWithCallbacks; private processAddFileToFolderWithCallbacks; protected processAddFileToFolder(xhr: any): FileInformation | null | null; /** * Creates a New folder In the specified folder * @param folderDesignation Catalog Folder Key * @param folderName New Folder Name * @param newContainerKey (optional) Optional New Folder Key */ addFolder(folderDesignation: string | null, folderName: string | null, newContainerKey?: string | null | undefined): Promise<FileInformation | null>; private addFolderWithCallbacks; private processAddFolderWithCallbacks; protected processAddFolder(xhr: any): FileInformation | 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 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 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; /** * Deletes the specified folder * @param folderKey Catalog Folder Key */ deleteFolder(folderKey: string): Promise<any>; private deleteFolderWithCallbacks; private processDeleteFolderWithCallbacks; protected processDeleteFolder(xhr: any): any | null; /** * Returns a FileInformation model for the specified folder * @param folderKey Catalog Folder Key */ getFolderInfo(folderKey: string): Promise<FileInformation | null>; private getFolderInfoWithCallbacks; private processGetFolderInfoWithCallbacks; protected processGetFolderInfo(xhr: any): FileInformation | null | null; /** * Moves a file Or folder * @param folderKey Target Folder Key * @param existingKey Existing file Or folder key */ moveIntoFolder(folderKey: string, existingKey: string): Promise<FileInformation | null>; private moveIntoFolderWithCallbacks; private processMoveIntoFolderWithCallbacks; protected processMoveIntoFolder(xhr: any): FileInformation | null | 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; /** * Updates the meta properties Of the specified catalog Object, either file Or folder * @param newData New Object Meta Data, must include key */ updateObjectMeta(newData: FileInformation): Promise<FileInformation | null>; private updateObjectMetaWithCallbacks; private processUpdateObjectMetaWithCallbacks; protected processUpdateObjectMeta(xhr: any): FileInformation | null | null; /** * Updates the specified entry on a catalog object * @param key File or Folder Key * @param fieldName Field Name * @param newValue Replacement Value */ patchObjectMeta(key: string, fieldName: string | null, newValue: string): Promise<any>; private patchObjectMetaWithCallbacks; private processPatchObjectMetaWithCallbacks; protected processPatchObjectMeta(xhr: any): any | null; /** * Gets FileInformation for the specified Object * @param objectKey Catalog Object Key (can be a file Or folder key) */ getObjectMeta(objectKey: string): Promise<FileInformation | null>; private getObjectMetaWithCallbacks; private processGetObjectMetaWithCallbacks; protected processGetObjectMeta(xhr: any): FileInformation | null | null; /** * Deletes the specified Object * @param objectKey Catalog Object Key (can be a file Or folder key) */ deleteObject(objectKey: string): Promise<any>; private deleteObjectWithCallbacks; private processDeleteObjectWithCallbacks; protected processDeleteObject(xhr: any): any | null; /** * Returns settings For a preset search * @param setID Set ID */ postPresetSearch(setID: string | null): Promise<CatalogPreset | null>; private postPresetSearchWithCallbacks; private processPostPresetSearchWithCallbacks; protected processPostPresetSearch(xhr: any): CatalogPreset | 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 the name Of the root folder */ getRootFolderName(): Promise<any>; private getRootFolderNameWithCallbacks; private processGetRootFolderNameWithCallbacks; protected processGetRootFolderName(xhr: any): any | 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 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 the fake utilization stats */ getStats(): Promise<{ [key: string]: any; } | null>; private getStatsWithCallbacks; private processGetStatsWithCallbacks; protected processGetStats(xhr: any): { [key: string]: any; } | null | null; /** * Returns a key for a file upload stream. You can discard the key. The meta data is held in the user session based on a hash of the file name * @param fileInfo meta data */ beginUpload(fileInfo: FileInformation): Promise<{ [key: string]: string; } | null>; private beginUploadWithCallbacks; private processBeginUploadWithCallbacks; protected processBeginUpload(xhr: any): { [key: string]: string; } | null | null; /** * Accepts file upload in chunks. Compatible with https://github.com/blueimp/jQuery-File-Upload */ uploadChunk(): Promise<XferFilesStatus[] | null>; private uploadChunkWithCallbacks; private processUploadChunkWithCallbacks; protected processUploadChunk(xhr: any): XferFilesStatus[] | null | null; /** * Returns the tree Of folders * @param folderSource Blank or Catalog for standard folders, D3 for Dynamic Document Depth */ getFolderTree(folderSource: string | null): Promise<FileInformation[] | null>; private getFolderTreeWithCallbacks; private processGetFolderTreeWithCallbacks; protected processGetFolderTree(xhr: any): FileInformation[] | null | null; /** * Accepts meta data and a file upload (up to 300MB) in a single request */ uploadFile(): Promise<XferFilesStatus | null>; private uploadFileWithCallbacks; private processUploadFileWithCallbacks; protected processUploadFile(xhr: any): XferFilesStatus | null | null; } export declare class ConfigClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Updates a flex key by name and segment number. Returns the new definition. * @param data Sparse definition of a single Flex Key Name. Existing segments greater than the last provided segment are removed. */ updateFlexKey(data: FlexMask[]): Promise<FlexMask[] | null>; private updateFlexKeyWithCallbacks; private processUpdateFlexKeyWithCallbacks; protected processUpdateFlexKey(xhr: any): FlexMask[] | null | null; /** * Returns all flex key segments */ getFlexKeyList(): Promise<FlexMask[] | null>; private getFlexKeyListWithCallbacks; private processGetFlexKeyListWithCallbacks; protected processGetFlexKeyList(xhr: any): FlexMask[] | null | null; /** * Deletes flex key segments by key * @param keys Flex segment keys (GUIDs) to delete */ deleteFlexKeys(keys: string[]): Promise<number>; private deleteFlexKeysWithCallbacks; private processDeleteFlexKeysWithCallbacks; protected processDeleteFlexKeys(xhr: any): number | null; /** * Returns parts of a flexible key by name * @param id Name (Project, Task, etc) or * */ getFlexKeyInfo(id: string | null): Promise<FlexMask[] | null>; private getFlexKeyInfoWithCallbacks; private processGetFlexKeyInfoWithCallbacks; protected processGetFlexKeyInfo(xhr: any): FlexMask[] | null | null; /** * Returns the mask for a flex key by name. EG xx-xxx * @param id Name (Project, Task, etc) */ getFlexKeyMask(id: string | null): Promise<string | null>; private getFlexKeyMaskWithCallbacks; private processGetFlexKeyMaskWithCallbacks; protected processGetFlexKeyMask(xhr: any): string | null | null; /** * Deletes a predefined route by key our by name * @param sourceRoute Key or Name */ deleteRoute(sourceRoute: string | null): Promise<boolean>; private deleteRouteWithCallbacks; private processDeleteRouteWithCallbacks; protected processDeleteRoute(xhr: any): boolean | null; /** * Copies a predefined route by key our by name * @param sourceRoute Key or Name * @param newName Key or Name */ copyRoute(sourceRoute: string | null, newName: string | null): Promise<string>; private copyRouteWithCallbacks; private processCopyRouteWithCallbacks; protected processCopyRoute(xhr: any): string | null; /** * Returns the list of account categories */ getAccountCategories(): Promise<WBPartEntry[] | null>; private getAccountCategoriesWithCallbacks; private processGetAccountCategoriesWithCallbacks; protected processGetAccountCategories(xhr: any): WBPartEntry[] | null | null; /** * Inserts account categories * @param data Account category rows to insert */ insertAccountCategories(data: WBPartEntry[]): Promise<WBPartEntry[] | null>; private insertAccountCategoriesWithCallbacks; private processInsertAccountCategoriesWithCallbacks; protected processInsertAccountCategories(xhr: any): WBPartEntry[] | null | null; /** * Updates one account category * @param data Account category row to update */ patchAccountCategory(data: WBPartEntry): Promise<WBPartEntry | null>; private patchAccountCategoryWithCallbacks; private processPatchAccountCategoryWithCallbacks; protected processPatchAccountCategory(xhr: any): WBPartEntry | null | null; /** * Deletes account categories by key * @param keys Account category row keys (GUIDs) to delete */ deleteAccountCategories(keys: string[]): Promise<number>; private deleteAccountCategoriesWithCallbacks; private processDeleteAccountCategoriesWithCallbacks; protected processDeleteAccountCategories(xhr: any): number | null; /** * Returns the System Admin dashboard tool menu */ getAdminTools(): Promise<MenuAction[] | null>; private getAdminToolsWithCallbacks; private processGetAdminToolsWithCallbacks; protected processGetAdminTools(xhr: any): MenuAction[] | null | null; /** * Returns the list of alert subscriptions */ getAlertSubscriptions(): Promise<AlertSubscription[] | null>; private getAlertSubscriptionsWithCallbacks; private processGetAlertSubscriptionsWithCallbacks; protected processGetAlertSubscriptions(xhr: any): AlertSubscription[] | null | null; /** * Inserts alert subscriptions * @param data Alert subscription rows to insert */ insertAlertSubscriptions(data: AlertSubscription[]): Promise<AlertSubscription[] | null>; private insertAlertSubscriptionsWithCallbacks; private processInsertAlertSubscriptionsWithCallbacks; protected processInsertAlertSubscriptions(xhr: any): AlertSubscription[] | null | null; /** * Updates one alert subscription * @param data Alert subscription row to update */ patchAlertSubscription(data: AlertSubscription): Promise<AlertSubscription | null>; private patchAlertSubscriptionWithCallbacks; private processPatchAlertSubscriptionWithCallbacks; protected processPatchAlertSubscription(xhr: any): AlertSubscription | null | null; /** * Deletes alert subscriptions by key * @param keys Alert subscription row keys (GUIDs) to delete */ deleteAlertSubscriptions(keys: string[]): Promise<number>; private deleteAlertSubscriptionsWithCallbacks; private processDeleteAlertSubscriptionsWithCallbacks; protected processDeleteAlertSubscriptions(xhr: any): number | null; /** * Returns the list of alert types */ getAlertTypes(): Promise<AlertType[] | null>; private getAlertTypesWithCallbacks; private processGetAlertTypesWithCallbacks; protected processGetAlertTypes(xhr: any): AlertType[] | null | null; /** * Inserts alert types * @param data Alert type rows to insert */ insertAlertTypes(data: AlertType[]): Promise<AlertType[] | null>; private insertAlertTypesWithCallbacks; private processInsertAlertTypesWithCallbacks; protected processInsertAlertTypes(xhr: any): AlertType[] | null | null; /** * Updates one alert type * @param data Alert type row to update */ patchAlertType(data: AlertType): Promise<AlertType | null>; private patchAlertTypeWithCallbacks; private processPatchAlertTypeWithCallbacks; protected processPatchAlertType(xhr: any): AlertType | null | null; /** * Deletes alert types by key * @param keys Alert type row keys (GUIDs) to delete */ deleteAlertTypes(keys: string[]): Promise<number>; private deleteAlertTypesWithCallbacks; private processDeleteAlertTypesWithCallbacks; protected processDeleteAlertTypes(xhr: any): number | null; /** * Returns the list of cloud storage definitions */ getCloudStores(): Promise<CloudStore[] | null>; private getCloudStoresWithCallbacks; private processGetCloudStoresWithCallbacks; protected processGetCloudStores(xhr: any): CloudStore[] | null | null; /** * Inserts cloud storage definitions * @param data Cloud storage rows to insert */ insertCloudStores(data: CloudStore[]): Promise<CloudStore[] | null>; private insertCloudStoresWithCallbacks; private processInsertCloudStoresWithCallbacks; protected processInsertCloudStores(xhr: any): CloudStore[] | null | null; /** * Updates one cloud storage definition * @param data Cloud storage row to update */ patchCloudStore(data: CloudStore): Promise<CloudStore | null>; private patchCloudStoreWithCallbacks; private processPatchCloudStoreWithCallbacks; protected processPatchCloudStore(xhr: any): CloudStore | null | null; /** * Deletes cloud storage definitions by key * @param keys Cloud storage row keys (GUIDs) to delete */ deleteCloudStores(keys: string[]): Promise<number>; private deleteCloudStoresWithCallbacks; private processDeleteCloudStoresWithCallbacks; protected processDeleteCloudStores(xhr: any): number | null; /** * Returns the list of code set values */ getCodeSetValues(): Promise<CodeSetValue[] | null>; private getCodeSetValuesWithCallbacks; private processGetCodeSetValuesWithCallbacks; protected processGetCodeSetValues(xhr: any): CodeSetValue[] | null | null; /** * Inserts code set values * @param data Code set value rows to insert */ insertCodeSetValues(data: CodeSetValue[]): Promise<CodeSetValue[] | null>; private insertCodeSetValuesWithCallbacks; private processInsertCodeSetValuesWithCallbacks; protected processInsertCodeSetValues(xhr: any): CodeSetValue[] | null | null; /** * Updates one code set value