bx-rest 0.9.10 → 0.10.0

package/functions/serializeBitrixParams.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Serializes nested REST parameters using the indexed bracket notation
+ * expected by Bitrix, for example: fields[PHONE][0][VALUE].
+ */
+export declare function serializeBitrixParams(params: unknown): string;

package/map/crm/automatedsolution.d.ts

@@ -0,0 +1,7 @@
+import { iBXRestCrmAutomatedSolution, iBXRestCrmAutomatedSolutionListResult, iBXRestCrmAutomatedSolutionResult } from '../../typification/rest/crm';
+export declare class BXRestMapCrmAutomatedSolution {
+    /** Возвращает цифровое рабочее место из контейнера REST-ответа. */
+    static get(v: iBXRestCrmAutomatedSolutionResult | undefined): iBXRestCrmAutomatedSolution | undefined;
+    /** Возвращает список цифровых рабочих мест из контейнера REST-ответа. */
+    static list(v: iBXRestCrmAutomatedSolutionListResult | undefined): iBXRestCrmAutomatedSolution[] | undefined;
+}

package/map/crm/index.d.ts

@@ -3,3 +3,4 @@ export * from './deal';
 export * from './contact';
 export * from './company';
 export * from './quote';
+export * from './automatedsolution';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.9.10",
+  "version": "0.10.0",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",
@@ -35,7 +35,7 @@
     "just-flatten-it": "^5.2.0",
     "just-values": "^2.2.0",
     "luxon": "^3.4.4",
-    "qs": "^6.13.1",
+    "qs-esm": "^8.0.1",
     "rxjs": "^7.8.1",
     "snake-camel-types": "^1.0.1",
     "ts-case-convert": "^2.1.0",

package/request-navvy/crm/automatedsolution.d.ts

@@ -0,0 +1,56 @@
+import { iBXRestCrmAutomatedSolution, iBXRestCrmAutomatedSolutionFields, iBXRestCrmAutomatedSolutionResult, iBXRestParamCrmAutomatedSolutionAdd, iBXRestParamCrmAutomatedSolutionDelete, iBXRestParamCrmAutomatedSolutionGet, iBXRestParamCrmAutomatedSolutionList, iBXRestParamCrmAutomatedSolutionUpdate } from '../../typification/rest/crm';
+export declare class BXRestNavvyCrmAutomatedSolution {
+    url: {
+        /** Создает новое цифровое рабочее место. */
+        add: string[];
+        /** Возвращает цифровое рабочее место по идентификатору. */
+        get: string[];
+        /** Возвращает список цифровых рабочих мест. */
+        list: string[];
+        /** Обновляет существующее цифровое рабочее место. */
+        update: string[];
+        /** Удаляет цифровое рабочее место. */
+        delete: string[];
+        /** Возвращает описание полей цифрового рабочего места. */
+        fields: string[];
+    };
+    private Navvy;
+    /**
+     * Создает новое цифровое рабочее место.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-add.html
+     */
+    add(param: iBXRestParamCrmAutomatedSolutionAdd): import("../../services/navvy").NavvySimple<iBXRestCrmAutomatedSolutionResult, iBXRestCrmAutomatedSolution, iBXRestParamCrmAutomatedSolutionAdd | undefined>;
+    /**
+     * Возвращает цифровое рабочее место по идентификатору.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-get.html
+     */
+    get(param: iBXRestParamCrmAutomatedSolutionGet): import("../../services/navvy").NavvySimple<iBXRestCrmAutomatedSolutionResult, iBXRestCrmAutomatedSolution, iBXRestParamCrmAutomatedSolutionGet | undefined>;
+    /**
+     * Возвращает список цифровых рабочих мест.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-list.html
+     */
+    list(param?: iBXRestParamCrmAutomatedSolutionList): import("../../services/navvy").NavvyPagNavResultKey<iBXRestCrmAutomatedSolution, iBXRestCrmAutomatedSolution, iBXRestParamCrmAutomatedSolutionList, "automatedSolutions">;
+    /**
+     * Обновляет существующее цифровое рабочее место.
+     * При передаче `typeIds` список привязанных смарт-процессов перезаписывается целиком.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-update.html
+     */
+    update(param: iBXRestParamCrmAutomatedSolutionUpdate): import("../../services/navvy").NavvySimple<iBXRestCrmAutomatedSolutionResult, iBXRestCrmAutomatedSolution, iBXRestParamCrmAutomatedSolutionUpdate | undefined>;
+    /**
+     * Удаляет цифровое рабочее место.
+     * Удаление возможно только если к рабочему месту не привязаны смарт-процессы.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-delete.html
+     */
+    delete(param: iBXRestParamCrmAutomatedSolutionDelete): import("../../services/navvy").NavvySimple<null, null, iBXRestParamCrmAutomatedSolutionDelete | undefined>;
+    /**
+     * Возвращает описание полей цифрового рабочего места.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automated-solution/crm-automated-solution-fields.html
+     */
+    fields(): import("../../services/navvy").NavvySimple<iBXRestCrmAutomatedSolutionFields, iBXRestCrmAutomatedSolutionFields, undefined>;
+}

