bx-rest 0.26.0 → 1.0.0

package/typification/base/workpiece/methods-list.d.ts

@@ -0,0 +1,247 @@
+export interface iBXRestWorkpieceMethodsUser<admin, _get, current, update, search, access, fields, userfield> {
+    admin: admin;
+    get: _get;
+    current: current;
+    update: update;
+    search: search;
+    access: access;
+    fields: fields;
+    userfield: userfield;
+}
+export interface iBXRestWorkpieceMethodsUserField<add, update, _delete, list, file extends iBXRestWorkpieceMethodsUserFieldList<file['get']>> {
+    /**
+     * Добавляет пользовательское поле
+     */
+    add: add;
+    /**
+     * Обновляет пользовательское поле
+     */
+    update: update;
+    /**
+     * Удаляет пользовательское поле
+     */
+    delete: _delete;
+    /**
+     *  Получает список пользовательских полей
+     */
+    list: list;
+    file: file;
+}
+export interface iBXRestWorkpieceMethodsUserFieldList<get> {
+    get: get;
+}
+export interface iBXRestWorkpieceMethodsTasks<task extends iBXRestWorkpieceMethodsTasksTask<task['add'], task['approve'], task['complete'], task['defer'], task['delegate'], task['get'], task['getFields'], task['getAccess'], task['list'], task['update'], iBXRestWorkpieceMethodsTasksTaskResult<task['result']['list'], task['result']['addFromComment'], task['result']['deleteFromComment']>>> {
+    task: task;
+}
+export interface iBXRestWorkpieceMethodsTasksTask<add, approve, complete, defer, delegate, _get, getFields, getAccess, list, update, result> {
+    add: add;
+    approve: approve;
+    complete: complete;
+    defer: defer;
+    delegate: delegate;
+    get: _get;
+    getFields: getFields;
+    getAccess: getAccess;
+    list: list;
+    update: update;
+    result: result;
+}
+export interface iBXRestWorkpieceMethodsTasksTaskResult<list, addFromComment, deleteFromComment> {
+    list: list;
+    addFromComment: addFromComment;
+    /**
+     * Удаление результата задачи по комментарию из которого он был создан
+     */
+    deleteFromComment: deleteFromComment;
+}
+export interface iBXRestWorkpieceMethodsTask<elapsedItem extends iBXRestWorkpieceMethodsTaskElapsedItem<elapsedItem['getList'], elapsedItem['add'], elapsedItem['delete'], elapsedItem['isActionAllowed'], elapsedItem['update']>, commentItem extends iBXRestWorkpieceMethodsTaskCommentItem<commentItem['getList'], commentItem['get'], commentItem['add'], commentItem['update'], commentItem['delete']>, planner extends iBXRestWorkpieceMethodsTaskPlanner<planner['getList']>, item extends iBXRestWorkpieceMethodsTaskItem<iBXRestWorkpieceMethodsTaskItemUserField<item['userField']['getList'], item['userField']['getFields']>>, stages extends iBXRestWorkpieceMethodsTaskStages<stages['add'], stages['canmovetask'], stages['delete'], stages['get'], stages['movetask'], stages['update']>> {
+    elapsedItem: elapsedItem;
+    commentItem: commentItem;
+    planner: planner;
+    item: item;
+    stages: stages;
+}
+export interface iBXRestWorkpieceMethodsTaskElapsedItem<getList, add, _delete, isActionAllowed, update> {
+    getList: getList;
+    add: add;
+    delete: _delete;
+    isActionAllowed: isActionAllowed;
+    update: update;
+}
+export interface iBXRestWorkpieceMethodsTaskCommentItem<getList, get, add, update, _delete> {
+    getList: getList;
+    get: get;
+    add: add;
+    update: update;
+    delete: _delete;
+}
+export interface iBXRestWorkpieceMethodsTaskPlanner<getList> {
+    getList: getList;
+}
+export interface iBXRestWorkpieceMethodsTaskItem<item extends iBXRestWorkpieceMethodsTaskItemUserField<item['getFields'], item['getList']>> {
+    userField: item;
+}
+export interface iBXRestWorkpieceMethodsTaskStages<add, canmovetask, _delete, _get, movetask, update> {
+    add: add;
+    canmovetask: canmovetask;
+    delete: _delete;
+    get: _get;
+    movetask: movetask;
+    update: update;
+}
+export interface iBXRestWorkpieceMethodsTaskItemUserField<getFields, getList> {
+    getFields: getFields;
+    getList: getList;
+}
+export interface iBXRestWorkpieceMethodsTimeman<status> {
+    /**
+     * Получение информации о текущем рабочем дне пользователя
+     */
+    status: status;
+}
+export interface iBXRestWorkpieceMethodsSonetGroup<_get> {
+    /**
+     * Возвращает массив групп соцсети, каждая из которых содержит массив полей, осуществляя вызов CSocNetGroup::GetList(), при этом возвращаются только те группы, которые доступны пользователю по правам
+     */
+    get: _get;
+}
+export interface iBXRestWorkpieceMethodsServer<time> {
+    /**
+     * Получить время сервера
+     */
+    time: time;
+}
+export interface iBXRestWorkpieceMethodsLog<blogpost extends iBXRestWorkpieceMethodsLogBlogpost<blogpost['add'], blogpost['get']>> {
+    blogpost: blogpost;
+}
+export interface iBXRestWorkpieceMethodsLogBlogpost<add, _get> {
+    /**
+     * Добавляет в Живую Ленту сообщение от имени текущего пользователя
+     */
+    add: add;
+    /**
+     * Возвращает массив с доступными текущему пользователю сообщениями Живой ленты.
+     * Каждое из сообщений представляет собой массив значений полей (включая пользовательские поля)
+     */
+    get: _get;
+}
+export interface iBXRestWorkpieceMethodsLists<_get, element extends iBXRestWorkpieceMethodsListsElement<element['add'], element['get']>, field extends iBXRestWorkpieceMethodsListsField<field['get']>> {
+    /**
+     * Метод возвращает данные по спискам
+     */
+    get: _get;
+    element: element;
+    field: field;
+}
+export interface iBXRestWorkpieceMethodsListsElement<add, _get> {
+    /**
+     * Метод создаёт элемент списка
+     */
+    add: add;
+    /**
+     * Метод возвращает список элементов или элемент
+     */
+    get: _get;
+}
+export interface iBXRestWorkpieceMethodsListsField<_get> {
+    /**
+     * Метод возвращает данные поля
+     */
+    get: _get;
+}
+export interface iBXRestWorkpieceMethodsIm<chat extends iBXRestWorkpieceMethodsImChat<chat['add']>> {
+    chat: chat;
+}
+export interface iBXRestWorkpieceMethodsImChat<add> {
+    add: add;
+}
+export interface iBXRestWorkpieceMethodsDisk<file extends iBXRestWorkpieceMethodsDiskFile<file['get'], file['markDeleted']>, folder extends iBXRestWorkpieceMethodsDiskFolder<folder['getFields'], folder['get'], folder['getChildren'], folder['addSubFolder'], folder['copyTo'], folder['moveTo'], folder['rename'], folder['deleteTree'], folder['markDeleted'], folder['restore'], folder['uploadFile'], folder['getExternalLink']>, attachedObject extends iBXRestWorkpieceMethodsDiskAttachedObject<attachedObject['get']>> {
+    file: file;
+    folder: folder;
+    attachedObject: attachedObject;
+}
+export interface iBXRestWorkpieceMethodsDiskFile<_get, markDeleted> {
+    /**
+     * Возвращает файл по идентификатору
+     */
+    get: _get;
+    /**
+     * Перемещает файл в корзину
+     */
+    markDeleted: markDeleted;
+}
+export interface iBXRestWorkpieceMethodsDiskFolder<getFields, _get, getChildren, addSubFolder, copyTo, moveTo, rename, deleteTree, markDeleted, restore, uploadFile, getExternalLink> {
+    getFields: getFields;
+    get: _get;
+    getChildren: getChildren;
+    addSubFolder: addSubFolder;
+    copyTo: copyTo;
+    moveTo: moveTo;
+    rename: rename;
+    deleteTree: deleteTree;
+    markDeleted: markDeleted;
+    restore: restore;
+    uploadFile: uploadFile;
+    getExternalLink: getExternalLink;
+}
+export interface iBXRestWorkpieceMethodsDiskAttachedObject<_get> {
+    get: _get;
+}
+export interface iBXRestWorkpieceMethodsDepartment<_get, del, add, update> {
+    get: _get;
+    del: del;
+    add: add;
+    update: update;
+}
+export interface iBXRestWorkpieceMethodsCalendar<event extends iBXRestWorkpieceMethodsCalendarEvent<event['get']>> {
+    event: event;
+}
+export interface iBXRestWorkpieceMethodsCalendarEvent<_get> {
+    /**
+     * Возвращает список событий календаря
+     */
+    get: _get;
+}
+export interface iBXRestWorkpieceMethodsBizProc<workflow extends iBXRestWorkpieceMethodsBizProcWorkflow<workflow['start']>> {
+    workflow: workflow;
+}
+export interface iBXRestWorkpieceMethodsBizProcWorkflow<start> {
+    /**
+     * Запускает Бизнес-процесс
+     */
+    start: start;
+}
+export interface iBXRestWorkpieceMethodsApp<info> {
+    /**
+     * Показ информации о приложении. Метод поддерживает безопасный вызов
+     */
+    info: info;
+}
+export interface iBXRestWorkpieceSocialNetWorkApiContentView<set> {
+    /**
+     * Чтобы отмечать пасты просмотренными (наверное)
+     */
+    set: set;
+}
+export interface iBXRestWorkpieceSocialNetWorkApiLiveFeed<blogPost> {
+    blogPost: blogPost;
+}
+export interface iBXRestWorkpieceSocialNetWorkApiLiveFeedBlogpost<important> {
+    important: important;
+}
+export interface iBXRestWorkpieceSocialNetWorkApiLiveFeedBlogpostImportant<vote> {
+    /**
+     * Чтобы подтверждать важные посты на прочтение
+     */
+    vote: vote;
+}
+export interface iBXRestWorkpieceSocialNetWorkApi<contentView, liveFeed> {
+    contentView: contentView;
+    liveFeed: liveFeed;
+}
+export interface iBXRestWorkpieceSocialNetWork<api> {
+    /**
+     * Пространство socialNetWork (не документировано)
+     */
+    api: api;
+}

