bx-rest 0.10.0 → 0.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/consts/part-name-methods.d.ts +5 -0
- package/esm2022/consts/part-name-methods.mjs +6 -1
- package/esm2022/functions/serializeBitrixParams.mjs +2 -3
- package/esm2022/request-navvy/crm/documentgenerator/document.mjs +103 -0
- package/esm2022/request-navvy/crm/documentgenerator/index.mjs +18 -0
- package/esm2022/request-navvy/crm/documentgenerator/numerator.mjs +61 -0
- package/esm2022/request-navvy/crm/documentgenerator/template.mjs +76 -0
- package/esm2022/request-navvy/crm.mjs +4 -1
- package/esm2022/services/navvy/navvy-pag-nav-result-key-object.mjs +60 -0
- package/esm2022/services/navvy.mjs +6 -1
- package/esm2022/typification/rest/crm/documentgenerator.mjs +2 -0
- package/esm2022/typification/rest/crm/index.mjs +2 -1
- package/fesm2022/bx-rest.mjs +316 -3
- package/fesm2022/bx-rest.mjs.map +1 -1
- package/package.json +2 -2
- package/request-navvy/crm/documentgenerator/document.d.ts +92 -0
- package/request-navvy/crm/documentgenerator/index.d.ts +15 -0
- package/request-navvy/crm/documentgenerator/numerator.d.ts +51 -0
- package/request-navvy/crm/documentgenerator/template.d.ts +65 -0
- package/request-navvy/crm.d.ts +3 -0
- package/services/navvy/navvy-pag-nav-result-key-object.d.ts +12 -0
- package/services/navvy.d.ts +3 -0
- package/typification/rest/crm/documentgenerator.d.ts +200 -0
- package/typification/rest/crm/index.d.ts +1 -0
package/package.json
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bx-rest",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.1",
|
|
4
4
|
"description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"bitrix",
|
|
7
7
|
"bitrix24",
|
|
8
8
|
"bitrix24-rest",
|
|
9
9
|
"bitrix24-api",
|
|
10
|
-
"bitrix24-sdk",
|
|
11
10
|
"bitrix-rest",
|
|
12
11
|
"bitrix-rest-client",
|
|
13
12
|
"bx24",
|
|
@@ -15,6 +14,7 @@
|
|
|
15
14
|
"bx24-api",
|
|
16
15
|
"rest-client",
|
|
17
16
|
"api-client",
|
|
17
|
+
"client",
|
|
18
18
|
"typescript",
|
|
19
19
|
"angular",
|
|
20
20
|
"vue",
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { iBXRestCrmDocumentGeneratorDocument, iBXRestCrmDocumentGeneratorField, iBXRestParamCrmDocumentGeneratorDocumentAdd, iBXRestParamCrmDocumentGeneratorDocumentDelete, iBXRestParamCrmDocumentGeneratorDocumentEnablePublicUrl, iBXRestParamCrmDocumentGeneratorDocumentGet, iBXRestParamCrmDocumentGeneratorDocumentGetFields, iBXRestParamCrmDocumentGeneratorDocumentList, iBXRestParamCrmDocumentGeneratorDocumentUpdate, iBXRestParamCrmDocumentGeneratorDocumentUpload } from '../../../typification/rest/crm';
|
|
2
|
+
interface DocumentResult {
|
|
3
|
+
document?: iBXRestCrmDocumentGeneratorDocument;
|
|
4
|
+
}
|
|
5
|
+
interface DocumentFieldsResult {
|
|
6
|
+
documentFields?: Record<string, iBXRestCrmDocumentGeneratorField>;
|
|
7
|
+
}
|
|
8
|
+
/** Методы документов генератора документов (`crm.documentgenerator.document.*`). */
|
|
9
|
+
export declare class BXRestNavvyCrmDocumentGeneratorDocument {
|
|
10
|
+
private readonly Navvy;
|
|
11
|
+
readonly url: {
|
|
12
|
+
/** Создаёт документ по шаблону. */
|
|
13
|
+
add: string[];
|
|
14
|
+
/** Обновляет существующий документ. */
|
|
15
|
+
update: string[];
|
|
16
|
+
/** Возвращает документ по идентификатору. */
|
|
17
|
+
get: string[];
|
|
18
|
+
/** Возвращает список документов. */
|
|
19
|
+
list: string[];
|
|
20
|
+
/** Удаляет документ. */
|
|
21
|
+
delete: string[];
|
|
22
|
+
/** Включает или выключает публичную ссылку на документ. */
|
|
23
|
+
enablePublicUrl: string[];
|
|
24
|
+
/** Загружает готовый документ и прикрепляет его к CRM-объекту. */
|
|
25
|
+
upload: string[];
|
|
26
|
+
/** Возвращает доступные поля созданного документа. */
|
|
27
|
+
getFields: string[];
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Создаёт документ по шаблону для указанного CRM-объекта.
|
|
31
|
+
*
|
|
32
|
+
* `pdfUrl` и `imageUrl` могут появиться позднее, поскольку конвертация выполняется асинхронно.
|
|
33
|
+
*
|
|
34
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-add.html
|
|
35
|
+
*/
|
|
36
|
+
add(param: iBXRestParamCrmDocumentGeneratorDocumentAdd): import("../../../services/navvy").NavvySimple<DocumentResult, iBXRestCrmDocumentGeneratorDocument, iBXRestParamCrmDocumentGeneratorDocumentAdd | undefined>;
|
|
37
|
+
/**
|
|
38
|
+
* Обновляет значения существующего документа и запускает его повторную генерацию.
|
|
39
|
+
*
|
|
40
|
+
* `pdfUrl` и `imageUrl` могут появиться позднее, поскольку конвертация выполняется асинхронно.
|
|
41
|
+
*
|
|
42
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-update.html
|
|
43
|
+
*/
|
|
44
|
+
update(param: iBXRestParamCrmDocumentGeneratorDocumentUpdate): import("../../../services/navvy").NavvySimple<DocumentResult, iBXRestCrmDocumentGeneratorDocument, iBXRestParamCrmDocumentGeneratorDocumentUpdate | undefined>;
|
|
45
|
+
/**
|
|
46
|
+
* Возвращает документ по идентификатору.
|
|
47
|
+
*
|
|
48
|
+
* Если конвертация ещё не завершилась, повторите запрос через 30–40 секунд.
|
|
49
|
+
*
|
|
50
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-get.html
|
|
51
|
+
*/
|
|
52
|
+
get(param: iBXRestParamCrmDocumentGeneratorDocumentGet): import("../../../services/navvy").NavvySimple<DocumentResult, iBXRestCrmDocumentGeneratorDocument, iBXRestParamCrmDocumentGeneratorDocumentGet | undefined>;
|
|
53
|
+
/**
|
|
54
|
+
* Возвращает список документов по фильтру с поддержкой постраничной навигации.
|
|
55
|
+
*
|
|
56
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-list.html
|
|
57
|
+
*/
|
|
58
|
+
list(param?: iBXRestParamCrmDocumentGeneratorDocumentList): import("../../../services/navvy").NavvyPagNavResultKey<iBXRestCrmDocumentGeneratorDocument, iBXRestCrmDocumentGeneratorDocument, iBXRestParamCrmDocumentGeneratorDocumentList, "documents">;
|
|
59
|
+
/**
|
|
60
|
+
* Удаляет документ.
|
|
61
|
+
*
|
|
62
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-delete.html
|
|
63
|
+
*/
|
|
64
|
+
delete(param: iBXRestParamCrmDocumentGeneratorDocumentDelete): import("../../../services/navvy").NavvySimple<null, null, iBXRestParamCrmDocumentGeneratorDocumentDelete | undefined>;
|
|
65
|
+
/**
|
|
66
|
+
* Включает или выключает публичную ссылку на документ.
|
|
67
|
+
* Если `status` не передан, ссылка включается.
|
|
68
|
+
*
|
|
69
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-enable-public-url.html
|
|
70
|
+
*/
|
|
71
|
+
enablePublicUrl(param: iBXRestParamCrmDocumentGeneratorDocumentEnablePublicUrl): import("../../../services/navvy").NavvySimple<{
|
|
72
|
+
publicUrl: string | null;
|
|
73
|
+
}, {
|
|
74
|
+
publicUrl: string | null;
|
|
75
|
+
}, iBXRestParamCrmDocumentGeneratorDocumentEnablePublicUrl | undefined>;
|
|
76
|
+
/**
|
|
77
|
+
* Загружает готовый DOCX-документ и прикрепляет его к CRM-объекту.
|
|
78
|
+
* Дополнительно можно передать готовые PDF и изображение в Base64.
|
|
79
|
+
*
|
|
80
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-upload.html
|
|
81
|
+
*/
|
|
82
|
+
upload(param: iBXRestParamCrmDocumentGeneratorDocumentUpload): import("../../../services/navvy").NavvySimple<DocumentResult, iBXRestCrmDocumentGeneratorDocument, iBXRestParamCrmDocumentGeneratorDocumentUpload | undefined>;
|
|
83
|
+
/**
|
|
84
|
+
* Возвращает карточку полей созданного документа.
|
|
85
|
+
* Переданные `values` используются только для вычисления ответа и не изменяют документ.
|
|
86
|
+
*
|
|
87
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-get-fields.html
|
|
88
|
+
*/
|
|
89
|
+
getFields(param: iBXRestParamCrmDocumentGeneratorDocumentGetFields): import("../../../services/navvy").NavvySimple<DocumentFieldsResult, Record<string, iBXRestCrmDocumentGeneratorField>, iBXRestParamCrmDocumentGeneratorDocumentGetFields | undefined>;
|
|
90
|
+
private documentRequest;
|
|
91
|
+
}
|
|
92
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { BXRestNavvyCrmDocumentGeneratorDocument } from './document';
|
|
2
|
+
import { BXRestNavvyCrmDocumentGeneratorNumerator } from './numerator';
|
|
3
|
+
import { BXRestNavvyCrmDocumentGeneratorTemplate } from './template';
|
|
4
|
+
export * from './document';
|
|
5
|
+
export * from './numerator';
|
|
6
|
+
export * from './template';
|
|
7
|
+
/** Методы генератора документов CRM (`crm.documentgenerator.*`). */
|
|
8
|
+
export declare class BXRestNavvyCrmDocumentGenerator {
|
|
9
|
+
/** Нумераторы задают шаблон номера и параметры счётчика документов. */
|
|
10
|
+
readonly numerator: BXRestNavvyCrmDocumentGeneratorNumerator;
|
|
11
|
+
/** Шаблоны DOCX, привязанные к нумераторам и типам CRM-объектов. */
|
|
12
|
+
readonly template: BXRestNavvyCrmDocumentGeneratorTemplate;
|
|
13
|
+
/** Создание, загрузка и управление документами CRM. */
|
|
14
|
+
readonly document: BXRestNavvyCrmDocumentGeneratorDocument;
|
|
15
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { iBXRestCrmDocumentGeneratorNumerator, iBXRestParamCrmDocumentGeneratorNumeratorAdd, iBXRestParamCrmDocumentGeneratorNumeratorDelete, iBXRestParamCrmDocumentGeneratorNumeratorGet, iBXRestParamCrmDocumentGeneratorNumeratorList, iBXRestParamCrmDocumentGeneratorNumeratorUpdate } from '../../../typification/rest/crm';
|
|
2
|
+
interface NumeratorResult {
|
|
3
|
+
numerator?: iBXRestCrmDocumentGeneratorNumerator;
|
|
4
|
+
}
|
|
5
|
+
/** Методы нумераторов генератора документов (`crm.documentgenerator.numerator.*`). */
|
|
6
|
+
export declare class BXRestNavvyCrmDocumentGeneratorNumerator {
|
|
7
|
+
private readonly Navvy;
|
|
8
|
+
readonly url: {
|
|
9
|
+
/** Добавляет новый нумератор. */
|
|
10
|
+
add: string[];
|
|
11
|
+
/** Обновляет существующий нумератор. */
|
|
12
|
+
update: string[];
|
|
13
|
+
/** Возвращает нумератор по идентификатору. */
|
|
14
|
+
get: string[];
|
|
15
|
+
/** Возвращает список нумераторов. */
|
|
16
|
+
list: string[];
|
|
17
|
+
/** Удаляет созданный через REST нумератор. */
|
|
18
|
+
delete: string[];
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Добавляет новый нумератор.
|
|
22
|
+
*
|
|
23
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-add.html
|
|
24
|
+
*/
|
|
25
|
+
add(param: iBXRestParamCrmDocumentGeneratorNumeratorAdd): import("../../../services/navvy").NavvySimple<NumeratorResult, iBXRestCrmDocumentGeneratorNumerator, iBXRestParamCrmDocumentGeneratorNumeratorAdd | undefined>;
|
|
26
|
+
/**
|
|
27
|
+
* Обновляет существующий нумератор и возвращает его актуальные данные.
|
|
28
|
+
*
|
|
29
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-update.html
|
|
30
|
+
*/
|
|
31
|
+
update(param: iBXRestParamCrmDocumentGeneratorNumeratorUpdate): import("../../../services/navvy").NavvySimple<iBXRestCrmDocumentGeneratorNumerator, iBXRestCrmDocumentGeneratorNumerator, iBXRestParamCrmDocumentGeneratorNumeratorUpdate | undefined>;
|
|
32
|
+
/**
|
|
33
|
+
* Возвращает информацию о нумераторе по идентификатору.
|
|
34
|
+
*
|
|
35
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-get.html
|
|
36
|
+
*/
|
|
37
|
+
get(param: iBXRestParamCrmDocumentGeneratorNumeratorGet): import("../../../services/navvy").NavvySimple<NumeratorResult, iBXRestCrmDocumentGeneratorNumerator, iBXRestParamCrmDocumentGeneratorNumeratorGet | undefined>;
|
|
38
|
+
/**
|
|
39
|
+
* Возвращает список нумераторов с поддержкой постраничной навигации.
|
|
40
|
+
*
|
|
41
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-list.html
|
|
42
|
+
*/
|
|
43
|
+
list(param?: iBXRestParamCrmDocumentGeneratorNumeratorList): import("../../../services/navvy").NavvyPagNavResultKey<iBXRestCrmDocumentGeneratorNumerator, iBXRestCrmDocumentGeneratorNumerator, import("../../../typification/rest/base").iBXRestPagination, "numerators">;
|
|
44
|
+
/**
|
|
45
|
+
* Удаляет нумератор. Удалить можно только нумератор, созданный через REST.
|
|
46
|
+
*
|
|
47
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-delete.html
|
|
48
|
+
*/
|
|
49
|
+
delete(param: iBXRestParamCrmDocumentGeneratorNumeratorDelete): import("../../../services/navvy").NavvySimple<null, null, iBXRestParamCrmDocumentGeneratorNumeratorDelete | undefined>;
|
|
50
|
+
}
|
|
51
|
+
export {};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { iBXRestCrmDocumentGeneratorField, iBXRestCrmDocumentGeneratorTemplate, iBXRestParamCrmDocumentGeneratorTemplateAdd, iBXRestParamCrmDocumentGeneratorTemplateDelete, iBXRestParamCrmDocumentGeneratorTemplateGet, iBXRestParamCrmDocumentGeneratorTemplateGetFields, iBXRestParamCrmDocumentGeneratorTemplateList, iBXRestParamCrmDocumentGeneratorTemplateUpdate } from '../../../typification/rest/crm';
|
|
2
|
+
interface TemplateResult {
|
|
3
|
+
template?: iBXRestCrmDocumentGeneratorTemplate;
|
|
4
|
+
}
|
|
5
|
+
interface TemplateFieldsResult {
|
|
6
|
+
templateFields?: Record<string, iBXRestCrmDocumentGeneratorField>;
|
|
7
|
+
}
|
|
8
|
+
/** Методы шаблонов генератора документов (`crm.documentgenerator.template.*`). */
|
|
9
|
+
export declare class BXRestNavvyCrmDocumentGeneratorTemplate {
|
|
10
|
+
private readonly Navvy;
|
|
11
|
+
readonly url: {
|
|
12
|
+
/** Добавляет новый шаблон документа. */
|
|
13
|
+
add: string[];
|
|
14
|
+
/** Обновляет существующий шаблон документа. */
|
|
15
|
+
update: string[];
|
|
16
|
+
/** Возвращает шаблон документа по идентификатору. */
|
|
17
|
+
get: string[];
|
|
18
|
+
/** Возвращает список шаблонов документов. */
|
|
19
|
+
list: string[];
|
|
20
|
+
/** Удаляет шаблон документа. */
|
|
21
|
+
delete: string[];
|
|
22
|
+
/** Возвращает доступные поля шаблона для CRM-объекта. */
|
|
23
|
+
getFields: string[];
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Добавляет новый шаблон документа из файла DOCX.
|
|
27
|
+
*
|
|
28
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-add.html
|
|
29
|
+
*/
|
|
30
|
+
add(param: iBXRestParamCrmDocumentGeneratorTemplateAdd): import("../../../services/navvy").NavvySimple<TemplateResult, iBXRestCrmDocumentGeneratorTemplate, iBXRestParamCrmDocumentGeneratorTemplateAdd | undefined>;
|
|
31
|
+
/**
|
|
32
|
+
* Обновляет существующий шаблон документа.
|
|
33
|
+
*
|
|
34
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-update.html
|
|
35
|
+
*/
|
|
36
|
+
update(param: iBXRestParamCrmDocumentGeneratorTemplateUpdate): import("../../../services/navvy").NavvySimple<TemplateResult, iBXRestCrmDocumentGeneratorTemplate, iBXRestParamCrmDocumentGeneratorTemplateUpdate | undefined>;
|
|
37
|
+
/**
|
|
38
|
+
* Возвращает информацию о шаблоне документа по идентификатору.
|
|
39
|
+
*
|
|
40
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-get.html
|
|
41
|
+
*/
|
|
42
|
+
get(param: iBXRestParamCrmDocumentGeneratorTemplateGet): import("../../../services/navvy").NavvySimple<TemplateResult, iBXRestCrmDocumentGeneratorTemplate, iBXRestParamCrmDocumentGeneratorTemplateGet | undefined>;
|
|
43
|
+
/**
|
|
44
|
+
* Возвращает список шаблонов с поддержкой постраничной навигации.
|
|
45
|
+
*
|
|
46
|
+
* В ответе Битрикс24 шаблоны индексированы идентификаторами; навигатор преобразует их в массив.
|
|
47
|
+
*
|
|
48
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-list.html
|
|
49
|
+
*/
|
|
50
|
+
list(param?: iBXRestParamCrmDocumentGeneratorTemplateList): import("../../../services/navvy").NavvyPagNavResultKeyObject<iBXRestCrmDocumentGeneratorTemplate, iBXRestCrmDocumentGeneratorTemplate, iBXRestParamCrmDocumentGeneratorTemplateList, "templates">;
|
|
51
|
+
/**
|
|
52
|
+
* Удаляет шаблон документа.
|
|
53
|
+
*
|
|
54
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-delete.html
|
|
55
|
+
*/
|
|
56
|
+
delete(param: iBXRestParamCrmDocumentGeneratorTemplateDelete): import("../../../services/navvy").NavvySimple<null, null, iBXRestParamCrmDocumentGeneratorTemplateDelete | undefined>;
|
|
57
|
+
/**
|
|
58
|
+
* Возвращает карточку полей шаблона для указанного типа и элемента CRM.
|
|
59
|
+
* Переданные `values` применяются временно и не изменяют данные CRM.
|
|
60
|
+
*
|
|
61
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-get-fields.html
|
|
62
|
+
*/
|
|
63
|
+
getFields(param: iBXRestParamCrmDocumentGeneratorTemplateGetFields): import("../../../services/navvy").NavvySimple<TemplateFieldsResult, Record<string, iBXRestCrmDocumentGeneratorField>, iBXRestParamCrmDocumentGeneratorTemplateGetFields | undefined>;
|
|
64
|
+
}
|
|
65
|
+
export {};
|
package/request-navvy/crm.d.ts
CHANGED
|
@@ -7,7 +7,10 @@ import { BXRestNavvyCrmEnum } from './crm/enum/index';
|
|
|
7
7
|
import { BXRestNavvyCrmMultifield } from './crm/multifield';
|
|
8
8
|
import { BXRestNavvyCrmAutomation } from './crm/automation/index';
|
|
9
9
|
import { BXRestNavvyCrmAutomatedSolution } from './crm/automatedsolution';
|
|
10
|
+
import { BXRestNavvyCrmDocumentGenerator } from './crm/documentgenerator/index';
|
|
10
11
|
export declare class BXRestNavvyCrm {
|
|
12
|
+
/** Генератор документов CRM (`crm.documentgenerator.*`). */
|
|
13
|
+
readonly documentGenerator: BXRestNavvyCrmDocumentGenerator;
|
|
11
14
|
/** Цифровые рабочие места (`crm.automatedsolution.*`). */
|
|
12
15
|
readonly automatedSolution: BXRestNavvyCrmAutomatedSolution;
|
|
13
16
|
/** Автоматизация CRM (`crm.automation.*`). */
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { iBXRestPagination } from '../../typification/rest/base/api-pagination-bx';
|
|
2
|
+
import { NavvyPagBase } from './extends/navvy-pag-base';
|
|
3
|
+
type KeyedObjectResult<K extends string, T> = Record<K, Record<string, T> | undefined>;
|
|
4
|
+
/** Пагинация для методов, возвращающих коллекцию как объект с идентификаторами в ключах. */
|
|
5
|
+
export declare class NavvyPagNavResultKeyObject<T, R, P extends iBXRestPagination, K extends string> extends NavvyPagBase<KeyedObjectResult<K, T>, R[], P> {
|
|
6
|
+
private readonly key;
|
|
7
|
+
constructor(url: string[], param: P, key: K, mapResult?: (param: KeyedObjectResult<K, T> | undefined) => R[] | undefined);
|
|
8
|
+
resAll(): import("rxjs").Observable<R[] | undefined>;
|
|
9
|
+
private resultAllEnd;
|
|
10
|
+
private mapResult;
|
|
11
|
+
}
|
|
12
|
+
export {};
|
package/services/navvy.d.ts
CHANGED
|
@@ -5,12 +5,14 @@ import { NavvyPagNavWithUselessKey } from './navvy/navvy-pag-nav-with-useless-ke
|
|
|
5
5
|
import { NavvyPagNavTasks } from './navvy/navvy-pag-nav-tasks';
|
|
6
6
|
import { NavvyPag } from './navvy/navvy-pag';
|
|
7
7
|
import { NavvyPagNavResultKey } from './navvy/navvy-pag-nav-result-key';
|
|
8
|
+
import { NavvyPagNavResultKeyObject } from './navvy/navvy-pag-nav-result-key-object';
|
|
8
9
|
export * from './navvy/navvy-simple';
|
|
9
10
|
export * from './navvy/navvy-alternative-pagination-navigation';
|
|
10
11
|
export * from './navvy/navvy-pag-nav-with-useless-key';
|
|
11
12
|
export * from './navvy/navvy-pag-nav-tasks';
|
|
12
13
|
export * from './navvy/navvy-pag-nav-result-key';
|
|
13
14
|
export * from './navvy/navvy-pag';
|
|
15
|
+
export * from './navvy/navvy-pag-nav-result-key-object';
|
|
14
16
|
export * from './navvy/navvy-support';
|
|
15
17
|
export declare class Navvy {
|
|
16
18
|
simple<T, R = T, A = undefined>(url: string[], arg?: A, map?: (param: T | undefined) => R | undefined): NavvySimple<T, R, (A & ({} | null)) | undefined>;
|
|
@@ -27,6 +29,7 @@ export declare class Navvy {
|
|
|
27
29
|
tasks: T[] | undefined;
|
|
28
30
|
} | undefined) => R[] | undefined): NavvyPagNavTasks<T, R, A>;
|
|
29
31
|
pagNavResultKey<T, R, A extends iBXRestPagination, K extends string>(url: string[], arg: A, key: K, map?: (param: Record<K, T[] | undefined> | undefined) => R[] | undefined): NavvyPagNavResultKey<T, R, A, K>;
|
|
32
|
+
pagNavResultKeyObject<T, R, A extends iBXRestPagination, K extends string>(url: string[], arg: A, key: K, map?: (param: Record<K, Record<string, T> | undefined> | undefined) => R[] | undefined): NavvyPagNavResultKeyObject<T, R, A, K>;
|
|
30
33
|
pagNavWithUselessKey<T, R, A extends iBXRestPagination>(url: string[], arg: A, map?: (param: Record<string, T> | undefined) => R[] | undefined): NavvyPagNavWithUselessKey<T, R, A>;
|
|
31
34
|
alterPagNav<T, R, A extends iBXRestAlternativePagination>(url: string[], arg: A, map?: (param: T[] | undefined) => R[] | undefined): NavvyAlterPagNav<T, R, A>;
|
|
32
35
|
}
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
import { iBXRestPagination } from '../base/api-pagination-bx';
|
|
2
|
+
import { iBXRestYesNo } from '../base/yes-no';
|
|
3
|
+
/** Произвольные значения полей шаблона или документа. */
|
|
4
|
+
export type iBXRestDocumentGeneratorValues = Record<string, unknown>;
|
|
5
|
+
/** Настройки генератора последовательных номеров. */
|
|
6
|
+
export interface iBXRestCrmDocumentGeneratorNumeratorSequenceSettings {
|
|
7
|
+
start?: number;
|
|
8
|
+
step?: number;
|
|
9
|
+
length?: number;
|
|
10
|
+
padString?: string;
|
|
11
|
+
periodicBy?: '' | 'day' | 'month' | 'year' | null;
|
|
12
|
+
timezone?: string | null;
|
|
13
|
+
isDirectNumeration?: boolean;
|
|
14
|
+
}
|
|
15
|
+
/** Настройки нумератора документов. */
|
|
16
|
+
export interface iBXRestCrmDocumentGeneratorNumeratorSettings {
|
|
17
|
+
Bitrix_Main_Numerator_Generator_SequentNumberGenerator?: iBXRestCrmDocumentGeneratorNumeratorSequenceSettings;
|
|
18
|
+
}
|
|
19
|
+
/** Нумератор документов. */
|
|
20
|
+
export interface iBXRestCrmDocumentGeneratorNumerator {
|
|
21
|
+
id: number | string;
|
|
22
|
+
name: string;
|
|
23
|
+
template: string;
|
|
24
|
+
code?: string | null;
|
|
25
|
+
settings?: iBXRestCrmDocumentGeneratorNumeratorSettings;
|
|
26
|
+
}
|
|
27
|
+
export interface iBXRestParamCrmDocumentGeneratorNumeratorAdd {
|
|
28
|
+
fields: {
|
|
29
|
+
name: string;
|
|
30
|
+
template: string;
|
|
31
|
+
settings?: iBXRestCrmDocumentGeneratorNumeratorSettings;
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
export interface iBXRestParamCrmDocumentGeneratorNumeratorUpdate {
|
|
35
|
+
id: number;
|
|
36
|
+
fields: {
|
|
37
|
+
name?: string;
|
|
38
|
+
template?: string;
|
|
39
|
+
settings?: iBXRestCrmDocumentGeneratorNumeratorSettings;
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
export interface iBXRestParamCrmDocumentGeneratorNumeratorGet {
|
|
43
|
+
id: number;
|
|
44
|
+
}
|
|
45
|
+
export type iBXRestParamCrmDocumentGeneratorNumeratorList = iBXRestPagination;
|
|
46
|
+
export interface iBXRestParamCrmDocumentGeneratorNumeratorDelete {
|
|
47
|
+
id: number;
|
|
48
|
+
}
|
|
49
|
+
/** Файл шаблона в формате `[имя файла, содержимое Base64]`. */
|
|
50
|
+
export type iBXRestCrmDocumentGeneratorTemplateFile = [fileName: string, base64Content: string];
|
|
51
|
+
/** Поля шаблона документа. */
|
|
52
|
+
export interface iBXRestCrmDocumentGeneratorTemplateFields {
|
|
53
|
+
name: string;
|
|
54
|
+
file: iBXRestCrmDocumentGeneratorTemplateFile;
|
|
55
|
+
numeratorId: number;
|
|
56
|
+
region: string;
|
|
57
|
+
entityTypeId: (number | string)[];
|
|
58
|
+
users?: string[];
|
|
59
|
+
active?: iBXRestYesNo;
|
|
60
|
+
withStamps?: iBXRestYesNo;
|
|
61
|
+
sort?: number;
|
|
62
|
+
}
|
|
63
|
+
/** Шаблон документа. */
|
|
64
|
+
export interface iBXRestCrmDocumentGeneratorTemplate {
|
|
65
|
+
id: number | string;
|
|
66
|
+
name: string;
|
|
67
|
+
region: string;
|
|
68
|
+
code?: string | null;
|
|
69
|
+
download?: string;
|
|
70
|
+
downloadMachine?: string;
|
|
71
|
+
active?: iBXRestYesNo;
|
|
72
|
+
moduleId?: string;
|
|
73
|
+
numeratorId?: number | string;
|
|
74
|
+
withStamps?: iBXRestYesNo;
|
|
75
|
+
users?: string[] | Record<string, string>;
|
|
76
|
+
isDeleted?: iBXRestYesNo;
|
|
77
|
+
sort?: number | string;
|
|
78
|
+
entityTypeId?: string[];
|
|
79
|
+
createTime?: string;
|
|
80
|
+
updateTime?: string;
|
|
81
|
+
}
|
|
82
|
+
export interface iBXRestParamCrmDocumentGeneratorTemplateAdd {
|
|
83
|
+
fields: iBXRestCrmDocumentGeneratorTemplateFields;
|
|
84
|
+
}
|
|
85
|
+
export interface iBXRestParamCrmDocumentGeneratorTemplateUpdate {
|
|
86
|
+
id: number;
|
|
87
|
+
fields: Partial<iBXRestCrmDocumentGeneratorTemplateFields>;
|
|
88
|
+
}
|
|
89
|
+
export interface iBXRestParamCrmDocumentGeneratorTemplateGet {
|
|
90
|
+
id: number;
|
|
91
|
+
}
|
|
92
|
+
export interface iBXRestParamCrmDocumentGeneratorTemplateList extends iBXRestPagination {
|
|
93
|
+
select?: string[];
|
|
94
|
+
filter?: Record<string, unknown>;
|
|
95
|
+
order?: Record<string, 'ASC' | 'DESC'>;
|
|
96
|
+
}
|
|
97
|
+
export interface iBXRestParamCrmDocumentGeneratorTemplateDelete {
|
|
98
|
+
id: number;
|
|
99
|
+
}
|
|
100
|
+
export interface iBXRestParamCrmDocumentGeneratorTemplateGetFields {
|
|
101
|
+
id: number;
|
|
102
|
+
entityTypeId: number;
|
|
103
|
+
entityId?: number;
|
|
104
|
+
values?: iBXRestDocumentGeneratorValues;
|
|
105
|
+
}
|
|
106
|
+
/** Описание вычисляемого поля шаблона или документа. */
|
|
107
|
+
export interface iBXRestCrmDocumentGeneratorField {
|
|
108
|
+
title?: string;
|
|
109
|
+
value?: unknown;
|
|
110
|
+
required?: iBXRestYesNo;
|
|
111
|
+
group?: string[];
|
|
112
|
+
chain?: unknown;
|
|
113
|
+
default?: unknown;
|
|
114
|
+
type?: string;
|
|
115
|
+
[key: string]: unknown;
|
|
116
|
+
}
|
|
117
|
+
/** Сводная информация о товарах документа. */
|
|
118
|
+
export interface iBXRestCrmDocumentGeneratorDocumentProducts {
|
|
119
|
+
currencyId?: string;
|
|
120
|
+
totalSum?: string;
|
|
121
|
+
totalRows?: number;
|
|
122
|
+
}
|
|
123
|
+
/** Документ генератора документов CRM. */
|
|
124
|
+
export interface iBXRestCrmDocumentGeneratorDocument {
|
|
125
|
+
id: number | string;
|
|
126
|
+
title: string;
|
|
127
|
+
number: string;
|
|
128
|
+
createTime?: string;
|
|
129
|
+
updateTime?: string;
|
|
130
|
+
createdBy?: number | string | null;
|
|
131
|
+
updatedBy?: number | string | null;
|
|
132
|
+
changeStampsEnabled?: boolean;
|
|
133
|
+
changeStampsDisabledReason?: string;
|
|
134
|
+
changeQrCodeEnabled?: boolean;
|
|
135
|
+
qrCodeEnabled?: boolean;
|
|
136
|
+
changeQrCodeDisabledReason?: string;
|
|
137
|
+
products?: iBXRestCrmDocumentGeneratorDocumentProducts;
|
|
138
|
+
stampsEnabled?: boolean;
|
|
139
|
+
isTransformationError?: boolean;
|
|
140
|
+
values?: iBXRestDocumentGeneratorValues;
|
|
141
|
+
templateId?: number | string;
|
|
142
|
+
entityId?: number | string;
|
|
143
|
+
entityTypeId?: number | string;
|
|
144
|
+
fileId?: number | string;
|
|
145
|
+
imageId?: number | string;
|
|
146
|
+
pdfId?: number | string;
|
|
147
|
+
emailDiskFile?: number | string;
|
|
148
|
+
pullTag?: string;
|
|
149
|
+
downloadUrl?: string;
|
|
150
|
+
downloadUrlMachine?: string;
|
|
151
|
+
publicUrl?: string | null;
|
|
152
|
+
imageUrl?: string;
|
|
153
|
+
imageUrlMachine?: string;
|
|
154
|
+
pdfUrl?: string;
|
|
155
|
+
pdfUrlMachine?: string;
|
|
156
|
+
}
|
|
157
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentAdd {
|
|
158
|
+
templateId: number;
|
|
159
|
+
entityTypeId: number;
|
|
160
|
+
entityId: number;
|
|
161
|
+
values?: iBXRestDocumentGeneratorValues;
|
|
162
|
+
stampsEnabled?: 0 | 1;
|
|
163
|
+
fields?: Record<string, iBXRestCrmDocumentGeneratorField>;
|
|
164
|
+
}
|
|
165
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentUpdate {
|
|
166
|
+
id: number;
|
|
167
|
+
values?: iBXRestDocumentGeneratorValues;
|
|
168
|
+
stampsEnabled?: 0 | 1;
|
|
169
|
+
}
|
|
170
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentGet {
|
|
171
|
+
id: number;
|
|
172
|
+
}
|
|
173
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentList extends iBXRestPagination {
|
|
174
|
+
select?: string[];
|
|
175
|
+
filter?: Record<string, unknown>;
|
|
176
|
+
order?: Record<string, 'ASC' | 'DESC'>;
|
|
177
|
+
}
|
|
178
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentDelete {
|
|
179
|
+
id: number;
|
|
180
|
+
}
|
|
181
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentEnablePublicUrl {
|
|
182
|
+
id: number;
|
|
183
|
+
status?: 0 | 1;
|
|
184
|
+
}
|
|
185
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentUpload {
|
|
186
|
+
fields: {
|
|
187
|
+
entityTypeId: number;
|
|
188
|
+
entityId: number;
|
|
189
|
+
fileContent: string;
|
|
190
|
+
region: string;
|
|
191
|
+
title: string;
|
|
192
|
+
number: string;
|
|
193
|
+
pdfContent?: string;
|
|
194
|
+
imageContent?: string;
|
|
195
|
+
};
|
|
196
|
+
}
|
|
197
|
+
export interface iBXRestParamCrmDocumentGeneratorDocumentGetFields {
|
|
198
|
+
id: number;
|
|
199
|
+
values?: iBXRestDocumentGeneratorValues;
|
|
200
|
+
}
|