bx-rest 0.9.11 → 0.10.0

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

@@ -0,0 +1,121 @@
+import { iBXRestYesNo } from '../base/yes-no';
+import { iBXRestHttpTaskPeople, iBXRestTaskPeople } from './base/people';
+export interface iBXRestTask extends iBXRestBaseTask {
+    id: number;
+    parentId: number;
+    priority: number;
+    status: number;
+    multitask: boolean;
+    groupId: number;
+    stageId: number;
+    createdBy: number;
+    createdDate: Date;
+    responsibleId: number;
+    changedBy: number;
+    changedDate: Date;
+    statusChangedBy: number;
+    statusChangedDate: Date;
+    closedBy: number;
+    closedDate: Date | null;
+    dateStart: Date;
+    deadline: Date;
+    startDatePlan: Date;
+    endDatePlan: Date;
+    forumTopicId: number;
+    forumId: number;
+    viewedDate: Date;
+    sorting: number;
+    durationPlan: number;
+    descriptionInBbcode: boolean;
+    accomplices: number[];
+    subStatus: number;
+    creator: iBXRestTaskPeople;
+    responsible: iBXRestTaskPeople;
+    accomplicesData: iBXRestTaskPeople[];
+    allowTimeTracking: boolean;
+    tags: iBXRestTaskTag[];
+}
+export interface iBXRestHttpTask extends iBXRestBaseTask {
+    id: string;
+    parentId: string;
+    priority: string;
+    status: string;
+    multitask: iBXRestYesNo;
+    groupId: string;
+    group: iBXRestHttpTaskGroupHttp;
+    stageId: string;
+    createdBy: string;
+    createdDate: string;
+    responsibleId: string;
+    changedBy: string;
+    changedDate: string;
+    statusChangedBy: string;
+    statusChangedDate: string;
+    closedBy: string;
+    closedDate: string | null;
+    dateStart: string;
+    deadline: string;
+    startDatePlan: string;
+    endDatePlan: string;
+    forumTopicId: string;
+    forumId: string;
+    viewedDate: string;
+    sorting: string;
+    durationPlan: string;
+    descriptionInBbcode: iBXRestYesNo;
+    accomplices: string[];
+    subStatus: string;
+    additionalData: any[];
+    creator: iBXRestHttpTaskPeople;
+    responsible: iBXRestHttpTaskPeople;
+    accomplicesData: {
+        [key: number]: iBXRestHttpTaskPeople;
+    };
+    allowTimeTracking: iBXRestYesNo;
+    tags: iBXRestTaskHttpTag;
+}
+export interface iBXRestTaskTag {
+    id: number;
+    title: string;
+}
+export interface iBXRestTaskHttpTag {
+    [key: string]: {
+        id: string;
+        title: string;
+    };
+}
+export interface iBXRestHttpTaskGroupHttp {
+    id: string;
+    name: string;
+    opened: boolean;
+    membersCount: number;
+}
+export interface iBXRestBaseTask {
+    title: string;
+    description: string;
+    mark: string;
+    notViewed: string;
+    replicate: string;
+    guid: string;
+    xmlId: string;
+    commentsCount: string;
+    taskControl: string;
+    addInReport: string;
+    forkedByTemplateId: string;
+    timeEstimate: string;
+    timeSpentInLogs: string;
+    matchWorkTime: string;
+    siteId: string;
+    subordinate: string;
+    favorite: string;
+    exchangeModified: string;
+    exchangeId: string;
+    outlookVersion: string;
+    durationFact: string | null;
+    durationType: string;
+    ufCrmTask: number[];
+    ufTaskWebdavFiles: number[];
+    ufMailMessage: string;
+    auditors: number[];
+    newCommentsCount: number;
+}

package/typification/rest/tasks.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Файл для возможности импорта интерфейсов модуля tasks в локальные проекты
+ */
+export * from './tasks/base/fields-name';
+export * from './tasks/base/filter-generator';
+export * from './tasks/base/people';
+export * from './tasks/result/list';
+export * from './tasks/task/result/result';
+export * from './tasks/task/add';
+export * from './tasks/task/approve';
+export * from './tasks/task/base';
+export * from './tasks/task/complete';
+export * from './tasks/task/defer';
+export * from './tasks/task/get';
+export * from './tasks/task/getFields';
+export * from './tasks/task/list';
+export * from './tasks/task/update';
+export * from './tasks/task';

package/typification/rest/timeman/status.d.ts

