bx-rest 0.10.5 → 0.10.7

package/typification/rest/task/elapseditem/item.d.ts

@@ -0,0 +1,25 @@
+export interface iBXRestTaskElapsedItem extends iBXRestTaskElapsedItemBase {
+    ID: number;
+    MINUTES: number;
+    SECONDS: number;
+    TASK_ID: number;
+    USER_ID: number;
+    SOURCE: number;
+    CREATED_DATE: Date;
+    DATE_START: Date;
+    DATE_STOP: Date;
+}
+export interface iBXRestTaskElapsedItemHttp extends iBXRestTaskElapsedItemBase {
+    ID: string;
+    MINUTES: string;
+    SECONDS: string;
+    TASK_ID: string;
+    USER_ID: string;
+    SOURCE: string;
+    CREATED_DATE: string;
+    DATE_START: string;
+    DATE_STOP: string;
+}
+export interface iBXRestTaskElapsedItemBase {
+    COMMENT_TEXT: string;
+}

package/typification/rest/task/elapseditem/update.d.ts

@@ -0,0 +1,10 @@
+export interface iBXRestParamUpdateElapseditem {
+    TASKID: number;
+    ITEMID: number;
+    ARFIELDS: iBXRestParamElapsedTaskFields;
+}
+export interface iBXRestParamElapsedTaskFields {
+    SECONDS: number;
+    COMMENT_TEXT: string;
+    CREATED_DATE: Date;
+}

package/typification/rest/task/item/userfield/getlist.d.ts

@@ -0,0 +1,91 @@
+import { iBXRestYesNo } from '../../../base/yes-no';
+import { iBXRestOrderOption } from '../../../base/order-options';
+import { iBXRestPagination } from '../../../base/api-pagination-bx';
+export interface iBXRestParamTaskItemUserFieldGetlist extends iBXRestPagination {
+    ORDER?: {
+        [key in keyof iBXRestTaskItemUserFieldGetlistHttp]: iBXRestOrderOption;
+    };
+    FILTER?: {
+        ID?: number | number[];
+        USER_TYPE_ID?: 'string';
+        FIELD_NAME?: string;
+    };
+}
+export interface iBXRestTaskItemUserFieldGetlist {
+    ID: number;
+    ENTITY_ID: 'TASKS_TASK';
+    FIELD_NAME: string;
+    USER_TYPE_ID: iBXRestCustomTskFieldInfoType;
+    XML_ID: string | null;
+    SORT: string;
+    MULTIPLE: boolean;
+    MANDATORY: boolean;
+    SHOW_FILTER: 'E' | 'N';
+    SHOW_IN_LIST: boolean;
+    EDIT_IN_LIST: boolean;
+    IS_SEARCHABLE: boolean;
+    SETTINGS: iCustomUserFieldInfoSETTINGSTypeString | iCustomUserFieldInfoSETTINGSTypeFile | iCustomUserFieldInfoSETTINGSTypeEnumeration | iCustomUserFieldInfoSETTINGSTypeDatetime | iCustomUserFieldInfoSETTINGSTypeCRM;
+    LIST?: iCustomUserFieldInfoSETTINGSTypeEnumerationLIST[];
+}
+export interface iBXRestTaskItemUserFieldGetlistHttp {
+    ID: string;
+    ENTITY_ID: 'TASKS_TASK';
+    FIELD_NAME: string;
+    USER_TYPE_ID: iBXRestCustomTskFieldInfoType;
+    XML_ID: string | null;
+    SORT: string;
+    MULTIPLE: iBXRestYesNo;
+    MANDATORY: iBXRestYesNo;
+    SHOW_FILTER: 'E' | 'N';
+    SHOW_IN_LIST: iBXRestYesNo;
+    EDIT_IN_LIST: iBXRestYesNo;
+    IS_SEARCHABLE: iBXRestYesNo;
+    SETTINGS: iCustomUserFieldInfoSETTINGSTypeString | iCustomUserFieldInfoSETTINGSTypeFile | iCustomUserFieldInfoSETTINGSTypeEnumeration | iCustomUserFieldInfoSETTINGSTypeDatetime | iCustomUserFieldInfoSETTINGSTypeCRM;
+    LIST?: iCustomUserFieldInfoSETTINGSTypeEnumerationLIST[];
+}
+export interface iCustomUserFieldInfoSETTINGSTypeCRM {
+    LEAD: iBXRestYesNo;
+    CONTACT: iBXRestYesNo;
+    COMPANY: iBXRestYesNo;
+    DEAL: iBXRestYesNo;
+    ORDER: iBXRestYesNo;
+    SMART_INVOICE: iBXRestYesNo;
+}
+export interface iCustomUserFieldInfoSETTINGSTypeString {
+    SIZE: number;
+    ROWS: number;
+    REGEXP: string | null;
+    MIN_LENGTH: number;
+    MAX_LENGTH: number;
+    DEFAULT_VALUE: string | null;
+}
+export interface iCustomUserFieldInfoSETTINGSTypeFile {
+    SIZE: number;
+    LIST_WIDTH: number;
+    LIST_HEIGHT: number;
+    MAX_SHOW_SIZE: number;
+    MAX_ALLOWED_SIZE: number;
+    EXTENSIONS: any[];
+    TARGET_BLANK: iBXRestYesNo;
+}
+export interface iCustomUserFieldInfoSETTINGSTypeEnumeration {
+    DISPLAY: 'UI' | 'DIALOG';
+    LIST_HEIGHT: number;
+    CAPTION_NO_VALUE: string;
+    SHOW_NO_VALUE: iBXRestYesNo;
+}
+export interface iCustomUserFieldInfoSETTINGSTypeEnumerationLIST {
+    ID: string;
+    SORT: string;
+    VALUE: string;
+    DEF: iBXRestYesNo;
+}
+export interface iCustomUserFieldInfoSETTINGSTypeDatetime {
+    DEFAULT_VALUE: {
+        TYPE: 'NONE';
+        VALUE: string;
+    };
+    'USE_SECOND': iBXRestYesNo;
+    'USE_TIMEZONE': iBXRestYesNo;
+}
+export type iBXRestCustomTskFieldInfoType = 'string' | 'file' | 'enumeration' | 'datetime' | 'crm';

