@docsvision/webclient 5.16.1 → 5.17.0-beta.12

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 = {
@@ -1104,12 +1149,17 @@ export declare namespace GenControllers {
          * 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 = {
@@ -1141,11 +1191,21 @@ export declare namespace GenControllers {
          * 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 = {
@@ -1230,13 +1290,27 @@ export declare namespace GenControllers {
          */
         setAllCardsReadStatus(saveAllCardsReadStatusModel: GenModels.SaveAllCardsReadStatusRequestModel, options?: RequestOptions): Promise<void>;
         /**
-         * Get list {@link GenModels}
+         * 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>;
@@ -1251,7 +1325,10 @@ export declare namespace GenControllers {
         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 = {
@@ -1364,6 +1441,37 @@ 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
@@ -1879,7 +1987,7 @@ export declare namespace GenControllers {
         /**
          * HTTP: /LayoutCard/Delete
          */
-        delete(deleteCardRequestModel: GenModels.DeleteCardRequestModel, options?: RequestOptions): Promise<void>;
+        delete(deleteCardRequestModel: GenModels.DeleteCardRequestModel, options?: RequestOptions): Promise<string>;
         /**
          * Gets layout part
          */
@@ -1929,7 +2037,7 @@ export declare namespace GenControllers {
         viewEx(request: GenModels.ViewCardLayoutRequest, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
         edit(cardId: string, layoutMode: string, refresh?: boolean, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
         editEx(request: GenModels.EditCardLayoutRequest, options?: RequestOptions): Promise<GenModels.LayoutCardViewModel>;
-        delete(deleteCardRequestModel: GenModels.DeleteCardRequestModel, options?: RequestOptions): Promise<void>;
+        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>;