bx-rest 0.6.1 → 0.6.2

package/map/calendar/event.d.ts

@@ -1,5 +1,6 @@
-import { iBXRestCalendarEventGetAnswer, iBXRestCalendarEventGetAnswerHttp } from '../../typification/rest/calendar/get/answer';
+import { iBXRestCalendarEventGetAnswer, iBXRestCalendarEventGetAnswerHttp } from '../../typification/rest/calendar/event/get';
 export declare class BXRestMapCalendarEvent {
+    static getById(item: iBXRestCalendarEventGetAnswerHttp | undefined | null): iBXRestCalendarEventGetAnswer | undefined;
     static get(item: iBXRestCalendarEventGetAnswerHttp[] | undefined): iBXRestCalendarEventGetAnswer[] | undefined;
     static CalendarEventGetAnswerHttpToCalendarEventGetAnswer(item: iBXRestCalendarEventGetAnswerHttp): iBXRestCalendarEventGetAnswer;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "bitrix rest api on angular, vue or typescript",
   "keywords": [
     "bitrix",

package/request-navvy/calendar/event.d.ts

@@ -1,9 +1,21 @@
-import { iBXRestCalendarEventGetParam } from '../../typification/rest/calendar/get/param';
+import { iBXRestCalendarEventGetByIdParam, iBXRestCalendarEventGetParam } from '../../typification/rest/calendar/event/get';
+import { iBXRestCalendarEventAddParam } from '../../typification/rest/calendar/event/add';
+import { iBXRestCalendarEventUpdateParam } from '../../typification/rest/calendar/event/update';
+import { iBXRestCalendarEventDeleteParam } from '../../typification/rest/calendar/event/delete';
+import { iBXRestCalendarEventGetNearestParam } from '../../typification/rest/calendar/event/get/nearest';
 export declare class BXRestNavvyRestCalendarEvent {
     private url;
     private readonly Navvy;
-    /**
-     * Возвращает список событий календаря, всегда весь список, паганации в методе нет да и не нужна
-     */
-    get(param: iBXRestCalendarEventGetParam): import("../../services/navvy/navvy-simple").NavvySimple<import("../../typification/rest/calendar/get/answer").iBXRestCalendarEventGetAnswerHttp[], import("../../typification/rest/calendar/get/answer").iBXRestCalendarEventGetAnswer[], iBXRestCalendarEventGetParam | undefined>;
+    /** Добавляет событие в календарь */
+    add(param: iBXRestCalendarEventAddParam): import("../../services/navvy/navvy-simple").NavvySimple<number, number, iBXRestCalendarEventAddParam | undefined>;
+    /** Добавляет событие в календарь */
+    delete(param: iBXRestCalendarEventDeleteParam): import("../../services/navvy/navvy-simple").NavvySimple<boolean, boolean, iBXRestCalendarEventDeleteParam | undefined>;
+    get: ((param: iBXRestCalendarEventGetParam) => import("../../services/navvy/navvy-simple").NavvySimple<import("../../typification/rest/calendar/event/get").iBXRestCalendarEventGetAnswerHttp[], import("../../typification/rest/calendar/event/get").iBXRestCalendarEventGetAnswer[], iBXRestCalendarEventGetParam | undefined>) & {
+        /** Метод получает список будущих событий */
+        nearest: (param: iBXRestCalendarEventGetNearestParam) => import("../../services/navvy/navvy-simple").NavvySimple<import("../../typification/rest/calendar/event/get").iBXRestCalendarEventGetAnswerHttp[], import("../../typification/rest/calendar/event/get").iBXRestCalendarEventGetAnswer[], iBXRestCalendarEventGetNearestParam | undefined>;
+    };
+    /** Обновление событие в календарь */
+    update(param: iBXRestCalendarEventUpdateParam): import("../../services/navvy/navvy-simple").NavvySimple<number, number, iBXRestCalendarEventUpdateParam | undefined>;
+    /** Метод получает информацию о событии календаря по идентификатору */
+    getById(param: iBXRestCalendarEventGetByIdParam): import("../../services/navvy/navvy-simple").NavvySimple<import("../../typification/rest/calendar/event/get").iBXRestCalendarEventGetAnswerHttp | null, import("../../typification/rest/calendar/event/get").iBXRestCalendarEventGetAnswer, iBXRestCalendarEventGetByIdParam | undefined>;
 }

package/request-navvy/calendar/section.d.ts

@@ -5,20 +5,12 @@ import { iBXRestCalendarSectionUpdateParam } from '../../typification/rest/calen
 export declare class BXRestNavvyRestCalendarSection {
     private url;
     private readonly Navvy;
-    /**
-     * Возвращает описание разделов, всегда весь список, паганации в методе нет да и не нужна
-     */
+    /** Возвращает описание разделов, всегда весь список, паганации в методе нет да и не нужна */
     get(param: iBXRestCalendarSectionGetParam): import("../../services/navvy/navvy-simple").NavvySimple<import("../../typification/rest/calendar/section/get").iBXRestCalendarSectionGetHttp[], import("../../typification/rest/calendar/section/get").iBXRestCalendarSectionGet[], iBXRestCalendarSectionGetParam | undefined>;
-    /**
-     * Добавляет новый раздел
-     */
+    /** Добавляет новый раздел */
     add(param: iBXRestCalendarSectionAddParam): import("../../services/navvy/navvy-simple").NavvySimple<number, number, iBXRestCalendarSectionAddParam | undefined>;
-    /**
-     * Удаляет раздел
-     */
+    /** Удаляет раздел */
     delete(param: iBXRestCalendarSectionDeleteParam): import("../../services/navvy/navvy-simple").NavvySimple<string | boolean, string | boolean, iBXRestCalendarSectionDeleteParam | undefined>;
-    /**
-     * Редактирует существующее разделы
-     */
+    /** Редактирует существующее разделы */
     update(param: iBXRestCalendarSectionUpdateParam): import("../../services/navvy/navvy-simple").NavvySimple<number, number, iBXRestCalendarSectionUpdateParam | undefined>;
 }

package/rest/base.d.ts

@@ -5,7 +5,6 @@ import { BXRestTasks } from '../request/tasks';
 import { BXRestDisk } from '../request/disk';
 import { BXRestBizProc } from '../request/bizproc';
 import { BXRestLog } from '../request/log';
-import { BXRestCalendar } from '../request/calendar';
 import { BXRestSonetGroup } from '../request/sonet_group';
 import { BXRestServer } from '../request/server';
 import { BXRestDepartment } from '../request/department';
@@ -24,7 +23,6 @@ export declare class BXRest {
     readonly disk: BXRestDisk;
     readonly bizProc: BXRestBizProc;
     readonly log: BXRestLog;
-    readonly calendar: BXRestCalendar;
     readonly sonet_group: BXRestSonetGroup;
     readonly server: BXRestServer;
     readonly department: BXRestDepartment;

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 { iBXRestCalendarType } 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: iBXRestCalendarType;
+    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: iBXRestCalendarType;
+        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: iBXRestCalendarType;
+    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 {};