@docsvision/webclient 5.17.0-beta.1 → 5.17.0-beta.13

package/Generated/DocsVision.WebClient.Controllers.d.ts

@@ -26,10 +26,10 @@ export declare namespace GenControllers {
          *
          * @returns file stream
          */
-        downloadPdf(fileId: string, options?: RequestOptions): Promise<string>;
+        downloadPdf(fileId: string, cardId: string, options?: RequestOptions): Promise<string>;
     }
     class FilePreviewController extends BaseController implements IFilePreviewController {
-        downloadPdf(fileId: string, options?: RequestOptions): Promise<string>;
+        downloadPdf(fileId: string, cardId: string, options?: RequestOptions): Promise<string>;
     }
 }
 export declare type $FilePreviewController = {
@@ -401,6 +401,22 @@ export declare type $ExtensionsController = {
     extensionsController: GenControllers.IExtensionsController;
 };
 export declare const $ExtensionsController: string | ((model?: $ExtensionsController) => GenControllers.IExtensionsController);
+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 BaseController 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 {
     /**
      * Represents folder type controller
@@ -469,6 +485,30 @@ export declare type $SecurityController = {
     securityController: GenControllers.ISecurityController;
 };
 export declare const $SecurityController: string | ((model?: $SecurityController) => GenControllers.ISecurityController);
+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 BaseController 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 {
     interface IStateButtonsController {
         /**
@@ -598,9 +638,14 @@ export declare namespace GenControllers {
          * Get value of the field
          */
         getFieldValue(request: GenModels.GetFieldValueRequest, options?: RequestOptions): Promise<any>;
+        /**
+         * Gets card digest.
+         */
+        getDigest(cardId: string, options?: RequestOptions): Promise<string>;
     }
     class CardDataController extends BaseController implements ICardDataController {
         getFieldValue(request: GenModels.GetFieldValueRequest, options?: RequestOptions): Promise<any>;
+        getDigest(cardId: string, options?: RequestOptions): Promise<string>;
     }
 }
 export declare type $CardDataController = {
@@ -1096,10 +1141,25 @@ export declare namespace GenControllers {
          * @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
+         */
+        setShowArchivedCardsSetting(showArchiveCards: boolean, options?: RequestOptions): Promise<void>;
+        /**
+         * Set feedbackRequestDate
+         */
+        setFeedbackRequestDateSetting(date: string, options?: RequestOptions): Promise<void>;
     }
     class LayoutUserSettingsController extends BaseController implements ILayoutUserSettingsController {
         getMainMenuSettings(options?: RequestOptions): Promise<GenModels.MainMenuSettings>;
         saveMainMenuSettings(settings: GenModels.MainMenuSettings, options?: RequestOptions): Promise<void>;
+        getShowArchivedCardsSetting(options?: RequestOptions): Promise<boolean>;
+        setShowArchivedCardsSetting(showArchiveCards: boolean, options?: RequestOptions): Promise<void>;
+        setFeedbackRequestDateSetting(date: string, options?: RequestOptions): Promise<void>;
     }
 }
 export declare type $LayoutUserSettingsController = {
@@ -1119,14 +1179,33 @@ export declare namespace GenControllers {
          * @returns Model with list of recent cards
          */
         recentCards(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.CardListViewModel>;
+        /**
+         * Get recent cards
+         *
+         * @param request Request model
+         *
+         * @returns Model with list of recent cards
+         */
+        recentCardsEx(request: GenModels.RecentCardsRequest, options?: RequestOptions): Promise<GenModels.CardListViewModel>;
         /**
          * Get recent cards
          */
         recentCardsGridModel(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>;
+        /**
+         * Get favorites cards
+         */
+        favorites(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.CardListViewModel>;
+        /**
+         * Get favorites cards
+         */
+        favoritesCardsGridModel(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>;
     }
     class PagesController extends BaseController implements IPagesController {
         recentCards(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.CardListViewModel>;
+        recentCardsEx(request: GenModels.RecentCardsRequest, options?: RequestOptions): Promise<GenModels.CardListViewModel>;
         recentCardsGridModel(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>;
+        favorites(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.CardListViewModel>;
+        favoritesCardsGridModel(requestModel: GenModels.CardListRequestModel, options?: RequestOptions): Promise<GenModels.GridViewModel>;
     }
 }
 export declare type $PagesController = {
@@ -1146,6 +1225,18 @@ export declare namespace GenControllers {
          * @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
          *
@@ -1160,6 +1251,14 @@ export declare namespace GenControllers {
          * @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
          *
@@ -1184,14 +1283,52 @@ export declare namespace GenControllers {
          * @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>>;
+        /**
+         * Force unread counter recalculation.
+         *
+         * @param requestModel
+         */
+        refreshUnreadCounter(requestModel: GenModels.RefreshUnreadCounterRequest, options?: RequestOptions): Promise<any>;
     }
     class GridController extends BaseController 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>>;
+        refreshUnreadCounter(requestModel: GenModels.RefreshUnreadCounterRequest, options?: RequestOptions): Promise<any>;
     }
 }
 export declare type $GridController = {
@@ -1304,6 +1441,55 @@ export declare type $CardOperationsController = {
     cardOperationsController: GenControllers.ICardOperationsController;
 };
 export declare const $CardOperationsController: string | ((model?: $CardOperationsController) => GenControllers.ICardOperationsController);
+export declare namespace GenControllers {
+    /**
+     * Download files batch operation controller
+     */
+    interface IDownloadFilesBatchOperationController {
+        /**
+         * GET: /IsHasFileCertificateSignature/
+         *
+         * @param documentId Document ID
+         *
+         * @returns Is the document has a certificate signature
+         */
+        isHasFileCertificateSignature(documentId: string, options?: RequestOptions): Promise<GenModels.IsHasFileCertificateSignatureModel>;
+        /**
+         * GET: /DownloadFilesBatchOperation/
+         *
+         * @param documentId Document ID
+         * @param includeMainFiles Include main files to list?
+         * @param includeAdditionalFiles Include additional files to list?
+         */
+        getDocumentFiles(documentId: string, includeMainFiles: boolean, includeAdditionalFiles: boolean, options?: RequestOptions): Promise<Array<GenModels.DowloadFilesOperationFileInfoModel>>;
+    }
+    class DownloadFilesBatchOperationController extends BaseController implements IDownloadFilesBatchOperationController {
+        isHasFileCertificateSignature(documentId: string, options?: RequestOptions): Promise<GenModels.IsHasFileCertificateSignatureModel>;
+        getDocumentFiles(documentId: string, includeMainFiles: boolean, includeAdditionalFiles: boolean, options?: RequestOptions): Promise<Array<GenModels.DowloadFilesOperationFileInfoModel>>;
+    }
+}
+export declare type $DownloadFilesBatchOperationController = {
+    downloadFilesBatchOperationController: GenControllers.IDownloadFilesBatchOperationController;
+};
+export declare const $DownloadFilesBatchOperationController: string | ((model?: $DownloadFilesBatchOperationController) => GenControllers.IDownloadFilesBatchOperationController);
+export declare namespace GenControllers {
+    /**
+     * Layout card controller
+     */
+    interface IBaseCardController {
+        /**
+         * HTTP: /Card/SetWasRead
+         */
+        setWasRead(request: GenModels.WasReadRequest, options?: RequestOptions): Promise<string>;
+    }
+    class BaseCardController extends BaseController implements IBaseCardController {
+        setWasRead(request: GenModels.WasReadRequest, options?: RequestOptions): Promise<string>;
+    }
+}
+export declare type $BaseCardController = {
+    baseCardController: GenControllers.IBaseCardController;
+};
+export declare const $BaseCardController: string | ((model?: $BaseCardController) => GenControllers.IBaseCardController);
 export declare namespace GenControllers {
     /**
      * Layout file controller
@@ -1786,14 +1972,22 @@ export declare namespace GenControllers {
          * HTTP: /LayoutCard/View
          */
         view(cardId: string, layoutMode: string, refresh?: boolean, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
+        /**
+         * HTTP: /LayoutCard/ViewEx
+         */
+        viewEx(request: GenModels.ViewCardLayoutRequest, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
         /**
          * HTTP: /LayoutCard/Edit
          */
         edit(cardId: string, layoutMode: string, refresh?: boolean, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
+        /**
+         * HTTP: /LayoutCard/EditEx
+         */
+        editEx(request: GenModels.EditCardLayoutRequest, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
         /**
          * HTTP: /LayoutCard/Delete
          */
-        delete(deleteCardRequestModel: GenModels.DeleteCardRequestModel, options?: RequestOptions): Promise<void>;
+        delete(deleteCardRequestModel: GenModels.DeleteCardRequestModel, options?: RequestOptions): Promise<string>;
         /**
          * Gets layout part
          */
@@ -1840,8 +2034,10 @@ export declare namespace GenControllers {
     class LayoutCardController extends BaseController implements ILayoutCardController {
         newCard(createParams: GenModels.LayoutCardCreateParams, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
         view(cardId: string, layoutMode: string, refresh?: boolean, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
+        viewEx(request: GenModels.ViewCardLayoutRequest, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
         edit(cardId: string, layoutMode: string, refresh?: boolean, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
-        delete(deleteCardRequestModel: GenModels.DeleteCardRequestModel, options?: RequestOptions): Promise<void>;
+        editEx(request: GenModels.EditCardLayoutRequest, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
+        delete(deleteCardRequestModel: GenModels.DeleteCardRequestModel, options?: RequestOptions): Promise<string>;
         getLayout(cardLayoutParams: GenModels.CardLayoutParams, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
         getLayoutPart(layoutPartParams: GenModels.LayoutPartParams, options?: RequestOptions): Promise<GenModels.LayoutModel>;
         save(model: GenModels.SaveControlDataModel, options?: RequestOptions): Promise<void>;