bx-rest 0.9.11 → 0.10.0

package/typification/rest/socialnetwork/api/contentview/set.d.ts

@@ -0,0 +1,10 @@
+import { iBXRestYesNo } from '../../../base/yes-no';
+export interface iBXRestParamSocialNetWorkApiContentViewSet {
+    viewXMLIdList: {
+        xmlId: string;
+        save: iBXRestYesNo;
+    }[];
+}
+export interface iBXRestSocialNetWorkApiContentViewSet {
+    SUCCESS: iBXRestYesNo;
+}

package/typification/rest/socialnetwork/api/livefeed/blogpost/important/vote.d.ts

@@ -0,0 +1,12 @@
+import { iBXRestYesNo } from '../../../../../base/yes-no';
+export interface iBXRestParamSocialNetWorkApiBlogpostImportantVote {
+    params: {
+        POST_ID: number;
+    };
+}
+export interface iBXRestSocialNetWorkApiBlogpostImportantVoteHttp {
+    success: iBXRestYesNo;
+}
+export interface iBXRestSocialNetWorkApiBlogpostImportantVote {
+    success: boolean;
+}

package/typification/rest/socialnetwork.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Файл для возможности импорта интерфейсов socialnetwork.api в локальные проекты
+ */
+export * from './socialnetwork/api/contentview/set';
+export * from './socialnetwork/api/livefeed/blogpost/important/vote';

package/typification/rest/sonet_group/base.d.ts

@@ -0,0 +1,8 @@
+export type iBXRestSonetGroupFieldsSelect = iBXRestSonetGroupFieldsBase | iBXRestSonetGroupFieldsAddForSelect;
+export type iBXRestSonetGroupFieldsOrder = iBXRestSonetGroupFieldsBase | iBXRestSonetGroupFieldsAddForOrder;
+export type iBXRestSonetGroupFieldsFilter = iBXRestSonetGroupFieldsBase | iBXRestSonetGroupFieldsAddForOrder | iBXRestSonetGroupFieldsAddForFilter;
+type iBXRestSonetGroupFieldsAddForFilter = 'CHECK_PERMISSIONS';
+type iBXRestSonetGroupFieldsAddForOrder = 'OWNER_LAST_NAME' | 'OWNER_LOGIN' | 'IMAGE_ID';
+type iBXRestSonetGroupFieldsAddForSelect = 'DESCRIPTION' | 'KEYWORDS' | 'IMAGE_ID';
+export type iBXRestSonetGroupFieldsBase = 'ID' | 'SITE_ID' | 'NAME' | 'DATE_CREATE' | 'DATE_UPDATE' | 'DATE_ACTIVITY' | 'ACTIVE' | 'VISIBLE' | 'OPENED' | 'CLOSED' | 'SUBJECT_ID' | 'OWNER_ID' | 'INITIATE_PERMS' | 'SPAM_PERMS' | 'SUBJECT_NAME' | 'NUMBER_OF_MEMBERS';
+export {};

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

@@ -0,0 +1,30 @@
+import { iBXRestParamSort } from '../base/sort';
+import { iBXRestSonetGroupFieldsFilter, iBXRestSonetGroupFieldsOrder, iBXRestSonetGroupFieldsSelect } from './base';
+import { Modify } from '../../base/modyfy';
+import { iBXRestFilterGenerator } from '../base/filter-generator';
+export interface iBXRestParamSonetGroupGet {
+    FILTER?: iBXRestParamSonetGroupGetFilterWithParam;
+    ORDER?: iBXRestParamSonetOrderWorkgroup;
+}
+export type iBXRestParamSonetGroupGetFilterWithParam = iBXRestFilterGenerator<iBXRestParamSonetGroupGetFilter>;
+export interface iBXRestParamSonetGroupGetFilter extends iBXRestParamSonetFilerWorkgroup {
+    NAME: string;
+}
+export type iBXRestParamSonetFilerWorkgroup = Partial<Record<iBXRestSonetGroupFieldsFilter, string | string[] | number | number[] | Date>>;
+export type iBXRestParamSonetOrderWorkgroup = Partial<Record<iBXRestSonetGroupFieldsOrder, iBXRestParamSort>>;
+export type iBXRestSonetGroupGetHttp = Record<iBXRestSonetGroupFieldsSelect, string>;
+export type iBXRestSonetGroupGet = Modify<iBXRestSonetGroupGetHttp, {
+    ID: number;
+    DATE_CREATE: Date;
+    DATE_UPDATE: Date;
+    ACTIVE: boolean;
+    VISIBLE: boolean;
+    OPENED: boolean;
+    CLOSED: boolean;
+    SUBJECT_ID: number;
+    OWNER_ID: number;
+    NUMBER_OF_MEMBERS: number;
+    DATE_ACTIVITY: Date;
+    PROJECT: boolean;
+    IS_EXTRANET: boolean;
+}>;