@@ -0,0 +1,107 @@
+type BXRestTimeManStatusDay = 'OPENED' | 'CLOSED' | 'PAUSED' | 'EXPIRED';
+/** Параметры для timeman.status */
+export interface iBXRestParamTimeManStatus {
+    /** Идентификатор пользователя (по умолчанию текущий) */
+    USER_ID?: number;
+}
+/** Параметры для timeman.open */
+export interface iBXRestParamTimeManOpen {
+    /** Идентификатор пользователя (по умолчанию текущий) */
+    USER_ID?: number;
+    /** Время начала дня в формате ISO-8601 */
+    TIME?: Date | string;
+    /** Причина изменения рабочего дня */
+    REPORT?: string;
+    /** Широта точки начала дня */
+    LAT?: number;
+    /** Долгота точки начала дня */
+    LON?: number;
+}
+/** Параметры для timeman.close */
+export interface iBXRestParamTimeManClose {
+    /** Идентификатор пользователя (по умолчанию текущий) */
+    USER_ID?: number;
+    /** Время окончания дня в формате ISO-8601 */
+    TIME?: Date | string;
+    /** Причина изменения рабочего дня */
+    REPORT?: string;
+    /** Широта точки окончания дня */
+    LAT?: number;
+    /** Долгота точки окончания дня */
+    LON?: number;
+}
+/** Параметры для timeman.pause */
+export interface iBXRestParamTimeManPause {
+    /** Идентификатор пользователя (по умолчанию текущий) */
+    USER_ID?: number;
+}
+/** Параметры для timeman.settings */
+export interface iBXRestParamTimeManSettings {
+    /** Идентификатор пользователя (по умолчанию текущий) */
+    USER_ID?: number;
+}
+/** Ответ timeman.status после маппинга в Date/числа */
+export interface iBXRestTimeManStatus extends iBXRestTimeManStatusBase {
+    /** Дата начала рабочего дня */
+    TIME_START: Date | undefined;
+    /** Дата завершения рабочего дня */
+    TIME_FINISH: Date | undefined;
+    /** Длительность рабочего дня в секундах */
+    DURATION: number;
+    /** Суммарная длительность перерывов в секундах */
+    TIME_LEAKS: number;
+    /** Дефолтное значение закрытого дня */
+    TIME_FINISH_DEFAULT?: Date;
+}
+/** Ответ timeman.status в сыром виде от API */
+export interface iBXRestTimeManStatusHttp extends iBXRestTimeManStatusBase {
+    /** Дата начала рабочего дня в ISO-8601 */
+    TIME_START: string | null;
+    /** Дата завершения рабочего дня в ISO-8601 */
+    TIME_FINISH: string | null;
+    /** Длительность рабочего дня в HH:MM:SS */
+    DURATION: string;
+    /** Суммарная длительность перерывов в HH:MM:SS */
+    TIME_LEAKS: string;
+    /** Дефолтное значение закрытого дня */
+    TIME_FINISH_DEFAULT?: string;
+}
+/** Базовые поля статуса рабочего дня */
+interface iBXRestTimeManStatusBase {
+    /** Статус текущего рабочего дня */
+    STATUS: BXRestTimeManStatusDay;
+    /** Требуется подтверждение руководителем (false если ждет) */
+    ACTIVE: boolean;
+    /** IP при открытии дня */
+    IP_OPEN: string;
+    /** IP при закрытии дня */
+    IP_CLOSE: string;
+    /** Широта точки начала дня */
+    LAT_OPEN: number;
+    /** Долгота точки начала дня */
+    LON_OPEN: number;
+    /** Широта точки окончания дня */
+    LAT_CLOSE: number;
+    /** Долгота точки окончания дня */
+    LON_CLOSE: number;
+    /** Смещение часового пояса начала дня */
+    TZ_OFFSET: number;
+}
+/** Настройки учета рабочего времени пользователя */
+export interface iBXRestTimeManSettings {
+    /** Учет рабочего времени включен */
+    UF_TIMEMAN: boolean;
+    /** Свободный график включен */
+    UF_TM_FREE: boolean;
+    /** Максимальное время начала дня HH:MM:SS */
+    UF_TM_MAX_START: string;
+    /** Минимальное время завершения HH:MM:SS */
+    UF_TM_MIN_FINISH: string;
+    /** Минимальная длительность дня HH:MM:SS */
+    UF_TM_MIN_DURATION: string;
+    /** Допустимая дельта изменений HH:MM:SS */
+    UF_TM_ALLOWED_DELTA: string;
+    /** Может управлять днями других сотрудников (только для текущего пользователя) */
+    ADMIN?: boolean;
+}
+export {};

package/typification/rest/timeman.d.ts

@@ -0,0 +1 @@
+export * from './timeman/status';

package/typification/rest/user/get.d.ts

