bx-rest 0.9.11 → 0.10.1

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[];
+    };
+}

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

@@ -0,0 +1,35 @@
+/** Параметры запуска webhook-триггера, настроенного в автоматизации CRM. */
+export interface iBXRestParamCrmAutomationTrigger {
+    /** Целевой объект автоматизации в формате `TYPENAME_ID`, например `DEAL_25`. */
+    target: string;
+    /** Символьный код триггера из настроек автоматизации CRM. */
+    code?: string;
+}
+/** Параметры регистрации триггера приложения. */
+export interface iBXRestParamCrmAutomationTriggerAdd {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+    /** Название триггера. */
+    NAME: string;
+}
+/** Триггер приложения, зарегистрированный в автоматизации CRM. */
+export interface iBXRestCrmAutomationTrigger {
+    /** Название триггера. */
+    NAME: string;
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+}
+/** Параметры запуска триггера приложения для объекта CRM. */
+export interface iBXRestParamCrmAutomationTriggerExecute {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+    /** Тип объекта CRM из справочника `crm.enum.ownertype`. */
+    OWNER_TYPE_ID: number;
+    /** Идентификатор элемента CRM. */
+    OWNER_ID: number;
+}
+/** Параметры удаления триггера приложения. */
+export interface iBXRestParamCrmAutomationTriggerDelete {
+    /** Внутренний уникальный идентификатор триггера в рамках приложения. */
+    CODE: string;
+}

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

@@ -0,0 +1,6 @@
+export interface iBXRestParamCrmCompanyAdd {
+    fields: Record<string, any>;
+    params?: {
+        REGISTER_SONET_EVENT?: 'Y' | 'N';
+    };
+}

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

@@ -0,0 +1,38 @@
+import { iBXRestYesNo } from '../../base/yes-no';
+export interface iBXRestCrmCompany extends iBXRestCrmCompanyBase {
+    ID: number;
+    LEAD_ID?: number;
+    ASSIGNED_BY_ID?: number;
+    CREATED_BY_ID?: number;
+    MODIFY_BY_ID?: number;
+    DATE_CREATE?: Date;
+    DATE_MODIFY?: Date;
+    OPENED?: boolean;
+    IS_MY_COMPANY?: boolean;
+    EMPLOYEES?: number;
+    REVENUE?: number;
+}
+export interface iBXRestCrmCompanyHttp extends iBXRestCrmCompanyBase {
+    ID: string;
+    LEAD_ID?: string;
+    ASSIGNED_BY_ID?: string;
+    CREATED_BY_ID?: string;
+    MODIFY_BY_ID?: string;
+    DATE_CREATE?: string;
+    DATE_MODIFY?: string;
+    OPENED?: iBXRestYesNo;
+    IS_MY_COMPANY?: iBXRestYesNo;
+    EMPLOYEES?: string;
+    REVENUE?: string;
+}
+interface iBXRestCrmCompanyBase {
+    TITLE?: string;
+    COMPANY_TYPE?: string;
+    LOGO?: string;
+    ADDRESS?: string;
+    BANKING_DETAILS?: string;
+    INDUSTRY?: string;
+    CURRENCY_ID?: string;
+    [key: string]: any;
+}
+export {};

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

@@ -0,0 +1,3 @@
+export interface iBXRestParamCrmCompanyDelete {
+    id: number | string;
+}

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

@@ -0,0 +1,3 @@
+export interface iBXRestParamCrmCompanyGet {
+    id: number | string;
+}

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

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

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

@@ -0,0 +1,6 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamCrmCompanyList extends iBXRestPagination {
+    order?: Record<string, 'asc' | 'desc'>;
+    filter?: Record<string, any>;
+    select?: string[];
+}

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

@@ -0,0 +1,7 @@
+export interface iBXRestParamCrmCompanyUpdate {
+    id: number | string;
+    fields: Record<string, any>;
+    params?: {
+        REGISTER_SONET_EVENT?: 'Y' | 'N';
+    };
+}

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

@@ -0,0 +1,6 @@
+export interface iBXRestParamCrmContactAdd {
+    fields: Record<string, any>;
+    params?: {
+        REGISTER_SONET_EVENT?: 'Y' | 'N';
+    };
+}

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