package/typification/rest/sonet_group.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Файл для возможности импорта интерфейсов рабочих групп (sonet_group) в локальные проекты
+ */
+export * from './sonet_group/base';
+export * from './sonet_group/get';

package/typification/rest/support/param.d.ts

@@ -0,0 +1,5 @@
+export interface iBXRestBaseParam {
+    start?: number;
+}
+export interface iBXRestBaseParamFactor<T extends iBXRestBaseParam> {
+}

package/typification/rest/support.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Файл для возможности импорта интерфейсов модуля поддержки (support) в локальные проекты
+ */
+export * from './support/param';

package/typification/rest/task/access/getaccess.d.ts

@@ -0,0 +1,40 @@
+export interface iBXRestParamTaskGetAccess {
+    id: number;
+    /**
+     * Чеи права чекать, по у молчанию чекаются того кто запрашивает
+     */
+    users?: number[];
+}
+export interface iBXRestTaskGetAccess {
+    allowedActions: {
+        [key: number]: iBXRestTaskGetAccessItem;
+    };
+}
+export interface iBXRestTaskGetAccessItem {
+    ACCEPT: boolean;
+    DECLINE: boolean;
+    COMPLETE: boolean;
+    APPROVE: boolean;
+    DISAPPROVE: boolean;
+    START: boolean;
+    PAUSE: boolean;
+    DELEGATE: boolean;
+    REMOVE: boolean;
+    EDIT: boolean;
+    DEFER: boolean;
+    RENEW: boolean;
+    CREATE: boolean;
+    CHANGE_DEADLINE: boolean;
+    CHECKLIST_ADD_ITEMS: boolean;
+    ADD_FAVORITE: true;
+    DELETE_FAVORITE: boolean;
+    RATE: boolean;
+    'EDIT.ORIGINATOR': boolean;
+    'CHECKLIST.REORDER': boolean;
+    'ELAPSEDTIME.ADD': boolean;
+    'DAYPLAN.TIMER.TOGGLE': boolean;
+    'EDIT.PLAN': boolean;
+    'CHECKLIST.ADD': boolean;
+    'FAVORITE.ADD': boolean;
+    'FAVORITE.DELETE': boolean;
+}

package/typification/rest/task/commentitem/add.d.ts

@@ -0,0 +1,18 @@
+export interface iBXRestCommentTaskAdd {
+    TASKID: number;
+    FIELDS: iBXRestAddCommentTaskFields;
+}
+export interface iBXRestAddCommentTaskFields {
+    /**
+     * Идентификатор пользователя, от имени которого создается комментарий
+     */
+    AUTHOR_ID: number;
+    /**
+     *  Текст сообщения
+     */
+    POST_MESSAGE: string;
+    /**
+     * Массив файлов с диска для прикрепления вида ['n123', ...]
+     */
+    UF_FORUM_MESSAGE_DOC?: string[];
+}

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

@@ -0,0 +1,36 @@
+export interface iBXRestTaskComment extends iBXRestTaskCommentBase {
+    ATTACHED_OBJECTS?: iCommentTaskFile[];
+    AUTHOR_ID: number;
+    ID: number;
+    POST_DATE: Date;
+}
+export interface iBXRestTaskCommentHtml extends iBXRestTaskCommentBase {
+    ATTACHED_OBJECTS?: {
+        [key: number]: iCommentTaskFileHtml;
+    };
+    AUTHOR_ID: string;
+    ID: string;
+    POST_DATE: string;
+}
+interface iBXRestTaskCommentBase {
+    AUTHOR_EMAIL: string;
+    AUTHOR_NAME: string;
+    POST_MESSAGE: string;
+    POST_MESSAGE_HTML: null | string;
+}
+export interface iCommentTaskFile extends iCommentTaskFileBase {
+    ATTACHMENT_ID: number;
+    FILE_ID: number;
+    SIZE: number;
+}
+export interface iCommentTaskFileHtml extends iCommentTaskFileBase {
+    ATTACHMENT_ID: string;
+    FILE_ID: string;
+    SIZE: string;
+}
+interface iCommentTaskFileBase {
+    DOWNLOAD_URL: string;
+    NAME: string;
+    VIEW_URL: string;
+}
+export {};