package/request-navvy/crm.d.ts

@@ -6,7 +6,10 @@ import { BXRestNavvyCrmQuote } from './crm/quote/index';
 import { BXRestNavvyCrmEnum } from './crm/enum/index';
 import { BXRestNavvyCrmMultifield } from './crm/multifield';
 import { BXRestNavvyCrmAutomation } from './crm/automation/index';
+import { BXRestNavvyCrmAutomatedSolution } from './crm/automatedsolution';
 export declare class BXRestNavvyCrm {
+    /** Цифровые рабочие места (`crm.automatedsolution.*`). */
+    readonly automatedSolution: BXRestNavvyCrmAutomatedSolution;
     /** Автоматизация CRM (`crm.automation.*`). */
     readonly automation: BXRestNavvyCrmAutomation;
     /** Перечисления CRM (`crm.enum.*`). */

package/services/http/HttpBX.d.ts

@@ -27,7 +27,7 @@ export declare class HttpBXServices extends HttpServices {
      */
     get<T>(name: string[], params?: any): Observable<iBXRestAnswer<T> | undefined>;
     httpPost<T>(url: string, params?: any): Observable<T | undefined>;
-    serializeBitrixParams(obj: any, prefix?: string): string;
+    serializeBitrixParams(params: unknown): string;
     httpGet<T>(url: string, params?: any): Observable<T | undefined>;
     getNameMethod(arr: string[]): string;
 }

package/services/navvy/navvy-pag-nav-result-key.d.ts

@@ -0,0 +1,13 @@
+import { iBXRestPagination } from '../../typification/rest/base/api-pagination-bx';
+import { ReturnTypeNavvy } from './navvy-support';
+import { NavvyPagBase } from './extends/navvy-pag-base';
+type KeyedResult<K extends string, T> = Record<K, T[] | undefined>;
+export declare class NavvyPagNavResultKey<T, R, P extends iBXRestPagination, K extends string> extends NavvyPagBase<KeyedResult<K, T>, R[], P> {
+    private readonly key;
+    save: ReturnTypeNavvy<T, R>[];
+    constructor(url: string[], param: P, key: K, map?: (param: KeyedResult<K, T> | undefined) => R[] | undefined);
+    resAll(): import("rxjs").Observable<ReturnTypeNavvy<T, R>[]>;
+    private resultAllEnd;
+    private mapResForGetAll;
+}
+export {};

package/services/navvy.d.ts

@@ -4,10 +4,12 @@ import { iBXRestAlternativePagination, iBXRestPagination } from '../typification
 import { NavvyPagNavWithUselessKey } from './navvy/navvy-pag-nav-with-useless-key';
 import { NavvyPagNavTasks } from './navvy/navvy-pag-nav-tasks';
 import { NavvyPag } from './navvy/navvy-pag';
+import { NavvyPagNavResultKey } from './navvy/navvy-pag-nav-result-key';
 export * from './navvy/navvy-simple';
 export * from './navvy/navvy-alternative-pagination-navigation';
 export * from './navvy/navvy-pag-nav-with-useless-key';
 export * from './navvy/navvy-pag-nav-tasks';
+export * from './navvy/navvy-pag-nav-result-key';
 export * from './navvy/navvy-pag';
 export * from './navvy/navvy-support';
 export declare class Navvy {
@@ -24,6 +26,7 @@ export declare class Navvy {
     pagNavTasks<T, R, A extends iBXRestPagination>(url: string[], arg: A, map?: (param: {
         tasks: T[] | undefined;
     } | undefined) => R[] | undefined): NavvyPagNavTasks<T, R, A>;
+    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>;
     pagNavWithUselessKey<T, R, A extends iBXRestPagination>(url: string[], arg: A, map?: (param: Record<string, T> | undefined) => R[] | undefined): NavvyPagNavWithUselessKey<T, R, A>;
     alterPagNav<T, R, A extends iBXRestAlternativePagination>(url: string[], arg: A, map?: (param: T[] | undefined) => R[] | undefined): NavvyAlterPagNav<T, R, A>;
 }

package/typification/rest/crm/automatedsolution/add.d.ts

@@ -0,0 +1,8 @@
+export interface iBXRestParamCrmAutomatedSolutionAdd {
+    fields: {
+        /** Название цифрового рабочего места. */
+        title: string;
+        /** Идентификаторы смарт-процессов, которые нужно привязать к рабочему месту. */
+        typeIds?: number[];
+    };
+}

package/typification/rest/crm/automatedsolution/automatedsolution.d.ts

@@ -0,0 +1,23 @@
+import { iBXRestCrmFieldDescription } from '../enum';
+/** Цифровое рабочее место CRM. */
+export interface iBXRestCrmAutomatedSolution {
+    /** Уникальный идентификатор цифрового рабочего места. */
+    id: number;
+    /** Название цифрового рабочего места. */
+    title: string;
+    /** Идентификаторы смарт-процессов, привязанных к рабочему месту. */
+    typeIds: number[];
+}
+/** Контейнер ответа методов `crm.automatedsolution.add`, `get` и `update`. */
+export interface iBXRestCrmAutomatedSolutionResult {
+    automatedSolution: iBXRestCrmAutomatedSolution;
+}
+/** Контейнер ответа метода `crm.automatedsolution.list`. */
+export interface iBXRestCrmAutomatedSolutionListResult {
+    automatedSolutions?: iBXRestCrmAutomatedSolution[];
+}
+/** Описание полей цифрового рабочего места. */
+export type iBXRestCrmAutomatedSolutionFields = Record<string, iBXRestCrmFieldDescription & {
+    /** Верхний регистр имени поля в REST API. */
+    upperName: string;
+}>;

package/typification/rest/crm/automatedsolution/delete.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamCrmAutomatedSolutionDelete {
+    /** Идентификатор цифрового рабочего места. */
+    id: number | string;
+}

package/typification/rest/crm/automatedsolution/get.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamCrmAutomatedSolutionGet {
+    /** Идентификатор цифрового рабочего места. */
+    id: number | string;
+}

package/typification/rest/crm/automatedsolution/index.d.ts

@@ -0,0 +1,6 @@
+export * from './add';
+export * from './update';
+export * from './get';
+export * from './list';
+export * from './delete';
+export * from './automatedsolution';

package/typification/rest/crm/automatedsolution/list.d.ts

@@ -0,0 +1,7 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamCrmAutomatedSolutionList extends iBXRestPagination {
+    /** Сортировка по полям `id` и `title`. */
+    order?: Record<string, 'ASC' | 'DESC' | 'asc' | 'desc'>;
+    /** Фильтр по полям `id` и `title`, включая REST-префиксы операторов. */
+    filter?: Record<string, any>;
+}

package/typification/rest/crm/automatedsolution/update.d.ts

@@ -0,0 +1,10 @@
+export interface iBXRestParamCrmAutomatedSolutionUpdate {
+    /** Идентификатор цифрового рабочего места. */
+    id: number | string;
+    fields: {
+        /** Название цифрового рабочего места. */
+        title?: string;
+        /** Полный список идентификаторов смарт-процессов, которые должны быть привязаны к рабочему месту. */
+        typeIds?: number[];
+    };
+}

package/typification/rest/crm/index.d.ts

@@ -6,3 +6,4 @@ export * from './quote';
 export * from './enum';
 export * from './multifield';
 export * from './automation';
+export * from './automatedsolution';