bx-rest 0.9.11 → 0.10.0

package/typification/rest/calendar/event/add.d.ts

@@ -0,0 +1,145 @@
+import { iBXRestYesNo } from '../../base/yes-no';
+export interface iBXRestCalendarEventAddParam {
+    type: 
+    /**
+     * календарь пользователя
+     */
+    'user'
+    /**
+     * календарь группы
+     */
+     | 'group'
+    /**
+     * календарь компании
+     */
+     | 'company_calendar';
+    /**
+     * Для календаря компании параметр ownerId имеет пустое значение ""
+     */
+    ownerId: number;
+    /**
+     * Дата и время начала события.
+     *
+     * Можно указать дату без времени. Для этого передайте значение Y в параметре skip_time
+     */
+    from: Date;
+    /**
+     * Дата окончания события.
+     *
+     * Можно указать дату без времени. Для этого передайте значение Y в параметре skip_time
+     */
+    to: Date;
+    /**
+     * Дата и время в формате timestamp. Можно использовать вместо параметра from
+     */
+    from_ts?: number;
+    /**
+     * Дата и время в формате timestamp. Можно использовать вместо параметра to
+     */
+    to_ts?: number;
+    /**
+     * Идентификатор календаря
+     */
+    section: number;
+    /**
+     * Название события
+     */
+    name: string;
+    /**
+     * Передать значение даты без времени в параметрах from и to. Возможные значения:
+     *
+     * Y — использовать только дату
+     * N — использовать дату и время
+     * Формат даты по стандарту ISO-8601
+     */
+    skip_time?: iBXRestYesNo;
+    /**
+     * Часовой пояс даты и времени начала события. По умолчанию — таймзона текущего пользователя.
+     *
+     * Значение нужно передавать в виде строки, например, Europe/Riga
+     */
+    timezone_from?: string;
+    /**
+     * Часовой пояс даты и времени окончания события. Значение по умолчанию — таймзона текущего пользователя.
+     *
+     * Значение нужно передавать в виде строки, например, Europe/Riga
+     */
+    timezone_to?: string;
+    /**
+     * Описание события
+     */
+    description?: string;
+    /**
+     * Цвет фона события.
+     *
+     * Cимвол # в цвете необходимо передавать в формате unicode — %23
+     */
+    color?: string;
+    /**
+     * Цвет текста события.
+     *
+     * Cимвол # в цвете необходимо передавать в формате unicode — %23
+     */
+    text_color?: string;
+    /**
+     * Доступность на время события
+     */
+    accessibility?: 
+    /**
+     * Занят
+     */
+    'busy'
+    /**
+     * Отсутствую
+     */
+     | 'absent'
+    /**
+     * Под вопросом
+     */
+     | 'quest'
+    /**
+     * Свободен
+     */
+     | 'free';
+    /**
+     * Важность события
+     */
+    importance?: 'high' | 'normal' | 'low';
+    /**
+     * Отметка, что событие частное.
+     */
+    private_event?: iBXRestYesNo;
+    /**
+     * Повторяемость события в виде объекта в терминах стандарта iCalendar.
+     * Подробнее тут https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-add.html#rrule
+     */
+    rrule?: string;
+    is_meeting?: iBXRestYesNo;
+    location?: string;
+    /**
+     * Список идентификаторов участников события. Если is_meeting = Y
+     *
+     * Подробнее тут https://apidocs.bitrix24.ru/api-reference/calendar/calendar-event/calendar-event-add.html#remind
+     */
+    remind?: {
+        type: 'min' | 'hour' | 'day';
+        count: number;
+    }[];
+    /**
+     * Список идентификаторов участников события. Если is_meeting = Y
+     */
+    attendees?: number[];
+    /**
+     * Идентификатор организатора события. Если is_meeting = Y
+     */
+    host?: number;
+    /**
+     * Объект с параметрами встречи
+     */
+    meeting?: {
+        text?: string;
+        open?: boolean;
+        notify?: boolean;
+        reinvite?: boolean;
+    };
+}

package/typification/rest/calendar/event/delete.d.ts

@@ -0,0 +1,3 @@
+export interface iBXRestCalendarEventDeleteParam {
+    id: number;
+}

