bx-rest 0.9.9 → 0.9.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.9.9",
+  "version": "0.9.10",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",

package/request-navvy/crm/automation/index.d.ts

@@ -0,0 +1,42 @@
+import { iBXRestCrmAutomationTrigger, iBXRestParamCrmAutomationTrigger, iBXRestParamCrmAutomationTriggerAdd, iBXRestParamCrmAutomationTriggerDelete, iBXRestParamCrmAutomationTriggerExecute } from '../../../typification/rest/crm';
+/** Методы автоматизации CRM (`crm.automation.*`). */
+export declare class BXRestNavvyCrmAutomation {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Запускает webhook-триггер, настроенный в автоматизации CRM.
+     * Значение `target` передается в формате `TYPENAME_ID`, например `DEAL_25`.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/crm-automation-trigger.html
+     */
+    readonly trigger: ((param: iBXRestParamCrmAutomationTrigger) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTrigger | undefined>) & {
+        /**
+         * Добавляет триггер приложения.
+         * Метод доступен только в контексте приложения; повторный `CODE` обновит `NAME`.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-add.html
+         */
+        add: (param: iBXRestParamCrmAutomationTriggerAdd) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTriggerAdd | undefined>;
+        /**
+         * Возвращает список триггеров приложения.
+         * Метод доступен только в контексте приложения.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-list.html
+         */
+        list: () => import("../../../services/navvy").NavvySimple<iBXRestCrmAutomationTrigger[], iBXRestCrmAutomationTrigger[], undefined>;
+        /**
+         * Запускает триггер приложения для конкретного объекта CRM.
+         * Тип объекта берется из `crm.enum.ownertype`, идентификатор объекта - из CRM-элемента.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-execute.html
+         */
+        execute: (param: iBXRestParamCrmAutomationTriggerExecute) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTriggerExecute | undefined>;
+        /**
+         * Удаляет триггер приложения.
+         * Метод доступен только в контексте приложения.
+         *
+         * @see https://apidocs.bitrix24.ru/api-reference/crm/automation/triggers/crm-automation-trigger-delete.html
+         */
+        delete: (param: iBXRestParamCrmAutomationTriggerDelete) => import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAutomationTriggerDelete | undefined>;
+    };
+}

package/request-navvy/crm.d.ts

@@ -5,7 +5,10 @@ import { BXRestNavvyCrmCompany } from './crm/company';
 import { BXRestNavvyCrmQuote } from './crm/quote/index';
 import { BXRestNavvyCrmEnum } from './crm/enum/index';
 import { BXRestNavvyCrmMultifield } from './crm/multifield';
+import { BXRestNavvyCrmAutomation } from './crm/automation/index';
 export declare class BXRestNavvyCrm {
+    /** Автоматизация CRM (`crm.automation.*`). */
+    readonly automation: BXRestNavvyCrmAutomation;
     /** Перечисления CRM (`crm.enum.*`). */
     readonly enum: BXRestNavvyCrmEnum;
     /** Описание множественных полей CRM (`crm.multifield.*`). */

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

@@ -0,0 +1,35 @@
+/** Параметры запуска webhook-триггера, настроенного в автоматизации CRM. */
+export interface iBXRestParamCrmAutomationTrigger {
+    /** Целевой объект автоматизации в формате `TYPENAME_ID`, например `DEAL_25`. */
+    target: string;
+    /** Символьный код триггера из настроек автоматизации CRM. */
+    code?: string;
+}
+/** Параметры регистрации триггера приложения. */
+export interface iBXRestParamCrmAutomationTriggerAdd {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+    /** Название триггера. */
+    NAME: string;
+}
+/** Триггер приложения, зарегистрированный в автоматизации CRM. */
+export interface iBXRestCrmAutomationTrigger {
+    /** Название триггера. */
+    NAME: string;
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+}
+/** Параметры запуска триггера приложения для объекта CRM. */
+export interface iBXRestParamCrmAutomationTriggerExecute {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+    /** Тип объекта CRM из справочника `crm.enum.ownertype`. */
+    OWNER_TYPE_ID: number;
+    /** Идентификатор элемента CRM. */
+    OWNER_ID: number;
+}
+/** Параметры удаления триггера приложения. */
+export interface iBXRestParamCrmAutomationTriggerDelete {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+}

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

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