package/typification/rest/task/commentitem/delete.d.ts

@@ -0,0 +1,4 @@
+export interface BXRestTaskCommentItemDelete {
+    TASKID: number;
+    ITEMID: number;
+}

package/typification/rest/task/commentitem/get.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamTaskCommentItemGet {
+    TASKID: number;
+    ITEMID: number;
+}

package/typification/rest/task/commentitem/getlist.d.ts

@@ -0,0 +1,20 @@
+import { iBXRestOrderOption } from '../../base/order-options';
+import { filterGenerator } from '../../tasks/base/filter-generator';
+export interface BXRestTaskCommentItemGetList {
+    FILTER: iBXRestTaskCommentItemFilterList;
+    ORDER: iBXRestTaskCommentItemOrderList;
+}
+export interface iBXRestTaskCommentItemFilterList extends filterGenerator<{
+    ID: number;
+    AUTHOR_ID: number;
+    POST_DATE: Date;
+}> {
+    AUTHOR_NAME?: string;
+}
+export interface iBXRestTaskCommentItemOrderList {
+    ID?: iBXRestOrderOption;
+    AUTHOR_ID?: iBXRestOrderOption;
+    POST_DATE?: iBXRestOrderOption;
+    AUTHOR_NAME?: iBXRestOrderOption;
+    AUTHOR_EMAIL?: iBXRestOrderOption;
+}

package/typification/rest/task/commentitem/update.d.ts

@@ -0,0 +1,4 @@
+import { iBXRestCommentTaskAdd } from './add';
+export interface iBXRestTaskCommentItemUpdate extends iBXRestCommentTaskAdd {
+    ITEMID: number;
+}

package/typification/rest/task/elapseditem/add.d.ts

@@ -0,0 +1,10 @@
+export interface iBXRestParamAddElapseditem {
+    TASKID: number;
+    FIELDS: iBXRestParamAddElapsedTaskFields;
+}
+export interface iBXRestParamAddElapsedTaskFields {
+    SECONDS: number;
+    COMMENT_TEXT: string;
+    USER_ID: number;
+    CREATED_DATE: Date;
+}

package/typification/rest/task/elapseditem/del.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamDelElapseditem {
+    TASKID: number;
+    ITEMID: number;
+}

package/typification/rest/task/elapseditem/get.d.ts