package/typification/rest/calendar/event/get/nearest.d.ts

@@ -0,0 +1,24 @@
+export interface iBXRestCalendarEventGetNearestParam {
+    /**
+     * Тип календаря:
+     * - 'user' —
+     * - 'group' — групповой календарь
+     */
+    type?: 
+    /** календарь пользователя */
+    'user'
+    /** групповой календарь */
+     | 'group'
+    /** календарь компании */
+     | 'company_calendar';
+    /** Идентификатор владельца календаря */
+    ownerId?: string;
+    /** Количество дней для выборки (по умолчанию 60) */
+    days?: number;
+    /** Учитывать только события текущего пользователя (по умолчанию false) */
+    forCurrentUser?: boolean;
+    /** Максимальное количество возвращаемых событий */
+    maxEventsCount?: number;
+    /** URL для календаря */
+    detailUrl?: string;
+}

package/typification/rest/calendar/event/get.d.ts

@@ -0,0 +1,136 @@
+import { CountryCode, TimezoneName } from 'countries-and-timezones';
+import { iBXRestCalendarTypeEvent } from '../base/type';
+import { iBXRestYesNo } from '../../base/yes-no';
+export interface iBXRestCalendarEventGetAnswer extends iBXRestCalendarEventGetAnswerBase {
+    ATTENDEE_LIST: {
+        id: number;
+        entryId: number;
+        status: 'Y' | 'N' | 'H';
+    }[];
+    CREATED_BY: string;
+    DATE_CREATE: Date;
+    DATE_FROM: Date;
+    DATE_FROM_TS_UTC: number;
+    DATE_TO: Date;
+    DATE_TO_TS_UTC: number;
+    DELETED: boolean;
+    DT_LENGTH: number;
+    DT_SKIP_TIME: boolean;
+    MEETING_STATUS: boolean;
+    EXDATE: Date[];
+    ID: number;
+    MEETING_HOST: number;
+    ORIGINAL_DATE_FROM: Date | null;
+    OWNER_ID: number;
+    PARENT_ID: number;
+    RECURRENCE_ID: number;
+    SECTION_ID: number;
+    SECT_ID: number;
+    TIMESTAMP_X: Date;
+    TZ_OFFSET_FROM: number;
+    TZ_OFFSET_TO: number;
+    VERSION: number;
+    RRULE: null | iBXRestCalendarEventGetAnswerRule;
+}
+export interface iBXRestCalendarEventGetAnswerHttp extends iBXRestCalendarEventGetAnswerBase {
+    ATTENDEE_LIST?: {
+        id: number;
+        entryId: string;
+        status: 'Y' | 'N' | 'H';
+    }[];
+    CREATED_BY: string;
+    DATE_CREATE: string;
+    DATE_FROM: string;
+    DATE_FROM_TS_UTC: string;
+    DATE_TO: string;
+    DATE_TO_TS_UTC: string;
+    DELETED: iBXRestYesNo;
+    DT_LENGTH: string;
+    DT_SKIP_TIME: iBXRestYesNo;
+    MEETING_STATUS: iBXRestYesNo;
+    EXDATE: string;
+    ID: string;
+    MEETING_HOST: string;
+    ORIGINAL_DATE_FROM: string | null;
+    OWNER_ID: string;
+    PARENT_ID: string;
+    RECURRENCE_ID: string;
+    RRULE: string | iBXRestCalendarEventGetAnswerRuleHttp;
+    SECTION_ID: string;
+    SECT_ID: string;
+    TIMESTAMP_X: string;
+    TZ_OFFSET_FROM: string;
+    TZ_OFFSET_TO: string;
+    VERSION: string;
+}
+export interface iBXRestCalendarEventGetAnswerBase {
+    ACCESSIBILITY: 'busy';
+    ATTENDEES_CODES: string[];
+    CAL_DAV_LABEL: null;
+    CAL_TYPE: iBXRestCalendarTypeEvent;
+    COLOR: string;
+    DAV_EXCH_LABEL: null;
+    DAV_XML_ID: string;
+    EVENT_TYPE: null;
+    G_EVENT_ID: null;
+    IMPORTANCE: 'normal';
+    IS_MEETING: boolean;
+    LOCATION: string;
+    RINDEX?: number;
+    MEETING: {
+        ALLOW_INVITE: boolean;
+        HIDE_GUESTS: boolean;
+        HOST_NAME: string;
+        LANGUAGE_ID: Lowercase<CountryCode>;
+        MAIL_FROM: string;
+        MEETING_CREATOR: number;
+        NOTIFY: boolean;
+        REINVITE: boolean;
+    } | null;
+    NAME: string;
+    PRIVATE_EVENT: "";
+    RELATIONS: {
+        COMMENT_XML_ID: string;
+    };
+    REMIND: {
+        type: 'min';
+        count: number;
+    }[];
+    SYNC_STATUS: null;
+    TZ_FROM: TimezoneName;
+    TZ_TO: TimezoneName;
+    UF_CRM_CAL_EVENT: boolean;
+    UF_WEBDAV_CAL_EVENT: boolean;
+    attendeesEntityList?: {
+        entityId: iBXRestCalendarTypeEvent;
+        id: number;
+    }[] | null;
+    '~USER_OFFSET_FROM': number;
+    '~USER_OFFSET_TO': number;
+}
+interface iBXRestCalendarEventGetAnswerRuleHttp extends iBXRestCalendarEventGetAnswerRuleBase {
+    UNTIL: string;
+    '~UNTIL': string;
+}
+interface iBXRestCalendarEventGetAnswerRule extends iBXRestCalendarEventGetAnswerRuleBase {
+    UNTIL: Date;
+    '~UNTIL': Date;
+}
+interface iBXRestCalendarEventGetAnswerRuleBase {
+    FR?: 'FR';
+    MO?: 'MO';
+    WE?: 'WE';
+    FREQ: 'WEEKLY';
+    INTERVAL: number;
+}
+export interface iBXRestCalendarEventGetParam {
+    type: iBXRestCalendarTypeEvent;
+    ownerId?: number;
+    from?: Date;
+    to?: Date;
+    section?: any;
+}
+export interface iBXRestCalendarEventGetByIdParam {
+    id: number;
+}
+export {};

