bx-rest 0.10.4 → 0.10.5

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

@@ -1,200 +0,0 @@
-import { iBXRestPagination } from '../base/api-pagination-bx';
-import { iBXRestYesNo } from '../base/yes-no';
-/** Произвольные значения полей шаблона или документа. */
-export type iBXRestDocumentGeneratorValues = Record<string, unknown>;
-/** Настройки генератора последовательных номеров. */
-export interface iBXRestCrmDocumentGeneratorNumeratorSequenceSettings {
-    start?: number;
-    step?: number;
-    length?: number;
-    padString?: string;
-    periodicBy?: '' | 'day' | 'month' | 'year' | null;
-    timezone?: string | null;
-    isDirectNumeration?: boolean;
-}
-/** Настройки нумератора документов. */
-export interface iBXRestCrmDocumentGeneratorNumeratorSettings {
-    Bitrix_Main_Numerator_Generator_SequentNumberGenerator?: iBXRestCrmDocumentGeneratorNumeratorSequenceSettings;
-}
-/** Нумератор документов. */
-export interface iBXRestCrmDocumentGeneratorNumerator {
-    id: number | string;
-    name: string;
-    template: string;
-    code?: string | null;
-    settings?: iBXRestCrmDocumentGeneratorNumeratorSettings;
-}
-export interface iBXRestParamCrmDocumentGeneratorNumeratorAdd {
-    fields: {
-        name: string;
-        template: string;
-        settings?: iBXRestCrmDocumentGeneratorNumeratorSettings;
-    };
-}
-export interface iBXRestParamCrmDocumentGeneratorNumeratorUpdate {
-    id: number;
-    fields: {
-        name?: string;
-        template?: string;
-        settings?: iBXRestCrmDocumentGeneratorNumeratorSettings;
-    };
-}
-export interface iBXRestParamCrmDocumentGeneratorNumeratorGet {
-    id: number;
-}
-export type iBXRestParamCrmDocumentGeneratorNumeratorList = iBXRestPagination;
-export interface iBXRestParamCrmDocumentGeneratorNumeratorDelete {
-    id: number;
-}
-/** Файл шаблона в формате `[имя файла, содержимое Base64]`. */
-export type iBXRestCrmDocumentGeneratorTemplateFile = [fileName: string, base64Content: string];
-/** Поля шаблона документа. */
-export interface iBXRestCrmDocumentGeneratorTemplateFields {
-    name: string;
-    file: iBXRestCrmDocumentGeneratorTemplateFile;
-    numeratorId: number;
-    region: string;
-    entityTypeId: (number | string)[];
-    users?: string[];
-    active?: iBXRestYesNo;
-    withStamps?: iBXRestYesNo;
-    sort?: number;
-}
-/** Шаблон документа. */
-export interface iBXRestCrmDocumentGeneratorTemplate {
-    id: number | string;
-    name: string;
-    region: string;
-    code?: string | null;
-    download?: string;
-    downloadMachine?: string;
-    active?: iBXRestYesNo;
-    moduleId?: string;
-    numeratorId?: number | string;
-    withStamps?: iBXRestYesNo;
-    users?: string[] | Record<string, string>;
-    isDeleted?: iBXRestYesNo;
-    sort?: number | string;
-    entityTypeId?: string[];
-    createTime?: string;
-    updateTime?: string;
-}
-export interface iBXRestParamCrmDocumentGeneratorTemplateAdd {
-    fields: iBXRestCrmDocumentGeneratorTemplateFields;
-}
-export interface iBXRestParamCrmDocumentGeneratorTemplateUpdate {
-    id: number;
-    fields: Partial<iBXRestCrmDocumentGeneratorTemplateFields>;
-}
-export interface iBXRestParamCrmDocumentGeneratorTemplateGet {
-    id: number;
-}
-export interface iBXRestParamCrmDocumentGeneratorTemplateList extends iBXRestPagination {
-    select?: string[];
-    filter?: Record<string, unknown>;
-    order?: Record<string, 'ASC' | 'DESC'>;
-}
-export interface iBXRestParamCrmDocumentGeneratorTemplateDelete {
-    id: number;
-}
-export interface iBXRestParamCrmDocumentGeneratorTemplateGetFields {
-    id: number;
-    entityTypeId: number;
-    entityId?: number;
-    values?: iBXRestDocumentGeneratorValues;
-}
-/** Описание вычисляемого поля шаблона или документа. */
-export interface iBXRestCrmDocumentGeneratorField {
-    title?: string;
-    value?: unknown;
-    required?: iBXRestYesNo;
-    group?: string[];
-    chain?: unknown;
-    default?: unknown;
-    type?: string;
-    [key: string]: unknown;
-}
-/** Сводная информация о товарах документа. */
-export interface iBXRestCrmDocumentGeneratorDocumentProducts {
-    currencyId?: string;
-    totalSum?: string;
-    totalRows?: number;
-}
-/** Документ генератора документов CRM. */
-export interface iBXRestCrmDocumentGeneratorDocument {
-    id: number | string;
-    title: string;
-    number: string;
-    createTime?: string;
-    updateTime?: string;
-    createdBy?: number | string | null;
-    updatedBy?: number | string | null;
-    changeStampsEnabled?: boolean;
-    changeStampsDisabledReason?: string;
-    changeQrCodeEnabled?: boolean;
-    qrCodeEnabled?: boolean;
-    changeQrCodeDisabledReason?: string;
-    products?: iBXRestCrmDocumentGeneratorDocumentProducts;
-    stampsEnabled?: boolean;
-    isTransformationError?: boolean;
-    values?: iBXRestDocumentGeneratorValues;
-    templateId?: number | string;
-    entityId?: number | string;
-    entityTypeId?: number | string;
-    fileId?: number | string;
-    imageId?: number | string;
-    pdfId?: number | string;
-    emailDiskFile?: number | string;
-    pullTag?: string;
-    downloadUrl?: string;
-    downloadUrlMachine?: string;
-    publicUrl?: string | null;
-    imageUrl?: string;
-    imageUrlMachine?: string;
-    pdfUrl?: string;
-    pdfUrlMachine?: string;
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentAdd {
-    templateId: number;
-    entityTypeId: number;
-    entityId: number;
-    values?: iBXRestDocumentGeneratorValues;
-    stampsEnabled?: 0 | 1;
-    fields?: Record<string, iBXRestCrmDocumentGeneratorField>;
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentUpdate {
-    id: number;
-    values?: iBXRestDocumentGeneratorValues;
-    stampsEnabled?: 0 | 1;
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentGet {
-    id: number;
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentList extends iBXRestPagination {
-    select?: string[];
-    filter?: Record<string, unknown>;
-    order?: Record<string, 'ASC' | 'DESC'>;
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentDelete {
-    id: number;
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentEnablePublicUrl {
-    id: number;
-    status?: 0 | 1;
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentUpload {
-    fields: {
-        entityTypeId: number;
-        entityId: number;
-        fileContent: string;
-        region: string;
-        title: string;
-        number: string;
-        pdfContent?: string;
-        imageContent?: string;
-    };
-}
-export interface iBXRestParamCrmDocumentGeneratorDocumentGetFields {
-    id: number;
-    values?: iBXRestDocumentGeneratorValues;
-}

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

@@ -1,57 +0,0 @@
-/** Тип CRM-объекта, поддерживаемый поиском дубликатов. */
-export type iBXRestCrmDuplicateEntityType = 'LEAD' | 'CONTACT' | 'COMPANY';
-/** Числовой идентификатор типа CRM-объекта, поддерживаемого настройкой поиска дубликатов. */
-export type iBXRestCrmDuplicateEntityTypeId = 1 | 3 | 4;
-/** Тип коммуникации, по которой выполняется поиск совпадений. */
-export type iBXRestCrmDuplicateCommunicationType = 'EMAIL' | 'PHONE';
-/** Параметры метода `crm.duplicate.findbycomm`. */
-export interface iBXRestParamCrmDuplicateFindByComm {
-    /** Тип коммуникации: email-адрес или телефон. */
-    type: iBXRestCrmDuplicateCommunicationType;
-    /** Email-адреса или телефоны для поиска. Метод принимает не более 20 значений. */
-    values: string[];
-    /** Ограничение поиска одним типом CRM-объекта. По умолчанию поиск идет по всем типам. */
-    entity_type?: iBXRestCrmDuplicateEntityType;
-}
-/** Идентификаторы CRM-объектов с совпадающими коммуникациями. */
-export type iBXRestCrmDuplicateFindByCommResult = Partial<Record<iBXRestCrmDuplicateEntityType, number[]>>;
-/** Параметры метода `crm.duplicate.volatileType.fields`. */
-export interface iBXRestParamCrmDuplicateVolatileTypeFields {
-    /** Тип CRM-объекта. Если не указан, возвращаются поля лидов, контактов и компаний. */
-    entityTypeId?: iBXRestCrmDuplicateEntityTypeId;
-}
-/** Поле, которое можно использовать для поиска дубликатов. */
-export interface iBXRestCrmDuplicateVolatileTypeField {
-    /** Тип CRM-объекта, которому принадлежит поле. */
-    entityTypeId: iBXRestCrmDuplicateEntityTypeId;
-    /** Код стандартного или пользовательского поля. */
-    fieldCode: string;
-    /** Отображаемое название поля. */
-    fieldTitle: string;
-}
-/** Параметры метода `crm.duplicate.volatileType.register`. */
-export interface iBXRestParamCrmDuplicateVolatileTypeRegister {
-    /** Тип CRM-объекта: `1` — лид, `3` — контакт, `4` — компания. */
-    entityTypeId: iBXRestCrmDuplicateEntityTypeId;
-    /** Код поля из результата `crm.duplicate.volatileType.fields`. */
-    fieldCode: string;
-}
-/** Результат добавления поля в поиск дубликатов. */
-export interface iBXRestCrmDuplicateVolatileTypeRegisterResult {
-    /** Идентификатор записи, необходимый для последующего удаления поля из поиска. */
-    id: number;
-}
-/** Нестандартное поле, уже участвующее в поиске дубликатов. */
-export interface iBXRestCrmDuplicateVolatileType {
-    /** Идентификатор записи о добавленном поле. */
-    id: number;
-    /** Тип CRM-объекта, которому принадлежит поле. */
-    entityTypeId: iBXRestCrmDuplicateEntityTypeId;
-    /** Код поля. */
-    fieldCode: string;
-}
-/** Параметры метода `crm.duplicate.volatileType.unregister`. */
-export interface iBXRestParamCrmDuplicateVolatileTypeUnregister {
-    /** Идентификатор записи из результата `crm.duplicate.volatileType.list` или `register`. */
-    id: number;
-}

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

@@ -1,29 +0,0 @@
-/**
- * Идентификатор типа CRM-объекта для объединения.
- *
- * Стандартные значения: `1` — лид, `2` — сделка, `3` — контакт, `4` — компания,
- * `7` — предложение, `31` — счет. Для смарт-процесса передается его динамический идентификатор.
- */
-export type iBXRestCrmEntityTypeId = number;
-/** Параметры метода `crm.entity.mergeBatch`. */
-export interface iBXRestParamCrmEntityMergeBatch {
-    /** Контейнер параметров объединения. */
-    params: {
-        /** Идентификатор типа объединяемых CRM-объектов. */
-        entityTypeId: iBXRestCrmEntityTypeId;
-        /**
-         * Идентификаторы как минимум двух объектов одного типа.
-         * Первый объект становится главным, остальные удаляются после успешного объединения.
-         */
-        entityIds: number[];
-    };
-}
-/** Статус объединения CRM-объектов. */
-export type iBXRestCrmEntityMergeBatchStatus = 'SUCCESS' | 'CONFLICT' | 'ERROR';
-/** Результат метода `crm.entity.mergeBatch`. */
-export interface iBXRestCrmEntityMergeBatchResult {
-    /** Статус автоматического объединения. */
-    STATUS: iBXRestCrmEntityMergeBatchStatus;
-    /** Идентификаторы объектов, удаленных после успешного объединения. */
-    ENTITY_IDS: number[];
-}

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

@@ -1,46 +0,0 @@
-/** Характеристики поля, возвращаемые методами описания полей CRM. */
-export interface iBXRestCrmFieldDescription {
-    /** Тип данных поля. */
-    type: string;
-    /** Является ли поле обязательным. */
-    isRequired: boolean;
-    /** Доступно ли поле только для чтения. */
-    isReadOnly: boolean;
-    /** Является ли поле неизменяемым. */
-    isImmutable: boolean;
-    /** Является ли поле множественным. */
-    isMultiple: boolean;
-    /** Является ли поле динамическим. */
-    isDynamic: boolean;
-    /** Отображаемое название поля. */
-    title: string;
-}
-/** Описание полей стандартного элемента перечисления CRM. */
-export interface iBXRestCrmEnumFields {
-    ID: iBXRestCrmFieldDescription;
-    NAME: iBXRestCrmFieldDescription;
-    SYMBOL_CODE: iBXRestCrmFieldDescription;
-    SYMBOL_CODE_SHORT: iBXRestCrmFieldDescription;
-}
-/** Стандартный элемент перечисления CRM. */
-export interface iBXRestCrmEnumItem {
-    /** Идентификатор элемента. */
-    ID: number;
-    /** Название элемента. */
-    NAME: string;
-    /** Символьный код, если он задан для этого перечисления. */
-    SYMBOL_CODE: string | null;
-    /** Краткий символьный код, если он задан для этого перечисления. */
-    SYMBOL_CODE_SHORT: string | null;
-}
-/** Тип объекта, к которому можно привязать заказ. */
-export interface iBXRestCrmOrderOwnerType {
-    /** Атрибут типа объекта. */
-    attribute: string;
-    /** Код типа объекта. */
-    code: string;
-    /** Идентификатор типа объекта для `ownerTypeId` методов `crm.orderentity.*`. */
-    id: number;
-    /** Название типа объекта. */
-    name: string;
-}

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

@@ -1,14 +0,0 @@
-export * from './lead';
-export * from './deal';
-export * from './contact';
-export * from './company';
-export * from './quote';
-export * from './enum';
-export * from './multifield';
-export * from './automation';
-export * from './automatedsolution';
-export * from './documentgenerator';
-export * from './currency';
-export * from './status';
-export * from './duplicate';
-export * from './entity';

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

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

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

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

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

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

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

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

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

@@ -1,52 +0,0 @@
-import { iBXRestYesNo } from '../../base/yes-no';
-export interface iBXRestCrmLead extends iBXRestCrmLeadBase {
-    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;
-    BIRTHDATE?: Date;
-    OPENED?: boolean;
-    IS_MANUAL_OPPORTUNITY?: boolean;
-    HAS_PHONE?: boolean;
-    HAS_EMAIL?: boolean;
-    HAS_IMOL?: boolean;
-    OPPORTUNITY?: number;
-}
-export interface iBXRestCrmLeadHttp extends iBXRestCrmLeadBase {
-    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;
-    BIRTHDATE?: string;
-    OPENED?: iBXRestYesNo;
-    IS_MANUAL_OPPORTUNITY?: iBXRestYesNo;
-    HAS_PHONE?: iBXRestYesNo;
-    HAS_EMAIL?: iBXRestYesNo;
-    HAS_IMOL?: iBXRestYesNo;
-    OPPORTUNITY?: string;
-}
-interface iBXRestCrmLeadBase {
-    TITLE?: string;
-    HONORIFIC?: string;
-    NAME?: string;
-    SECOND_NAME?: string;
-    LAST_NAME?: string;
-    COMPANY_TITLE?: string;
-    SOURCE_ID?: string;
-    SOURCE_DESCRIPTION?: string;
-    STATUS_ID?: string;
-    STATUS_DESCRIPTION?: string;
-    STATUS_SEMANTIC_ID?: string;
-    CURRENCY_ID?: string;
-    COMMENTS?: string;
-    [key: string]: any;
-}
-export {};

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

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

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

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

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

@@ -1,12 +0,0 @@
-import { iBXRestCrmFieldDescription } from './enum';
-/** Описание полей элемента множественного поля CRM. */
-export interface iBXRestCrmMultifieldFields {
-    /** Идентификатор элемента множественного поля. */
-    ID: iBXRestCrmFieldDescription;
-    /** Тип поля: телефон, email, мессенджер и другие. */
-    TYPE_ID: iBXRestCrmFieldDescription;
-    /** Значение поля. */
-    VALUE: iBXRestCrmFieldDescription;
-    /** Тип значения, например рабочий или мобильный телефон. */
-    VALUE_TYPE: iBXRestCrmFieldDescription;
-}