@@ -0,0 +1,66 @@
+import { iBXRestYesNo } from '../base/yes-no';
+import { iBXRestBaseParam } from '../support';
+import { iBXRestOrderOption } from '../base/order-options';
+import { iAllBXGender } from './user';
+export interface iBXRestParamUserGet extends iBXRestBaseParam {
+    FILTER?: iBXRestParamUserGetFilter;
+    order?: iBXRestOrderOption;
+    ADMIN_MODE?: string;
+}
+export interface iBXRestParamUserGetFilter {
+    ID?: number[] | number;
+    PERSONAL_BIRTHDAY?: string | string[];
+    /** Принадлежность к структуре компании */
+    UF_DEPARTMENT?: number[];
+    /** Внутренний телефонный номер */
+    UF_PHONE_INNER?: string;
+    /** Позволяет показать только авторизованных или нет пользователей */
+    IS_ONLINE?: iBXRestYesNo;
+    /** Быстрый поиск по персональным данны */
+    NAME_SEARCH?: string;
+    /**
+     * Тип пользователя. Может принимать следующие значения:
+     * employee - сотрудник
+     * extranet - пользователь экстранета
+     * email - почтовый пользователь
+     */
+    USER_TYPE?: 'employee' | 'extranet' | 'email';
+    /**
+     * При значении true исключает из запроса уволенных пользователей.
+     * False показывает только уволенных
+     * Отсутствие указателя показывает и тех и других
+     */
+    ACTIVE?: boolean | null;
+    EMAIL?: string;
+    NAME?: string;
+    LAST_NAME?: string;
+    SECOND_NAME?: string;
+    PERSONAL_GENDER?: iAllBXGender;
+    PERSONAL_PROFESSION?: string;
+    PERSONAL_WWW?: string;
+    PERSONAL_PHOTO?: string;
+    PERSONAL_ICQ?: string;
+    PERSONAL_PHONE?: string;
+    PERSONAL_FAX?: string;
+    PERSONAL_MOBILE?: string;
+    PERSONAL_PAGER?: string;
+    PERSONAL_STREET?: string;
+    PERSONAL_CITY?: string;
+    PERSONAL_STATE?: string;
+    PERSONAL_ZIP?: string;
+    PERSONAL_COUNTRY?: string;
+    TIME_ZONE?: string;
+    TIME_ZONE_OFFSET?: string;
+    WORK_COMPANY?: string;
+    WORK_POSITION?: string;
+    WORK_PHONE?: string;
+    UF_INTERESTS?: string;
+    UF_SKILLS?: string;
+    UF_WEB_SITES?: string;
+    UF_XING?: string;
+    UF_LINKEDIN?: string;
+    UF_FACEBOOK?: string;
+    UF_TWITTER?: string;
+    UF_SKYPE?: string;
+    UF_DISTRICT?: string;
+}

package/typification/rest/user/search.d.ts

@@ -0,0 +1,66 @@
+import { iBXRestPagination } from '../base/api-pagination-bx';
+import { iBXRestYesNo } from '../base/yes-no';
+export interface iBXRestParamUserSearch extends iBXRestPagination {
+    /**
+     * Имя
+     */
+    NAME?: string;
+    /**
+     * Фамилия
+     */
+    LAST_NAME?: string;
+    /**
+     * Отчество
+     */
+    SECOND_NAME?: string;
+    /**
+     * Должность
+     */
+    WORK_POSITION?: string;
+    /**
+     * Название подразделения
+     */
+    UF_DEPARTMENT_NAME?: string;
+    USER_TYPE?: 'employee' | 'extranet' | 'email';
+    /**
+     * Поиск по всем выше перечисленным полям
+     */
+    FIND?: string;
+    /**
+     * Уволен или нет сотрудник
+     */
+    ACTIVE?: iBXRestYesNo;
+    EMAIL?: string;
+    LAST_LOGIN?: string;
+    DATE_REGISTER?: string;
+    IS_ONLINE?: iBXRestYesNo;
+    PERSONAL_GENDER?: 'M' | 'F';
+    PERSONAL_PROFESSION?: string;
+    PERSONAL_WWW?: string;
+    PERSONAL_BIRTHDAY?: string;
+    PERSONAL_PHOTO?: string;
+    PERSONAL_ICQ?: string;
+    PERSONAL_PHONE?: string;
+    PERSONAL_FAX?: string;
+    PERSONAL_MOBILE?: string;
+    PERSONAL_PAGER?: string;
+    PERSONAL_STREET?: string;
+    PERSONAL_CITY?: string;
+    PERSONAL_STATE?: string;
+    PERSONAL_ZIP?: string;
+    PERSONAL_COUNTRY?: string;
+    TIME_ZONE_OFFSET?: string;
+    WORK_COMPANY?: string;
+    WORK_PHONE?: string;
+    UF_DEPARTMENT?: number[];
+    UF_INTERESTS?: string;
+    UF_SKILLS?: string;
+    UF_WEB_SITES?: string;
+    UF_XING?: string;
+    UF_LINKEDIN?: string;
+    UF_FACEBOOK?: string;
+    UF_TWITTER?: string;
+    UF_SKYPE?: string;
+    UF_DISTRICT?: string;
+    UF_PHONE_INNER?: string;
+}