package/typification/rest/calendar/event/update.d.ts

@@ -0,0 +1,6 @@
+import { iBXRestCalendarEventAddParam } from './add';
+type iBXRestCalendarEventAddP = Omit<iBXRestCalendarEventAddParam, 'from' | 'to' | 'section'> & Partial<Pick<iBXRestCalendarEventAddParam, 'from' | 'to' | 'section'>>;
+export interface iBXRestCalendarEventUpdateParam extends iBXRestCalendarEventAddP {
+    id: number;
+}
+export {};

package/typification/rest/calendar/section/add.d.ts

@@ -0,0 +1,10 @@
+import { iBXRestCalendarType } from '../base/type';
+export interface iBXRestCalendarSectionAddParam {
+    type: iBXRestCalendarType;
+    ownerId?: number;
+    name: string;
+    description: string;
+    color?: string;
+    text_color?: string;
+    access: string[];
+}

package/typification/rest/calendar/section/delete.d.ts

@@ -0,0 +1,6 @@
+import { iBXRestCalendarType } from '../base/type';
+export interface iBXRestCalendarSectionDeleteParam {
+    type: iBXRestCalendarType;
+    ownerId: number;
+    id: number;
+}

package/typification/rest/calendar/section/get.d.ts

@@ -0,0 +1,50 @@
+import { iBXRestCalendarType } from '../base/type';
+export interface iBXRestCalendarSectionGetParam {
+    type: iBXRestCalendarType;
+    ownerId?: number;
+}
+interface CalendarExport {
+    ALLOW: boolean;
+    LINK: string;
+}
+type CalendarAccess = Record<string, number>;
+interface CalendarPermissions {
+    view_time: boolean;
+    view_title: boolean;
+    view_full: boolean;
+    add: boolean;
+    edit: boolean;
+    edit_section: boolean;
+    access: boolean;
+}
+export interface iBXRestCalendarSectionGet extends iBXRestCalendarSectionGetBase {
+    ID: number;
+    OWNER_ID: number;
+    CREATED_BY: number;
+    DATE_CREATE: Date;
+    TIMESTAMP_X: Date;
+}
+export interface iBXRestCalendarSectionGetHttp extends iBXRestCalendarSectionGetBase {
+    ID: string;
+    OWNER_ID: string;
+    CREATED_BY: string;
+    DATE_CREATE: string;
+    TIMESTAMP_X: string;
+}
+interface iBXRestCalendarSectionGetBase {
+    NAME: string;
+    GAPI_CALENDAR_ID: string | null;
+    DESCRIPTION: string;
+    COLOR: string;
+    TEXT_COLOR: null;
+    EXPORT: CalendarExport;
+    CAL_TYPE: iBXRestCalendarType;
+    CAL_DAV_CON: null;
+    SYNC_TOKEN: null;
+    PAGE_TOKEN: null;
+    EXTERNAL_TYPE: string;
+    ACCESS: CalendarAccess;
+    IS_COLLAB: boolean;
+    PERM: CalendarPermissions;
+}
+export {};

