bx-rest 0.4.11 → 0.4.12

package/methods.d.ts

@@ -0,0 +1,581 @@
+export declare const methods: {
+    user: {
+        admin: string[];
+        get: string[];
+        current: string[];
+        update: string[];
+        search: string[];
+        access: string[];
+        fields: string[];
+    };
+    tasks: {
+        task: {
+            /**
+             * Создает задачу
+             */
+            add: string[];
+            /**
+             * Позволяет принять задачу
+             */
+            approve: string[];
+            /**
+             * Переводит задачу в статус «завершена»
+             */
+            complete: string[];
+            counters: {
+                /**
+                 * Получает счетчики пользователя
+                 */
+                get: string[];
+            };
+            /**
+             * Переводит задачу в статус «отложена»
+             */
+            defer: string[];
+            /**
+             * Метод для делегирования задачи
+             */
+            delegate: string[];
+            /**
+             * Удаляет задачу
+             */
+            delete: string[];
+            /**
+             * Позволяет отклонить задачу
+             */
+            disapprove: string[];
+            favorite: {
+                /**
+                 * Добавляет задачи в "Избранное"
+                 */
+                add: string[];
+                /**
+                 * Удаляет задачи из "Избранного"
+                 */
+                delete: string[];
+            };
+            files: {
+                /**
+                 * Прикрепляет загруженный на диск файл к задаче
+                 */
+                attach: string[];
+            };
+            /**
+             * Возвращает информацию о конкретной задаче
+             */
+            get: string[];
+            /**
+             * Возвращает все доступные поля
+             */
+            getFields: string[];
+            /**
+             * Метод для проверки доступа к задаче
+             */
+            getAccess: string[];
+            history: {
+                /**
+                 * Получает историю задачи
+                 */
+                list: string[];
+            };
+            /**
+             * Возвращает массив задач, каждая из которых содержит массив полей
+             */
+            list: string[];
+            /**
+             * Останавливает выполнение задачи, переводя ее в статус "ждет выполнения"
+             */
+            pause: string[];
+            /**
+             * Возобновляет задачу после ее завершения
+             */
+            renew: string[];
+            /**
+             * Переводит задачу в статус «выполняется»
+             */
+            start: string[];
+            /**
+             * Позволяет наблюдать за задачей
+             */
+            startWatch: string[];
+            /**
+             * Останавливает наблюдение за задачей
+             */
+            stopwatch: string[];
+            /**
+             * Обновляет задачу
+             */
+            update: string[];
+            result: {
+                /**
+                 *  Просмотр списка результатов к задаче
+                 */
+                list: string[];
+                /**
+                 * Создание результата задачи из комментария
+                 */
+                addFromComment: string[];
+                /**
+                 * Удаление результата задачи по комментарию из которого он был создан
+                 */
+                deleteFromComment: string[];
+            };
+        };
+    };
+    task: {
+        elapsedItem: {
+            /**
+             * Возвращает список методов и их описание
+             */
+            getManifest: string[];
+            /**
+             * Возвращает список записей о затраченном времени по задаче
+             */
+            getList: string[];
+            /**
+             * Возвращает запись о затраченном времени по ее идентификатору
+             */
+            get: string[];
+            /**
+             * Добавляет затраченное время к задаче
+             */
+            add: string[];
+            /**
+             * Удаляет запись о затраченном времени
+             */
+            delete: string[];
+            /**
+             * Проверяет разрешено ли действие
+             */
+            isActionAllowed: string[];
+            /**
+             * Изменяет параметры записи о затраченном времени
+             */
+            update: string[];
+        };
+        commentItem: {
+            /**
+             * Возвращает список методов и их описание
+             */
+            getManifest: string[];
+            /**
+             * Возвращает список комментариев к задаче
+             */
+            getList: string[];
+            /**
+             * Возвращает комментарий к задаче
+             */
+            get: string[];
+            /**
+             * Создает новый комментарий к задаче
+             */
+            add: string[];
+            /**
+             * Обновляет данные комментария
+             */
+            update: string[];
+            /**
+             * Удаляет комментарий
+             */
+            delete: string[];
+            /**
+             * Проверяет, разрешено ли действие
+             */
+            isActionAllowed: string[];
+        };
+        planner: {
+            getList: string[];
+        };
+        item: {
+            userField: {
+                /**
+                 * Получение всех доступных полей свойства
+                 */
+                getFields: string[];
+                /**
+                 * Получение всех доступных типов данных
+                 */
+                getTypes: string[];
+                /**
+                 * Создание нового свойства
+                 */
+                add: string[];
+                /**
+                 * Получение свойства по идентификатору
+                 */
+                get: string[];
+                /**
+                 * Получение списка свойств
+                 */
+                getList: string[];
+                /**
+                 * Редактирование параметров свойства
+                 */
+                update: string[];
+                /**
+                 * Удаление свойства
+                 */
+                delete: string[];
+            };
+        };
+    };
+    timeman: {
+        /**
+         * Получение настроек рабочего времени пользователя
+         */
+        settings: string[];
+        /**
+         * Получение информации о текущем рабочем дне пользователя
+         */
+        status: string[];
+        /**
+         * Начать новый рабочий день либо возобновить закрытый или приостановленный
+         */
+        open: string[];
+        /**
+         * Закрыть рабочий день
+         */
+        close: string[];
+        /**
+         * Приостановить рабочий день
+         */
+        pause: string[];
+    };
+    sonet_group: {
+        /**
+         * Создает группу соцсети, используя метод API CSocNetGroup::CreateGroup(), указывая владельцем группы текущего пользователя
+         */
+        create: string[];
+        /**
+         * Удаляет группу соцсети
+         */
+        delete: string[];
+        /**
+         * Возвращает массив групп соцсети, каждая из которых содержит массив полей, осуществляя вызов CSocNetGroup::GetList(), при этом возвращаются только те группы, которые доступны пользователю по правам
+         */
+        get: string[];
+        /**
+         * Изменяет владельца группы
+         */
+        setOwner: string[];
+        /**
+         * Изменяет параметры группы соцсети, используя метод API CSocNetGroup::Update()
+         */
+        update: string[];
+    };
+    server: {
+        time: string[];
+    };
+    log: {
+        blogpost: {
+            /**
+             * Добавляет в Живую Ленту сообщение от имени текущего пользователя
+             */
+            add: string[];
+            /**
+             * Возвращает массив с доступными текущему пользователю сообщениями Живой ленты. Каждое из сообщений представляет собой массив значений полей (включая пользовательские поля)
+             */
+            get: string[];
+            /**
+             * Удаляет сообщение Живой Ленты
+             */
+            delete: string[];
+            /**
+             * Добавляет получателей в сообщение Живой Ленты
+             */
+            share: string[];
+            /**
+             * Изменяет сообщение Живой Ленты
+             */
+            update: string[];
+        };
+        blogcomment: {
+            /**
+             * Добавляет комментарий к сообщению Живой ленты
+             */
+            add: string[];
+        };
+    };
+    lists: {
+        /**
+         * Метод создаёт список
+         */
+        add: string[];
+        /**
+         * Метод удаляет список
+         */
+        delete: string[];
+        /**
+         * Метод возвращает данные по спискам
+         */
+        get: string[];
+        /**
+         * Метод обновляет существующий список
+         */
+        update: string[];
+        /**
+         * Метод возвращает id типа инфоблока
+         */
+        getIBlockTypeId: string[];
+        element: {
+            /**
+             * Метод создаёт элемент списка
+             */
+            add: string[];
+            /**
+             * Метод удаляет элемент списка TODO: Реализовать
+             */
+            delete: string[];
+            /**
+             * Метод возвращает список элементов или элемент
+             */
+            get: string[];
+            /**
+             * Метод обновляет элемент списка TODO: Реализовать
+             */
+            update: string[];
+            /**
+             * Метод возвращает путь к файлу TODO: Реализовать
+             */
+            getFileUrl: string[];
+        };
+        field: {
+            /**
+             * Метод создает поле списка
+             */
+            add: string[];
+            /**
+             * Метод удаляет поле списка
+             */
+            delete: string[];
+            /**
+             * Метод возвращает данные поля
+             */
+            get: string[];
+            type: {
+                /**
+                 * Метод возвращает доступные типа полей для указанного списка
+                 */
+                get: string[];
+            };
+            /**
+             * Метод обновляет поле списка
+             */
+            update: string[];
+        };
+    };
+    im: {
+        chat: {
+            add: string[];
+            updateTitle: string[];
+            updateColor: string[];
+            updateAvatar: string[];
+            setOwner: string[];
+            get: string[];
+            mute: string[];
+        };
+    };
+    disk: {
+        file: {
+            /**
+             * Возвращает описание полей файла
+             */
+            getFields: string[];
+            /**
+             * Возвращает файл по идентификатору
+             */
+            get: string[];
+            /**
+             * Переименовывает файл
+             */
+            rename: string[];
+            /**
+             * Копирует файл в указанную папку
+             */
+            copyTo: string[];
+            /**
+             * Перемещает файл в указанную папку
+             */
+            moveto: string[];
+            /**
+             * Уничтожает файл навсегда
+             */
+            delete: string[];
+            /**
+             * Перемещает файл в корзину
+             */
+            markDeleted: string[];
+            /**
+             * Восстанавливает файл из корзины
+             */
+            restore: string[];
+            /**
+             * Загружает новую версию файла
+             */
+            uploadVersion: string[];
+            /**
+             * Возвращает список версий файла
+             */
+            getVersions: string[];
+            /**
+             * Восстанавливает файл из конкретной версии
+             */
+            restoreFromVersion: string[];
+            /**
+             * Возвращает публичную ссылку на файл
+             */
+            getExternalLink: string[];
+        };
+        folder: {
+            getFields: string[];
+            get: string[];
+            getChildren: string[];
+            addSubFolder: string[];
+            copyTo: string[];
+            moveTo: string[];
+            rename: string[];
+            deleteTree: string[];
+            markDeleted: string[];
+            restore: string[];
+            uploadFile: string[];
+            getExternalLink: string[];
+        };
+        attachedObject: {
+            get: string[];
+        };
+    };
+    department: {
+        get: string[];
+        del: string[];
+        add: string[];
+        update: string[];
+    };
+    calendar: {
+        event: {
+            /**
+             * Добавляет новое событие
+             */
+            add: string[];
+            /**
+             * Удаляет событие
+             */
+            delete: string[];
+            /**
+             * Возвращает список событий календаря
+             */
+            get: string[];
+            /**
+             * Возвращает список будущих событий для текущего пользователя
+             */
+            getNearest: string[];
+            /**
+             * Редактирует существующее событие
+             */
+            update: string[];
+        };
+    };
+    bizProc: {
+        workflow: {
+            /**
+             * Возвращает список запущенных бизнес-процессов TODO: реализовать
+             */
+            instances: {
+                /**
+                 * Возвращает список запущенных бизнес-процессов. Алиас bizproc.workflow.instances
+                 */
+                list: string[];
+            };
+            /**
+             * Останавливает активный Бизнес-процесс TODO: реализовать
+             */
+            terminate: {
+                /**
+                 * Добавляет шаблон Бизнес-процесса // TODO: реализовать
+                 */
+                add: string[];
+                /**
+                 * Удаляет шаблон Бизнес-процесса // TODO: реализовать
+                 */
+                delete: string[];
+                /**
+                 * Изменяет шаблон Бизнес-процесса // TODO: реализовать
+                 */
+                update: string[];
+                /**
+                 * Возвращает список шаблонов Бизнес-процессов, установленных на сайте
+                 */
+                list: string[];
+            };
+            /**
+             * Запускает Бизнес-процесс
+             */
+            start: string[];
+            /**
+             * Удаляет запущенный бизнес-процесс TODO: реализовать
+             */
+            kill: string[];
+        };
+        activity: {
+            /**
+             * Добавляет новое действие в бизнес-процесс
+             */
+            add: string[];
+            /**
+             * Удаляет действие
+             */
+            delete: string[];
+            /**
+             * Возвращает список установленных приложением действий
+             */
+            list: string[];
+            /**
+             * Позволяет обновить поля действия
+             */
+            update: string[];
+            /**
+             * Записывает информацию в лог бизнес-процесса
+             */
+            log: string[];
+        };
+        task: {
+            /**
+             * Осуществляет выполнение заданий БП
+             */
+            complete: string[];
+            /**
+             * Возвращает список заданий бизнес-процессов
+             */
+            list: string[];
+        };
+        robot: {
+            /**
+             * Регистрирует нового робота
+             */
+            add: string[];
+            /**
+             * Удаляет зарегистрированного робота
+             */
+            delete: string[];
+            /**
+             * Список зарегистрированных приложением роботов
+             */
+            list: string[];
+            /**
+             * Обновляет поля робота
+             */
+            update: string[];
+        };
+        event: {
+            /**
+             * Возвращает действию выходные параметры, заданные в описании действия
+             */
+            send: string[];
+        };
+    };
+    app: {
+        /**
+         * Показ информации о приложении. Метод поддерживает безопасный вызов
+         */
+        info: string[];
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.4.11",
+  "version": "0.4.12",
   "description": "bitrix rest api",
   "keywords": [
     "bitrix",
@@ -9,6 +9,7 @@
     "api"
   ],
   "author": "Aricatofuka",
+  "main": "./src/public-api.ts",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/Aricatofuka/bx-rest/issues"

package/request/bizproc/workflow/instance.d.ts

@@ -1,8 +1,8 @@
 import * as i0 from "@angular/core";
-export declare class BXRestBizprocWorkflowInstance {
+export declare class BXRestBizProcWorkflowInstance {
     protected url: {
         list: string[];
     };
-    static ɵfac: i0.ɵɵFactoryDeclaration<BXRestBizprocWorkflowInstance, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<BXRestBizprocWorkflowInstance>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BXRestBizProcWorkflowInstance, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<BXRestBizProcWorkflowInstance>;
 }

package/request/bizproc/workflow/template.d.ts

@@ -1,7 +1,6 @@
-import { iBXRestParamBizprocWorkflowTemplateList } from '../../../typification/rest/bizproc/workflow/template/list';
 import { HttpBXServices } from '../../../services/http/HttpBX';
 import * as i0 from "@angular/core";
-export declare class BXRestBizprocWorkflowTemplate {
+export declare class BXRestBizProcWorkflowTemplate {
     private http;
     protected url: {
         add: string[];
@@ -10,7 +9,6 @@ export declare class BXRestBizprocWorkflowTemplate {
         list: string[];
     };
     constructor(http: HttpBXServices);
-    list(param?: iBXRestParamBizprocWorkflowTemplateList): import("rxjs").Observable<import("../../../typification/rest/base/answer").iBXRestAnswer<unknown> | undefined>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<BXRestBizprocWorkflowTemplate, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<BXRestBizprocWorkflowTemplate>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BXRestBizProcWorkflowTemplate, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<BXRestBizProcWorkflowTemplate>;
 }

package/request/bizproc/workflow.d.ts

@@ -1,19 +1,26 @@
-import { BXRestBizprocWorkflowInstance } from './workflow/instance';
-import { BXRestBizprocWorkflowTemplate } from './workflow/template';
+import { BXRestBizProcWorkflowInstance } from './workflow/instance';
 import { HttpBXServices } from '../../services/http/HttpBX';
 import { iBXRestParamBizprocWorkflowStart } from '../../typification/rest/bizproc/workflow/start';
+import { BXRestBizProcWorkflowTemplate } from './workflow/template';
 import * as i0 from "@angular/core";
 export declare class BXRestBizProcWorkflow {
-    instances: BXRestBizprocWorkflowInstance;
-    template: BXRestBizprocWorkflowTemplate;
+    instances: BXRestBizProcWorkflowInstance;
+    template: BXRestBizProcWorkflowTemplate;
     private http;
     protected url: {
-        instances: string[];
-        terminate: string[];
+        instances: {
+            list: string[];
+        };
+        terminate: {
+            add: string[];
+            delete: string[];
+            update: string[];
+            list: string[];
+        };
         start: string[];
         kill: string[];
     };
-    constructor(instances: BXRestBizprocWorkflowInstance, template: BXRestBizprocWorkflowTemplate, http: HttpBXServices);
+    constructor(instances: BXRestBizProcWorkflowInstance, template: BXRestBizProcWorkflowTemplate, http: HttpBXServices);
     start(param: iBXRestParamBizprocWorkflowStart): import("rxjs").Observable<import("../../typification/rest/base/answer").iBXRestAnswer<string> | undefined>;
     static ɵfac: i0.ɵɵFactoryDeclaration<BXRestBizProcWorkflow, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<BXRestBizProcWorkflow>;

package/request/disk/attachedObject.d.ts

@@ -1,5 +1,5 @@
 import { HttpBXServices } from '../../services/http/HttpBX';
-import { iBXRestDiskAttachedObjectHttp } from '../../typification/rest/disk/AttachedObject';
+import { iBXRestDiskAttachedObjectHttp, iBXRestParamRestDiskAttachedObject } from '../../typification/rest/disk/AttachedObject';
 import * as i0 from "@angular/core";
 export declare class BXRestDiskAttachedObject {
     private http;
@@ -7,7 +7,7 @@ export declare class BXRestDiskAttachedObject {
         get: string[];
     };
     constructor(http: HttpBXServices);
-    get(id: number): import("rxjs").Observable<import("../../typification/rest/base/answer").iBXRestAnswer<iBXRestDiskAttachedObjectHttp> | undefined>;
+    get(param: iBXRestParamRestDiskAttachedObject): import("rxjs").Observable<import("../../typification/rest/base/answer").iBXRestAnswer<iBXRestDiskAttachedObjectHttp> | undefined>;
     static ɵfac: i0.ɵɵFactoryDeclaration<BXRestDiskAttachedObject, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<BXRestDiskAttachedObject>;
 }