spitfirepm

import { APIClientBase } from './APIClientBase'; export declare class ActionItemsClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * 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 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 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; /** * 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; } export declare class ProjectToolsClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns a summary overview of the specified project * @param projectID Full Project ID */ getProjectDetail(projectID: string | null): Promise<ProjectAbstract | null>; private getProjectDetailWithCallbacks; private processGetProjectDetailWithCallbacks; protected processGetProjectDetail(xhr: any): ProjectAbstract | null | null; /** * Releases all cached financial data * @param projectID Full Project ID */ deleteProjectCache(projectID: string | null): Promise<any>; private deleteProjectCacheWithCallbacks; private processDeleteProjectCacheWithCallbacks; protected processDeleteProjectCache(xhr: any): any | null; /** * Returns a summary of peer tasks for this project * @param projectID Full Project ID */ getProjectPeerSummary(projectID: string | null): Promise<ProjectXTSTaskState[] | null>; private getProjectPeerSummaryWithCallbacks; private processGetProjectPeerSummaryWithCallbacks; protected processGetProjectPeerSummary(xhr: any): ProjectXTSTaskState[] | null | null; /** * Requests peer re-sync * @param projectID Full Project ID */ refreshPeerSummary(projectID: string | null): Promise<any>; private refreshPeerSummaryWithCallbacks; private processRefreshPeerSummaryWithCallbacks; protected processRefreshPeerSummary(xhr: any): any | null; /** * Returns programs in which the specified project is listed * @param projectID Full Project ID */ getProjectPrograms(projectID: string | null): Promise<ProjectPrograms[] | null>; private getProjectProgramsWithCallbacks; private processGetProjectProgramsWithCallbacks; protected processGetProjectPrograms(xhr: any): ProjectPrograms[] | null | null; /** * Returns programs in which the specified project is listed * @param projectID Full Project ID * @param programList list of programs */ removeProjectPrograms(projectID: string | null, programList: string[]): Promise<ProjectPrograms[] | null>; private removeProjectProgramsWithCallbacks; private processRemoveProjectProgramsWithCallbacks; protected processRemoveProjectPrograms(xhr: any): ProjectPrograms[] | null | null; /** * Adds programs, then returns programs in which the specified project is listed * @param projectID Full Project ID * @param programList list of programs */ addProjectPrograms(projectID: string | null, programList: string[]): Promise<ProjectPrograms[] | null>; private addProjectProgramsWithCallbacks; private processAddProjectProgramsWithCallbacks; protected processAddProjectPrograms(xhr: any): ProjectPrograms[] | null | null; /** * Returns projects that link to the specified project * @param projectID Full Project ID */ getProjectLinks(projectID: string | null): Promise<ProjectLink[] | null>; private getProjectLinksWithCallbacks; private processGetProjectLinksWithCallbacks; protected processGetProjectLinks(xhr: any): ProjectLink[] | null | null; /** * Returns WBS for the specified project * @param projectID Full Project ID */ getProjectWBS(projectID: string | null): Promise<ProjectWBS[] | null>; private getProjectWBSWithCallbacks; private processGetProjectWBSWithCallbacks; protected processGetProjectWBS(xhr: any): ProjectWBS[] | null | null; /** * Adds WBS to the specified project * @param projectID Full Project ID */ addProjectWBS(projectID: string | null, wbsLine: ProjectWBS): Promise<ProjectWBS | null>; private addProjectWBSWithCallbacks; private processAddProjectWBSWithCallbacks; protected processAddProjectWBS(xhr: any): ProjectWBS | null | null; /** * Returns WBS for the specified project * @param projectID Full Project ID */ putProjectWBS(projectID: string | null, wbsLine: ProjectWBS): Promise<ProjectWBS | null>; private putProjectWBSWithCallbacks; private processPutProjectWBSWithCallbacks; protected processPutProjectWBS(xhr: any): ProjectWBS | null | null; /** * Updates a WBS entry for the specified project. * @param projectID Full Project ID * @param wBSID Row Key or WB Code * @param fieldName Field Name * @param newValue Replacement data */ patchProjectWBS(projectID: string | null, wBSID: string | null, fieldName: string | null, newValue: string): Promise<ProjectWBS | null>; private patchProjectWBSWithCallbacks; private processPatchProjectWBSWithCallbacks; protected processPatchProjectWBS(xhr: any): ProjectWBS | null | null; /** * Creates a Project and Project Setup document (uncommitted) * @param projectID Full Project ID without mask * @param abstract Data for new project */ putProject(projectID: string | null, abstract: ProjectAbstract): Promise<ProjectAbstract | null>; private putProjectWithCallbacks; private processPutProjectWithCallbacks; protected processPutProject(xhr: any): ProjectAbstract | null | null; /** * Creates and posts a NET project budget revision. * @param projectID Full Project ID without mask * @param targets Bit mask Targets 1=Original, 2=EAC/Current, 4=FAC, 7=all * @param budget Budget Line Items * @param subType (optional) (Optional) Sub Type code * @param sourceNum (optional) (Optional) Source Reference Number * @param title (optional) (Optional) Title */ postProjectBudget(projectID: string | null, targets: number, budget: DocItemTask[], subType?: string | null | undefined, sourceNum?: string | null | undefined, title?: string | null | undefined): Promise<string>; private postProjectBudgetWithCallbacks; private processPostProjectBudgetWithCallbacks; protected processPostProjectBudget(xhr: any): string | null; /** * Returns project costs summarized by Account and or Task * @param projectID Full Project ID * @param summaryByAccount (optional) Summarize by Account Category * @param summaryByTask (optional) Summarize by WB Task * @param showExp (optional) Include Expense * @param showRev (optional) Include Revenue * @param showUnits (optional) Show Units instead of dollars * @param showThousands (optional) Return amounts in Thousands */ getProjectCost(projectID: string | null, summaryByAccount?: boolean | undefined, summaryByTask?: boolean | undefined, showExp?: boolean | undefined, showRev?: boolean | undefined, showUnits?: boolean | undefined, showThousands?: boolean | undefined): Promise<{ [key: string]: any; }[] | null>; private getProjectCostWithCallbacks; private processGetProjectCostWithCallbacks; protected processGetProjectCost(xhr: any): { [key: string]: any; }[] | null | null; /** * Returns one to three rows to summarize project costs summarized by Account and or Task. The task_desk and acct fields are set to identify the Expense, Revenue and Margin in the result set. The Revenue and Margin rows return the values (revenue and expense margin) in the expense fields * @param projectID Full Project ID * @param summaryByAccount (optional) Summarize by Account Category * @param summaryByTask (optional) Summarize by WB Task * @param showExp (optional) Include Expenses * @param showRev (optional) Include Revenue (only if summaryByAccount) * @param showUnits (optional) Return Units instead of dollars * @param showThousands (optional) Return amounts in Thousands */ getProjectCostFooters(projectID: string | null, summaryByAccount?: boolean | undefined, summaryByTask?: boolean | undefined, showExp?: boolean | undefined, showRev?: boolean | undefined, showUnits?: boolean | undefined, showThousands?: boolean | undefined): Promise<any>; private getProjectCostFootersWithCallbacks; private processGetProjectCostFootersWithCallbacks; protected processGetProjectCostFooters(xhr: any): any | null | null; /** * Returns recent weather reading at the specified project site * @param projectID Full Project ID */ getProjectWeatherReading(projectID: string | null): Promise<ProjectWeatherNow | null>; private getProjectWeatherReadingWithCallbacks; private processGetProjectWeatherReadingWithCallbacks; protected processGetProjectWeatherReading(xhr: any): ProjectWeatherNow | null | null; /** * Returns history of weather readings at the specified project site INCOMPLETE * @param projectID Full Project ID */ getProjectWeatherHistory(projectID: string | null): Promise<WeatherAtLocation[] | null>; private getProjectWeatherHistoryWithCallbacks; private processGetProjectWeatherHistoryWithCallbacks; protected processGetProjectWeatherHistory(xhr: any): WeatherAtLocation[] | null | null; /** * Returns current note for the specified project * @param projectID Full Project ID */ getProjectNote(projectID: string | null): Promise<string | null>; private getProjectNoteWithCallbacks; private processGetProjectNoteWithCallbacks; protected processGetProjectNote(xhr: any): string | null | null; /** * Sets project note INCOMPLETE!!! * @param projectID Full Project ID */ newProjectNote(projectID: string | null, newNote: string): Promise<boolean>; private newProjectNoteWithCallbacks; private processNewProjectNoteWithCallbacks; protected processNewProjectNote(xhr: any): boolean | null; /** * Returns all notes for the specified project * @param projectID Full Project ID */ getProjectNotes(projectID: string | null): Promise<Comment[] | null>; private getProjectNotesWithCallbacks; private processGetProjectNotesWithCallbacks; protected processGetProjectNotes(xhr: any): Comment[] | null | null; /** * Returns transactions that detail costs on the project * @param projectID Full Project ID * @param forWBS (optional) Cost Code Like * @param forAccount (optional) Account Category * @param forAccountType (optional) Account Category Type (RV,EX,%) * @param forAccountClass (optional) Account Category Class (L,LB,M,O,P) * @param forPeriod (optional) Fiscal Period * @param fromDate (optional) From Date * @param thruDate (optional) Thru Date * @param refDMK (optional) Reference Document * @param refVendor (optional) Reference Vendor ID (or Contact Key) */ getProjectCostTransactions(projectID: string | null, forWBS?: string | null | undefined, forAccount?: string | null | undefined, forAccountType?: string | null | undefined, forAccountClass?: string | null | undefined, forPeriod?: string | null | undefined, fromDate?: string | null | undefined, thruDate?: string | null | undefined, refDMK?: string | null | undefined, refVendor?: string | null | undefined): Promise<ProjectTranDetail[] | null>; private getProjectCostTransactionsWithCallbacks; private processGetProjectCostTransactionsWithCallbacks; protected processGetProjectCostTransactions(xhr: any): ProjectTranDetail[] | null | null; /** * Returns Committed Amounts on the project * @param projectID Full Project ID * @param forWBS (optional) Cost Code Like * @param forAccount (optional) Account Category * @param forAccountType (optional) Account Category Type (RV,EX,%) * @param forAccountClass (optional) Account Category Class (L,LB,M,O,P) * @param forPeriod (optional) Fiscal Period */ getProjectCommittedCosts(projectID: string | null, forWBS?: string | null | undefined, forAccount?: string | null | undefined, forAccountType?: string | null | undefined, forAccountClass?: string | null | undefined, forPeriod?: string | null | undefined): Promise<ProjectCommitmentDetail[] | null>; private getProjectCommittedCostsWithCallbacks; private processGetProjectCommittedCostsWithCallbacks; protected processGetProjectCommittedCosts(xhr: any): ProjectCommitmentDetail[] | null | null; } export declare class ContactClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns contacts that match filters * @param usingFilters Search Criteria */ matchingContactList(usingFilters: ContactFilters): Promise<ContactSummary[] | null>; private matchingContactListWithCallbacks; private processMatchingContactListWithCallbacks; protected processMatchingContactList(xhr: any): ContactSummary[] | null | null; /** * Returns the contact * @param id Contact Key */ getContact(id: string): Promise<Contact | null>; private getContactWithCallbacks; private processGetContactWithCallbacks; protected processGetContact(xhr: any): Contact | null | null; /** * Updates the contact * @param id Contact Key * @param newData Replacement Data * @param project (optional) Optional Project Context */ updateContact(id: string, newData: Contact, project?: string | null | undefined): Promise<any>; private updateContactWithCallbacks; private processUpdateContactWithCallbacks; protected processUpdateContact(xhr: any): any | null; /** * Adds the contact * @param newData Contact Data * @param project (optional) Optional Project Contact * @param isCompany (optional) Optional is Primary Company Contact */ addContact(newData: Contact, project?: string | null | undefined, isCompany?: boolean | undefined): Promise<Contact | null>; private addContactWithCallbacks; private processAddContactWithCallbacks; protected processAddContact(xhr: any): Contact | null | 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 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 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 * @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 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 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 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 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 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; /** * 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; } export declare class SystemClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns server version in major.minor.build.t * @param shortVersion (optional) */ getVersion(shortVersion?: boolean | undefined): Promise<string | null>; private getVersionWithCallbacks; private processGetVersionWithCallbacks; protected processGetVersion(xhr: any): string | null | null; /** * Returns UUID */ getNonce(peerKey: string | null): Promise<string>; private getNonceWithCallbacks; private processGetNonceWithCallbacks; protected processGetNonce(xhr: any): string | null; /** * Returns OK or NAK * @param peer Identifies the source * @param type Type of peer notification. See PeerNotificationType enum <ul><li>CK - Discard catalog cache by key</li> <li>FFF - Flush File by Key/Rev</li> <li>LV - Limited Volatility Data has been changed and should be reloaded</li> <li>PROJ - Project Flush</li> <li>RR - Rules have been changed</li> <li>UAC - User Roles have been changed</li> <li>ReloadSiteConfig - Full reload (Diagnostic page button)</li> <li>ATC - ATC Active </li> <li>XTS - Exchange Token Sync (asks peers if they know the exchange token)</li> * @param info Body of notification */ postHMS(peer: string | null, type: string | null, info: string | null): Promise<string | null>; private postHMSWithCallbacks; private processPostHMSWithCallbacks; protected processPostHMS(xhr: any): string | null | null; /** * Returns server notification or empty string * @param hash Optional Notification Hash (eschews stale cache) */ getSystemNotification(hash: string | null): Promise<string | null>; private getSystemNotificationWithCallbacks; private processGetSystemNotificationWithCallbacks; protected processGetSystemNotification(xhr: any): string | null | null; /** * Returns site branding label */ getBranding(): Promise<string | null>; private getBrandingWithCallbacks; private processGetBrandingWithCallbacks; protected processGetBranding(xhr: any): string | null | null; /** * Returns site copyright label */ getCopyright(): Promise<string | null>; private getCopyrightWithCallbacks; private processGetCopyrightWithCallbacks; protected processGetCopyright(xhr: any): string | null | null; /** * Returns site logo URL */ getSiteLogo(): Promise<string | null>; private getSiteLogoWithCallbacks; private processGetSiteLogoWithCallbacks; protected processGetSiteLogo(xhr: any): string | null | null; /** * Returns state of identity federation peers */ getFederationVia(): Promise<{ [key: string]: string; } | null>; private getFederationViaWithCallbacks; private processGetFederationViaWithCallbacks; protected processGetFederationVia(xhr: any): { [key: string]: string; } | null | null; /** * Returns public catalog data (for example login-1.htm */ getPublicResource(path: string | null): Promise<string | null>; private getPublicResourceWithCallbacks; private processGetPublicResourceWithCallbacks; protected processGetPublicResource(xhr: any): string | null | null; /** * Returns name of this IIS server */ getServerNodeName(): Promise<string | null>; private getServerNodeNameWithCallbacks; private processGetServerNodeNameWithCallbacks; protected processGetServerNodeName(xhr: any): string | null | null; /** * Returns if running in dev mode */ getDevMode(): Promise<boolean>; private getDevModeWithCallbacks; private processGetDevModeWithCallbacks; protected processGetDevMode(xhr: any): boolean | null; /** * Changes dev mode * @param mode New Dev Mode */ setDevMode(mode: boolean): Promise<boolean>; private setDevModeWithCallbacks; private processSetDevModeWithCallbacks; protected processSetDevMode(xhr: any): boolean | null; /** * Allows admin to suppress Declarative Referential Integrity * @param key Key, usually a Data PK * @param mode New DRI Mode */ setDRI(key: string | null, mode: boolean): Promise<boolean>; private setDRIWithCallbacks; private processSetDRIWithCallbacks; protected processSetDRI(xhr: any): boolean | null; /** * Allows admin to detect state of Declarative Referential Integrity * @param key Key, usually a Data PK */ getDRI(key: string | null): Promise<boolean>; private getDRIWithCallbacks; private processGetDRIWithCallbacks; protected processGetDRI(xhr: any): boolean | null; /** * Returns list of active document/process types * @param key Use 00000000-1000-0000-1000-000000000000 for all active processes */ getProcessList(key: string): Promise<ProcessDocumentType[] | null>; private getProcessListWithCallbacks; private processGetProcessListWithCallbacks; protected processGetProcessList(xhr: any): ProcessDocumentType[] | null | null; /** * Returns list of trashed documents * @param key (optional) Use empty for all deleted docs */ getDeletedDocList(key?: string | undefined): Promise<{ [key: string]: any; }[] | null>; private getDeletedDocListWithCallbacks; private processGetDeletedDocListWithCallbacks; protected processGetDeletedDocList(xhr: any): { [key: string]: any; }[] | null | null; /** * Recovers a specific deleted document * @param key (optional) Required DMK */ recoverDeletedDocument(key?: string | undefined): Promise<boolean>; private recoverDeletedDocumentWithCallbacks; private processRecoverDeletedDocumentWithCallbacks; protected processRecoverDeletedDocument(xhr: any): boolean | null; /** * Returns list of active documents */ getActiveDocList(): Promise<{ [key: string]: any; }[] | null>; private getActiveDocListWithCallbacks; private processGetActiveDocListWithCallbacks; protected processGetActiveDocList(xhr: any): { [key: string]: any; }[] | null | null; /** * Returns list of active users */ getActiveUserList(): Promise<UserSessionInfo[] | null>; private getActiveUserListWithCallbacks; private processGetActiveUserListWithCallbacks; protected processGetActiveUserList(xhr: any): UserSessionInfo[] | null | null; /** * Prunes idle users (per license) */ pruneIdleUsers(): Promise<number>; private pruneIdleUsersWithCallbacks; private processPruneIdleUsersWithCallbacks; protected processPruneIdleUsers(xhr: any): number | null; /** * Reloads site configuration and settings */ reloadSiteConfiguration(): Promise<string | null>; private reloadSiteConfigurationWithCallbacks; private processReloadSiteConfigurationWithCallbacks; protected processReloadSiteConfiguration(xhr: any): string | null | null; /** * Encrypts and stores the posted information in xtsConfig * @param partnerType partner type (eg CloudStore) * @param servicePoint for Service.oAuthData * @param payload Quote enclosed JSON */ postAuthData(partnerType: string | null, servicePoint: string | null, payload: string): Promise<HttpStatusCode>; private postAuthDataWithCallbacks; private processPostAuthDataWithCallbacks; protected processPostAuthData(xhr: any): HttpStatusCode | null; /** * Returns obfuscated and Base64 encoded string * @param usingKey Key for encrypt * @param payload What to encrypt and Base64 (enclose in quotes) * @return Umm */ obfuscateData(usingKey: string | null, payload: string): Promise<string>; private obfuscateDataWithCallbacks; private processObfuscateDataWithCallbacks; protected processObfuscateData(xhr: any): string | null; /** * Returns statistical data * @param withDetails (optional) */ getSystemStats(withDetails?: boolean | undefined): Promise<{ [key: string]: any; } | null>; private getSystemStatsWithCallbacks; private processGetSystemStatsWithCallbacks; protected processGetSystemStats(xhr: any): { [key: string]: any; } | null | null; } export declare class SessionClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns nice fresh GUID(s) / UUID * @param count Number of GUIDs to return, max is 39 */ getNewGuid(count: number): Promise<string[] | null>; private getNewGuidWithCallbacks; private processGetNewGuidWithCallbacks; protected processGetNewGuid(xhr: any): string[] | null | null; /** * Returns list of documents recently accessed by this user */ getRecentDocs(): Promise<MenuAction[] | null>; private getRecentDocsWithCallbacks; private processGetRecentDocsWithCallbacks; protected processGetRecentDocs(xhr: any): MenuAction[] | null | null; /** * Returns list of reports and report groups accessible to this user */ getReportMenu(groupId: string | null): Promise<MenuAction[] | null>; private getReportMenuWithCallbacks; private processGetReportMenuWithCallbacks; protected processGetReportMenu(xhr: any): MenuAction[] | null | null; /** * Returns list of reports of report groups accessible to this user */ getMenu(menuId: string | null): Promise<MenuAction[] | null>; private getMenuWithCallbacks; private processGetMenuWithCallbacks; protected processGetMenu(xhr: any): MenuAction[] | null | null; /** * returns magic number that allows client to know if its nonvolatile data is up-to-date */ getLVDataMagicNumber(): Promise<string | null>; private getLVDataMagicNumberWithCallbacks; private processGetLVDataMagicNumberWithCallbacks; protected processGetLVDataMagicNumber(xhr: any): string | null | null; /** * returns true if user has document open in this session * @param id key of document */ getUsingThisDocument(id: string): Promise<boolean>; private getUsingThisDocumentWithCallbacks; private processGetUsingThisDocumentWithCallbacks; protected processGetUsingThisDocument(xhr: any): boolean | null; /** * Returns this users permission flags for a specific capability and context. * @param ucModule ucModule (SYS, LIST, PAGE, PART, etc) * @param ucName ucName (substitute @ for slash and ! for periods) * @param projectID (optional) Project ID * @param documentType (optional) Document Type */ getCapabilityPermits(ucModule: string | null, ucName: string | null, projectID?: string | null | undefined, documentType?: string | null | undefined): Promise<PermissionFlags>; private getCapabilityPermitsWithCallbacks; private processGetCapabilityPermitsWithCallbacks; protected processGetCapabilityPermits(xhr: any): PermissionFlags | null; /** * Returns a token that can be exchanged for the specific packet of information */ createExchangeToken(tokenPayload: TokenRequest): Promise<string | null>; private createExchangeTokenWithCallbacks; private processCreateExchangeTokenWithCallbacks; protected processCreateExchangeToken(xhr: any): string | null | null; /** * Returns the token-specific packet of information with Auth, Session and Args encrypted * @param token Token */ exchangeToken(token: string | null): Promise<AuthenticationExchangeData | null>; private exchangeTokenWithCallbacks; private processExchangeTokenWithCallbacks; protected processExchangeToken(xhr: any): AuthenticationExchangeData | null | null; /** * Sets the time offset for this session */ postClientTime(timeNow: Date, tzOffset: number): Promise<boolean>; private postClientTimeWithCallbacks; private processPostClientTimeWithCallbacks; protected processPostClientTime(xhr: any): boolean | null; /** * Returns list of permissions for a project * @param projectID Project ID */ getProjectPermits(projectID: string | null): Promise<UCPermitSet | null>; private getProjectPermitsWithCallbacks; private processGetProjectPermitsWithCallbacks; protected processGetProjectPermits(xhr: any): UCPermitSet | null | null; /** * Returns server version in major.minor.build.t */ getVersion(): Promise<string | null>; private getVersionWithCallbacks; private processGetVersionWithCallbacks; protected processGetVersion(xhr: any): string | null | null; /** * Return cross request task state * @return task is done */ getTaskState(taskID: string): Promise<HttpResponseJsonContent>; private getTaskStateWithCallbacks; private processGetTaskStateWithCallbacks; protected processGetTaskState(xhr: any): HttpResponseJsonContent | null; /** * Return cross request task result data as json */ getTaskResult(taskID: string): Promise<any>; private getTaskResultWithCallbacks; private processGetTaskResultWithCallbacks; protected processGetTaskResult(xhr: any): any | null; /** * Return cross request result data as a file */ getTaskFile(taskID: string): Promise<Stream>; private getTaskFileWithCallbacks; private processGetTaskFileWithCallbacks; protected processGetTaskFile(xhr: any): Stream | null; /** * Returns list of permissions by Module | Function * @param eTag (optional) Returns nothing if eTag matches supplied eTag */ getProjectPermitNameMap(eTag?: string | null | undefined): Promise<any>; private getProjectPermitNameMapWithCallbacks; private processGetProjectPermitNameMapWithCallbacks; protected processGetProjectPermitNameMap(xhr: any): any | null; /** * Returns WCC Session data * @param context (optional) */ getWCC(context?: string | null | undefined): Promise<{ [key: string]: any; } | null>; private getWCCWithCallbacks; private processGetWCCWithCallbacks; protected processGetWCC(xhr: any): { [key: string]: any; } | null | null; /** * Returns list of open tabs * @param forTabType (optional) optional tab type (project,other, other-user,blank for all) */ getSessionTabs(forTabType?: string | null | undefined): Promise<TabStripDetails[] | null>; private getSessionTabsWithCallbacks; private processGetSessionTabsWithCallbacks; protected processGetSessionTabs(xhr: any): TabStripDetails[] | null | null; /** * Adds a tab to list of open tabs * @param tabKey tab key (perhaps project id or user key) * @param tabText tab text (displayed) * @param tabTip tab tip (display on mouse over) * @param tabAction tab action (must also be unique, so often includes tab key * @param forTabType (optional) optional tab type (project,other, otherUser) * @return User Tab collection not found */ addSessionTab(tabKey: string | null, tabText: string | null, tabTip: string | null, tabAction: string | null, forTabType?: string | null | undefined): Promise<string>; private addSessionTabWithCallbacks; private processAddSessionTabWithCallbacks; protected processAddSessionTab(xhr: any): string | null; /** * Returns list of open tabs * @param tabKey Tab Key * @return No tabs (verify session) */ deleteSessionTab(tabKey: string | null): Promise<string>; private deleteSessionTabWithCallbacks; private processDeleteSessionTabWithCallbacks; protected processDeleteSessionTab(xhr: any): string | null; /** * Returns label and tip for new tab * @param id key for new tab, typically project id * @param forTabType (optional) optional tab type (project,other, otherUser,blank for all) */ getSessionTabLabels(id: string | null, forTabType?: string | null | undefined): Promise<TabDisplay | null>; private getSessionTabLabelsWithCallbacks; private processGetSessionTabLabelsWithCallbacks; protected processGetSessionTabLabels(xhr: any): TabDisplay | null | null; /** * Releases document session by its session key * @param id Session Key * @return No session */ deleteDocumentSession(id: string | null): Promise<string>; private deleteDocumentSessionWithCallbacks; private processDeleteDocumentSessionWithCallbacks; protected processDeleteDocumentSession(xhr: any): string | null; /** * Logs the posted data * @param logData Information To be logged */ postToWebAppLog(logData: APIData): Promise<HttpStatusCode>; private postToWebAppLogWithCallbacks; private processPostToWebAppLogWithCallbacks; protected processPostToWebAppLog(xhr: any): HttpStatusCode | null; /** * Patches the value In the indicated resource * @param tableName Table Name (data layer, not native SQL) * @param fieldName field * @param changeData Change information */ patchFieldValue(tableName: string | null, fieldName: string | null, changeData: PDSData): Promise<HttpStatusCode>; private patchFieldValueWithCallbacks; private processPatchFieldValueWithCallbacks; protected processPatchFieldValue(xhr: any): HttpStatusCode | null; /** * Ends this session */ getEndOfSession(): Promise<boolean>; private getEndOfSessionWithCallbacks; private processGetEndOfSessionWithCallbacks; protected processGetEndOfSession(xhr: any): boolean | null; /** * Removes a specific users session */ deleteSessionById(userKey: string, sessionID: string | null): Promise<boolean>; private deleteSessionByIdWithCallbacks; private processDeleteSessionByIdWithCallbacks; protected processDeleteSessionById(xhr: any): boolean | null; } export declare class ProjectKPIClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * Returns list of KPI facts for the specified project * @param projectID Full Project ID */ getProjectKPIFacts(projectID: string | null): Promise<ProjKPIFact[] | null>; private getProjectKPIFactsWithCallbacks; private processGetProjectKPIFactsWithCallbacks; protected processGetProjectKPIFacts(xhr: any): ProjKPIFact[] | null | null; } export declare class DocumentToolsClient extends APIClientBase { baseUrl: string; beforeSend: any; protected jsonParseReviver: ((key: string, value: any) => any) | undefined; constructor(baseUrl?: string); /** * 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