package/typification/rest/calendar/section/update.d.ts

@@ -0,0 +1,10 @@
+import { iBXRestCalendarType } from '../base/type';
+export interface iBXRestCalendarSectionUpdateParam {
+    type: iBXRestCalendarType;
+    ownerId?: number;
+    name: string;
+    description: string;
+    color?: string;
+    text_color?: string;
+    access: string[];
+}

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

@@ -0,0 +1,102 @@
+import { iBXRestYesNo } from '../../../base/yes-no';
+export interface iBXRestCalendarUserSettingsGet {
+    /** Календарь для приглашений */
+    meetSection: number;
+    /** Календарь для CRM */
+    crmSection: number;
+    /** Скрывать нерабочее время в календаре в недельном и дневном представлении */
+    collapseOffHours: boolean;
+    /** Показывать номер недель */
+    showWeekNumbers: boolean;
+    /** Отображать задачи в календаре */
+    showTasks: boolean;
+    /** Синхронизировать календарь задач */
+    syncTasks: boolean;
+    /** Отображать завершенные задач */
+    showCompletedTasks: boolean;
+    /**
+     * Идентификатор календаря, который используется при создании событий, если в параметрах не передан идентификатор календаря.
+     *
+     * Значение по умолчанию — false
+     */
+    lastUsedSection: number | false;
+    /**
+     * Настройки предустановленных календарей.
+     *
+     * Ключем объекта настроек может быть:
+     *
+     * user[id] — тип Календарь пользователя c идентификатором пользователя. Например, user12 соответствует календарю пользователя с идентификатором 12
+     * group[id] — тип Календарь группы с идентификатором группы. Например, group36 соответствует календарю группы с идентификатором 36
+     * Значением объекта является идентификатор календаря
+     */
+    defaultSections: Record<string, number>[];
+    /** Количество месяцев для синхронизации в прошлом периоде */
+    syncPeriodPast: number;
+    /** Количество месяцев для синхронизации в будущем периоде */
+    syncPeriodFuture: number;
+}
+export interface iBXRestCalendarUserSettingsGetHttp extends iBXRestCalendarUserSettingsGetBase {
+    /** Календарь для приглашений */
+    meetSection: string;
+    /** Календарь для CRM */
+    crmSection: string;
+    /** Скрывать нерабочее время в календаре в недельном и дневном представлении */
+    collapseOffHours: iBXRestYesNo;
+    /** Показывать номер недель */
+    showWeekNumbers: iBXRestYesNo;
+    /** Отображать задачи в календаре */
+    showTasks: iBXRestYesNo;
+    /** Синхронизировать календарь задач */
+    syncTasks: iBXRestYesNo;
+    /** Отображать завершенные задач */
+    showCompletedTasks: iBXRestYesNo;
+    /**
+     * Идентификатор календаря, который используется при создании событий, если в параметрах не передан идентификатор календаря.
+     *
+     * Значение по умолчанию — false
+     */
+    lastUsedSection: string;
+    /** E-mail для отправки почтовых приглашений */
+    sendFromEmail: string;
+    /**
+     * Настройки предустановленных календарей.
+     *
+     * Ключем объекта настроек может быть:
+     *
+     * user[id] — тип Календарь пользователя c идентификатором пользователя. Например, user12 соответствует календарю пользователя с идентификатором 12
+     * group[id] — тип Календарь группы с идентификатором группы. Например, group36 соответствует календарю группы с идентификатором 36
+     * Значением объекта является идентификатор календаря
+     */
+    defaultSections: Record<string, string>[];
+    /** Количество месяцев для синхронизации в прошлом периоде */
+    syncPeriodPast: string;
+    /** Количество месяцев для синхронизации в будущем периоде */
+    syncPeriodFuture: string;
+}
+export interface iBXRestCalendarUserSettingsGetBase {
+    /** Стандартное представление для календаря */
+    view: 'day' | 'week' | 'list';
+    /** Показывать события, в которых пользователь отказался принять участие */
+    showDeclined: boolean;
+    /** Запрещать приглашать в событие, если время занято */
+    denyBusyInvitation: boolean;
+    /** Объект со стандартными настройками напоминаний о событии */
+    defaultReminders: {
+        fullDay: iBXRestCalendarUserSettingsGetDefaultReminders[];
+        withTime: iBXRestCalendarUserSettingsGetDefaultReminders[];
+    };
+    /** Таймзона календаря */
+    timezoneName: string;
+    /** Смешение таймзоны относительно UTC в секундах */
+    timezoneOffsetUTC: number;
+    /** Если параметр timezoneName не установлен, здесь будет указан часовой пояс из параметра timezoneOffsetUTC */
+    timezoneDefaultName: string;
+    /** Время начала рабочего дня */
+    work_time_start: string;
+    /** Время окончания рабочего дня */
+    work_time_end: string;
+}
+export interface iBXRestCalendarUserSettingsGetDefaultReminders {
+    type: 'min' | 'day' | 'hour';
+    count: number;
+}