package/typification/base/workpiece/methods.d.ts

@@ -0,0 +1,20 @@
+import { iBXRestWorkpieceMethodsApp, iBXRestWorkpieceMethodsBizProc, iBXRestWorkpieceMethodsBizProcWorkflow, iBXRestWorkpieceMethodsCalendar, iBXRestWorkpieceMethodsCalendarEvent, iBXRestWorkpieceMethodsDepartment, iBXRestWorkpieceMethodsDisk, iBXRestWorkpieceMethodsDiskAttachedObject, iBXRestWorkpieceMethodsDiskFile, iBXRestWorkpieceMethodsDiskFolder, iBXRestWorkpieceMethodsIm, iBXRestWorkpieceMethodsImChat, iBXRestWorkpieceMethodsLists, iBXRestWorkpieceMethodsListsElement, iBXRestWorkpieceMethodsListsField, iBXRestWorkpieceMethodsLog, iBXRestWorkpieceMethodsLogBlogpost, iBXRestWorkpieceMethodsServer, iBXRestWorkpieceMethodsSonetGroup, iBXRestWorkpieceMethodsTask, iBXRestWorkpieceMethodsTaskCommentItem, iBXRestWorkpieceMethodsTaskElapsedItem, iBXRestWorkpieceMethodsTaskItem, iBXRestWorkpieceMethodsTaskItemUserField, iBXRestWorkpieceMethodsTaskPlanner, iBXRestWorkpieceMethodsTasks, iBXRestWorkpieceMethodsTaskStages, iBXRestWorkpieceMethodsTasksTask, iBXRestWorkpieceMethodsTasksTaskResult, iBXRestWorkpieceMethodsTimeman, iBXRestWorkpieceMethodsUser, iBXRestWorkpieceMethodsUserField, iBXRestWorkpieceMethodsUserFieldList, iBXRestWorkpieceSocialNetWork, iBXRestWorkpieceSocialNetWorkApi, iBXRestWorkpieceSocialNetWorkApiContentView, iBXRestWorkpieceSocialNetWorkApiLiveFeed, iBXRestWorkpieceSocialNetWorkApiLiveFeedBlogpost, iBXRestWorkpieceSocialNetWorkApiLiveFeedBlogpostImportant } from './methods-list';
+export interface iBXRestWorkpieceMethodsFullOneArgument<T> extends iBXRestWorkpieceMethodsFull<iBXRestWorkpieceMethodsUser<T, T, T, T, T, T, T, iBXRestWorkpieceMethodsUserField<T, T, T, T, iBXRestWorkpieceMethodsUserFieldList<T>>>, iBXRestWorkpieceMethodsTasks<iBXRestWorkpieceMethodsTasksTask<T, T, T, T, T, T, T, T, T, T, iBXRestWorkpieceMethodsTasksTaskResult<T, T, T>>>, iBXRestWorkpieceMethodsTask<iBXRestWorkpieceMethodsTaskElapsedItem<T, T, T, T, T>, iBXRestWorkpieceMethodsTaskCommentItem<T, T, T, T, T>, iBXRestWorkpieceMethodsTaskPlanner<T>, iBXRestWorkpieceMethodsTaskItem<iBXRestWorkpieceMethodsTaskItemUserField<T, T>>, iBXRestWorkpieceMethodsTaskStages<T, T, T, T, T, T>>, iBXRestWorkpieceMethodsTimeman<T>, iBXRestWorkpieceMethodsSonetGroup<T>, iBXRestWorkpieceMethodsServer<T>, iBXRestWorkpieceMethodsLog<iBXRestWorkpieceMethodsLogBlogpost<T, T>>, iBXRestWorkpieceMethodsLists<T, iBXRestWorkpieceMethodsListsElement<T, T>, iBXRestWorkpieceMethodsListsField<T>>, iBXRestWorkpieceMethodsIm<iBXRestWorkpieceMethodsImChat<T>>, iBXRestWorkpieceMethodsDisk<iBXRestWorkpieceMethodsDiskFile<T, T>, iBXRestWorkpieceMethodsDiskFolder<T, T, T, T, T, T, T, T, T, T, T, T>, iBXRestWorkpieceMethodsDiskAttachedObject<T>>, iBXRestWorkpieceMethodsDepartment<T, T, T, T>, iBXRestWorkpieceMethodsCalendar<iBXRestWorkpieceMethodsCalendarEvent<T>>, iBXRestWorkpieceMethodsBizProc<iBXRestWorkpieceMethodsBizProcWorkflow<T>>, iBXRestWorkpieceMethodsApp<T>, iBXRestWorkpieceSocialNetWork<iBXRestWorkpieceSocialNetWorkApi<iBXRestWorkpieceSocialNetWorkApiContentView<T>, iBXRestWorkpieceSocialNetWorkApiLiveFeed<iBXRestWorkpieceSocialNetWorkApiLiveFeedBlogpost<iBXRestWorkpieceSocialNetWorkApiLiveFeedBlogpostImportant<T>>>>>> {
+}
+export interface iBXRestWorkpieceMethodsFull<user extends iBXRestWorkpieceMethodsUser<user['admin'], user['get'], user['current'], user['update'], user['search'], user['access'], user['fields'], iBXRestWorkpieceMethodsUserField<user['userfield']['add'], user['userfield']['update'], user['userfield']['delete'], user['userfield']['list'], iBXRestWorkpieceMethodsUserFieldList<user['userfield']['file']['get']>>>, tasks extends iBXRestWorkpieceMethodsTasks<iBXRestWorkpieceMethodsTasksTask<tasks['task']['add'], tasks['task']['approve'], tasks['task']['complete'], tasks['task']['defer'], tasks['task']['delegate'], tasks['task']['get'], tasks['task']['getFields'], tasks['task']['getAccess'], tasks['task']['list'], tasks['task']['update'], iBXRestWorkpieceMethodsTasksTaskResult<tasks['task']['result']['list'], tasks['task']['result']['addFromComment'], tasks['task']['result']['deleteFromComment']>>>, task extends iBXRestWorkpieceMethodsTask<iBXRestWorkpieceMethodsTaskElapsedItem<task['elapsedItem']['getList'], task['elapsedItem']['add'], task['elapsedItem']['delete'], task['elapsedItem']['isActionAllowed'], task['elapsedItem']['update']>, iBXRestWorkpieceMethodsTaskCommentItem<task['commentItem']['getList'], task['commentItem']['get'], task['commentItem']['add'], task['commentItem']['update'], task['commentItem']['delete']>, iBXRestWorkpieceMethodsTaskPlanner<task['planner']['getList']>, iBXRestWorkpieceMethodsTaskItem<iBXRestWorkpieceMethodsTaskItemUserField<task['item']['userField']['getFields'], task['item']['userField']['getList']>>, iBXRestWorkpieceMethodsTaskStages<task['stages']['add'], task['stages']['canmovetask'], task['stages']['delete'], task['stages']['get'], task['stages']['movetask'], task['stages']['update']>>, timeman extends iBXRestWorkpieceMethodsTimeman<timeman['status']>, sonet_group extends iBXRestWorkpieceMethodsSonetGroup<sonet_group['get']>, server extends iBXRestWorkpieceMethodsServer<server['time']>, log extends iBXRestWorkpieceMethodsLog<iBXRestWorkpieceMethodsLogBlogpost<log['blogpost']['add'], log['blogpost']['get']>>, lists extends iBXRestWorkpieceMethodsLists<lists['get'], iBXRestWorkpieceMethodsListsElement<lists['element']['add'], lists['element']['get']>, iBXRestWorkpieceMethodsListsField<lists['field']['get']>>, im extends iBXRestWorkpieceMethodsIm<iBXRestWorkpieceMethodsImChat<im['chat']['add']>>, disk extends iBXRestWorkpieceMethodsDisk<iBXRestWorkpieceMethodsDiskFile<disk['file']['get'], disk['file']['markDeleted']>, iBXRestWorkpieceMethodsDiskFolder<disk['folder']['getFields'], disk['folder']['get'], disk['folder']['getChildren'], disk['folder']['addSubFolder'], disk['folder']['copyTo'], disk['folder']['moveTo'], disk['folder']['rename'], disk['folder']['deleteTree'], disk['folder']['markDeleted'], disk['folder']['restore'], disk['folder']['uploadFile'], disk['folder']['getExternalLink']>, iBXRestWorkpieceMethodsDiskAttachedObject<disk['attachedObject']['get']>>, department extends iBXRestWorkpieceMethodsDepartment<department['get'], department['del'], department['add'], department['update']>, calendar extends iBXRestWorkpieceMethodsCalendar<iBXRestWorkpieceMethodsCalendarEvent<calendar['event']['get']>>, bizProc extends iBXRestWorkpieceMethodsBizProc<iBXRestWorkpieceMethodsBizProcWorkflow<bizProc['workflow']['start']>>, app extends iBXRestWorkpieceMethodsApp<app['info']>, socialNetWork extends iBXRestWorkpieceSocialNetWork<iBXRestWorkpieceSocialNetWorkApi<socialNetWork['api']['contentView'], socialNetWork['api']['liveFeed']>>> {
+    user: user;
+    tasks: tasks;
+    task: task;
+    timeman: timeman;
+    sonet_group: sonet_group;
+    server: server;
+    log: log;
+    lists: lists;
+    im: im;
+    disk: disk;
+    department: department;
+    calendar: calendar;
+    bizProc: bizProc;
+    app: app;
+    socialNetWork: socialNetWork;
+}