package/typification/rest/user/user.d.ts

@@ -0,0 +1,62 @@
+import { iBXRestYesNo } from '../base/yes-no';
+export interface iBXRestUser extends iBXRestUserBase {
+    ID: number;
+    IS_ONLINE: boolean;
+    DATE_REGISTER: Date;
+    PERSONAL_BIRTHDAY: Date;
+    LAST_LOGIN?: Date;
+}
+export interface iBXRestUserHttp extends iBXRestUserBase {
+    ID: string;
+    IS_ONLINE: iBXRestYesNo;
+    DATE_REGISTER: string;
+    PERSONAL_BIRTHDAY: string;
+    LAST_LOGIN?: string;
+}
+interface iBXRestUserBase {
+    ACTIVE: boolean;
+    EMAIL: string;
+    NAME: string;
+    LAST_NAME: string;
+    SECOND_NAME: string;
+    PERSONAL_GENDER: iAllBXGender;
+    PERSONAL_PROFESSION: string;
+    PERSONAL_WWW: string;
+    PERSONAL_BIRTHDAY: string | Date;
+    PERSONAL_PHOTO: string;
+    PERSONAL_ICQ: string;
+    PERSONAL_PHONE: string;
+    PERSONAL_FAX: string;
+    PERSONAL_MOBILE: string;
+    PERSONAL_PAGER: string;
+    PERSONAL_STREET: string;
+    PERSONAL_CITY: string;
+    PERSONAL_STATE: string;
+    PERSONAL_ZIP: string;
+    PERSONAL_COUNTRY: string;
+    TIME_ZONE: string;
+    TIME_ZONE_OFFSET: string;
+    WORK_COMPANY: string;
+    WORK_POSITION: string;
+    WORK_PHONE: string;
+    UF_DEPARTMENT: number[];
+    UF_INTERESTS: string;
+    UF_SKILLS: string;
+    UF_WEB_SITES: string;
+    UF_XING: string;
+    UF_LINKEDIN: string;
+    UF_FACEBOOK: string;
+    UF_TWITTER: string;
+    UF_SKYPE: string;
+    UF_DISTRICT: string;
+    UF_PHONE_INNER: string;
+    [keys: string]: any;
+}
+export type iAllBXGender = 'M' | 'F' | '';
+export type iBXRestUserKey = keyof iBXRestUser;
+export type MapKeyBx<Type> = {
+    [Property in keyof Type]: string;
+};
+export interface iBXRestUserHttpField extends MapKeyBx<iBXRestUserBase> {
+}
+export {};

package/typification/rest/user/userFilter.d.ts

@@ -0,0 +1,13 @@
+import { iBXRestYesNo } from '../base/yes-no';
+import { iBXRestBaseParam } from '../support';
+export interface UserFilter extends iBXRestBaseParam {
+    ID?: number[] | number;
+    PERSONAL_BIRTHDAY?: string | string[];
+    order?: 'ASC' | 'DESC';
+    UF_DEPARTMENT?: number[];
+    UF_PHONE_INNER?: string;
+    IS_ONLINE?: iBXRestYesNo;
+    NAME_SEARCH?: string;
+    USER_TYPE?: 'employee' | 'extranet' | 'email';
+    ACTIVE?: 2 | 1 | 0;
+}

package/typification/rest/user/userfield/list.d.ts

@@ -0,0 +1,56 @@
+import { iBXRestUserKey } from '../user';
+import { iBXRestYesNo } from '../../base/yes-no';
+export interface iBXRestUserUserField {
+    ID: string;
+    ENTITY_ID: "USER";
+    FIELD_NAME: iBXRestUserKey;
+    USER_TYPE_ID: iCustomUserFieldInfoType;
+    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;
+    LIST?: iCustomUserFieldInfoSETTINGSTypeEnumerationLIST[];
+}
+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 iCustomUserFieldInfoType = 'string' | 'file' | 'enumeration' | 'datetime';

package/typification/rest/user.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Файл для возможности импорта интерфейсов данного пакета в локальные проекты
+ */
+export * from './user/user';
+export * from './user/get';
+export * from './user/search';
+export * from './user/userFilter';
+export * from './user/userfield/list';

package/typification/settings.d.ts

@@ -0,0 +1,11 @@
+export interface iBXRestSettings {
+    auth: {
+        source: 'cookies' | 'localStorage' | 'off' | (() => string);
+        key: 'auth' | 'sessid' | string;
+    };
+    urls: {
+        source: 'string' | 'localStorage';
+        key: string | 'OAuth2';
+        additional_part?: string;
+    };
+}