@snabcentr/common-lib 4.0.1 → 4.1.0-dev

package/dist/src/reclamations/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/reclamations/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}

package/dist/src/reclamations/providers/reclamation-provider.d.ts

@@ -0,0 +1,83 @@
+import { BasePaginationProvider } from '../../pagination/providers/base-pagination-provider';
+import { Reclamation } from '../classes/reclamation';
+import { ReclamationShortInfo } from '../classes/reclamation-short-info';
+import { IReclamationMessageSaveData } from '../interfaces/i-reclamation-message-save-data';
+import { IReclamationsUpdates } from '../interfaces/i-reclamations-updates';
+import { IFilterGroup } from '../../table-data/interfaces/i-filter-group';
+import { IPaginationRequestParams } from '../../table-data/interfaces/i-pagination-request-params';
+import { ISortRequestParams } from '../../table-data/interfaces/i-sort-request-params';
+import { IFieldValidationResultData, IPaginatedResponse } from '@snabcentr/common-core';
+/**
+ * Предоставляет механизмы получения/управления рекламациями клиентов.
+ */
+export declare class ReclamationProvider extends BasePaginationProvider {
+    /**
+     * Возвращает список рекламаций.
+     *
+     * @param filters Параметры фильтрации данных. Статусы передаются строковыми кодами (см. ReclamationStatusHelper.toApiCodes).
+     * @param sortParams Параметры сортировки.
+     * @param paginationParams Параметры пагинации.
+     * @param signal Сигнал отмены запроса.
+     * @param disableNotifications Признак необходимости отключить уведомления об ошибках.
+     *
+     * @see /doc/api/internal#/operations/api_internal_reclamations_get_list
+     */
+    getReclamationsList(filters?: IFilterGroup, sortParams?: ISortRequestParams[] | ISortRequestParams, paginationParams?: IPaginationRequestParams, signal?: AbortSignal, disableNotifications?: boolean): Promise<IPaginatedResponse<ReclamationShortInfo>>;
+    /**
+     * Возвращает полные данные о рекламации. Открытие рекламации отмечает её прочитанной сотрудником.
+     *
+     * @param reclamationId Идентификатор рекламации.
+     * @param signal Сигнал отмены запроса.
+     * @param disableNotifications Признак необходимости отключить уведомления об ошибках.
+     *
+     * @see /doc/api/internal#/operations/api_internal_reclamation_get
+     */
+    getReclamation(reclamationId: number, signal?: AbortSignal, disableNotifications?: boolean): Promise<Reclamation>;
+    /**
+     * Добавляет сообщение в незакрытую рекламацию и возвращает её полные данные.
+     *
+     * @param reclamationId Идентификатор рекламации.
+     * @param data Данные сообщения. Без статуса сообщение не меняет статус рекламации.
+     * @param validationFieldResultData Список полей, для которых необходимо
+     *                                  установить данные об ошибках валидации
+     *                                  в случае ошибок в запросах.
+     *
+     * @see /doc/api/internal#/operations/api_internal_reclamation_create_message
+     */
+    createMessage(reclamationId: number, data: IReclamationMessageSaveData, validationFieldResultData?: Record<string, IFieldValidationResultData>): Promise<Reclamation>;
+    /**
+     * Удаляет незакрытую рекламацию, помеченную клиентом на удаление.
+     *
+     * @param reclamationId Идентификатор рекламации.
+     *
+     * @see /doc/api/internal#/operations/api_internal_reclamation_delete
+     */
+    deleteReclamation(reclamationId: number): Promise<void>;
+    /**
+     * Снимает пометку на удаление с незакрытой рекламации и возвращает её полные данные.
+     *
+     * @param reclamationId Идентификатор рекламации.
+     *
+     * @see /doc/api/internal#/operations/api_internal_reclamation_restore
+     */
+    restoreReclamation(reclamationId: number): Promise<Reclamation>;
+    /**
+     * Возвращает рекламацию в формате PDF.
+     *
+     * @param reclamationId Идентификатор рекламации.
+     * @param disableNotifications Признак необходимости отключить уведомления об ошибках.
+     *
+     * @see /doc/api/internal#/operations/api_internal_reclamation_download
+     */
+    downloadReclamation(reclamationId: number, disableNotifications?: boolean): Promise<Blob>;
+    /**
+     * Возвращает данные о количестве рекламаций с изменениями, не просмотренными сотрудниками, включая помеченные клиентом на удаление.
+     *
+     * @param signal Сигнал отмены запроса.
+     * @param disableNotifications Признак необходимости отключить уведомления об ошибках.
+     *
+     * @see /doc/api/internal#/operations/api_internal_reclamations_get_updates
+     */
+    getUpdates(signal?: AbortSignal, disableNotifications?: boolean): Promise<IReclamationsUpdates>;
+}
+//# sourceMappingURL=reclamation-provider.d.ts.map

package/dist/src/reclamations/providers/reclamation-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reclamation-provider.d.ts","sourceRoot":"","sources":["../../../../src/reclamations/providers/reclamation-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,uDAAuD,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qDAAqD,CAAC;AAC3F,OAAO,EAAE,2BAA2B,EAAE,MAAM,iEAAiE,CAAC;AAC9G,OAAO,EAAE,oBAAoB,EAAE,MAAM,wDAAwD,CAAC;AAC9F,OAAO,EAAE,YAAY,EAAE,MAAM,8CAA8C,CAAC;AAC5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,2DAA2D,CAAC;AACrG,OAAO,EAAE,kBAAkB,EAAE,MAAM,qDAAqD,CAAC;AACzF,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAExF;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,sBAAsB;IAC3D;;;;;;;;;;OAUG;IACI,mBAAmB,CACtB,OAAO,CAAC,EAAE,YAAY,EACtB,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EACtD,gBAAgB,CAAC,EAAE,wBAAwB,EAC3C,MAAM,CAAC,EAAE,WAAW,EACpB,oBAAoB,GAAE,OAAe,GACtC,OAAO,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;IAIpD;;;;;;;;OAQG;IACI,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,oBAAoB,GAAE,OAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAI/H;;;;;;;;;;OAUG;IACI,aAAa,CAChB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,2BAA2B,EACjC,yBAAyB,GAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAM,GAC3E,OAAO,CAAC,WAAW,CAAC;IAIvB;;;;;;OAMG;IACI,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D;;;;;;OAMG;IACI,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAItE;;;;;;;OAOG;IACI,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,oBAAoB,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvG;;;;;;;OAOG;IACI,UAAU,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,oBAAoB,GAAE,OAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGhH"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@snabcentr/common-lib",
-    "version": "4.0.1",
+    "version": "4.1.0-dev",
     "description": "Библиотека общих классов, используемых во всех проектах Снабцентр.",
     "keywords": [],
     "author": "Sergey S. Smirnov <dev@snabcentr.com>",