package/typification/rest/task/stages/add.d.ts

@@ -0,0 +1,7 @@
+export interface iBXRestAddTaskStage {
+    TITLE: string;
+    COLOR: string;
+    AFTER_ID?: number;
+    ENTITY_ID?: number;
+    isAdmin?: boolean;
+}

package/typification/rest/task/stages/canMoveTask.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamTaskStagesCanMoveTask {
+    entityId: number;
+    entityType: 'U' | 'G';
+}

package/typification/rest/task/stages/get.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamTaskStageGet {
+    entityId: number;
+    isAdmin: boolean;
+}

package/typification/rest/task/stages/stage.d.ts

@@ -0,0 +1,19 @@
+export interface iBXRestTaskStage extends iBXRestTaskStageBase {
+    ID: number;
+    SORT: number;
+    ENTITY_ID: number;
+}
+export interface iBXRestTaskStageHttp extends iBXRestTaskStageBase {
+    ID: string;
+    SORT: string;
+    ENTITY_ID: string;
+}
+export interface iBXRestTaskStageBase {
+    TITLE: string;
+    COLOR: string;
+    SYSTEM_TYPE: null;
+    ENTITY_TYPE: string;
+    ADDITIONAL_FILTER: [];
+    TO_UPDATE: [];
+    TO_UPDATE_ACCESS: null;
+}

package/typification/rest/task/stages/update.d.ts

@@ -0,0 +1,5 @@
+import { iBXRestAddTaskStage } from './add';
+export interface iBXRestParamTaskStagesUpdate {
+    id: number;
+    fields: iBXRestAddTaskStage;
+}

package/typification/rest/task.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Файл для возможности импорта интерфейсов задач (task) в локальные проекты
+ */
+export * from './task/access/getaccess';
+export * from './task/commentitem/add';
+export * from './task/commentitem/commentitem';
+export * from './task/commentitem/delete';
+export * from './task/commentitem/get';
+export * from './task/commentitem/getlist';
+export * from './task/commentitem/update';
+export * from './task/elapseditem/add';
+export * from './task/elapseditem/del';
+export * from './task/elapseditem/get';
+export * from './task/elapseditem/isActionAllowedParam';
+export * from './task/elapseditem/item';
+export * from './task/elapseditem/update';
+export * from './task/item/userfield/getlist';
+export * from './task/stages/add';
+export * from './task/stages/canMoveTask';
+export * from './task/stages/get';
+export * from './task/stages/stage';
+export * from './task/stages/update';

package/typification/rest/tasks/base/fields-name.d.ts

@@ -0,0 +1,19 @@
+import { iBXRestHttpTask, iBXRestTask } from '../task';
+import { CamelToSnake } from 'snake-camel-types';
+/**
+ * Причины таких странных мувов можно найти тут
+ * https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php
+ *
+ * в разеделе select и после него глянуть на ответ
+ */
+type UppercaseKeys<T extends CamelToSnake<iBXRestHttpTask | iBXRestTask>> = {
+    [K in keyof T as Uppercase<K & string>]: T[K];
+};
+/**
+ * Причины таких странных мувов можно найти тут
+ * https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php
+ *
+ * в разеделе select и после него глянуть на ответ
+ */
+export type iBXRestTaskFieldsName = keyof UppercaseKeys<CamelToSnake<iBXRestTask>>;
+export {};

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