@@ -0,0 +1,23 @@
+import { iBXRestParamSort } from '../../base/sort';
+import { iBXRestFilterGenerator } from '../../base/filter-generator';
+import { iBXRestAlternativePagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamElapseditemGet extends iBXRestAlternativePagination {
+    TASKID?: number | number[];
+    ORDER?: {
+        ID?: iBXRestParamSort;
+        USER_ID?: iBXRestParamSort;
+        MINUTES?: iBXRestParamSort;
+        SECONDS?: iBXRestParamSort;
+        CREATED_DATE?: iBXRestParamSort;
+        DATE_START?: iBXRestParamSort;
+        DATE_STOP?: iBXRestParamSort;
+    };
+    FILTER?: iBXRestFilterGenerator<iBXRestParamElapseditemGetFilter>;
+    SELECT?: string[];
+}
+interface iBXRestParamElapseditemGetFilter {
+    ID?: number;
+    USER_ID?: number | number[];
+    CREATED_DATE?: string;
+}
+export {};

package/typification/rest/task/elapseditem/isActionAllowedParam.d.ts

@@ -0,0 +1,5 @@
+export interface iIsActionAllowedParam {
+    TASKID: number;
+    ITEMID: number;
+    ACTIONID: number;
+}

package/typification/rest/task/elapseditem/item.d.ts

@@ -0,0 +1,25 @@
+export interface iBXRestTaskElapsedItem extends iBXRestTaskElapsedItemBase {
+    ID: number;
+    MINUTES: number;
+    SECONDS: number;
+    TASK_ID: number;
+    USER_ID: number;
+    SOURCE: number;
+    CREATED_DATE: Date;
+    DATE_START: Date;
+    DATE_STOP: Date;
+}
+export interface iBXRestTaskElapsedItemHttp extends iBXRestTaskElapsedItemBase {
+    ID: string;
+    MINUTES: string;
+    SECONDS: string;
+    TASK_ID: string;
+    USER_ID: string;
+    SOURCE: string;
+    CREATED_DATE: string;
+    DATE_START: string;
+    DATE_STOP: string;
+}
+export interface iBXRestTaskElapsedItemBase {
+    COMMENT_TEXT: string;
+}

package/typification/rest/task/elapseditem/update.d.ts

@@ -0,0 +1,10 @@
+export interface iBXRestParamUpdateElapseditem {
+    TASKID: number;
+    ITEMID: number;
+    ARFIELDS: iBXRestParamElapsedTaskFields;
+}
+export interface iBXRestParamElapsedTaskFields {
+    SECONDS: number;
+    COMMENT_TEXT: string;
+    CREATED_DATE: Date;
+}

package/typification/rest/task/item/userfield/getlist.d.ts

@@ -0,0 +1,91 @@
+import { iBXRestYesNo } from '../../../base/yes-no';
+import { iBXRestOrderOption } from '../../../base/order-options';
+import { iBXRestPagination } from '../../../base/api-pagination-bx';
+export interface iBXRestParamTaskItemUserFieldGetlist extends iBXRestPagination {
+    ORDER?: {
+        [key in keyof iBXRestTaskItemUserFieldGetlistHttp]: iBXRestOrderOption;
+    };
+    FILTER?: {
+        ID?: number | number[];
+        USER_TYPE_ID?: 'string';
+        FIELD_NAME?: string;
+    };
+}
+export interface iBXRestTaskItemUserFieldGetlist {
+    ID: number;
+    ENTITY_ID: 'TASKS_TASK';
+    FIELD_NAME: string;
+    USER_TYPE_ID: iBXRestCustomTskFieldInfoType;
+    XML_ID: string | null;
+    SORT: string;
+    MULTIPLE: boolean;
+    MANDATORY: boolean;
+    SHOW_FILTER: 'E' | 'N';
+    SHOW_IN_LIST: boolean;
+    EDIT_IN_LIST: boolean;
+    IS_SEARCHABLE: boolean;
+    SETTINGS: iCustomUserFieldInfoSETTINGSTypeString | iCustomUserFieldInfoSETTINGSTypeFile | iCustomUserFieldInfoSETTINGSTypeEnumeration | iCustomUserFieldInfoSETTINGSTypeDatetime | iCustomUserFieldInfoSETTINGSTypeCRM;
+    LIST?: iCustomUserFieldInfoSETTINGSTypeEnumerationLIST[];
+}
+export interface iBXRestTaskItemUserFieldGetlistHttp {
+    ID: string;
+    ENTITY_ID: 'TASKS_TASK';
+    FIELD_NAME: string;
+    USER_TYPE_ID: iBXRestCustomTskFieldInfoType;
+    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 | iCustomUserFieldInfoSETTINGSTypeCRM;
+    LIST?: iCustomUserFieldInfoSETTINGSTypeEnumerationLIST[];
+}
+export interface iCustomUserFieldInfoSETTINGSTypeCRM {
+    LEAD: iBXRestYesNo;
+    CONTACT: iBXRestYesNo;
+    COMPANY: iBXRestYesNo;
+    DEAL: iBXRestYesNo;
+    ORDER: iBXRestYesNo;
+    SMART_INVOICE: iBXRestYesNo;
+}
+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 iBXRestCustomTskFieldInfoType = 'string' | 'file' | 'enumeration' | 'datetime' | 'crm';

package/typification/rest/task/stages/add.d.ts

@@ -0,0 +1,7 @@
+export interface iBXRestAddTaskStage {
+    TITLE: string;
+    COLOR: string;
+    AFTER_ID?: number;
+    ENTITY_ID?: number;
+    isAdmin?: boolean;
+}

package/typification/rest/task/stages/canMoveTask.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamTaskStagesCanMoveTask {
+    entityId: number;
+    entityType: 'U' | 'G';
+}

package/typification/rest/task/stages/get.d.ts

@@ -0,0 +1,4 @@
+export interface iBXRestParamTaskStageGet {
+    entityId: number;
+    isAdmin: boolean;
+}

package/typification/rest/task/stages/stage.d.ts

@@ -0,0 +1,19 @@
+export interface iBXRestTaskStage extends iBXRestTaskStageBase {
+    ID: number;
+    SORT: number;
+    ENTITY_ID: number;
+}
+export interface iBXRestTaskStageHttp extends iBXRestTaskStageBase {
+    ID: string;
+    SORT: string;
+    ENTITY_ID: string;
+}
+export interface iBXRestTaskStageBase {
+    TITLE: string;
+    COLOR: string;
+    SYSTEM_TYPE: null;
+    ENTITY_TYPE: string;
+    ADDITIONAL_FILTER: [];
+    TO_UPDATE: [];
+    TO_UPDATE_ACCESS: null;
+}

package/typification/rest/task/stages/update.d.ts

@@ -0,0 +1,5 @@
+import { iBXRestAddTaskStage } from './add';
+export interface iBXRestParamTaskStagesUpdate {
+    id: number;
+    fields: iBXRestAddTaskStage;
+}

package/typification/rest/task.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Файл для возможности импорта интерфейсов задач (task) в локальные проекты
+ */
+export * from './task/access/getaccess';
+export * from './task/commentitem/add';
+export * from './task/commentitem/commentitem';
+export * from './task/commentitem/delete';
+export * from './task/commentitem/get';
+export * from './task/commentitem/getlist';
+export * from './task/commentitem/update';
+export * from './task/elapseditem/add';
+export * from './task/elapseditem/del';
+export * from './task/elapseditem/get';
+export * from './task/elapseditem/isActionAllowedParam';
+export * from './task/elapseditem/item';
+export * from './task/elapseditem/update';
+export * from './task/item/userfield/getlist';
+export * from './task/stages/add';
+export * from './task/stages/canMoveTask';
+export * from './task/stages/get';
+export * from './task/stages/stage';
+export * from './task/stages/update';

package/typification/rest/tasks/base/fields-name.d.ts

@@ -0,0 +1,19 @@
+import { iBXRestHttpTask, iBXRestTask } from '../task';
+import { CamelToSnake } from 'snake-camel-types';
+/**
+ * Причины таких странных мувов можно найти тут
+ * https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php
+ *
+ * в разеделе select и после него глянуть на ответ
+ */
+type UppercaseKeys<T extends CamelToSnake<iBXRestHttpTask | iBXRestTask>> = {
+    [K in keyof T as Uppercase<K & string>]: T[K];
+};
+/**
+ * Причины таких странных мувов можно найти тут
+ * https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php
+ *
+ * в разеделе select и после него глянуть на ответ
+ */
+export type iBXRestTaskFieldsName = keyof UppercaseKeys<CamelToSnake<iBXRestTask>>;
+export {};

package/typification/rest/tasks/base/filter-generator.d.ts

@@ -0,0 +1,6 @@
+export type filterGenerator<Type> = {
+    [Property in keyof Type as `${filterGeneratorKey<Property & string>}`]?: Type[Property];
+};
+type filterGeneratorKey<T extends string> = `${filterKeys}${T}`;
+type filterKeys = '' | '<' | '>' | '!' | '<=' | '>=';
+export {};

package/typification/rest/tasks/base/people.d.ts

@@ -0,0 +1,12 @@
+export interface iBXRestTaskPeople extends iBXRestBaseTaskPeople {
+    id: number;
+}
+export interface iBXRestHttpTaskPeople extends iBXRestBaseTaskPeople {
+    id: string;
+}
+export interface iBXRestBaseTaskPeople {
+    name: string;
+    link: string;
+    icon: string;
+    workPosition: string;
+}

package/typification/rest/tasks/result/list.d.ts

@@ -0,0 +1,4 @@
+import { iBXRestPagination } from '../../base/api-pagination-bx';
+export interface iBXRestParamTasksTaskResultList extends iBXRestPagination {
+    taskId: number;
+}