@docsvision/webclient
Version:
Type definitions for DocsVision WebClient scripts and extensions.
2,103 lines • 292 kB
TypeScript
export declare namespace GenModels {
interface ContractInfoModel {
/**
* Partner organization
*/
partnerOrganization: GenModels.DepartmentModel;
/**
* Contact employee info
*/
partnerContactPerson: GenModels.EmployeeDataModel;
/**
* Our organization
*/
organization: GenModels.DepartmentModel;
/**
* Our responsible person
*/
responsible: GenModels.EmployeeModel;
}
}
export declare namespace GenModels {
interface IDirectoryItemData {
/**
* Entity identifier
*
* @format datatype.uuid
*/
id: string;
/**
* Type of the data
*/
dataType: GenModels.DirectoryDataType;
}
}
export declare namespace GenModels {
interface DepartmentModel extends GenModels.IDirectoryItemData {
/**
* Department id
*
* @format datatype.uuid
*/
id: string;
/**
* Department name
*/
name: string;
/**
* Department full name
*/
fullName: string;
/**
* Department type
*/
departmentType: GenModels.DepartmentType;
/**
* Type of the data
*/
dataType: GenModels.DirectoryDataType;
/**
* Is department available when search
*/
notAvailable?: boolean;
}
}
export declare namespace GenModels {
interface EmployeeDataModel extends GenModels.IDirectoryItemData {
id: string;
isCurrent: boolean;
displayName: string;
firstName: string;
lastName: string;
middleName: string;
position: string;
fieldPath: string;
unitId: string;
pathInDirectory: Array<GenModels.DepartmentExtendedModel>;
dataType: GenModels.DirectoryDataType;
status: GenModels.StaffEmployeeStatus;
}
}
export declare namespace GenModels {
interface DepartmentExtendedModel extends GenModels.DepartmentModel {
/**
* Department email
*/
email: string;
/**
* Department phone
*/
phone: string;
}
}
export declare namespace GenModels {
interface EmployeeModel extends GenModels.IDirectoryItemData {
/**
* Unique identificator of employee
*
* @format datatype.uuid
*/
id: string;
/**
* Define if user is current
*/
isCurrent: boolean;
/**
* Employee account name
*/
accountName: string;
/**
* Employee display name
*/
displayName: string;
/**
* Employee first name
*/
firstName: string;
/**
* Employee last name
*/
lastName: string;
/**
* Employee middle name
*/
middleName: string;
/**
* Employee position
*/
position: string;
/**
* Gets or sets security identifier
*
* @format datatype.uuid
*/
sdid?: string;
/**
* Represents value indicating whether employee is favourite performer
*/
isFavoritePerformer: boolean;
/**
* Gets or sets unit identifier
*
* @format datatype.uuid
*/
unitId: string;
/**
* All units of employee, including parent units.
*/
units: Array<string>;
/**
* Email
*/
email: string;
/**
* Gets or sets employee status
*/
status: GenModels.StaffEmployeeStatus;
/**
* Name of department of employee
*/
departmentName: string;
/**
* Type of the data
*/
dataType: GenModels.DirectoryDataType;
}
}
export declare namespace GenModels {
interface ContractDatesModel {
/**
* Date of contract begin
*
* @format datatype.datetime
*/
dateFrom?: string;
/**
* Date of contract end
*
* @format datatype.datetime
*/
dateTo?: string;
/**
* Contract card
*
* @format datatype.uuid
*/
cardId: string;
}
}
export declare namespace GenModels {
interface ProlongateContractRequestModel {
/**
* Date of contract begin
*
* @format datatype.datetime
*/
dateFrom: string;
/**
* Date of contract end
*
* @format datatype.datetime
*/
dateTo: string;
/**
* Contract card id
*
* @format datatype.uuid
*/
contractId: string;
/**
* Contract card id
*
* @format datatype.uuid
*/
amendmentId: string;
}
}
export declare namespace GenModels {
interface ContractAgreementFillDatesModel {
/**
* Date of contract agreement
*
* @format datatype.datetime
*/
reconciliationDate: string;
/**
* Date of contract signing
*
* @format datatype.datetime
*/
signingDate: string;
/**
* Contract card id
*
* @format datatype.uuid
*/
contractId: string;
/**
* Semantic of decision
*/
decisionSemantics: GenModels.DecisionSemantics;
}
}
export declare namespace GenModels {
interface ContractFillDateModel {
/**
* Date of contract
*
* @format datatype.datetime
*/
dateOfContract: string;
/**
* Contract card id
*
* @format datatype.uuid
*/
contractId: string;
}
}
export declare namespace GenModels {
interface ContractFillSumInRubModel {
/**
* Sum in rub
*/
sumInRub: number;
/**
* Contract card id
*
* @format datatype.uuid
*/
contractId: string;
}
}
export declare namespace GenModels {
interface SettingsGraph {
stageNodes: Array<GenModels.StageNode>;
arrows: Array<GenModels.Arrow>;
}
}
export declare namespace GenModels {
interface StageNode {
id: string;
name: string;
first: boolean;
taskSendingMode: GenModels.StageTaskSendingMode;
repeatMode: GenModels.StageRepeatMode;
startConditionType: GenModels.ConditionType;
}
}
export declare namespace GenModels {
interface Arrow {
decisionSemantics: GenModels.DecisionSemantics;
sourceNode: GenModels.NodeReference;
targetNode: GenModels.NodeReference;
}
}
export declare namespace GenModels {
interface NodeReference {
id: string;
nodeType: GenModels.NodeType;
}
}
export declare namespace GenModels {
interface BarcodeSearchRequestModel {
/**
* String value of Barcode
*/
barcode: string;
}
}
export declare namespace GenModels {
interface BarcodeSearchResponseModel {
/**
* Card id to get info
*
* @format datatype.uuid
*/
cardId?: string;
}
}
export declare namespace GenModels {
interface CalendarRequestModel {
/**
* Restrict result with specified year only
*/
year?: number;
/**
* Restrict result with specified day only
*/
day?: number;
}
}
export declare namespace GenModels {
interface CalendarYearSettings {
/**
* Year
*/
year: number;
/**
* Value of business calendar EndTime
*/
days: Array<GenModels.CalendarDaySettings>;
}
}
export declare namespace GenModels {
interface CalendarDaySettings {
/**
* Day number from beginning of the year
*/
day: number;
/**
* Value of business calendar WorkTime
*/
workTime: GenModels.CalendarWorkTime;
}
}
export declare namespace GenModels {
interface CalendarWorkTime {
/**
* Value of business calendar StartTime in milliseconds from 0:00
*/
begin: number;
/**
* Value of business calendar EndTime in milliseconds from 0:00
*/
end: number;
}
}
export declare namespace GenModels {
interface CalendarDurationRequestModel {
/**
* What calendar use to calculate value
*/
calendarSources: Array<GenModels.BusinessCalendarSource>;
/**
* Date of the start of the period
*
* @format datatype.datetime
*/
startDate: string;
/**
* Date of the end of the period
*
* @format datatype.datetime
*/
endDate: string;
}
}
export declare namespace GenModels {
interface BusinessCalendarSource {
/**
* Employee or unit identifier
*
* @format datatype.uuid
*/
id: string;
/**
* Type of {@link GenModels}
*/
type: GenModels.BusinessCalendarSourceType;
}
}
export declare namespace GenModels {
interface CalendarStartDateRequestModel {
/**
* What calendar use to calculate value
*/
calendarSources: Array<GenModels.BusinessCalendarSource>;
/**
* Date of the end of the period
*
* @format datatype.datetime
*/
endDate: string;
/**
* Duration of the period
*/
duration: number;
}
}
export declare namespace GenModels {
interface CalendarEndDateRequestModel {
/**
* What calendar use to calculate value
*/
calendarSources: Array<GenModels.BusinessCalendarSource>;
/**
* Date of the start of the period
*
* @format datatype.datetime
*/
startDate: string;
/**
* Duration of the period
*/
duration: number;
}
}
export declare namespace GenModels {
interface IntervalsCalculationRequestModel {
/**
* Start date for entry task group
*
* @format datatype.datetime
*/
totalStartDate: string;
/**
* End date for entry task group
*
* @format datatype.datetime
*/
totalEndDate: string;
/**
* Duration for entry task group.
*/
totalDuration: number;
/**
* Default calendar id to calculate intervals (will be used if employee has no calendar configured). Empty guid to use system calendar.
*
* @format datatype.uuid
*/
defaultCalendarId: string;
/**
* Execution type
*/
executionType: GenModels.ExecutionType;
/**
* Existing intervals with specified durations, but without start/end dates.
*/
intervals: Array<GenModels.TaskGroupInterval>;
}
}
export declare namespace GenModels {
interface TaskGroupInterval {
/**
* Display name of the performer employee.
*/
performerName: string;
/**
* Performer id
*
* @format datatype.uuid
*/
performerId: string;
/**
* Task description
*/
description: string;
/**
* Does performer is responsible for entry task group.
*/
isResponsible: boolean;
/**
* Task start date
*
* @format datatype.datetime
*/
startDate?: string;
/**
* Task end date.
*
* @format datatype.datetime
*/
endDate?: string;
/**
* Task duration
*/
duration?: number;
/**
* Task order in task group.
*/
order: number;
}
}
export declare namespace GenModels {
interface GetFieldValueRequest {
/**
* Card id
*
* @format datatype.uuid
*/
cardId: string;
/**
* Section id
*
* @format datatype.uuid
*/
sectionId: string;
/**
* Field alias
*/
fieldAlias: string;
/**
* Remove dangerous code from HTML value.
*/
sanitizeHtml?: boolean;
}
}
export declare namespace GenModels {
interface CardKindModel {
/**
* Gets card kind name
*/
cardKindName: string;
/**
* Gets card kind name with parent kinds
*/
cardKindFullName: string;
/**
* Gets card kind identifier
*
* @format datatype.uuid
*/
cardKindId?: string;
/**
* Gets loading error
*/
loadingError: string;
}
}
export declare namespace GenModels {
interface CollectionRequestModelOf<T> {
/**
* Collection of entities
*/
collection: Array<T>;
}
}
export declare namespace GenModels {
interface SearchRequestModel {
/**
* Search query to execute
*
* @format datatype.uuid
*/
searchQueryId: string;
/**
* Search query parameters values
*/
parameters: Array<GenModels.SearchParameter>;
/**
* Use paging
*/
usePaging: boolean;
/**
* Zero-based page index
*/
page: number;
/**
* Page size
*/
pageSize?: number;
/**
* Identifier of the previous page response, when iterating over pages
*
* @format datatype.uuid
*/
instanceId: string;
/**
* Card types to load.
*/
allowedCardTypes: Array<string>;
}
}
export declare namespace GenModels {
interface SearchParameter {
/**
* Gets or sets parameter name
*/
name: string;
/**
* Gets or sets parameter value
*/
value: string;
/**
* Does parameter included in search
*/
enabled: boolean;
}
}
export declare namespace GenModels {
interface SearchResponseModel {
/**
* Identifier of the search session for performing pagination.
*
* @format datatype.uuid
*/
instanceId: string;
/**
* Found cards
*/
cards: Array<GenModels.DigestRow>;
}
}
export declare namespace GenModels {
interface DigestRow {
/**
* Card id
*
* @format datatype.uuid
*/
instanceId: string;
/**
* Card type id
*
* @format datatype.uuid
*/
cardTypeId: string;
/**
* Card description
*/
description: string;
/**
* Card was read by user
*/
wasRead: boolean;
/**
* Time of card creation
*
* @format datatype.datetime
*/
creationDateTime: string;
/**
* Time of the last card change
*
* @format datatype.datetime
*/
changeDateTime: string;
}
}
export declare namespace GenModels {
interface SearchRequestModelDiagram extends GenModels.SearchRequestModel {
/**
* ViewId for search
*/
viewId: string;
/**
* Primary Column that we try to find in cards
*/
columnPrimary: string;
/**
* Secondary Column that we try to find in cards
*/
columnSecondary: string;
}
}
export declare namespace GenModels {
interface SearchResponseModelDiagram {
/**
* Identifier of the search session for performing pagination.
*
* @format datatype.uuid
*/
instanceId: string;
/**
* Found cards
*/
cards: Array<GenModels.DiagramRow>;
}
}
export declare namespace GenModels {
interface DiagramRow {
/**
* Card id
*
* @format datatype.uuid
*/
instanceId: string;
/**
* First column value
*/
columnPrimary: any;
/**
* Second column value
*/
columnSecondary: any;
}
}
export declare namespace GenModels {
interface GetFolderCardsRequest {
queryViewRequest: GenModels.QueryViewRequest;
allowedCardTypes: Array<string>;
}
}
export declare namespace GenModels {
interface QueryViewRequest {
/**
* Gets or sets grid user settings data
*/
gridUserSettings: GenModels.GridUserSettingsData;
/**
* Gets or sets folder identifier
*
* @format datatype.uuid
*/
folderId: string;
/**
* Gets or sets a view identifier
*
* @format datatype.uuid
*/
viewId?: string;
/**
* Gets or sets whether save grid user settings data
*/
saveGridUserSettings: boolean;
/**
* Folder setting - seconds to auto refresh. Zero value indicates, that autorefresh disabled.
*/
folderRefreshTimeout: number;
/**
* Data for unread counters calculation (or not only unread counters?)
*/
forceVirtualFolderSearch: boolean;
/**
* Gets or sets search identifier
*
* @format datatype.uuid
*/
searchId: string;
/**
* Gets or sets whether view should get cached data or refreshed
*/
refreshView: boolean;
/**
* Gets or sets old search results store identifier
*
* @format datatype.uuid
*/
oldStoreId: string;
/**
* Custom page size for this specific query.
*/
pageSize?: number;
/**
* Page number (if no GridUserSettings provided)
*/
pageNumber?: number;
/**
* Location name, representing folder content. Default value is "DV.Folder".
*/
locationName: string;
/**
* Gets or sets base cursor ID
*
* @format datatype.uuid
*/
baseCursorId: string;
}
}
export declare namespace GenModels {
interface GridUserSettingsData {
/**
* Gets or sets a list with user settings of each column in folder view for Grid Presentation
*/
columns: Array<GenModels.GridUserSettingsColumn>;
/**
* Gets or sets a list with user setting of each column in folder view for List Presentation
*/
listColumns: Array<GenModels.GridUserSettingsColumn>;
/**
* Gets or sets grid view filters
*/
filters: Array<GenModels.QueryFilterItem>;
/**
* Gets or sets grid view grouping
*/
grouping: Array<GenModels.GridUserSettingsGroupColumn>;
/**
* Gets or sets a view mode
*/
viewMode: GenModels.GridViewMode;
/**
* Gets or sets an attribute text filter
*/
searchText: string;
/**
* Gets or sets search context option
*/
searchContextOption: GenModels.SearchContextOption;
/**
* Gets or sets a page number
*/
pageNumber: number;
/**
* Gets or sets sorted column name
*/
sortedColumnName: string;
/**
* Gets or sets value indicated whether is descending sort order
*/
isDescending: boolean;
/**
* User requested view without sorting.
*/
disableSorting: boolean;
/**
* Grid aggregate search value
*/
aggregates: Array<GenModels.AggregateFilterItem>;
/**
* Gets or sets whether used default grouping
*/
useDefaultGrouping: boolean;
/**
* Gets or sets table presentation mode
*/
tablePresentation: GenModels.TablePresentation;
/**
* Gets or sets column width mode
*/
columnWidthMode: GenModels.ColumnWidthMode;
}
}
export declare namespace GenModels {
interface GridUserSettingsColumn {
/**
* Gets or sets column name
*/
name: string;
/**
* Gets or sets width of a column in pixels
*/
width: number;
/**
* Gets or sets visibility of a column
*/
visible?: boolean;
/**
* Gets or sets order of a column
*/
order: number;
}
}
export declare namespace GenModels {
interface QueryFilterItem {
/**
* Gets or sets filtered column name
*/
name: string;
/**
* Gets or sets values
*/
values: Array<string>;
/**
* Gets or sets operation
*/
operation: GenModels.FilterOperation;
/**
* Gets or sets mode
*/
mode: GenModels.FilterMode;
}
}
export declare namespace GenModels {
interface GridUserSettingsGroupColumn {
/**
* Column name
*/
name: string;
/**
* Grouping level
*/
level: number;
/**
* Sorting by descending
*/
isDescending: boolean;
/**
* Active value
*/
activeValue: string;
}
}
export declare namespace GenModels {
interface AggregateFilterItem {
/**
* Gets or sets aggregation alias
*/
aggregationAlias: string;
/**
* Gets or sets selected value
*/
stringValue: string;
/**
* Gets or sets range values
*/
rangeValues: GenModels.AggregateRangeValues;
/**
* Gets or sets values count
*/
count: number;
}
}
export declare namespace GenModels {
interface AggregateRangeValues {
/**
* From value
*/
from: string;
/**
* To value
*/
to: string;
}
}
export declare namespace GenModels {
interface SearchPresentationRequestModel {
/**
* Card list found be search
*/
cards: Array<GenModels.DigestRow>;
/**
* Use paging
*/
extensionName: string;
/**
* Args for Layout presentation extension.
*/
layoutExtensionArgs: GenModels.LayoutCardsPresentationExtensionArgs;
/**
* Report id for Report presentation extension.
*
* @format datatype.uuid
*/
reportId: string;
}
}
export declare namespace GenModels {
interface LayoutCardsPresentationExtensionArgs {
deviceType: GenModels.DeviceType;
parentLayoutIds: Array<string>;
}
}
export declare namespace GenModels {
interface CardPresentation {
/**
* Card id
*
* @format datatype.uuid
*/
id: string;
/**
* Card description string
*/
description: string;
/**
* Card type, if known.
*
* @format datatype.uuid
*/
typeId?: string;
/**
* Card kind, if known.
*
* @format datatype.uuid
*/
kindId?: string;
/**
* String, indicating the type of the card data and the type of {@link GenModels} object.
*/
presentationType: string;
/**
* Additional card data, such as card layout.
*/
additionalInfo: any;
}
}
export declare namespace GenModels {
interface CommentsRequestModel {
dataSourceInfo: GenModels.CommentsDataSourceInfoModel;
maxCount: number;
}
}
export declare namespace GenModels {
interface CommentsDataSourceInfoModel {
/**
* Gets or sets card identifier
*
* @format datatype.uuid
*/
dataSourceCardId: string;
/**
* Gets or sets section identifier
*
* @format datatype.uuid
*/
dataSourceSectionId?: string;
/**
* Gets or sets row identifier
*
* @format datatype.uuid
*/
dataSourceRowId?: string;
/**
* Gets or sets comments section
*
* @format datatype.uuid
*/
sectionId: string;
/**
* Gets or sets author field alias
*/
authorFieldAlias: string;
/**
* Gets or sets date field alias
*/
dateFieldAlias: string;
/**
* Gets or sets text field alias
*/
textFieldAlias: string;
/**
* Comment operation
*
* @format datatype.uuid
*/
commentEditOperation: string;
/**
* Comment edit operation
*
* @format datatype.uuid
*/
editAnyCommentEditOperation: string;
/**
* Comment edit operation
*
* @format datatype.uuid
*/
editOwnCommentEditOperation: string;
}
}
export declare namespace GenModels {
interface CommentsModel {
/**
* Gets or sets comments list
*/
comments: Array<GenModels.Comment>;
/**
* Gets or sets comments data source
*/
dataSourceInfo: GenModels.CommentsDataSourceInfoModel;
/**
* Gets or sets all comments count
*/
allCommentsCount: number;
}
}
export declare namespace GenModels {
interface Comment {
/**
* Gets or sets identifier
*
* @format datatype.uuid
*/
id: string;
/**
* Gets or sets employee identifier
*
* @format datatype.uuid
*/
employeeId?: string;
/**
* Gets or sets employee display name
*/
employeeDisplayName: string;
/**
* Gets or sets date
*
* @format datatype.datetime
*/
date?: string;
/**
* Gets or sets text
*/
text: string;
}
}
export declare namespace GenModels {
interface AddCommentRequestModel {
dataSourceInfo: GenModels.CommentsDataSourceInfoModel;
cardId: string;
text: string;
}
}
export declare namespace GenModels {
interface RestoreCommentModel {
dataSourceInfo: GenModels.CommentsDataSourceInfoModel;
cardId: string;
text: string;
employeeId: string;
date?: string;
}
}
export declare namespace GenModels {
interface UpdateCommentRequestModel {
dataSourceInfo: GenModels.CommentsDataSourceInfoModel;
cardId: string;
commentId: string;
text: string;
}
}
export declare namespace GenModels {
interface DeleteCommentRequestModel {
dataSourceInfo: GenModels.CommentsDataSourceInfoModel;
cardId: string;
commentId: string;
}
}
export declare namespace GenModels {
interface UploadToDssRequest {
url: string;
authorization: string;
/**
* Parent document card id
*
* @format datatype.uuid
*/
documentId: string;
/**
* Signature parts
*/
parts: Array<GenModels.DocumentSignaturePartInfo>;
}
}
export declare namespace GenModels {
interface DocumentSignaturePartInfo {
/**
* What upload to DSS
*/
partType: GenModels.SignatureItemType;
/**
* FileManager file id to upload
*
* @format datatype.uuid
*/
fileId?: string;
}
}
export declare namespace GenModels {
interface DssRequestBody {
url: string;
authorization: string;
body: string;
}
}
export declare namespace GenModels {
interface DirectoryDesignerRowModel {
/**
* Row id
*
* @format datatype.uuid
*/
id: string;
/**
* Row name
*/
name: string;
/**
* Row description
*/
description: string;
/**
* Row parent id
*
* @format datatype.uuid
*/
parentId: string;
}
}
export declare namespace GenModels {
interface DirectoryDesignerNodeModel {
/**
* Node id
*
* @format datatype.uuid
*/
id: string;
/**
* Node name
*/
name: string;
/**
* Node description
*/
description: string;
/**
* Node parent id
*
* @format datatype.uuid
*/
parentId: string;
}
}
export declare namespace GenModels {
interface DirectoryDesignerQuery {
/**
* Search Area
*/
searchArea: GenModels.DirectoryDesignerSearchArea;
/**
* Search Text
*/
searchText: string;
/**
* Node Id
*
* @format datatype.uuid
*/
nodeId: string;
/**
* Pagination
*/
pagination: GenModels.Pagination;
/**
* Need return build path flag
*/
needBuildPath: boolean;
}
}
export declare namespace GenModels {
interface Pagination {
/**
* How many records client already have
*/
skip?: number;
/**
* How many records client want to receive
*/
maxCount?: number;
}
}
export declare namespace GenModels {
interface DirectoryDesignerLoadResponse {
/**
* Items
*/
items: Array<GenModels.DirectoryDesignerItem>;
/**
* Has more
*/
hasMore: boolean;
/**
* Directory timestamp
*/
directoryTimestamp: number;
/**
* Total count of items
*/
totalItemsCount?: number;
}
}
export declare namespace GenModels {
interface DirectoryDesignerItem extends GenModels.IDirectoryItemData {
/**
* Node Type
*/
type: GenModels.DirectoryDesignerTreeNodeType;
/**
* Has Children
*/
hasChildren: boolean;
/**
* Id
*
* @format datatype.uuid
*/
id: string;
/**
* Parent Id
*
* @format datatype.uuid
*/
parentId: string;
/**
* Name
*/
name: string;
/**
* Description
*/
description: string;
data: any;
dataType: GenModels.DirectoryDataType;
path: Array<GenModels.DirectoryDesignerItem>;
/**
* Partner search info
*/
searchInfo: GenModels.SearchInfo;
}
}
export declare namespace GenModels {
interface SearchInfo {
/**
* Is matched
*/
matched: boolean;
/**
* Matched field name
*/
matchedFieldName: string;
/**
* Matched field value
*/
matchedFieldValue: string;
}
}
export declare namespace GenModels {
interface DisableCardExRequestModel {
/**
* Disabled card ID
*
* @format datatype.uuid
*/
cardId: string;
/**
* Disabled card reasons
*/
reason: GenModels.Reason;
}
}
export declare namespace GenModels {
interface EmployeeStatusModel extends GenModels.EmployeeDataModel {
/**
* Return true whether user participate in Security Group for aggregates
*/
isAggregationUser: boolean;
}
}
export declare namespace GenModels {
interface ExcelReportRequest {
/**
* Параметры папки
*/
parameters: string;
/**
* ID экземпляра в кэше
*
* @format datatype.uuid
*/
instanceId?: string;
/**
* ID папки
*
* @format datatype.uuid
*/
folderId: string;
/**
* Название папки
*/
folderName: string;
/**
* ID поиска
*
* @format datatype.uuid
*/
searchId: string;
/**
* ID представления
*
* @format datatype.uuid
*/
viewId: string;
/**
* Сортировочная колонка
*/
sortedColumnName: string;
/**
* В обратно поряке
*/
isDescending: boolean;
/**
* Опции поиска
*/
searchContextOption: GenModels.SearchContextOption;
/**
* @format datatype.uuid
*/
oldStoreId: string;
}
}
export declare namespace GenModels {
interface FolderTypeInfo {
/**
* Gets or sets folder type identifier
*
* @format datatype.uuid
*/
folderTypeId: string;
/**
* Gets or sets parent folder identifier
*
* @format datatype.uuid
*/
parentFolderTypeId: string;
/**
* Gets or sets default view identifier
*
* @format datatype.uuid
*/
defaultViewId: string;
/**
* Gets or sets folder type name
*/
name: string;
/**
* Gets or sets whether to highlight unread cards
*/
highlightUnreadCards: boolean;
/**
* Gets or sets child folder types
*/
children: Array<GenModels.FolderTypeInfo>;
}
}
export declare namespace GenModels {
interface CardListRequestModel {
/**
* Request model for folder view
*/
folderViewRequest: GenModels.QueryViewRequest;
/**
* Search params
*/
parameters: Array<GenModels.SearchParameter>;
/**
* Instance id
*
* @format datatype.uuid
*/
instanceId?: string;
/**
* Device type
*/
deviceType: GenModels.DeviceType;
/**
* Need use old grid.
*/
useOldGrid?: boolean;
}
}
export declare namespace GenModels {
interface CardListViewModel {
/**
* Card list header text
*/
headerText: string;
/**
* Card list parent header text
*/
parentHeaderText: string;
/**
* Current view name
*/
currentViewName: string;
/**
* Default folder view style
*/
defaultStyle: GenModels.DvFolderStyles;
/**
* Url for DefaultStyle.FolderURL, when folder displayed as web page.
*/
folderUrl: string;
/**
* Grid model
*/
gridModel: GenModels.GridViewModel;
/**
* Are some batch operations available for the folder.
*/
hasBatchOperations: boolean;
/**
* Gets or sets grid layout
*/
gridLayout: GenModels.LayoutViewModel;
/**
* Gets or sets search parameters layout
*/
searchParametersLayout: GenModels.LayoutViewModel;
/**
* Current session id.
*
* @format datatype.uuid
*/
fullTextSearchSessionId: string;
/**
* Gets or sets folder identifier
*
* @format datatype.uuid
*/
folderId: string;
/**
* Gets or sets view identifier
*
* @format datatype.uuid
*/
viewId: string;
/**
* Gets or sets search identifier
*
* @format datatype.uuid
*/
searchId: string;
/**
* Gets or sets instanceId
*
* @format datatype.uuid
*/
instanceId: string;
/**
* Gets or sets grid user settings data
*/
gridUserSettings: GenModels.GridUserSettingsData;
}
}
export declare namespace GenModels {
interface GridViewModel {
instanceId: string;
cursorId: string;
pageSize: number;
modelSize: number;
isAllPagesLoaded: boolean;
isUnknownModelSize: boolean;
isFilterAllowed: boolean;
isPagingMode: boolean;
isLastPage: boolean;
markUnread: boolean;
checkCardAccess: boolean;
allowRowResize: boolean;
sortingKey: string;
columns: Array<GenModels.GridColumn>;
rows: Array<GenModels.GridRow>;
request: GenModels.QueryViewRequest;
fullTextSearchSessionId: string;
gridUserSettings: GenModels.GridUserSettingsData;
isGroupingAllowed: boolean;
showGroupingColumns: boolean;
baseCursorRowCount: number;
hasDefaultGrouping: boolean;
keyColumnName: string;
sortingColumns: Array<GenModels.GridSorting>;
groupingColumnNames: Array<GenModels.GridGrouping>;
}
}
export declare namespace GenModels {
interface GridColumn {
displayName: string;
sorting: boolean;
cssClassName: string;
type: GenModels.ColumnType;
sortDirection?: GenModels.SortDirection;
dateFormat: string;
isDefaultSort: boolean;
name: string;
isSystemColumn: boolean;
isHiddenColumn: boolean;
displayAsHTML: boolean;
unresizable: boolean;
width: string;
order: number;
isFilteringAllowed: boolean;
isGroupingAllowed: boolean;
evalRow: any;
getGridFieldData: any;
}
}
export declare namespace GenModels {
interface GridRow {
params: Array<GenModels.GridRowParam>;
backColor: string;
foreColor: string;
wasRead: boolean;
isArchived: boolean;
}
}
export declare namespace GenModels {
interface GridRowParam {
columnName: string;
value: any;
rawValue: any;
}
}
export declare namespace GenModels {
interface GridSorting {
columnName: string;
order: number;
ascending: boolean;
}
}
export declare namespace GenModels {
interface GridGrouping {
columnName: string;
ascending: boolean;
showExpanded: boolean;
}
}
export declare namespace GenModels {
interface ILayoutViewModel {
/**
* Gets or sets a layout model
*/
layoutModel: GenModels.LayoutModel;
}
}
export declare namespace GenModels {
interface ControlModel {
/**
* Gets or sets control type name
*/
controlTypeName: string;
/**
* Gets or sets whether control will be loaded later by special request
*/
isAsync?: boolean;
/**
* Gets control properties
*/
properties: {
[name: string]: any;
};
/**
* Gets control children
*/
children: Array<GenModels.ControlModel>;
}
}
export declare namespace GenModels {
interface LayoutModel extends GenModels.ControlModel {
/**
* Gets or sets layout info model
*/
layoutInfo: GenModels.LayoutInfoModel;
/**
* Gets or creates extended layouts info
*/
extendedDataSourceInfos: Array<GenModels.ExtendedDataSourceInfoModel>;
}
}
export declare namespace GenModels {
interface LayoutInfoModel {
/**
* Gets or sets layout type
*/
type: GenModels.LayoutType;
/**
* Gets or sets action
*/
action: GenModels.LayoutAction;
/**
* Gets or sets layout mode
*
* @format datatype.uuid
*/
layoutMode?: string;
/**
* Gets or sets device type
*/
deviceType: GenModels.DeviceType;
/**
* Gets or sets locale identifier
*/
localeId: number;
/**
* Gets or sets layout name
*/
name: string;
/**
* Gets or sets layout identifier
*
* @format datatype.uuid
*/
id: string;
/**
* Gets or sets layout instance identifier
*
* @format datatype.uuid
*/
instanceId: string;
/**
* Gets operation
*/
operations: Array<GenModels.OperationModel>;
/**
* Layout load options
*/
layoutParams: Array<GenModels.LayoutParamModel>;
}
}
export declare namespace GenModels {
interface OperationModel {
/**
* Gets operation identifier
*
* @format datatype.uuid
*/
id: string;
/**
* Gets operation identifier
*
* @format datatype.uuid
*/
builtInId?: string;
/**
* Gets operation caption
*/
caption: string;
/**
* Gets value indicating whether operation is available
*/
available: boolean;
/**
* Gets alias
*/
alias: string;
}
}
export declare namespace GenModels {
interface LayoutParamModel {
/**
* key
*/
key: string;
/**
* value
*/
value: string;
}
}
export declare namespace GenModels {
interface ExtendedDataSourceInfoModel {
/**
* Gets or sets extended layouts info identifier
*
* @format datatype.uuid
*/
id: string;
/**
* Gets or sets timestamp card identifier
*
* @format datatype.uuid
*/
cardId: string;
/**
* Gets or sets timestamp
*/
timestamp: number;
}
}
export declare namespace GenModels {
interface LayoutViewModel extends GenModels.ILayoutViewModel {
layoutModel: GenModels.LayoutModel;
}
}
export declare namespace GenModels {
interface FolderIdentityModel {
/**
* Folder id
*
* @format datatype.uuid
*/
folderId?: string;
/**
* System folder identification.
*/
systemFolder?: GenModels.SystemFolders;
}
}
export declare namespace GenModels {
interface FolderViewInfosModel {
/**
* Infos
*/
views: Array<GenModels.FolderViewInfo>;
}
}
export declare namespace GenModels {
interface FolderViewInfo {
/**
* Gets or sets view name
*/
name: string;
/**
* Gets or sets view identifier
*
* @format datatype.uuid
*/
viewId: string;
/**
* Is view configured as folder default view
*/
isDefaultFolderView: boolean;
}
}
export declare namespace GenModels {
interface ViewColumnModel {
/**
* Column name
*/
columnName: string;
/**
* Column date format
*/
dateFormat: string;
/**
* Column order
*/
order: number;
/**
* Is column hidden
*/
hidden: boolean;
/**
* Is column system
*/
system: boolean;
/**
* Gets or sets column caption
*/
caption: string;
/**
* Is column need save HTML content to show
*/
displayAsHTML: boolean;
}
}
export declare namespace GenModels {
interface GridFilterRequestModel {
/**
* Gets or sets folder identifier
*
* @format datatype.uuid
*/
folderId: string;
/**
* Gets or sets view identifier
*
* @format datatype.uuid
*/
viewId: string;
}
}
export declare namespace GenModels {
interface GridViewModelEx extends GenModels.GridViewModel {
searchParametersLayout?: GenModels.ILayoutViewModel;
}
}
export declare namespace GenModels {
interface SaveGridUserSettingsDataRequestModel {
/**
* Gets or sets folder identifier
*
* @format datatype.uuid
*/
folderId: string;
/**
* Get or sets view identifier
*
* @format datatype.uuid
*/
viewId: string;
/**
* Get or sets instance id
*
* @format datatype.uuid
*/
instanceId?: string;
/**
* Gets or sets grid user settings data
*/
gridUserSettings: GenModels.GridUserSettingsData;
}
}
export declare namespace GenModels {
interface SaveGridUserSettingsFolderDataRequestModel {
/**
* Gets or sets folder identifier
*
* @format datatype.uuid
*/
folderId: string;
/**
* Gets or sets grid user settings folder data
*/
gridUserSettingsFolder: GenModels.GridUserSettingsFolderData;
}
}
export declare namespace GenModels {
interface GridUserSettingsFolderData {
/**
* Gets or sets view id
*
* @format datatype.uuid
*/
viewId: string;
}
}
export declare namespace GenModels {
interface SaveAllCardsReadStatusRequestModel {
/**
* Request model
*/
requestModel: GenModels.CardListRequestModel;
/**
* Gets or sets card was read
*/
wasRead: boolean;
}
}
export declare namespace GenModels {
interface DistinctValuesRequestWithPagination {
/**
* Gets or sets Cursor ID
*
* @format datatype.uuid
*/
cursorId: string;
/**
* Gets or sets page number
*/
pageNumber: number;
/**
* Gets or sets page size
*/
pageSize: number;
}
}
export declare namespace GenModels {
interface DistinctValuesRequestModel extends GenModels.DistinctValuesRequestWithPagination {
/**
* Gets or sets
*/
grouping: Array<GenModels.GridUserSettingsGroupColumn>;
}
}
export declare namespace GenModels {
interface DistinctValuesModel {
/**
* Gets or sets page count
*/
pageCount: number;
/**
* Gets or sets current page
*/
currentPage: number;
/**
* Gets or sets distinct values
*/
distinctValues: Array<GenModels.ViewDistinctValue>;
}
}
export declare namespace GenModels {
interface ViewDistinctValue {
/**
* Gets or sets column name
*/
columnName: string;
/**
* Gets or sets whether sorting by descending
*/
isDescending: boolean;
/**
* Gets or sets value
*/
value: string;
/**
* Gets or sets raw value
*/
rawValue: any;
/**
* Gets or sets count
*/
count: number;
/**
* Gets or sets whether last level
*/
isLastLevel: boolean;
}
}
export declare namespace GenModels {
interface FilterDistinctValuesRequestModel extends GenModels.DistinctValuesRequestModel {
/**
* Column name
*/
filterColumnName: string;
/**
* Search text
*/
filterSearchText: string;
/**
* Instace ID
*
* @format datatype.uuid
*/
instanceId: string;
}
}
export declare namespace GenModels {
interface GridAggregateRequest {
/**
* Gets or sets folder ID
*
* @format datatype.uuid
*/
folderId: string;
/**
* Gets or sets query ID
*
* @format datatype.uuid
*/
queryId: string;
/**
* Gets or sets instance ID
*
* @format datatype.uuid
*/
instanceId: string;
/**
* Gets or sets filters
*/
filters: Array<GenModels.AggregateFilterItem>;
}
}
export declare namespace GenModels {
interface GridAggregateModel {
/**
* Grid aggregate name
*/
name: string;
/**
* Grid aggregate alias
*/
alias: string;
/**
* Is Grid aggregate main?
*/
isMain: boolean;
/**
* List of grid aggregate value
*/
aggregateValues: Array<GenModels.GridAggregateValue>;
}
}
export declare namespace GenModels {
interface GridAggregateValue {
/**
* Aggregate value name
*/
name: string;
/**
* Aggregate value alias
*/
alias: string;
/**
* Aggregate value count
*/
count: number;
/**
* Aggregate value count
*/
checked?: boolean;
}
}
export declare namespace GenModels {
interface DistinctValuesDiag