@@ -0,0 +1,41 @@
+import { iBXRestYesNo } from '../../base/yes-no';
+export interface iBXRestCrmContact extends iBXRestCrmContactBase {
+    ID: number;
+    COMPANY_ID?: number;
+    LEAD_ID?: number;
+    ASSIGNED_BY_ID?: number;
+    CREATED_BY_ID?: number;
+    MODIFY_BY_ID?: number;
+    DATE_CREATE?: Date;
+    DATE_MODIFY?: Date;
+    BIRTHDATE?: Date;
+    OPENED?: boolean;
+}
+export interface iBXRestCrmContactHttp extends iBXRestCrmContactBase {
+    ID: string;
+    COMPANY_ID?: string;
+    LEAD_ID?: string;
+    ASSIGNED_BY_ID?: string;
+    CREATED_BY_ID?: string;
+    MODIFY_BY_ID?: string;
+    DATE_CREATE?: string;
+    DATE_MODIFY?: string;
+    BIRTHDATE?: string;
+    OPENED?: iBXRestYesNo;
+}
+interface iBXRestCrmContactBase {
+    HONORIFIC?: string;
+    NAME?: string;
+    SECOND_NAME?: string;
+    LAST_NAME?: string;
+    PHOTO?: string;
+    TYPE_ID?: string;
+    SOURCE_ID?: string;
+    SOURCE_DESCRIPTION?: string;
+    COMPANY_TITLE?: string;
+    POST?: string;
+    ADDRESS?: string;
+    COMMENTS?: string;
+    [key: string]: any;
+}
+export {};

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

@@ -0,0 +1,3 @@
+export interface iBXRestParamCrmContactDelete {
+    id: number | string;
+}

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

@@ -0,0 +1,3 @@
+export interface iBXRestParamCrmContactGet {
+    id: number | string;
+}

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

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

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

@@ -0,0 +1,6 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamCrmContactList extends iBXRestPagination {
+    order?: Record<string, 'asc' | 'desc'>;
+    filter?: Record<string, any>;
+    select?: string[];
+}

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

@@ -0,0 +1,7 @@
+export interface iBXRestParamCrmContactUpdate {
+    id: number | string;
+    fields: Record<string, any>;
+    params?: {
+        REGISTER_SONET_EVENT?: 'Y' | 'N';
+    };
+}

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

@@ -0,0 +1,6 @@
+export interface iBXRestParamCrmDealAdd {
+    fields: Record<string, any>;
+    params?: {
+        REGISTER_SONET_EVENT?: 'Y' | 'N';
+    };
+}

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

@@ -0,0 +1,47 @@
+import { iBXRestYesNo } from '../../base/yes-no';
+export interface iBXRestCrmDeal extends iBXRestCrmDealBase {
+    ID: number;
+    COMPANY_ID?: number;
+    CONTACT_ID?: number;
+    ASSIGNED_BY_ID?: number;
+    CREATED_BY_ID?: number;
+    MODIFY_BY_ID?: number;
+    DATE_CREATE?: Date;
+    DATE_MODIFY?: Date;
+    BEGINDATE?: Date;
+    CLOSEDATE?: Date;
+    OPENED?: boolean;
+    IS_MANUAL_OPPORTUNITY?: boolean;
+    OPPORTUNITY?: number;
+    PROBABILITY?: number;
+    TAX_VALUE?: number;
+    LOCATION_ID?: number;
+}
+export interface iBXRestCrmDealHttp extends iBXRestCrmDealBase {
+    ID: string;
+    COMPANY_ID?: string;
+    CONTACT_ID?: string;
+    ASSIGNED_BY_ID?: string;
+    CREATED_BY_ID?: string;
+    MODIFY_BY_ID?: string;
+    DATE_CREATE?: string;
+    DATE_MODIFY?: string;
+    BEGINDATE?: string;
+    CLOSEDATE?: string;
+    OPENED?: iBXRestYesNo;
+    IS_MANUAL_OPPORTUNITY?: iBXRestYesNo;
+    OPPORTUNITY?: string;
+    PROBABILITY?: string;
+    TAX_VALUE?: string;
+    LOCATION_ID?: string;
+}
+interface iBXRestCrmDealBase {
+    TITLE?: string;
+    TYPE_ID?: string;
+    STAGE_ID?: string;
+    CURRENCY_ID?: string;
+    COMMENTS?: string;
+    ADDITIONAL_INFO?: string;
+    [key: string]: any;
+}
+export {};

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

@@ -0,0 +1,3 @@
+export interface iBXRestParamCrmDealDelete {
+    id: number | string;
+}

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

@@ -0,0 +1,3 @@
+export interface iBXRestParamCrmDealGet {
+    id: number | string;
+}

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

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

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

@@ -0,0 +1,6 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamCrmDealList extends iBXRestPagination {
+    order?: Record<string, 'asc' | 'desc'>;
+    filter?: Record<string, any>;
+    select?: string[];
+}

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

@@ -0,0 +1,7 @@
+export interface iBXRestParamCrmDealUpdate {
+    id: number | string;
+    fields: Record<string, any>;
+    params?: {
+        REGISTER_SONET_EVENT?: 'Y' | 'N';
+    };
+}