package/typification/rest/calendar/user/settings/set.d.ts

@@ -0,0 +1,58 @@
+import { iBXRestYesNo } from '../../../base/yes-no';
+import { iBXRestCalendarUserSettingsGetDefaultReminders } from './get';
+export interface iBXRestCalendarUserSettingsSetParam {
+    settings: {
+        /**
+         * Вид календаря. Возможные значения:
+         * - 'month' — месяц
+         * - 'week' — неделя
+         * - 'day' — день
+         */
+        view?: 'month' | 'week' | 'day';
+        /** Раздел встреч. Идентификатор раздела */
+        meetSection?: number;
+        /** Раздел CRM. Идентификатор раздела */
+        crmSection?: number;
+        /** Показывать отклоненные события */
+        showDeclined?: boolean;
+        /** Отклонять приглашения на занятые время */
+        denyBusyInvitation?: boolean;
+        /** Свернуть внерабочие часы. Возможные значения */
+        collapseOffHours?: iBXRestYesNo;
+        /** Показывать номера недель */
+        showWeekNumbers?: iBXRestYesNo;
+        /** Показывать задачи */
+        showTasks?: iBXRestYesNo;
+        /** Синхронизировать задачи */
+        syncTasks?: iBXRestYesNo;
+        /** Показывать завершенные задачи */
+        showCompletedTasks?: iBXRestYesNo;
+        /** Последний использованный раздел */
+        lastUsedSection?: 'true' | 'false';
+        /** Электронная почта для отправки. Адрес электронной почты */
+        sendFromEmail?: string;
+        /** Стандартные разделы. Объект, где ключ — идентификатор раздела, значение — его название */
+        defaultSections?: Record<string, string | number>;
+        /** Период синхронизации в прошлом. Число дней */
+        syncPeriodPast?: number;
+        /** Период синхронизации в будущем. Число дней */
+        syncPeriodFuture?: number;
+        /**
+         * Стандартные напоминания. Объект с массивами напоминаний для целого дня и с временем.
+         */
+        defaultReminders?: {
+            fullDay?: iBXRestCalendarUserSettingsGetDefaultReminders[];
+            withTime?: iBXRestCalendarUserSettingsGetDefaultReminders[];
+        };
+        /** Название часового пояса. Например, 'Europe/Riga' */
+        timezoneName?: string;
+        /** Смещение часового пояса от UTC в секундах */
+        timezoneOffsetUTC?: number;
+        /** Название стандартного часового пояса. Например, 'Europe/Riga' */
+        timezoneDefaultName?: string;
+        /** Время начала рабочего дня. В формате 'HH:mm' */
+        work_time_start?: string;
+        /** Время окончания рабочего дня. В формате 'HH:mm' */
+        work_time_end?: string;
+    };
+}

