bx-rest 0.9.11 → 0.10.0

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';
+    };
+}

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

@@ -0,0 +1,46 @@
+/** Характеристики поля, возвращаемые методами описания полей 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

@@ -0,0 +1,9 @@
+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';

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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,52 @@
+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

@@ -0,0 +1,6 @@
+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

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

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

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