@nemigo/dadata 0.5.0

package/dist/types.d.ts

@@ -0,0 +1,815 @@
+import type { Timestamp } from "@nemigo/helpers/types";
+export interface DaDataConfig {
+    secret: string;
+    token: string;
+}
+export type CleanPhoneType = "Стационарный" | "Мобильный" | "Прямой мобильный" | "Колл-центр" | "Неизвестный";
+export interface CleanPhone {
+    type: CleanPhoneType;
+    /**
+     * @example `"+7 999 123-45-67"`
+     */
+    phone?: string;
+    /**
+     * @example `"7"`
+     */
+    country_code?: string;
+    /**
+     * Код города / DEF-код
+     *
+     * @example `"999"`
+     */
+    city_code?: string;
+    /**
+     * @example `"1234567"`
+     */
+    number?: string;
+    /**
+     * Добавочный номер
+     *
+     * @example `"89"`
+     */
+    extension?: string;
+    /**
+     * Оператор (только для России)
+     *
+     * @example `'ПАО "МТС"'`
+     */
+    provider?: string;
+    /**
+     * @example `"Россия"`
+     */
+    country?: string;
+    /**
+     * Регион (только для России)
+     *
+     * @example `"Брянская область"`
+     */
+    region?: string;
+    /**
+     * Город (только для стационарных телефонов)
+     *
+     * @example `"Москва"`
+     */
+    city?: string;
+    /**
+     * @example `"UTC+3"`
+     * @example `"UTC+5/UTC+6"`
+     */
+    timezone?: string;
+    /**
+     * - `0` — Телефон соответствует адресу
+     * - `2` — Города адреса и телефона отличаются
+     * - `3` — Регионы адреса и телефона отличаются
+     *
+     * P.S. бесполезный
+     */
+    qc_conflict: 0 | 2 | 3;
+    /**
+     * - `0` — Российский телефон, распознан уверенно
+     * - `7` — Иностранный телефон, распознан уверенно
+     * - `2` — Телефон пустой или заведомо «мусорный»
+     * - `1` — Телефон распознан с допущениями или не распознан	(ненадёжно)
+     * - `3` — Обнаружено несколько телефонов, распознан первый
+     */
+    qc: 0 | 7 | 1 | 2 | 3;
+    /**
+     * Исходный запрос
+     */
+    source: string;
+}
+export type CleanPersonGender = "М" | "Ж" | "НД";
+export interface CleanPerson {
+    gender: CleanPersonGender;
+    surname?: string;
+    name?: string;
+    patronymic?: string;
+    result?: string;
+    /**
+     * В родительном падеже (кого?)
+     */
+    result_genitive?: string;
+    /**
+     * В дательном падеже (кому?)
+     */
+    result_dative?: string;
+    /**
+     * В творительном падеже (кем?)
+     */
+    result_ablative?: string;
+    /**
+     * - `0` — Исходное значение распознано уверенно
+     * - `1` — Исходное значение распознано с допущениями или не распознано
+     */
+    qc: 1 | 0;
+    /**
+     * Исходный запрос
+     */
+    source: string;
+}
+/**
+ * @see https://confluence.hflabs.ru/pages/viewpage.action?pageId=204669103
+ */
+export interface DaDataAddress {
+    /**
+     * Адрес одной строкой БЕЗ индекса
+     */
+    value: string;
+    /**
+     * Адрес одной строкой С индексом
+     */
+    unrestricted_value: string;
+    data: {
+        /**
+         * Индекс
+         */
+        postal_code?: string;
+        /**
+         * Страна
+         */
+        country: string;
+        /**
+         * Двухсимвольный код страны ISO 3166
+         */
+        country_iso_code: string;
+        /**
+         * Федеральный округ
+         */
+        federal_district: string;
+        /**
+         * ФИАС-код региона
+         */
+        region_fias_id: string;
+        /**
+         * КЛАДР-код региона
+         */
+        region_kladr_id: string;
+        /**
+         * Код региона ISO 3166
+         */
+        region_iso_code: string;
+        /**
+         * Регион с типом
+         */
+        region_with_type: string;
+        /**
+         * Тип региона (сокращенный)
+         */
+        region_type: string;
+        /**
+         * Тип региона
+         */
+        region_type_full: string;
+        /**
+         * Регион
+         */
+        region: string;
+        /**
+         * ФИАС-код района в регионе
+         */
+        area_fias_id?: string;
+        /**
+         * КЛАДР-код района в регионе
+         */
+        area_kladr_id?: string;
+        /**
+         * Район в регионе с типом
+         */
+        area_with_type?: string;
+        /**
+         * Тип района в регионе (сокращенный)
+         */
+        area_type?: string;
+        /**
+         * Тип района в регионе
+         */
+        area_type_full?: string;
+        /**
+         * Район в регионе
+         */
+        area?: string;
+        /**
+         * ФИАС-код муниципального поселения
+         */
+        sub_area_fias_id?: string;
+        /**
+         * КЛАДР-код муниципального поселения
+         */
+        sub_area_kladr_id?: string;
+        /**
+         * Муниципальное поселение с типом
+         */
+        sub_area_with_type?: string;
+        /**
+         * Тип муниципального поселения (сокращенный)
+         */
+        sub_area_type?: string;
+        /**
+         * Тип муниципального поселения
+         */
+        sub_area_type_full?: string;
+        /**
+         * Муниципальное поселение
+         */
+        sub_area?: string;
+        /**
+         * ФИАС-код города
+         */
+        city_fias_id?: string;
+        /**
+         * КЛАДР-код города
+         */
+        city_kladr_id?: string;
+        /**
+         * Город с типом
+         */
+        city_with_type?: string;
+        /**
+         * Тип города (сокращенный)
+         */
+        city_type?: string;
+        /**
+         * Тип города
+         */
+        city_type_full?: string;
+        /**
+         * Город
+         */
+        city?: string;
+        /**
+         * Административный округ (только для Москвы)
+         */
+        city_area?: string;
+        /**
+         * ФИАС-код нас. пункта
+         */
+        settlement_fias_id?: string;
+        /**
+         * КЛАДР-код нас. пункта
+         */
+        settlement_kladr_id?: string;
+        /**
+         * Населенный пункт с типом
+         */
+        settlement_with_type?: string;
+        /**
+         * Тип населенного пункта (сокращенный)
+         */
+        settlement_type?: string;
+        /**
+         * Тип населенного пункта
+         */
+        settlement_type_full?: string;
+        /**
+         * Населенный пункт
+         */
+        settlement?: string;
+        /**
+         * ФИАС-код улицы
+         */
+        street_fias_id?: string;
+        /**
+         * КЛАДР-код улицы
+         */
+        street_kladr_id?: string;
+        /**
+         * Улица с типом
+         */
+        street_with_type?: string;
+        /**
+         * Тип улицы (сокращенный)
+         */
+        street_type?: string;
+        /**
+         * Тип улицы
+         */
+        street_type_full?: string;
+        /**
+         * Улица
+         */
+        street?: string;
+        /**
+         * ФИАС-код участка
+         */
+        stead_fias_id?: string;
+        /**
+         * Кадастровый номер участка
+         */
+        stead_cadnum?: string;
+        /**
+         * Тип участка (сокращенный)
+         */
+        stead_type?: string;
+        /**
+         * Тип участка
+         */
+        stead_type_full?: string;
+        /**
+         * Участок
+         */
+        stead?: string;
+        /**
+         * ФИАС-код дома
+         */
+        house_fias_id?: string;
+        /**
+         * КЛАДР-код дома
+         */
+        house_kladr_id?: string;
+        /**
+         * Кадастровый номер дома
+         */
+        house_cadnum?: string;
+        /**
+         * Количество квартир в доме
+         */
+        house_flat_count?: string;
+        /**
+         * Тип дома (сокращенный)
+         */
+        house_type?: string;
+        /**
+         * Тип дома
+         */
+        house_type_full?: string;
+        /**
+         * Дом
+         */
+        house?: string;
+        /**
+         * Тип корпуса/строения (сокращенный)
+         */
+        block_type?: string;
+        /**
+         * Тип корпуса/строения
+         */
+        block_type_full?: string;
+        /**
+         * Корпус/строение
+         */
+        block?: string;
+        /**
+         * ФИАС-код квартиры
+         */
+        flat_fias_id?: string;
+        /**
+         * Кадастровый номер квартиры
+         */
+        flat_cadnum?: string;
+        /**
+         * Площадь квартиры
+         */
+        flat_area?: string;
+        /**
+         * Рыночная стоимость м²
+         */
+        square_meter_price?: string;
+        /**
+         * Рыночная стоимость квартиры
+         */
+        flat_price?: string;
+        /**
+         * Тип квартиры (сокращенный)
+         */
+        flat_type?: string;
+        /**
+         * Тип квартиры
+         */
+        flat_type_full?: string;
+        /**
+         * Квартира
+         */
+        flat?: string;
+        /**
+         * ФИАС-код комнаты
+         */
+        room_fias_id?: string;
+        /**
+         * Кадастровый номер комнаты
+         */
+        room_cadnum?: string;
+        /**
+         * Тип комнаты (сокращенный)
+         */
+        room_type?: string;
+        /**
+         * Тип комнаты
+         */
+        room_type_full?: string;
+        /**
+         * Комната
+         */
+        room?: string;
+        /**
+         * Абонентский ящик
+         */
+        postal_box?: string;
+        /**
+         * ФИАС-код (он же код ГАР) адреса для России.
+         * Идентификатор OpenStreetMap для Белоруссии, Казахстана и Узбекистана.
+         * Для остальных стран — не заполняется
+         */
+        fias_id: string;
+        /**
+         * Уровень детализации, до которого адрес найден в ФИАС (ГАР):
+         *
+         * - 0 — страна
+         * - 1 — регион
+         * - 3 — район
+         * - 4 — город
+         * - 5 — район города
+         * - 6 — населенный пункт
+         * - 7 — улица
+         * - 8 — дом
+         * - 9 — квартира или комната
+         * - 65 — планировочная структура
+         * - 75 — земельный участок
+         * - -1 — иностранный или пустой
+         */
+        fias_level: string;
+        /**
+         * Признак актуальности адреса в ФИАС
+         *
+         * - 0 — актуальный
+         * - 1–50 — переименован
+         * - 51 — переподчинен
+         * - 99 — удален
+         */
+        fias_actuality_state: string;
+        /**
+         * КЛАДР-код адреса
+         */
+        kladr_id: string;
+        /**
+         * Идентификатор GeoNames. Для России не заполняется
+         */
+        geoname_id?: string;
+        /**
+         * Признак центра района или региона:
+         *
+         * - 1 — центр района
+         *      (Московская обл, Одинцовский р-н, г Одинцово)
+         * - 2 — центр региона
+         *      (Новосибирская обл, г Новосибирск)
+         * - 3 — центр района и региона
+         *      (Томская обл, г Томск)
+         * - 4 — центральный район региона
+         *      (Тюменская обл, Тюменский р-н)
+         * - 0 — ничего из перечисленного
+         *      (Московская обл, г Балашиха)
+         */
+        capital_marker: string;
+        /**
+         * Код ОКАТО
+         */
+        okato: string;
+        /**
+         * Код ОКТМО
+         */
+        oktmo: string;
+        /**
+         * Код ИФНС для физических лиц
+         */
+        tax_office: string;
+        /**
+         * Код ИФНС для организаций
+         */
+        tax_office_legal: string;
+        /**
+         * Координаты: широта
+         */
+        geo_lat?: string;
+        /**
+         * Координаты: долгота
+         */
+        geo_lon?: string;
+        /**
+         * Код точности координат:
+         *
+         * - 0 — точные координаты
+         * - 1 — ближайший дом
+         * - 2 — улица
+         * - 3 — населенный пункт
+         * - 4 — город
+         * - 5 — координаты не определены
+         */
+        qc_geo: string;
+        /**
+         * Внутри кольцевой?
+         */
+        beltway_hit?: string;
+        /**
+         * Расстояние от кольцевой в километрах
+         */
+        beltway_distance?: string;
+        /**
+         * Часовой пояс
+         *
+         * @examle "UTC+5"
+         */
+        timezone?: string;
+        /**
+         * Список исторических названий объекта нижнего уровня.
+         * Если подсказка до улицы — это прошлые названия этой улицы, если до города — города
+         */
+        history_values?: string[];
+        /**
+         * Искомое значение
+         */
+        source?: string;
+    };
+}
+/**
+ * @see https://confluence.hflabs.ru/pages/viewpage.action?pageId=204669126
+ */
+export interface DaDataParty {
+    /**
+     * Краткое наименование организации {@link DaDataParty.name.short_with_opf}.
+     * Если краткое наименование не указано — полное наименование {@link DaDataParty.name.full_with_opf}
+     *
+     * @example "ООО ТОТСОФТ"
+     */
+    value: string;
+    /**
+     * Алиас к {@link DaDataParty.value}
+     */
+    unrestricted_value: string;
+    data: {
+        /**
+         * - "INDIVIDUAL" — ИП
+         *
+         * - "LEGAL" — юридическое лицо
+         */
+        type: "INDIVIDUAL" | "LEGAL";
+        state: {
+            /**
+             * - "ACTIVE" — действующая
+             * - "LIQUIDATING" — ликвидируется
+             * - "LIQUIDATED" — ликвидирована
+             * - "REORGANIZING" — в процессе присоединения к другому юрлицу, с последующей ликвидацией
+             * - "BANKRUPT" — банкрот
+             */
+            status: "ACTIVE" | "LIQUIDATING" | "LIQUIDATED" | "REORGANIZING" | "BANKRUPT";
+            /**
+             * Актуальность сведений
+             */
+            actuality_date: Timestamp;
+            /**
+             * Дата регистрации
+             */
+            registration_date?: Timestamp;
+            /**
+             * Дата ликвидации
+             */
+            liquidation_date?: Timestamp;
+            /**
+             * @see https://github.com/hflabs/party-state/blob/master/party-state.csv
+             */
+            code?: number;
+        };
+        name: {
+            /**
+             * Полное наименование
+             *
+             * @example 'ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ "ТОТСОФТ"'
+             */
+            full_with_opf: string;
+            /**
+             * Краткое наименование
+             *
+             * @example 'ООО "ТОТСОФТ"'
+             */
+            short_with_opf?: string;
+            /**
+             * Полное наименование без ОПФ (может быть неточное)
+             *
+             * @example "ТОТСОФТ"
+             */
+            full: string;
+            /**
+             * Краткое наименование без ОПФ (может быть неточное)
+             *
+             * @example "ТОТСОФТ"
+             */
+            short?: string;
+        };
+        /**
+         * Организационно-правовая форма
+         */
+        opf: {
+            /**
+             * Полное название ОПФ
+             *
+             * @example "Общество с ограниченной ответственностью"
+             */
+            full: string;
+            /**
+             * Краткое название ОПФ
+             *
+             * @example "ООО"
+             */
+            short: string;
+            /**
+             * Версия справочника ОКОПФ
+             */
+            type: "99" | "2012" | "2014";
+            /**
+             * Код ОКОПФ
+             *
+             * @example "12300"
+             */
+            code: string;
+        };
+        /**
+         * Головное подразделение или филиал
+         *
+         * Отсутствует у ИП
+         */
+        branch_type?: "MAIN" | "BRANCH";
+        /**
+         * Количество филиалов
+         *
+         * Отсутствует у ИП
+         */
+        branch_count?: number;
+        /**
+         * ФИО у ИП
+         */
+        fio: {
+            surname: string;
+            name: string;
+            patronymic?: string;
+        };
+        /**
+         * Руководитель
+         */
+        management?: {
+            /**
+             * ФИО руководителя
+             *
+             * @example "Аристов Михаил Викторович"
+             */
+            name: string;
+            /**
+             * Должность руководителя
+             *
+             * @example "ГЕНЕРАЛЬНЫЙ ДИРЕКТОР"
+             */
+            post: string;
+            /**
+             * Дата вступления в должность
+             */
+            start_date?: Timestamp;
+            /**
+             * Если в состав руководства входят дисквалифицированные лица
+             */
+            disqualified?: boolean;
+        };
+        /**
+         * Внутренний идентификатор в Дадате
+         */
+        hid: string;
+        inn: string;
+        kpp?: string;
+        /**
+         * КПП крупнейшего налогоплательщика
+         */
+        kpp_largest?: string;
+        /**
+         * Для представительств иностранных компаний — номер записи об аккредитации (НЗА, 11 цифр) в РАФП
+         */
+        ogrn: string;
+        /**
+         * Дата выдачи ОГРН
+         */
+        ogrn_date?: Timestamp;
+        /**
+         * Код ОКАТО
+         *
+         * @example "37401000000"
+         */
+        okato?: string;
+        /**
+         * Код ОКТМО
+         *
+         * @example "37701000001"
+         */
+        oktmo?: string;
+        /**
+         * Код ОКПО
+         *
+         * @example "55669204"
+         */
+        okpo?: string;
+        /**
+         * Код ОКОГУ
+         *
+         * @example "55669204"
+         */
+        okogu?: string;
+        /**
+         * Код ОКФС
+         *
+         * @example "16"
+         */
+        okfs?: string;
+        /**
+         * Код ОКВЭД
+         *
+         * @example "80.10"
+         */
+        okved?: string;
+        /**
+         * 	Версия справочника ОКВЭД
+         */
+        okved_type?: "2001" | "2014";
+        /**
+         * Юридический адрес
+         */
+        address?: DaDataAddress;
+    };
+}
+/**
+ * @see https://confluence.hflabs.ru/pages/viewpage.action?pageId=262996082
+ */
+export interface DaDataBank {
+    /**
+     * Для банков ({@link DaDataBank.data.opf.type} = BANK): краткое наименование ({@link DaDataBank.data.name.short}).
+     * Если краткое наименование не указано — платежное наименование ({@link DaDataBank.data.name.payment})
+     *
+     * Для всех остальных: платежное наименование ({@link DaDataBank.data.name.payment})
+     */
+    value: string;
+    /**
+     * Алиас к {@link DaDataBank.value}
+     */
+    unrestricted_value: string;
+    data: {
+        inn?: string;
+        kpp?: string;
+        bic: string;
+        swift?: string;
+        /**
+         * Регистрационный номер в ЦБ РФ
+         */
+        registration_number: string;
+        /**
+         * Корреспондентский счет в ЦБ РФ
+         */
+        correspondent_account: string;
+        /**
+         * Казначейские счета территориального ОФК
+         */
+        treasury_accounts?: string[];
+        /**
+         * Наименование
+         */
+        name: {
+            payment: string;
+            short?: string;
+        };
+        /**
+         * Город для платежного поручения (поля справочника Tnp + Nnp)
+         */
+        payment_city: string;
+        /**
+         * Тип кредитной организации
+         */
+        opf: {
+            /**
+             * - CBR — главное управление Банка России
+             * - BANK — банк
+             * - BANK_BRANCH — филиал банка
+             * - NKO — небанковская кредитная организация (НКО)
+             * - NKO_BRANCH — филиал НКО
+             * - RKC — расчетно-кассовый центр
+             * - TREASURY — управление Казначейства
+             * - OTHER — другой
+             */
+            type: "CBR" | "BANK" | "BANK_BRANCH" | "NKO" | "NKO_BRANCH" | "RKC" | "TREASURY" | "OTHER";
+        };
+        state: {
+            /**
+             * - "ACTIVE" — действующая
+             * - "LIQUIDATING" — ликвидируется
+             * - "LIQUIDATED" — ликвидирована
+             *
+             * Статус `"LIQUIDATED"` в реальных данных не встречается, потому что Банк России не возвращает информацию о ликвидированных финансовых организациях
+             */
+            status: "ACTIVE" | "LIQUIDATING" | "LIQUIDATED" | "REORGANIZING" | "BANKRUPT";
+            /**
+             * Актуальность сведений
+             */
+            actuality_date: Timestamp;
+            /**
+             * Дата регистрации
+             */
+            registration_date?: Timestamp;
+            /**
+             * Дата ликвидации
+             */
+            liquidation_date?: Timestamp;
+        };
+        address?: DaDataAddress;
+    };
+}