@@ -0,0 +1,6 @@
+export type filterGenerator<Type> = {
+    [Property in keyof Type as `${filterGeneratorKey<Property & string>}`]?: Type[Property];
+};
+type filterGeneratorKey<T extends string> = `${filterKeys}${T}`;
+type filterKeys = '' | '<' | '>' | '!' | '<=' | '>=';
+export {};

package/typification/rest/tasks/base/people.d.ts

@@ -0,0 +1,12 @@
+export interface iBXRestTaskPeople extends iBXRestBaseTaskPeople {
+    id: number;
+}
+export interface iBXRestHttpTaskPeople extends iBXRestBaseTaskPeople {
+    id: string;
+}
+export interface iBXRestBaseTaskPeople {
+    name: string;
+    link: string;
+    icon: string;
+    workPosition: string;
+}

package/typification/rest/tasks/result/list.d.ts

@@ -0,0 +1,4 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamTasksTaskResultList extends iBXRestPagination {
+    taskId: number;
+}

package/typification/rest/tasks/task/add.d.ts

@@ -0,0 +1,254 @@
+import { iBXRestYesNo } from '../../base/yes-no';
+import { ObjectToSnake } from 'ts-case-convert/lib/caseConvert';
+import { ToUpperCaseKeys } from '../../../base/upper-case-keys';
+export interface iBXRestParamTaskAdd<CustomFields extends object> {
+    fields: iBXRestParamTaskAddFields<CustomFields>;
+}
+export type iBXRestParamTaskAddFields<CustomFields extends object> = iBXRestParamTaskAddFieldsBase & ToUpperCaseKeys<ObjectToSnake<CustomFields>>;
+export interface iBXRestParamTaskAddFieldsBase {
+    /**
+     * Идентификатор задачи
+     */
+    ID?: number;
+    /**
+     * ID родительской задачи
+     * По умолчанию - отсутствует
+     */
+    PARENT_ID?: number;
+    /**
+     * Название
+     */
+    TITLE: string;
+    /**
+     * Описание
+     */
+    DESCRIPTION?: string;
+    /**
+     * Оценка:
+     * N - Отрицательная,
+     * P - Положительная.
+     *
+     * По умолчанию - null
+     */
+    MARK?: 'N' | 'P' | null;
+    /**
+     * Приоритет:
+     * 2 - Высокий,
+     * 1 - Средний,
+     * 0 - Низкий.
+     *
+     * По умолчанию - 1
+     */
+    PRIORITY?: 2 | 1 | 0;
+    /**
+     * Статус	enum:
+     * 2 - Ждет выполнения,
+     * 3 - Выполняется,
+     * 4 - Ожидает контроля,
+     * 5 - Завершена,
+     * 6 - Отложена.
+     *
+     * По умолчанию - 2
+     */
+    STATUS?: 2 | 3 | 4 | 5 | 6;
+    /**
+     * Множественная задача. По умолчанию - Нет
+     */
+    MULTITASK?: iBXRestYesNo;
+    /**
+     * По умолчанию - Нет
+     */
+    NOT_VIEWED?: iBXRestYesNo;
+    /**
+     * Повторяемая задача. По умолчанию - Нет
+     */
+    REPLICATE?: iBXRestYesNo;
+    /**
+     * Проект. По умолчанию - 0
+     */
+    GROUP_ID?: number;
+    /**
+     * Стадия.	По умолчанию - 0
+     */
+    STAGE_ID?: number;
+    /**
+     * Постановщик, если оставить парамер пустым, им будет тот кто отправил запрос
+     */
+    CREATED_BY?: number;
+    /**
+     * Дата создания
+     */
+    CREATED_DATE?: Date;
+    /**
+     * Исполнитель
+     */
+    RESPONSIBLE_ID: number;
+    /**
+     * Соисполнители (id)
+     */
+    ACCOMPLICES?: number[];
+    /**
+     * Наблюдатели (id)
+     */
+    AUDITORS?: number[];
+    /**
+     * Изменил кто (id)
+     */
+    CHANGED_BY?: number;
+    /**
+     * Дата изменения
+     */
+    CHANGED_DATE?: Date;
+    /**
+     * Изменил статус
+     */
+    STATUS_CHANGED_BY?: number;
+    /**
+     * Закрыл задачу
+     */
+    CLOSED_BY?: number;
+    /**
+     * Дата закрытия
+     */
+    CLOSED_DATE?: Date;
+    /**
+     * Дата начала
+     */
+    DATE_START?: Date;
+    /**
+     * Крайний срок
+     */
+    DEADLINE?: Date;
+    /**
+     * Плановое начало
+     */
+    START_DATE_PLAN?: Date;
+    /**
+     * Плановое завершение
+     */
+    END_DATE_PLAN?: Date;
+    /**
+     * GUID
+     */
+    GUID?: string;
+    /**
+     * XML_ID
+     */
+    XML_ID?: string;
+    /**
+     * Кол-во комментариев
+     */
+    COMMENTS_COUNT?: string;
+    /**
+     * Кол-во новых комментариев
+     */
+    NEW_COMMENTS_COUNT?: string;
+    /**
+     * Разрешить менять сроки. По умолчанию - Нет
+     */
+    ALLOW_CHANGE_DEADLINE?: iBXRestYesNo;
+    /**
+     * Принять работу По умолчанию - Нет
+     */
+    TASK_CONTROL?: iBXRestYesNo;
+    /**
+     * Добавить в отчёт. По умолчанию - Нет
+     */
+    ADD_IN_REPORT?: iBXRestYesNo;
+    /**
+     * Создано из шаблона. По умолчанию - Нет
+     */
+    FORKED_BY_TEMPLATE_ID?: iBXRestYesNo;
+    /**
+     * Затраченное время
+     */
+    TIME_ESTIMATE?: number;
+    /**
+     * Затраченное время из истории изменений
+     */
+    TIME_SPENT_IN_LOGS?: number;
+    /**
+     * Пропустить выходные дни
+     */
+    MATCH_WORK_TIME?: number;
+    /**
+     * Идентификатор темы форума
+     */
+    FORUM_TOPIC_ID?: number;
+    /**
+     * Идентификатор форума
+     */
+    FORUM_ID?: number;
+    /**
+     * Идентификатор сайта
+     */
+    SITE_ID?: string;
+    /**
+     * Задача подчиненного. По умолчанию - Нет
+     */
+    SUBORDINATE?: iBXRestYesNo;
+    /**
+     * Добавлен в Избранное. По умолчанию - Нет
+     */
+    FAVORITE?: iBXRestYesNo;
+    EXCHANGE_MODIFIED?: Date;
+    EXCHANGE_ID?: number;
+    OUTLOOK_VERSION?: number;
+    /**
+     * Дата последнего просмотра
+     */
+    VIEWED_DATE?: Date;
+    /**
+     * Индекс сортировки
+     */
+    SORTING?: number;
+    /**
+     * Затрачено (план)
+     */
+    DURATION_PLAN?: number;
+    /**
+     * Затрачено (фактически)
+     */
+    DURATION_FACT?: number;
+    /**
+     * Чеклист ???
+     */
+    CHECKLIST?: any[];
+    /**
+     * DURATION_TYPE	 По умолчанию - 3
+     */
+    DURATION_TYPE?: 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Привязка к элементам CRM L_XX - lead, C_XX - contact,D_XX - deal
+     */
+    UF_CRM_TASK?: string;
+    /**
+     * Файл (Диск)	disk_file
+     */
+    UF_TASK_WEBDAV_FILES?: string[];
+    /**
+     * Письмо (email)	mail_message ???
+     */
+    UF_MAIL_MESSAGE?: any;
+    /**
+     * Уведомления. По умолчанию - Нет
+     */
+    IS_MUTED?: iBXRestYesNo;
+    /**
+     * Закреплён. По умолчанию - Нет
+     */
+    IS_PINNED?: iBXRestYesNo;
+    /**
+     * Закреплён в группе. По умолчанию - Нет
+     */
+    IS_PINNED_IN_GROUP?: iBXRestYesNo;
+    /**
+     * Разрешить учет времени в задаче, по умолчанию - нет
+     */
+    ALLOW_TIME_TRACKING?: iBXRestYesNo;
+    SERVICE_COMMENTS_COUNT?: number;
+    /**
+     * Теги
+     */
+    TAGS?: string[];
+}

