UNPKG

@docsvision/webclient

Version:

Type definitions for DocsVision WebClient scripts and extensions.

1,037 lines (1,036 loc) 166 kB
import { ControllerBase } from '@docsvision/webclient/System/ControllerBase'; import { RequestOptions } from '@docsvision/webclient/Legacy/Utils'; import { GenModels } from '@docsvision/webclient/Generated/DocsVision.WebClient.Models'; export declare namespace GenControllers { /** * Represents controller to check Web-client initialization status. */ interface IInitializationController { /** * Gets the initialization status of Web-client. * Returns a 200 OK status if initialized, otherwise returns a 503 Service Unavailable status. */ isInitialized(options?: RequestOptions): Promise<string>; } class InitializationController extends ControllerBase implements IInitializationController { isInitialized(options?: RequestOptions): Promise<string>; } } export declare type $InitializationController = { initializationController: GenControllers.IInitializationController; }; export declare const $InitializationController: string | ((model?: $InitializationController) => GenControllers.IInitializationController); export declare namespace GenControllers { /** * Employee controller */ interface IContractsController { /** * Get contract info * * @param contractCardId Contract card identifier */ getContractInfo(contractCardId: string, options?: RequestOptions): Promise<GenModels.ContractInfoModel>; /** * Get contract dates * * @param contractCardId Contract card identifier */ getContractDates(contractCardId: string, options?: RequestOptions): Promise<GenModels.ContractDatesModel>; /** * Attach supplement to contract */ prolongateContract(request: GenModels.ProlongateContractRequestModel, options?: RequestOptions): Promise<void>; /** * Fill agreement fields on contract decision. */ fillContractAgreementDates(request: GenModels.ContractAgreementFillDatesModel, options?: RequestOptions): Promise<void>; /** * Fill contract sum in rub field. */ fillContractDate(request: GenModels.ContractFillDateModel, options?: RequestOptions): Promise<void>; /** * Fill agreement fields on contract decision. */ fillContractSumInRub(request: GenModels.ContractFillSumInRubModel, options?: RequestOptions): Promise<void>; } class ContractsController extends ControllerBase implements IContractsController { getContractInfo(contractCardId: string, options?: RequestOptions): Promise<GenModels.ContractInfoModel>; getContractDates(contractCardId: string, options?: RequestOptions): Promise<GenModels.ContractDatesModel>; prolongateContract(request: GenModels.ProlongateContractRequestModel, options?: RequestOptions): Promise<void>; fillContractAgreementDates(request: GenModels.ContractAgreementFillDatesModel, options?: RequestOptions): Promise<void>; fillContractDate(request: GenModels.ContractFillDateModel, options?: RequestOptions): Promise<void>; fillContractSumInRub(request: GenModels.ContractFillSumInRubModel, options?: RequestOptions): Promise<void>; } } export declare type $ContractsController = { contractsController: GenControllers.IContractsController; }; export declare const $ContractsController: string | ((model?: $ContractsController) => GenControllers.IContractsController); export declare namespace GenControllers { /** * Application settings controller */ interface IApplicationSettingsController { /** * /Api/System/GetApplicationSettings */ get(options?: RequestOptions): Promise<string>; } class ApplicationSettingsController extends ControllerBase implements IApplicationSettingsController { get(options?: RequestOptions): Promise<string>; } } export declare type $ApplicationSettingsController = { applicationSettingsController: GenControllers.IApplicationSettingsController; }; export declare const $ApplicationSettingsController: string | ((model?: $ApplicationSettingsController) => GenControllers.IApplicationSettingsController); export declare namespace GenControllers { /** * Represents */ interface IApprovalPathVisualizationController { /** * Gets settings graph */ getSettingsGraph(reconcileCardId: string, options?: RequestOptions): Promise<GenModels.SettingsGraph>; } class ApprovalPathVisualizationController extends ControllerBase implements IApprovalPathVisualizationController { getSettingsGraph(reconcileCardId: string, options?: RequestOptions): Promise<GenModels.SettingsGraph>; } } export declare type $ApprovalPathVisualizationController = { approvalPathVisualizationController: GenControllers.IApprovalPathVisualizationController; }; export declare const $ApprovalPathVisualizationController: string | ((model?: $ApprovalPathVisualizationController) => GenControllers.IApprovalPathVisualizationController); export declare namespace GenControllers { /** * AuthenticationKindsController */ interface IAuthenticationKindsController { /** * Get card html by xslt id */ checkUserAuthenticationLogin(extensionId: string, login: string, options?: RequestOptions): Promise<boolean>; } class AuthenticationKindsController extends ControllerBase implements IAuthenticationKindsController { checkUserAuthenticationLogin(extensionId: string, login: string, options?: RequestOptions): Promise<boolean>; } } export declare type $AuthenticationKindsController = { authenticationKindsController: GenControllers.IAuthenticationKindsController; }; export declare const $AuthenticationKindsController: string | ((model?: $AuthenticationKindsController) => GenControllers.IAuthenticationKindsController); export declare namespace GenControllers { /** * Represents available templates control controller */ interface IAvailableTemplatesController { /** * Get card html by xslt id */ getHtmlByXsltId(cardId: string, xsltId: string, options?: RequestOptions): Promise<string>; /** * Get card html by xslt alias */ getHtmlByXsltAlias(cardId: string, alias: string, options?: RequestOptions): Promise<string>; /** * Get card xml */ getXml(cardId: string, options?: RequestOptions): Promise<string>; } class AvailableTemplatesController extends ControllerBase implements IAvailableTemplatesController { getHtmlByXsltId(cardId: string, xsltId: string, options?: RequestOptions): Promise<string>; getHtmlByXsltAlias(cardId: string, alias: string, options?: RequestOptions): Promise<string>; getXml(cardId: string, options?: RequestOptions): Promise<string>; } } export declare type $AvailableTemplatesController = { availableTemplatesController: GenControllers.IAvailableTemplatesController; }; export declare const $AvailableTemplatesController: string | ((model?: $AvailableTemplatesController) => GenControllers.IAvailableTemplatesController); export declare namespace GenControllers { /** * Barcode search button controller */ interface IBarcodeSearchButtonController { /** * Search * * @param barcodeSearchRequestModel Request model */ search(barcodeSearchRequestModel: GenModels.BarcodeSearchRequestModel, options?: RequestOptions): Promise<GenModels.BarcodeSearchResponseModel>; } class BarcodeSearchButtonController extends ControllerBase implements IBarcodeSearchButtonController { search(barcodeSearchRequestModel: GenModels.BarcodeSearchRequestModel, options?: RequestOptions): Promise<GenModels.BarcodeSearchResponseModel>; } } export declare type $BarcodeSearchButtonController = { barcodeSearchButtonController: GenControllers.IBarcodeSearchButtonController; }; export declare const $BarcodeSearchButtonController: string | ((model?: $BarcodeSearchButtonController) => GenControllers.IBarcodeSearchButtonController); export declare namespace GenControllers { /** * Business calendar controller */ interface IBusinessCalendarController { /** * Get work-time settings * * @param requestModel Request model */ getWorkTimeSettings(requestModel: GenModels.CalendarRequestModel, options?: RequestOptions): Promise<Array<GenModels.CalendarYearSettings>>; /** * Get duration * * @param requestModel Request model */ getDuration(requestModel: GenModels.CalendarDurationRequestModel, options?: RequestOptions): Promise<number>; /** * Get start date * * @param requestModel Request model */ getStartDate(requestModel: GenModels.CalendarStartDateRequestModel, options?: RequestOptions): Promise<string>; /** * Get end date * * @param requestModel Request model */ getEndDate(requestModel: GenModels.CalendarEndDateRequestModel, options?: RequestOptions): Promise<string>; /** * Calculate start/end dates of task group intervals, based on the specified durations. * * @param requestModel Request model */ calculateIntervalsDates(requestModel: GenModels.IntervalsCalculationRequestModel, options?: RequestOptions): Promise<Array<GenModels.TaskGroupInterval>>; } class BusinessCalendarController extends ControllerBase implements IBusinessCalendarController { getWorkTimeSettings(requestModel: GenModels.CalendarRequestModel, options?: RequestOptions): Promise<Array<GenModels.CalendarYearSettings>>; getDuration(requestModel: GenModels.CalendarDurationRequestModel, options?: RequestOptions): Promise<number>; getStartDate(requestModel: GenModels.CalendarStartDateRequestModel, options?: RequestOptions): Promise<string>; getEndDate(requestModel: GenModels.CalendarEndDateRequestModel, options?: RequestOptions): Promise<string>; calculateIntervalsDates(requestModel: GenModels.IntervalsCalculationRequestModel, options?: RequestOptions): Promise<Array<GenModels.TaskGroupInterval>>; } } export declare type $BusinessCalendarController = { businessCalendarController: GenControllers.IBusinessCalendarController; }; export declare const $BusinessCalendarController: string | ((model?: $BusinessCalendarController) => GenControllers.IBusinessCalendarController); export declare namespace GenControllers { /** * Access card data controller */ interface ICardDataController { /** * Get value of the field */ getFieldValue(request: GenModels.GetFieldValueRequest, options?: RequestOptions): Promise<any>; /** * Gets card digest. */ getDigest(cardId: string, options?: RequestOptions): Promise<string>; /** * Gets card digest without showing error if something goes wrong */ getDigestSilence(cardId: string, options?: RequestOptions): Promise<string>; } class CardDataController extends ControllerBase implements ICardDataController { getFieldValue(request: GenModels.GetFieldValueRequest, options?: RequestOptions): Promise<any>; getDigest(cardId: string, options?: RequestOptions): Promise<string>; getDigestSilence(cardId: string, options?: RequestOptions): Promise<string>; } } export declare type $CardDataController = { cardDataController: GenControllers.ICardDataController; }; export declare const $CardDataController: string | ((model?: $CardDataController) => GenControllers.ICardDataController); export declare namespace GenControllers { /** * CardKind controller */ interface ICardKindController { /** * Get card kind by id. * * @param cardKindId Card kind identifier */ getCardKind(cardKindId: string, options?: RequestOptions): Promise<GenModels.CardKindModel>; /** * Get card kinds by list of ids. * * @param cardKinds * * @returns Collection of kinds */ getCardKinds(cardKinds: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.CardKindModel>>; } class CardKindController extends ControllerBase implements ICardKindController { getCardKind(cardKindId: string, options?: RequestOptions): Promise<GenModels.CardKindModel>; getCardKinds(cardKinds: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.CardKindModel>>; } } export declare type $CardKindController = { cardKindController: GenControllers.ICardKindController; }; export declare const $CardKindController: string | ((model?: $CardKindController) => GenControllers.ICardKindController); export declare namespace GenControllers { /** * Controller for loading cards and its presentation. */ interface ICardsPresentationController { /** * Execute search query with Digest view. */ search(requestModel: GenModels.SearchRequestModel, options?: RequestOptions): Promise<GenModels.SearchResponseModel>; /** * Execute search query with Digest view columns */ searchWithViewColumns(requestModel: GenModels.SearchRequestModelDiagram, options?: RequestOptions): Promise<GenModels.SearchResponseModelDiagram>; /** * POST: /SearchQuery/GetFolderCards */ getFolderCards(request: GenModels.GetFolderCardsRequest, options?: RequestOptions): Promise<GenModels.SearchResponseModel>; /** * Get cards presentation from card list, retrieved by {@link GenModels} */ getSearchResultsPresentation(request: GenModels.SearchPresentationRequestModel, options?: RequestOptions): Promise<Array<GenModels.CardPresentation>>; } class CardsPresentationController extends ControllerBase implements ICardsPresentationController { search(requestModel: GenModels.SearchRequestModel, options?: RequestOptions): Promise<GenModels.SearchResponseModel>; searchWithViewColumns(requestModel: GenModels.SearchRequestModelDiagram, options?: RequestOptions): Promise<GenModels.SearchResponseModelDiagram>; getFolderCards(request: GenModels.GetFolderCardsRequest, options?: RequestOptions): Promise<GenModels.SearchResponseModel>; getSearchResultsPresentation(request: GenModels.SearchPresentationRequestModel, options?: RequestOptions): Promise<Array<GenModels.CardPresentation>>; } } export declare type $CardsPresentationController = { cardsPresentationController: GenControllers.ICardsPresentationController; }; export declare const $CardsPresentationController: string | ((model?: $CardsPresentationController) => GenControllers.ICardsPresentationController); export declare namespace GenControllers { /** * Comments controller */ interface ICommentsController { /** * Get comments * * @param requestModel Request model */ getComments(requestModel: GenModels.CommentsRequestModel, options?: RequestOptions): Promise<GenModels.CommentsModel>; /** * Add comment * * @param requestModel Request model */ addComment(requestModel: GenModels.AddCommentRequestModel, options?: RequestOptions): Promise<void>; /** * Restore comment * * @param requestModel Request model */ restoreComment(requestModel: GenModels.RestoreCommentModel, options?: RequestOptions): Promise<void>; /** * Update comment * * @param requestModel Request model */ updateComment(requestModel: GenModels.UpdateCommentRequestModel, options?: RequestOptions): Promise<void>; /** * Delete comment * * @param requestModel Request model */ deleteComment(requestModel: GenModels.DeleteCommentRequestModel, options?: RequestOptions): Promise<GenModels.RestoreCommentModel>; } class CommentsController extends ControllerBase implements ICommentsController { getComments(requestModel: GenModels.CommentsRequestModel, options?: RequestOptions): Promise<GenModels.CommentsModel>; addComment(requestModel: GenModels.AddCommentRequestModel, options?: RequestOptions): Promise<void>; restoreComment(requestModel: GenModels.RestoreCommentModel, options?: RequestOptions): Promise<void>; updateComment(requestModel: GenModels.UpdateCommentRequestModel, options?: RequestOptions): Promise<void>; deleteComment(requestModel: GenModels.DeleteCommentRequestModel, options?: RequestOptions): Promise<GenModels.RestoreCommentModel>; } } export declare type $CommentsController = { commentsController: GenControllers.ICommentsController; }; export declare const $CommentsController: string | ((model?: $CommentsController) => GenControllers.ICommentsController); export declare namespace GenControllers { /** * Controller for interaction with CryptoPro DSS service */ interface ICryptoProDssController { acceptAuthorization(code: string, options?: RequestOptions): Promise<any>; authorize(accountName?: string, options?: RequestOptions): Promise<any>; resetAuthorization(options?: RequestOptions): Promise<void>; acceptConfirmation(options?: RequestOptions): Promise<any>; uploadToDss(request: GenModels.UploadToDssRequest, options?: RequestOptions): Promise<any>; postToDss(request: GenModels.DssRequestBody, options?: RequestOptions): Promise<any>; deleteFromDss(request: GenModels.DssRequestBody, options?: RequestOptions): Promise<any>; getFromDss(url: string, authorization: string, options?: RequestOptions): Promise<any>; downloadFromDssAsBase64(url: string, authorization: string, options?: RequestOptions): Promise<any>; } class CryptoProDssController extends ControllerBase implements ICryptoProDssController { acceptAuthorization(code: string, options?: RequestOptions): Promise<any>; authorize(accountName?: string, options?: RequestOptions): Promise<any>; resetAuthorization(options?: RequestOptions): Promise<void>; acceptConfirmation(options?: RequestOptions): Promise<any>; uploadToDss(request: GenModels.UploadToDssRequest, options?: RequestOptions): Promise<any>; postToDss(request: GenModels.DssRequestBody, options?: RequestOptions): Promise<any>; deleteFromDss(request: GenModels.DssRequestBody, options?: RequestOptions): Promise<any>; getFromDss(url: string, authorization: string, options?: RequestOptions): Promise<any>; downloadFromDssAsBase64(url: string, authorization: string, options?: RequestOptions): Promise<any>; } } export declare type $CryptoProDssController = { cryptoProDssController: GenControllers.ICryptoProDssController; }; export declare const $CryptoProDssController: string | ((model?: $CryptoProDssController) => GenControllers.ICryptoProDssController); export declare namespace GenControllers { /** * Defines DataVisualizationController */ interface IDataVisualizationController { /** * generate new file with data visualization */ generate(generatorType: GenModels.ImageGeneratorType, cardId: string, fileCardId: string, fileVersionId: string, options?: RequestOptions): Promise<any>; } class DataVisualizationController extends ControllerBase implements IDataVisualizationController { generate(generatorType: GenModels.ImageGeneratorType, cardId: string, fileCardId: string, fileVersionId: string, options?: RequestOptions): Promise<any>; } } export declare type $DataVisualizationController = { dataVisualizationController: GenControllers.IDataVisualizationController; }; export declare const $DataVisualizationController: string | ((model?: $DataVisualizationController) => GenControllers.IDataVisualizationController); export declare namespace GenControllers { /** * Department controller */ interface IDepartmentController { /** * Get staff department by id. * * @param departmentId Department's identifier */ getStaffDepartment(departmentId: string, options?: RequestOptions): Promise<GenModels.DepartmentModel>; /** * Get partner department by id. * * @param departmentId Department's identifier */ getPartnerDepartment(departmentId: string, options?: RequestOptions): Promise<GenModels.DepartmentModel>; /** * Get departments by list of ids. * * @param departments Collection of staff departments */ getStaffDepartments(departments: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.DepartmentModel>>; /** * Get departments by list of ids. * * @param departments Collection of partner departments */ getPartnerDepartments(departments: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.DepartmentModel>>; /** * /api/Department/MarkPartnersCompanyTypeAsDepartment?partnerCompanyId=GUID */ markPartnersCompanyTypeAsDepartment(partnerCompanyId: string, options?: RequestOptions): Promise<void>; /** * /api/Department/MarkStaffCompanyTypeAsDepartment?staffCompanyId=GUID */ markStaffCompanyTypeAsDepartment(staffCompanyId: string, options?: RequestOptions): Promise<void>; /** * Returns parent departments */ getParentDepartments(departmentId: string, options?: RequestOptions): Promise<Array<GenModels.DepartmentModel>>; /** * Returns staff employee's department * * @param employeeId */ getStaffEmployeeDepartment(employeeId: string, options?: RequestOptions): Promise<GenModels.DepartmentModel>; } class DepartmentController extends ControllerBase implements IDepartmentController { getStaffDepartment(departmentId: string, options?: RequestOptions): Promise<GenModels.DepartmentModel>; getPartnerDepartment(departmentId: string, options?: RequestOptions): Promise<GenModels.DepartmentModel>; getStaffDepartments(departments: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.DepartmentModel>>; getPartnerDepartments(departments: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.DepartmentModel>>; markPartnersCompanyTypeAsDepartment(partnerCompanyId: string, options?: RequestOptions): Promise<void>; markStaffCompanyTypeAsDepartment(staffCompanyId: string, options?: RequestOptions): Promise<void>; getParentDepartments(departmentId: string, options?: RequestOptions): Promise<Array<GenModels.DepartmentModel>>; getStaffEmployeeDepartment(employeeId: string, options?: RequestOptions): Promise<GenModels.DepartmentModel>; } } export declare type $DepartmentController = { departmentController: GenControllers.IDepartmentController; }; export declare const $DepartmentController: string | ((model?: $DepartmentController) => GenControllers.IDepartmentController); export declare namespace GenControllers { /** * Directory designer row controller */ interface IDirectoryDesignerRowController { /** * Get directory designer row by id * * @param rowId Directory designer row identifier */ getDirectoryDesignerRow(rowId: string, options?: RequestOptions): Promise<GenModels.DirectoryDesignerRowModel>; /** * Get directory designer row by id * * @param nodeId Directory designer row identifier */ getDirectoryDesignerNode(nodeId: string, options?: RequestOptions): Promise<GenModels.DirectoryDesignerNodeModel>; /** * Get directory designer rows by list of ids. * * @param rows * * @returns Collection of directory designer rows */ getDirectoryDesignerRows(rows: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.DirectoryDesignerRowModel>>; /** * Find items / item types by name */ loadDirectoryData(query: GenModels.DirectoryDesignerQuery, options?: RequestOptions): Promise<GenModels.DirectoryDesignerLoadResponse>; } class DirectoryDesignerRowController extends ControllerBase implements IDirectoryDesignerRowController { getDirectoryDesignerRow(rowId: string, options?: RequestOptions): Promise<GenModels.DirectoryDesignerRowModel>; getDirectoryDesignerNode(nodeId: string, options?: RequestOptions): Promise<GenModels.DirectoryDesignerNodeModel>; getDirectoryDesignerRows(rows: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.DirectoryDesignerRowModel>>; loadDirectoryData(query: GenModels.DirectoryDesignerQuery, options?: RequestOptions): Promise<GenModels.DirectoryDesignerLoadResponse>; } } export declare type $DirectoryDesignerRowController = { directoryDesignerRowController: GenControllers.IDirectoryDesignerRowController; }; export declare const $DirectoryDesignerRowController: string | ((model?: $DirectoryDesignerRowController) => GenControllers.IDirectoryDesignerRowController); export declare namespace GenControllers { /** * Defines card lock controller */ interface IDisableCardController { /** * /api/LayoutCard/DisableCard */ disableCard(cardId: string, reason: GenModels.Reason, options?: RequestOptions): Promise<any>; /** * /api/LayoutCard/DisableCardEx */ disableCardEx(request: GenModels.DisableCardExRequestModel, options?: RequestOptions): Promise<any>; /** * /api/LayoutCard/EnableCard */ enableCard(cardId: string, options?: RequestOptions): Promise<any>; /** * /api/LayoutCard/RemoveAllCardLocks */ removeAllCardLocks(options?: RequestOptions): Promise<void>; } class DisableCardController extends ControllerBase implements IDisableCardController { disableCard(cardId: string, reason: GenModels.Reason, options?: RequestOptions): Promise<any>; disableCardEx(request: GenModels.DisableCardExRequestModel, options?: RequestOptions): Promise<any>; enableCard(cardId: string, options?: RequestOptions): Promise<any>; removeAllCardLocks(options?: RequestOptions): Promise<void>; } } export declare type $DisableCardController = { disableCardController: GenControllers.IDisableCardController; }; export declare const $DisableCardController: string | ((model?: $DisableCardController) => GenControllers.IDisableCardController); export declare namespace GenControllers { /** * Represents send email control controller */ interface IEmailController { /** * Generates and downloads EML file from {@link GenModels}. * * @param documentId Document identifier. * @param cardLink Url for open card. * @param templateAlias Whether or not to include link to card * @param fileAttachmentsMode File attachments mode * @param fileIds List of files identifiers */ getEmlFile(documentId: string, cardLink: string, templateAlias: string, fileAttachmentsMode: GenModels.FileAttachmentsMode, fileIds: Array<string>, options?: RequestOptions): Promise<any>; } class EmailController extends ControllerBase implements IEmailController { getEmlFile(documentId: string, cardLink: string, templateAlias: string, fileAttachmentsMode: GenModels.FileAttachmentsMode, fileIds: Array<string>, options?: RequestOptions): Promise<any>; } } export declare type $EmailController = { emailController: GenControllers.IEmailController; }; export declare const $EmailController: string | ((model?: $EmailController) => GenControllers.IEmailController); export declare namespace GenControllers { /** * Employee controller */ interface IEmployeeController { /** * Get staff employee by id * * @param employeeId Employee identifier * * @returns Staff employee */ getEmployee(employeeId: string, options?: RequestOptions): Promise<GenModels.EmployeeDataModel>; /** * Get staff employee by id with extra status information * * @param employeeId Employee identifier * * @returns Staff employee */ getEmployeeStatus(employeeId: string, options?: RequestOptions): Promise<GenModels.EmployeeStatusModel>; /** * Get employees by list of ids. * * @param employees * * @returns Collection of employees */ getEmployees(employees: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.EmployeeDataModel>>; } class EmployeeController extends ControllerBase implements IEmployeeController { getEmployee(employeeId: string, options?: RequestOptions): Promise<GenModels.EmployeeDataModel>; getEmployeeStatus(employeeId: string, options?: RequestOptions): Promise<GenModels.EmployeeStatusModel>; getEmployees(employees: GenModels.CollectionRequestModelOf<string>, options?: RequestOptions): Promise<Array<GenModels.EmployeeDataModel>>; } } export declare type $EmployeeController = { employeeController: GenControllers.IEmployeeController; }; export declare const $EmployeeController: string | ((model?: $EmployeeController) => GenControllers.IEmployeeController); export declare namespace GenControllers { /** * Extensions controller */ interface IExtensionsController { /** * /Api/Extensions/Get */ get(options?: RequestOptions): Promise<string>; } class ExtensionsController extends ControllerBase implements IExtensionsController { get(options?: RequestOptions): Promise<string>; } } export declare type $ExtensionsController = { extensionsController: GenControllers.IExtensionsController; }; export declare const $ExtensionsController: string | ((model?: $ExtensionsController) => GenControllers.IExtensionsController); export declare namespace GenControllers { interface IExtGridController { /** * HTTP: /ExtGrid/GetExcelReport */ getExcelReport(requestModel: GenModels.ExcelReportRequest, options?: RequestOptions): Promise<string>; } class ExtGridController extends ControllerBase implements IExtGridController { getExcelReport(requestModel: GenModels.ExcelReportRequest, options?: RequestOptions): Promise<string>; } } export declare type $ExtGridController = { extGridController: GenControllers.IExtGridController; }; export declare const $ExtGridController: string | ((model?: $ExtGridController) => GenControllers.IExtGridController); export declare namespace GenControllers { interface IFavoritesController { checkFavoriteCard(cardId: string, options?: RequestOptions): Promise<boolean>; addFavoriteCard(cardId: string, options?: RequestOptions): Promise<void>; removeFavoriteCard(cardId: string, options?: RequestOptions): Promise<void>; } class FavoritesController extends ControllerBase implements IFavoritesController { checkFavoriteCard(cardId: string, options?: RequestOptions): Promise<boolean>; addFavoriteCard(cardId: string, options?: RequestOptions): Promise<void>; removeFavoriteCard(cardId: string, options?: RequestOptions): Promise<void>; } } export declare type $FavoritesController = { favoritesController: GenControllers.IFavoritesController; }; export declare const $FavoritesController: string | ((model?: $FavoritesController) => GenControllers.IFavoritesController); export declare namespace GenControllers { /** * File hash controller */ interface IFileHashController { /** * Get hash of file data * * @param fileId File ID * @param algorithm Hash algorithm name * * @returns Returns the hash of the file */ getDataHash(fileId: string, algorithm: string, options?: RequestOptions): Promise<string>; /** * Get hash of attachment stream * * @param cardId Card id * @param algorithm Hash algorithm name * * @returns Returns the hash of the attachment stream */ getAttachmentStreamHash(cardId: string, algorithm: string, options?: RequestOptions): Promise<string>; /** * Get hash of fields stream * * @param cardId Card id * @param algorithm Hash algorithm name * * @returns Returns the hash of the fields stream */ getFieldsStreamHash(cardId: string, algorithm: string, options?: RequestOptions): Promise<string>; /** * Get hash algorithm name from certificate in base64 * * @returns Hash algorithm name */ getCertificateHashAlgorithm(options?: RequestOptions): Promise<any>; } class FileHashController extends ControllerBase implements IFileHashController { getDataHash(fileId: string, algorithm: string, options?: RequestOptions): Promise<string>; getAttachmentStreamHash(cardId: string, algorithm: string, options?: RequestOptions): Promise<string>; getFieldsStreamHash(cardId: string, algorithm: string, options?: RequestOptions): Promise<string>; getCertificateHashAlgorithm(options?: RequestOptions): Promise<any>; } } export declare type $FileHashController = { fileHashController: GenControllers.IFileHashController; }; export declare const $FileHashController: string | ((model?: $FileHashController) => GenControllers.IFileHashController); export declare namespace GenControllers { /** * Defines FilePreviewController */ interface IFilePreviewController { /** * HTTP: /File/DownloadPdf * * @returns file stream */ downloadPdf(fileId: string, cardId?: string, options?: RequestOptions): Promise<string>; } class FilePreviewController extends ControllerBase implements IFilePreviewController { downloadPdf(fileId: string, cardId?: string, options?: RequestOptions): Promise<string>; } } export declare type $FilePreviewController = { filePreviewController: GenControllers.IFilePreviewController; }; export declare const $FilePreviewController: string | ((model?: $FilePreviewController) => GenControllers.IFilePreviewController); export declare namespace GenControllers { /** * Represents folder type controller */ interface IFolderTypesController { /** * HTTP: /FolderTypes/GetFolderTypes */ getFolderTypes(options?: RequestOptions): Promise<Array<GenModels.FolderTypeInfo>>; } class FolderTypesController extends ControllerBase implements IFolderTypesController { getFolderTypes(options?: RequestOptions): Promise<Array<GenModels.FolderTypeInfo>>; } } export declare type $FolderTypesController = { folderTypesController: GenControllers.IFolderTypesController; }; export declare const $FolderTypesController: string | ((model?: $FolderTypesController) => GenControllers.IFolderTypesController); export declare namespace GenControllers { /** * Grid controller */ interface IGridController { /** * Get card list * * TODO: make http get * * @param requestModel Request model */ getCardList(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.CardListViewModel>; /** * Get View List */ getViewList(folderInfo: GenModels.FolderIdentityModel, options?: RequestOptions): Promise<GenModels.FolderViewInfosModel>; /** * Get Grid User Settings Data */ getGridUserSettingsData(folderId: string, viewId: string, options?: RequestOptions): Promise<GenModels.GridUserSettingsData>; /** * Get Ordered Columns */ getColumns(viewId: string, options?: RequestOptions): Promise<Array<GenModels.ViewColumnModel>>; /** * Get grid filter layout model * * @param requestModel Request model */ getFilter(requestModel: GenModels.GridFilterRequestModel, options?: RequestOptions): Promise<GenModels.LayoutViewModel>; /** * Get grid data * * @param requestModel Request model * * @returns Grid data */ getGridData(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>; /** * Get grid data * * @param requestModel Request model * * @returns Grid data */ getGridDataEx(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModelEx>; /** * Get grid data silently * * @param requestModel Request model * * @returns Grid data */ getGridDataSilent(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>; /** * Saves grid user settings data * * @param requestModel Request model * * @returns Returns CommonResponse */ saveGridUserSettingsData(requestModel: GenModels.SaveGridUserSettingsDataRequestModel, options?: RequestOptions): Promise<void>; /** * Saves grid user settings data * * @param requestModel Request model * * @returns Returns CommonResponse */ saveGridUserSettingsFolderData(requestModel: GenModels.SaveGridUserSettingsFolderDataRequestModel, options?: RequestOptions): Promise<void>; /** * Seat all cards read status * * @param saveAllCardsReadStatusModel Request model */ setAllCardsReadStatus(saveAllCardsReadStatusModel: GenModels.SaveAllCardsReadStatusRequestModel, options?: RequestOptions): Promise<void>; /** * Get list of {@link GenModels} for usage in grouping */ getViewDistinctValues(distinctValuesRequest: GenModels.DistinctValuesRequestModel, options?: RequestOptions): Promise<GenModels.DistinctValuesModel>; /** * Get list of {@link GenModels} for usage in filtration */ getFilterDistinctValues(request: GenModels.FilterDistinctValuesRequestModel, options?: RequestOptions): Promise<GenModels.DistinctValuesModel>; /** * load all pages */ loadAllPages(baseCursorId: string, options?: RequestOptions): Promise<number>; /** * Get grid aggregates model */ getGridAggregatesModel(request: GenModels.GridAggregateRequest, options?: RequestOptions): Promise<Array<GenModels.GridAggregateModel>>; /** * @param diagramRequestModel */ getDiagramDistinctValuesModel(diagramRequestModel: GenModels.DistinctValuesDiagramRequestModel, options?: RequestOptions): Promise<GenModels.DistinctDiagramValuesModel>; /** * Force unread counter recalculation. * * @param requestModel */ refreshUnreadCounter(requestModel: GenModels.RefreshUnreadCounterRequest, options?: RequestOptions): Promise<any>; /** * Force unread counter recalculation. * * @param requestModel */ refreshUnreadCounterEx(requestModel: GenModels.RefreshUnreadCounterRequest, options?: RequestOptions): Promise<any>; } class GridController extends ControllerBase implements IGridController { getCardList(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.CardListViewModel>; getViewList(folderInfo: GenModels.FolderIdentityModel, options?: RequestOptions): Promise<GenModels.FolderViewInfosModel>; getGridUserSettingsData(folderId: string, viewId: string, options?: RequestOptions): Promise<GenModels.GridUserSettingsData>; getColumns(viewId: string, options?: RequestOptions): Promise<Array<GenModels.ViewColumnModel>>; getFilter(requestModel: GenModels.GridFilterRequestModel, options?: RequestOptions): Promise<GenModels.LayoutViewModel>; getGridData(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>; getGridDataEx(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModelEx>; getGridDataSilent(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>; saveGridUserSettingsData(requestModel: GenModels.SaveGridUserSettingsDataRequestModel, options?: RequestOptions): Promise<void>; saveGridUserSettingsFolderData(requestModel: GenModels.SaveGridUserSettingsFolderDataRequestModel, options?: RequestOptions): Promise<void>; setAllCardsReadStatus(saveAllCardsReadStatusModel: GenModels.SaveAllCardsReadStatusRequestModel, options?: RequestOptions): Promise<void>; getViewDistinctValues(distinctValuesRequest: GenModels.DistinctValuesRequestModel, options?: RequestOptions): Promise<GenModels.DistinctValuesModel>; getFilterDistinctValues(request: GenModels.FilterDistinctValuesRequestModel, options?: RequestOptions): Promise<GenModels.DistinctValuesModel>; loadAllPages(baseCursorId: string, options?: RequestOptions): Promise<number>; getGridAggregatesModel(request: GenModels.GridAggregateRequest, options?: RequestOptions): Promise<Array<GenModels.GridAggregateModel>>; getDiagramDistinctValuesModel(diagramRequestModel: GenModels.DistinctValuesDiagramRequestModel, options?: RequestOptions): Promise<GenModels.DistinctDiagramValuesModel>; refreshUnreadCounter(requestModel: GenModels.RefreshUnreadCounterRequest, options?: RequestOptions): Promise<any>; refreshUnreadCounterEx(requestModel: GenModels.RefreshUnreadCounterRequest, options?: RequestOptions): Promise<any>; } } export declare type $GridController = { gridController: GenControllers.IGridController; }; export declare const $GridController: string | ((model?: $GridController) => GenControllers.IGridController); export declare namespace GenControllers { /** * Controller for receiving access token */ interface IJwtTokenController { /** * Get access token for Bearer authorization */ getAccessToken(options?: RequestOptions): Promise<string>; } class JwtTokenController extends ControllerBase implements IJwtTokenController { getAccessToken(options?: RequestOptions): Promise<string>; } } export declare type $JwtTokenController = { jwtTokenController: GenControllers.IJwtTokenController; }; export declare const $JwtTokenController: string | ((model?: $JwtTokenController) => GenControllers.IJwtTokenController); export declare namespace GenControllers { /** * Layout controller */ interface ILayoutController { /** * Get layout * * @param locationName Position name * @param cardId Card id * * @returns Layout model */ get(locationName: string, cardId?: string, options?: RequestOptions): Promise<any>; /** * Get layout */ getWithParams(request: GenModels.GetRequestModel, options?: RequestOptions): Promise<any>; /** * Get specified control info from whole layout * * @param locationName Position name * @param controlName Control name * @param cardId Card id * * @returns Layout model with control info */ getPart(locationName: string, controlName: string, cardId?: string, options?: RequestOptions): Promise<any>; /** * Get specified control info from whole layout * * @returns Layout model with control info */ getPartWithParams(request: GenModels.GetPartRequestModel, options?: RequestOptions): Promise<any>; /** * Get specified control info from whole layout * * @returns Layout model with control info */ getPartWithParamsEx(request: GenModels.GetPartRequestModelEx, options?: RequestOptions): Promise<any>; /** * Gets root layout */ getRootLayout(location: string, cacheVary?: string, options?: RequestOptions): Promise<any>; /** * HTTP: /Layout/Save */ save(model: GenModels.SaveRequestModel, options?: RequestOptions): Promise<any>; } class LayoutController extends ControllerBase implements ILayoutController { get(locationName: string, cardId?: string, options?: RequestOptions): Promise<any>; getWithParams(request: GenModels.GetRequestModel, options?: RequestOptions): Promise<any>; getPart(locationName: string, controlName: string, cardId?: string, options?: RequestOptions): Promise<any>; getPartWithParams(request: GenModels.GetPartRequestModel, options?: RequestOptions): Promise<any>; getPartWithParamsEx(request: GenModels.GetPartRequestModelEx, options?: RequestOptions): Promise<any>; getRootLayout(location: string, cacheVary?: string, options?: RequestOptions): Promise<any>; save(model: GenModels.SaveRequestModel, options?: RequestOptions): Promise<any>; } } export declare type $LayoutController = { layoutController: GenControllers.ILayoutController; }; export declare const $LayoutController: string | ((model?: $LayoutController) => GenControllers.ILayoutController); export declare namespace GenControllers { /** * Layout history controller */ interface ILayoutHistoryController { /** * Get history records * * @param query search string */ getHistoryRecords(query: GenModels.HistorySearchQuery, options?: RequestOptions): Promise<GenModels.HistorySearchResult>; } class LayoutHistoryController extends ControllerBase implements ILayoutHistoryController { getHistoryRecords(query: GenModels.HistorySearchQuery, options?: RequestOptions): Promise<GenModels.HistorySearchResult>; } } export declare type $LayoutHistoryController = { layoutHistoryController: GenControllers.ILayoutHistoryController; }; export declare const $LayoutHistoryController: string | ((model?: $LayoutHistoryController) => GenControllers.ILayoutHistoryController); export declare namespace GenControllers { /** * Layout partner controller */ interface ILayoutPartnerController { /** * find department by name * * @param query search string */ quickSearch(query: GenModels.PartnerQuickSearchQuery, options?: RequestOptions): Promise<GenModels.PartnerQuickSearchResponse>; /** * find department by name * * @param query search string */ loadTree(query: GenModels.PartnerLoadQuery, options?: RequestOptions): Promise<GenModels.PartnerTreeLoadResponse>; /** * find department by name * * @param query search string */ directorySearch(query: GenModels.PartnerQuickSearchQuery, options?: RequestOptions): Promise<GenModels.PartnerSearchResponse>; } class LayoutPartnerController extends ControllerBase implements ILayoutPartnerController { quickSearch(query: GenModels.PartnerQuickSearchQuery, options?: RequestOptions): Promise<GenModels.PartnerQuickSearchResponse>; loadTree(query: GenModels.PartnerLoadQuery, options?: RequestOptions): Promise<GenModels.PartnerTreeLoadResponse>; directorySearch(query: GenModels.PartnerQuickSearchQuery, options?: RequestOptions): Promise<GenModels.PartnerSearchResponse>; } } export declare type $LayoutPartnerController = { layoutPartnerController: GenControllers.ILayoutPartnerController; }; export declare const $LayoutPartnerController: string | ((model?: $LayoutPartnerController) => GenControllers.ILayoutPartnerController); export declare namespace GenControllers { /** * Controller for user settings of layout */ interface ILayoutUserSettingsController { /** * Get settings for main menu */ getMainMenuSettings(options?: RequestOptions): Promise<GenModels.MainMenuSettings>; /** * Save settings for main menu * * @param settings Request model */ saveMainMenuSettings(settings: GenModels.MainMenuSettings, options?: RequestOptions): Promise<void>; /** * Get Show Archived Cards setting */ getShowArchivedCardsSetting(options?: RequestOptions): Promise<boolean>; /** * Set Show Archived Cards setting */