bx-rest 0.10.6 → 0.11.0

package/typification/rest/crm/timeline/logmessage.d.ts

@@ -0,0 +1,52 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+import { iBXRestCrmTimelineSortOrder } from './common';
+/** Лог-запись приложения в таймлайне CRM. */
+export interface iBXRestCrmTimelineLogMessage {
+    /** Идентификатор записи таймлайна. */
+    id: number;
+    /** Дата и время создания в формате ISO 8601. */
+    created: string;
+    /** Идентификатор автора. */
+    authorId: number;
+    /** Заголовок записи. */
+    title: string;
+    /** Текст записи. */
+    text: string;
+    /** Код иконки из `crm.timeline.icon.list`. */
+    iconCode: string;
+}
+/** Поля новой лог-записи. */
+export interface iBXRestCrmTimelineLogMessageAddFields {
+    /** Идентификатор типа CRM-сущности. */
+    entityTypeId: number;
+    /** Идентификатор элемента CRM. */
+    entityId: number;
+    /** Заголовок записи. */
+    title: string;
+    /** Текст записи. */
+    text: string;
+    /** Код иконки из `crm.timeline.icon.list`. */
+    iconCode: string;
+}
+/** Параметры добавления лог-записи. */
+export interface iBXRestParamCrmTimelineLogMessageAdd {
+    fields: iBXRestCrmTimelineLogMessageAddFields;
+}
+/** Параметры получения или удаления лог-записи. */
+export interface iBXRestParamCrmTimelineLogMessageGet {
+    /** Идентификатор лог-записи. */
+    id: number;
+}
+/** Параметры списка лог-записей приложения. */
+export interface iBXRestParamCrmTimelineLogMessageList extends iBXRestPagination {
+    /** Идентификатор типа CRM-сущности. */
+    entityTypeId: number;
+    /** Идентификатор элемента CRM. */
+    entityId: number;
+    /** Сортировка по идентификатору и/или дате создания. */
+    order?: Partial<Record<'id' | 'created', iBXRestCrmTimelineSortOrder>>;
+}
+/** Контейнер лог-записи в ответах `add` и `get`. */
+export interface iBXRestCrmTimelineLogMessageResult {
+    logMessage: iBXRestCrmTimelineLogMessage;
+}

package/typification/rest/crm/timeline/logo.d.ts

@@ -0,0 +1,9 @@
+import { iBXRestCrmTimelineMedia } from './common';
+/** Результат добавления или получения логотипа лог-записи. */
+export interface iBXRestCrmTimelineLogoResult {
+    logo: iBXRestCrmTimelineMedia;
+}
+/** Результат получения списка доступных логотипов. */
+export interface iBXRestCrmTimelineLogoListResult {
+    logos: iBXRestCrmTimelineMedia[];
+}

package/typification/rest/crm/timeline/note.d.ts

@@ -0,0 +1,31 @@
+/** Тип записи, к которой относится заметка. */
+export type iBXRestCrmTimelineNoteItemType = 1 | 2;
+/** Общие параметры методов заметок таймлайна. */
+export interface iBXRestParamCrmTimelineNote {
+    /** Идентификатор типа CRM-элемента, к которому относится запись. */
+    ownerTypeId: number;
+    /** Идентификатор CRM-элемента, к которому относится запись. */
+    ownerId: number;
+    /** `1` — запись истории таймлайна, `2` — дело CRM. */
+    itemType: iBXRestCrmTimelineNoteItemType;
+    /** Идентификатор записи истории или дела — в зависимости от `itemType`. */
+    itemId: number;
+}
+/** Параметры сохранения заметки. */
+export interface iBXRestParamCrmTimelineNoteSave extends iBXRestParamCrmTimelineNote {
+    /** Текст заметки. Повторный вызов обновляет существующую заметку. */
+    text: string;
+}
+/** Заметка к записи таймлайна или делу CRM. */
+export interface iBXRestCrmTimelineNote {
+    /** Текст заметки. */
+    text: string;
+    /** Идентификатор создавшего заметку пользователя. */
+    createdById: number;
+    /** Дата и время создания в формате ISO 8601. */
+    createdTime: string;
+    /** Идентификатор последнего изменившего заметку пользователя. */
+    updatedById: number;
+    /** Дата и время последнего изменения в формате ISO 8601. */
+    updatedTime: string;
+}

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

@@ -17,39 +17,39 @@ interface iBXRestUserBase {
     ACTIVE: boolean;
     EMAIL: string;
     NAME: string;
-    LAST_NAME: string;
-    SECOND_NAME: string;
-    PERSONAL_GENDER: iAllBXGender;
-    PERSONAL_PROFESSION: string;
-    PERSONAL_WWW: string;
+    LAST_NAME: string | null;
+    SECOND_NAME: string | null;
+    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;
+    PERSONAL_PHOTO: string | null;
+    PERSONAL_ICQ: string | null;
+    PERSONAL_PHONE: string | null;
+    PERSONAL_FAX: string | null;
+    PERSONAL_MOBILE: string | null;
+    PERSONAL_PAGER: string | null;
+    PERSONAL_STREET: string | null;
+    PERSONAL_CITY: string | null;
+    PERSONAL_STATE: string | null;
+    PERSONAL_ZIP: string | null;
+    PERSONAL_COUNTRY: string | null;
+    TIME_ZONE?: string;
+    TIME_ZONE_OFFSET?: string;
+    WORK_COMPANY?: string;
+    WORK_POSITION: string | null;
+    WORK_PHONE?: string;
+    UF_DEPARTMENT: number[] | null;
+    UF_INTERESTS?: string | null;
+    UF_SKILLS?: string | null;
+    UF_WEB_SITES?: string | null;
+    UF_XING?: string | null;
+    UF_LINKEDIN?: string | null;
+    UF_FACEBOOK?: string | null;
+    UF_TWITTER?: string | null;
+    UF_SKYPE?: string | null;
+    UF_DISTRICT?: string | null;
+    UF_PHONE_INNER?: string | null;
     [keys: string]: any;
 }
 export type iAllBXGender = 'M' | 'F' | '';