package/typification/rest/app/info.d.ts

@@ -0,0 +1,33 @@
+import { iBXRestYesNo } from '../base/yes-no';
+export interface iBXRestAppInfo extends iBXRestAppInfoBase {
+    /** Локальный идентификатор приложения на портале. */
+    ID: number;
+    /** Истек ли оплаченный или пробный период. */
+    PAYMENT_EXPIRED: boolean;
+}
+export interface iBXRestAppInfoHttp extends iBXRestAppInfoBase {
+    /** Локальный идентификатор приложения в исходном формате REST API. */
+    ID: string | number;
+    /** Признак окончания оплаченного или пробного периода. */
+    PAYMENT_EXPIRED: iBXRestYesNo;
+}
+export interface iBXRestAppInfoBase {
+    /** Код приложения. */
+    CODE: string;
+    /** Установленная версия приложения. */
+    VERSION: number;
+    /** Статус: бесплатное, демо, пробное, платное, локальное или подписное. */
+    STATUS: 'F' | 'D' | 'T' | 'P' | 'L' | 'S';
+    /** Завершена ли установка приложения. */
+    INSTALLED: boolean;
+    /** Количество дней до конца оплаченного или пробного периода. */
+    DAYS: number | null;
+    /** Базовый язык портала. */
+    LANGUAGE_ID: string;
+    /** Тариф с региональным префиксом, например `ru_ent10000`. */
+    LICENSE: string;
+    /** Идентификатор тарифного плана без регионального префикса. */
+    LICENSE_TYPE: string;
+    /** Семейство тарифного плана. */
+    LICENSE_FAMILY: string;
+}