package/typification/rest/tasks/task/approve.d.ts

@@ -0,0 +1,144 @@
+export interface iBXRestParamTasksTaskApprove {
+    taskId: number;
+}
+export interface iBXRestTasksTaskApproveHttp {
+    id: string;
+    parentId: string | null;
+    title: string;
+    description: string;
+    mark: null;
+    priority: string;
+    multitask: string;
+    notViewed: string;
+    replicate: string;
+    stageId: string;
+    createdBy: string;
+    createdDate: string;
+    responsibleId: string;
+    changedBy: string;
+    changedDate: string;
+    statusChangedBy: string;
+    closedBy: string;
+    closedDate: string;
+    activityDate: string;
+    dateStart: string | null;
+    deadline: string | null;
+    startDatePlan: string | null;
+    endDatePlan: string | null;
+    guid: string;
+    xmlId: string | null;
+    commentsCount: string;
+    serviceCommentsCount: string;
+    allowChangeDeadline: string;
+    allowTimeTracking: string;
+    taskControl: string;
+    addInReport: string;
+    forkedByTemplateId: string | null;
+    timeEstimate: string;
+    timeSpentInLogs: string;
+    matchWorkTime: string;
+    forumTopicId: string;
+    forumId: string;
+    siteId: string;
+    subordinate: string;
+    exchangeModified: string | null;
+    exchangeId: string | null;
+    outlookVersion: string;
+    viewedDate: string;
+    sorting: string;
+    durationFact: string;
+    isMuted: string;
+    isPinned: string;
+    isPinnedInGroup: string;
+    descriptionInBbcode: string;
+    status: string;
+    statusChangedDate: string;
+    durationPlan: string;
+    durationType: string;
+    favorite: string;
+    groupId: string;
+    auditors: any[];
+    accomplices: any[];
+    checklist: any[];
+    group: BXRestTasksTaskApproveGroup;
+    creator: BXRestTasksTaskApproveCreator;
+    responsible: BXRestTasksTaskApproveResponsible;
+    accomplicesData: any[];
+    auditorsData: any[];
+    newCommentsCount: number;
+    action: BXRestTasksTaskApproveAction;
+    checkListTree: BXRestTasksTaskApproveCheckListTree;
+    checkListCanAdd: boolean;
+}
+interface BXRestTasksTaskApproveGroup {
+    id: string;
+    name: string;
+    opened: boolean;
+    membersCount: number;
+    image: string;
+    additionalData: any[];
+}
+interface BXRestTasksTaskApproveCreator {
+    id: string;
+    name: string;
+    link: string;
+    icon: string;
+    workPosition: string;
+}
+interface BXRestTasksTaskApproveResponsible {
+    id: string;
+    name: string;
+    link: string;
+    icon: string;
+    workPosition: string;
+}
+interface BXRestTasksTaskApproveAction {
+    accept: boolean;
+    decline: boolean;
+    complete: boolean;
+    approve: boolean;
+    disapprove: boolean;
+    start: boolean;
+    pause: boolean;
+    delegate: boolean;
+    remove: boolean;
+    edit: boolean;
+    defer: boolean;
+    renew: boolean;
+    create: boolean;
+    changeDeadline: boolean;
+    checklistAddItems: boolean;
+    addFavorite: boolean;
+    deleteFavorite: boolean;
+    rate: boolean;
+    "edit.originator": boolean;
+    "checklist.reorder": boolean;
+    "elapsedtime.add": boolean;
+    "dayplan.timer.toggle": boolean;
+    "edit.plan": boolean;
+    "checklist.add": boolean;
+    "favorite.add": boolean;
+}
+interface BXRestTasksTaskApproveCheckListTree {
+    nodeId: number;
+    fields: BXRestTasksTaskApproveFields;
+    action: any[];
+    descendants: any[];
+}
+interface BXRestTasksTaskApproveFields {
+    id: string | null;
+    copiedId: string | null;
+    entityId: string | null;
+    userId: number;
+    createdBy: string | null;
+    parentId: string | null;
+    title: string;
+    sortIndex: string | null;
+    displaySortIndex: string | null;
+    isComplete: boolean;
+    isImportant: boolean;
+    completedCount: number;
+    members: any[];
+    attachments: any[];
+}
+export {};

package/typification/rest/tasks/task/base.d.ts

@@ -0,0 +1,3 @@
+export interface iBXRestTasksTaskBaseAnswer<T> {
+    task: T;
+}

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

@@ -0,0 +1,6 @@
+import { iBXRestTasksTaskApproveHttp } from './approve';
+export interface iBXRestParamTasksTaskComplete {
+    taskId: number;
+}
+export interface iBXRestTasksTaskCompleteHttp extends iBXRestTasksTaskApproveHttp {
+}

package/typification/rest/tasks/task/defer.d.ts

@@ -0,0 +1,6 @@
+import { iBXRestTasksTaskApproveHttp } from './approve';
+export interface iBXRestParamTasksTaskDefer {
+    taskId: number;
+}
+export interface iBXRestTasksTaskDeferHttp extends iBXRestTasksTaskApproveHttp {
+}