package/typification/rest/calendar.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Файл для возможности импорта интерфейсов календаря в локальные проекты
+ */
+export * from './calendar/base/type';
+export * from './calendar/event/add';
+export * from './calendar/event/delete';
+export * from './calendar/event/get';
+export * from './calendar/event/get/nearest';
+export * from './calendar/event/update';
+export * from './calendar/section/add';
+export * from './calendar/section/delete';
+export * from './calendar/section/get';
+export * from './calendar/section/update';
+export * from './calendar/user/settings/get';
+export * from './calendar/user/settings/set';

package/typification/rest/crm/automatedsolution/add.d.ts

@@ -0,0 +1,8 @@
+export interface iBXRestParamCrmAutomatedSolutionAdd {
+    fields: {
+        /** Название цифрового рабочего места. */
+        title: string;
+        /** Идентификаторы смарт-процессов, которые нужно привязать к рабочему месту. */
+        typeIds?: number[];
+    };
+}

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

@@ -0,0 +1,23 @@
+import { iBXRestCrmFieldDescription } from '../enum';
+/** Цифровое рабочее место CRM. */
+export interface iBXRestCrmAutomatedSolution {
+    /** Уникальный идентификатор цифрового рабочего места. */
+    id: number;
+    /** Название цифрового рабочего места. */
+    title: string;
+    /** Идентификаторы смарт-процессов, привязанных к рабочему месту. */
+    typeIds: number[];
+}
+/** Контейнер ответа методов `crm.automatedsolution.add`, `get` и `update`. */
+export interface iBXRestCrmAutomatedSolutionResult {
+    automatedSolution: iBXRestCrmAutomatedSolution;
+}
+/** Контейнер ответа метода `crm.automatedsolution.list`. */
+export interface iBXRestCrmAutomatedSolutionListResult {
+    automatedSolutions?: iBXRestCrmAutomatedSolution[];
+}
+/** Описание полей цифрового рабочего места. */
+export type iBXRestCrmAutomatedSolutionFields = Record<string, iBXRestCrmFieldDescription & {
+    /** Верхний регистр имени поля в REST API. */
+    upperName: string;
+}>;

package/typification/rest/crm/automatedsolution/delete.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamCrmAutomatedSolutionDelete {
+    /** Идентификатор цифрового рабочего места. */
+    id: number | string;
+}

package/typification/rest/crm/automatedsolution/get.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamCrmAutomatedSolutionGet {
+    /** Идентификатор цифрового рабочего места. */
+    id: number | string;
+}

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

@@ -0,0 +1,6 @@
+export * from './add';
+export * from './update';
+export * from './get';
+export * from './list';
+export * from './delete';
+export * from './automatedsolution';

package/typification/rest/crm/automatedsolution/list.d.ts

@@ -0,0 +1,7 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamCrmAutomatedSolutionList extends iBXRestPagination {
+    /** Сортировка по полям `id` и `title`. */
+    order?: Record<string, 'ASC' | 'DESC' | 'asc' | 'desc'>;
+    /** Фильтр по полям `id` и `title`, включая REST-префиксы операторов. */
+    filter?: Record<string, any>;
+}

package/typification/rest/crm/automatedsolution/update.d.ts

@@ -0,0 +1,10 @@
+export interface iBXRestParamCrmAutomatedSolutionUpdate {
+    /** Идентификатор цифрового рабочего места. */
+    id: number | string;
+    fields: {
+        /** Название цифрового рабочего места. */
+        title?: string;
+        /** Полный список идентификаторов смарт-процессов, которые должны быть привязаны к рабочему месту. */
+        typeIds?: number[];
+    };
+}