package/typification/rest/app/option.d.ts

@@ -0,0 +1,18 @@
+/** Значение, которое можно сохранить в настройках приложения. */
+export type iBXRestOptionValue = string | number | boolean | null | iBXRestOptionValue[] | {
+    [key: string]: iBXRestOptionValue;
+};
+/** Набор именованных настроек приложения или пользователя. */
+export type iBXRestOptionValues = Record<string, iBXRestOptionValue>;
+/** Параметры `app.option.set`. */
+export interface iBXRestParamAppOptionSet {
+    /** Настройки: ключ — имя свойства, значение — сохраняемые данные. */
+    options: iBXRestOptionValues;
+}
+/** Параметры `app.option.get`. */
+export interface iBXRestParamAppOptionGet {
+    /** Имя свойства. Если не указано, метод вернет все настройки приложения. */
+    option?: string;
+}
+/** Результат чтения одной настройки или всего набора настроек. */
+export type iBXRestOptionGetResult = iBXRestOptionValue | iBXRestOptionValues;

package/typification/rest/app.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Файл для возможности импорта интерфейсов данного пакета в локальные проекты
+ */
+export * from './app/info';
+export * from './app/option';

package/typification/rest/base/answer.d.ts

@@ -0,0 +1,19 @@
+export type iBXRestAnswer<T> = iBXRestAnswerSuccess<T> | iBXRestAnswerError;
+export interface iBXRestAnswerSuccess<T> {
+    result?: T | undefined;
+    next?: number;
+    total?: number;
+    time?: iBXRestAnswerSuccessTime;
+}
+export interface iBXRestAnswerSuccessTime {
+    start: number;
+    finish: number;
+    duration: number;
+    processing: number;
+    date_start: string;
+    date_finish: string;
+}
+export interface iBXRestAnswerError {
+    error?: string;
+    error_description?: string;
+}

package/typification/rest/base/api-pagination-bx.d.ts

@@ -0,0 +1,11 @@
+export interface iBXRestPagination {
+    start?: number;
+}
+export interface iBXRestAlternativePagination {
+    PARAMS?: {
+        NAV_PARAMS: {
+            nPageSize: number;
+            iNumPage: number;
+        };
+    };
+}

package/typification/rest/base/field-bx-type.d.ts

@@ -0,0 +1 @@
+export type iFieldBXType = 'text' | 'link' | 'datetime' | 'list' | 'phone' | 'timezone' | 'userField' | 'multilist';

package/typification/rest/base/filter-generator.d.ts

@@ -0,0 +1,5 @@
+export type iBXRestFilterGenerator<Type> = {
+    [Property in keyof Type as `${iBXRestFilterGeneratorKey<Property & string>}`]?: Type[Property];
+};
+export type iBXRestFilterGeneratorKey<T extends string> = `${iBXRestFilterKeys}${T}`;
+export type iBXRestFilterKeys = '' | '<' | '>' | '!' | '<=' | '>=' | '%';

package/typification/rest/base/order-options.d.ts

@@ -0,0 +1 @@
+export type iBXRestOrderOption = 'asc' | 'desc';

package/typification/rest/base/sort.d.ts

@@ -0,0 +1 @@
+export type iBXRestParamSort = 'ASC' | 'DESC';

package/typification/rest/base/yes-no.d.ts

@@ -0,0 +1 @@
+export type iBXRestYesNo = 'Y' | 'N';

package/typification/rest/base.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Файл для возможности импорта интерфейсов данного пакета в локальные проекты
+ */
+export * from './base/answer';
+export * from './base/api-pagination-bx';
+export * from './base/yes-no';
+export * from './base/sort';
+export * from './base/order-options';
+export * from './base/filter-generator';
+export * from './base/field-bx-type';

package/typification/rest/batch/batchRequestParam.d.ts

@@ -0,0 +1,15 @@
+import { iBXRestAnswer } from '../base/answer';
+export type keyBatch = string | number;
+export interface iBatchRequestParam<T> {
+    name: string;
+    param: T;
+}
+export type iBatchRequestParamHttp = {
+    [key: keyBatch]: string;
+};
+export type iBatchRequestParamArr<T> = {
+    [key: keyBatch]: iBatchRequestParam<T>;
+};
+export type iBatchRequestAnswer<T> = iBXRestAnswer<iBXRestAnswer<{
+    [key: keyBatch]: T;
+}>>;

package/typification/rest/batch.d.ts

@@ -0,0 +1,26 @@
+import { iBXRestAnswerSuccessTime } from './base/answer';
+import { Navvy } from '../../services/navvy';
+export interface iBXRestParamBatch {
+    /**
+     * Определяет прерывать ли последовательность запросов в случае ошибки.
+     */
+    halt: 0 | 1;
+    /**
+     * Массив запросов стандартного вида
+     */
+    cmd: Record<number | string, string> | string[];
+}
+export type iBXRestNavvyParamBatchCMD = Record<string, ReturnType<Navvy['simple'] | Navvy['pagNav'] | Navvy['pagNavTasks']>>;
+export interface iBXRestBatch<T> {
+    result: {
+        [K in keyof T]: T[K];
+    };
+    result_error: any[];
+    result_total: {
+        [K in keyof T]: number;
+    };
+    result_next: any[];
+    result_time: {
+        [K in keyof T]: iBXRestAnswerSuccessTime;
+    };
+}

package/typification/rest/bizproc/activity.d.ts

@@ -0,0 +1,25 @@
+import { iBXRestBizprocRegistrationFields } from './base/registration';
+/** Параметры `bizproc.activity.add`. */
+export interface iBXRestParamBizprocActivityAdd extends iBXRestBizprocRegistrationFields {
+    /** Уникальный в рамках приложения символьный код действия. */
+    CODE: string;
+}
+/** Параметры `bizproc.activity.update`. */
+export interface iBXRestParamBizprocActivityUpdate {
+    /** Символьный код зарегистрированного действия. */
+    CODE: string;
+    /** Новые поля действия. */
+    FIELDS: iBXRestBizprocRegistrationFields;
+}
+/** Параметры `bizproc.activity.delete`. */
+export interface iBXRestParamBizprocActivityDelete {
+    /** Символьный код зарегистрированного действия. */
+    CODE: string;
+}
+/** Параметры `bizproc.activity.log`. */
+export interface iBXRestParamBizprocActivityLog {
+    /** Актуальный токен события, полученный обработчиком действия. */
+    EVENT_TOKEN: string;
+    /** Сообщение для журнала бизнес-процесса. */
+    LOG_MESSAGE: string;
+}

package/typification/rest/bizproc/base/filedEnum.d.ts

@@ -0,0 +1 @@
+export type iRestBXBizprocWorkflowTemplateFieldEnum = 'ID' | 'MODULE_ID' | 'ENTITY' | 'DOCUMENT_TYPE' | 'AUTO_EXECUTE' | 'NAME' | 'TEMPLATE' | 'PARAMETERS' | 'VARIABLES' | 'CONSTANTS' | 'MODIFIED' | 'IS_MODIFIED' | 'USER_ID' | 'SYSTEM_CODE';

package/typification/rest/bizproc/base/registration.d.ts

@@ -0,0 +1,66 @@
+import { iBXRestYesNo } from '../../base/yes-no';
+/** Строка или набор ее локализованных вариантов. */
+export type iBXRestBizprocLocalizedString = string | Record<string, string>;
+/**
+ * Тип документа в формате `[модуль, объект, тип документа]`.
+ *
+ * @example ['crm', 'CCrmDocumentDeal', 'DEAL']
+ */
+export type iBXRestBizprocDocumentType = [
+    moduleId: string,
+    entity: string,
+    documentType: string
+];
+/** Правило доступности действия или робота для документа либо редакции Битрикс24. */
+export type iBXRestBizprocRegistrationFilterRule = string | string[];
+/** Ограничения видимости действия или робота. */
+export interface iBXRestBizprocRegistrationFilter {
+    /** Правила, для которых действие или робот отображается. */
+    INCLUDE?: iBXRestBizprocRegistrationFilterRule[];
+    /** Правила, для которых действие или робот скрывается. */
+    EXCLUDE?: iBXRestBizprocRegistrationFilterRule[];
+}
+/** Базовые типы параметров действия или робота. */
+export type iBXRestBizprocRegistrationPropertyType = 'bool' | 'date' | 'datetime' | 'double' | 'file' | 'int' | 'select' | 'string' | 'text' | 'user';
+/** Описание входного или выходного параметра действия либо робота. */
+export interface iBXRestBizprocRegistrationProperty {
+    /** Отображаемое имя параметра. */
+    Name: iBXRestBizprocLocalizedString;
+    /** Описание параметра. */
+    Description?: iBXRestBizprocLocalizedString;
+    /** Тип данных параметра. */
+    Type: iBXRestBizprocRegistrationPropertyType | string;
+    /** Варианты значения для параметра типа `select`. */
+    Options?: Record<string, string> | string[];
+    /** Является ли параметр обязательным. */
+    Required?: iBXRestYesNo;
+    /** Допускает ли параметр несколько значений. */
+    Multiple?: iBXRestYesNo;
+    /** Значение по умолчанию. */
+    Default?: unknown;
+}
+/** Поля регистрации действия или робота приложения. */
+export interface iBXRestBizprocRegistrationFields {
+    /** URL обработчика на домене установленного приложения. */
+    HANDLER: string;
+    /** Пользователь, чей токен будет передан обработчику. */
+    AUTH_USER_ID?: number;
+    /** Должен ли бизнес-процесс ожидать ответ приложения. */
+    USE_SUBSCRIPTION?: iBXRestYesNo;
+    /** Название действия или робота. */
+    NAME: iBXRestBizprocLocalizedString;
+    /** Описание действия или робота. */
+    DESCRIPTION?: iBXRestBizprocLocalizedString;
+    /** Входные параметры. */
+    PROPERTIES?: Record<string, iBXRestBizprocRegistrationProperty>;
+    /** Выходные параметры. */
+    RETURN_PROPERTIES?: Record<string, iBXRestBizprocRegistrationProperty>;
+    /** Тип документа, определяющий типы входных и выходных параметров. */
+    DOCUMENT_TYPE?: iBXRestBizprocDocumentType;
+    /** Ограничения по типу документа и редакции Битрикс24. */
+    FILTER?: iBXRestBizprocRegistrationFilter;
+    /** Включает дополнительные настройки во встройке приложения. */
+    USE_PLACEMENT?: iBXRestYesNo;
+    /** URL обработчика встройки; обязателен при `USE_PLACEMENT: 'Y'`. */
+    PLACEMENT_HANDLER?: string;
+}

package/typification/rest/bizproc/event.d.ts

@@ -0,0 +1,9 @@
+/** Параметры `bizproc.event.send`. */
+export interface iBXRestParamBizprocEventSend {
+    /** Актуальный токен события, полученный обработчиком действия или робота. */
+    EVENT_TOKEN: string;
+    /** Значения зарегистрированных выходных параметров. */
+    RETURN_VALUES?: Record<string, unknown>;
+    /** Сообщение для журнала бизнес-процесса. */
+    LOG_MESSAGE?: string;
+}

package/typification/rest/bizproc/robot.d.ts

@@ -0,0 +1,18 @@
+import { iBXRestBizprocRegistrationFields } from './base/registration';
+/** Параметры `bizproc.robot.add`. */
+export interface iBXRestParamBizprocRobotAdd extends iBXRestBizprocRegistrationFields {
+    /** Уникальный в рамках приложения символьный код робота. */
+    CODE: string;
+}
+/** Параметры `bizproc.robot.update`. */
+export interface iBXRestParamBizprocRobotUpdate {
+    /** Символьный код зарегистрированного робота. */
+    CODE: string;
+    /** Новые поля робота. */
+    FIELDS: iBXRestBizprocRegistrationFields;
+}
+/** Параметры `bizproc.robot.delete`. */
+export interface iBXRestParamBizprocRobotDelete {
+    /** Символьный код зарегистрированного робота. */
+    CODE: string;
+}

package/typification/rest/bizproc/task/complete.d.ts

@@ -0,0 +1,13 @@
+/** Допустимый результат выполнения задания бизнес-процесса. */
+export type iBXRestBizprocTaskCompleteStatus = 1 | 2 | 3 | 4 | 'yes' | 'no' | 'ok' | 'cancel';
+/** Параметры `bizproc.task.complete`. */
+export interface iBXRestParamBizprocTaskComplete {
+    /** Идентификатор задания. */
+    TASK_ID: number;
+    /** Целевой статус задания. */
+    STATUS: iBXRestBizprocTaskCompleteStatus;
+    /** Комментарий пользователя. */
+    COMMENT?: string;
+    /** Значения полей задания с запросом дополнительной информации. */
+    FIELDS?: Record<string, unknown>;
+}

package/typification/rest/bizproc/task/delegate.d.ts

@@ -0,0 +1,9 @@
+/** Параметры `bizproc.task.delegate`. */
+export interface iBXRestParamBizprocTaskDelegate {
+    /** Идентификаторы делегируемых заданий. */
+    TASK_IDS: number[];
+    /** Пользователь, от которого делегируются задания. */
+    FROM_USER_ID: number;
+    /** Пользователь, которому делегируются задания. */
+    TO_USER_ID: number;
+}