autoteka

Источник API: Автотека.json.

Enum

• AutotekaStatus

Пакет autoteka.

AutotekaMonitoring dataclass

AutotekaMonitoring(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект мониторинга Автотеки.

create_monitoring_bucket_add

create_monitoring_bucket_add(
    *,
    vehicles: list[str],
    idempotency_key: str | None = None,
) -> MonitoringBucketResult

Выполняет публичную операцию AutotekaMonitoring.create_monitoring_bucket_add и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

delete_bucket

delete_bucket(
    *, idempotency_key: str | None = None
) -> MonitoringBucketResult

Очищает bucket мониторинга.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

remove_bucket

remove_bucket(
    *,
    vehicles: list[str],
    idempotency_key: str | None = None,
) -> MonitoringBucketResult

Удаляет автомобили из bucket мониторинга.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_monitoring_reg_actions

get_monitoring_reg_actions(
    *, query: MonitoringEventsQuery | None = None
) -> MonitoringEventsResult

Выполняет публичную операцию AutotekaMonitoring.get_monitoring_reg_actions и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

AutotekaReport dataclass

AutotekaReport(
    transport: Transport,
    report_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект отчетов и пакетов Автотеки.

get_active_package

get_active_package() -> AutotekaPackageInfo

Выполняет публичную операцию AutotekaReport.get_active_package и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_report

create_report(
    *, preview_id: int, idempotency_key: str | None = None
) -> AutotekaReportInfo

Выполняет публичную операцию AutotekaReport.create_report и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_report_by_vehicle_id

create_report_by_vehicle_id(
    *, vehicle_id: str, idempotency_key: str | None = None
) -> AutotekaReportInfo

Выполняет публичную операцию AutotekaReport.create_report_by_vehicle_id и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

list_reports

list_reports() -> AutotekaReportsResult

Получает список отчетов Автотеки.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_report

get_report(
    *, report_id: int | str | None = None
) -> AutotekaReportInfo

Выполняет публичную операцию AutotekaReport.get_report и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_sync_report_by_reg_number

create_sync_report_by_reg_number(
    *, reg_number: str, idempotency_key: str | None = None
) -> AutotekaReportInfo

Выполняет публичную операцию AutotekaReport.create_sync_report_by_reg_number и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_sync_report_by_vin

create_sync_report_by_vin(
    *, vin: str, idempotency_key: str | None = None
) -> AutotekaReportInfo

Выполняет публичную операцию AutotekaReport.create_sync_report_by_vin и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

AutotekaScoring dataclass

AutotekaScoring(
    transport: Transport,
    scoring_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект скоринга рисков.

create_scoring_by_vehicle_id

create_scoring_by_vehicle_id(
    *, vehicle_id: str, idempotency_key: str | None = None
) -> AutotekaScoringInfo

Выполняет публичную операцию AutotekaScoring.create_scoring_by_vehicle_id и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_scoring_by_id

get_scoring_by_id(
    *, scoring_id: int | str | None = None
) -> AutotekaScoringInfo

Выполняет публичную операцию AutotekaScoring.get_scoring_by_id и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

AutotekaValuation dataclass

AutotekaValuation(
    transport: Transport, user_id: int | str | None = None
)

Bases: DomainObject

Доменный объект оценки автомобиля.

get_valuation_by_specification

get_valuation_by_specification(
    *, specification_id: int, mileage: int
) -> AutotekaValuationInfo

Выполняет публичную операцию AutotekaValuation.get_valuation_by_specification и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

AutotekaVehicle dataclass

AutotekaVehicle(
    transport: Transport,
    vehicle_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект превью, спецификаций, тизеров и каталога.

resolve_catalog

resolve_catalog(*, brand_id: int) -> CatalogResolveResult

Актуализирует параметры автокаталога.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_leads

get_leads(*, limit: int) -> AutotekaLeadsResult

Выполняет публичную операцию AutotekaVehicle.get_leads и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_preview_by_vin

create_preview_by_vin(
    *, vin: str, idempotency_key: str | None = None
) -> AutotekaPreviewInfo

Выполняет публичную операцию AutotekaVehicle.create_preview_by_vin и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_preview

get_preview(
    *, preview_id: int | str | None = None
) -> AutotekaPreviewInfo

Выполняет публичную операцию AutotekaVehicle.get_preview и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_preview_by_external_item

create_preview_by_external_item(
    *,
    item_id: str,
    site: str,
    idempotency_key: str | None = None,
) -> AutotekaPreviewInfo

Выполняет публичную операцию AutotekaVehicle.create_preview_by_external_item и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_preview_by_item_id

create_preview_by_item_id(
    *, item_id: int, idempotency_key: str | None = None
) -> AutotekaPreviewInfo

Выполняет публичную операцию AutotekaVehicle.create_preview_by_item_id и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_preview_by_reg_number

create_preview_by_reg_number(
    *, reg_number: str, idempotency_key: str | None = None
) -> AutotekaPreviewInfo

Выполняет публичную операцию AutotekaVehicle.create_preview_by_reg_number и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_specification_by_plate_number

create_specification_by_plate_number(
    *, plate_number: str, idempotency_key: str | None = None
) -> AutotekaSpecificationInfo

Выполняет публичную операцию AutotekaVehicle.create_specification_by_plate_number и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_specification_by_vehicle_id

create_specification_by_vehicle_id(
    *, vehicle_id: str, idempotency_key: str | None = None
) -> AutotekaSpecificationInfo

Выполняет публичную операцию AutotekaVehicle.create_specification_by_vehicle_id и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_specification_by_id

get_specification_by_id(
    *, specification_id: int | str | None = None
) -> AutotekaSpecificationInfo

Выполняет публичную операцию AutotekaVehicle.get_specification_by_id и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_teaser

create_teaser(
    *, vehicle_id: str, idempotency_key: str | None = None
) -> AutotekaTeaserInfo

Выполняет публичную операцию AutotekaVehicle.create_teaser и возвращает типизированную SDK-модель.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_teaser

get_teaser(
    *, teaser_id: int | str | None = None
) -> AutotekaTeaserInfo

Выполняет публичную операцию AutotekaVehicle.get_teaser и возвращает типизированную SDK-модель.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

AutotekaStatus

Bases: str, Enum

Статус сущности Автотеки.

AutotekaLeadEvent dataclass

AutotekaLeadEvent(
    event_id: str | None,
    subscription_id: str | None,
    vehicle_id: str | None,
    item_id: int | None,
    brand: str | None,
    model: str | None,
    price: int | None,
    created_at: str | None,
    url: str | None,
)

Bases: SerializableModel

Событие сервиса Сигнал.

AutotekaLeadsResult dataclass

AutotekaLeadsResult(
    items: list[AutotekaLeadEvent],
    last_id: int | None = None,
)

Bases: SerializableModel

Список событий сервиса Сигнал.

AutotekaPackageInfo dataclass

AutotekaPackageInfo(
    reports_total: int | None,
    reports_remaining: int | None,
    created_at: str | None,
    expires_at: str | None,
)

Bases: SerializableModel

Информация о текущем пакете отчетов Автотеки.

AutotekaPreviewInfo dataclass

AutotekaPreviewInfo(
    preview_id: str | None,
    status: AutotekaStatus | None,
    vehicle_id: str | None,
    reg_number: str | None,
)

Bases: SerializableModel

Информация о превью автомобиля.

AutotekaReportInfo dataclass

AutotekaReportInfo(
    report_id: str | None,
    status: AutotekaStatus | None,
    vehicle_id: str | None,
    created_at: str | None,
    web_link: str | None,
    pdf_link: str | None,
)

Bases: SerializableModel

Информация об отчете Автотеки.

AutotekaReportsResult dataclass

AutotekaReportsResult(items: list[AutotekaReportInfo])

Bases: SerializableModel

Список отчетов Автотеки.

AutotekaScoringInfo dataclass

AutotekaScoringInfo(
    scoring_id: str | None,
    is_completed: bool | None,
    created_at: int | None,
)

Bases: SerializableModel

Информация о скоринге рисков.

AutotekaSpecificationInfo dataclass

AutotekaSpecificationInfo(
    specification_id: str | None,
    status: AutotekaStatus | None,
    vehicle_id: str | None,
    plate_number: str | None,
)

Bases: SerializableModel

Информация о запросе спецификации автомобиля.

AutotekaTeaserInfo dataclass

AutotekaTeaserInfo(
    teaser_id: str | None,
    status: AutotekaStatus | None,
    brand: str | None = None,
    model: str | None = None,
    year: int | None = None,
)

Bases: SerializableModel

Информация о тизере Автотеки.

AutotekaValuationInfo dataclass

AutotekaValuationInfo(
    status: AutotekaStatus | None,
    vehicle_id: str | None,
    brand: str | None,
    model: str | None,
    year: int | None,
    owners_count: str | None,
    mileage: int | None,
    avg_price_with_condition: int | None,
    avg_market_price: int | None,
)

Bases: SerializableModel

Оценка стоимости автомобиля.

CatalogField dataclass

CatalogField(
    field_id: str | None,
    label: str | None,
    data_type: str | None,
    values: list[CatalogFieldValue],
)

Bases: SerializableModel

Параметр автокаталога.

CatalogFieldValue dataclass

CatalogFieldValue(value_id: str | None, label: str | None)

Bases: SerializableModel

Значение параметра автокаталога.

CatalogResolveRequest dataclass

CatalogResolveRequest(brand_id: int)

Запрос актуализации параметров автокаталога.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос автокаталога.

CatalogResolveResult dataclass

CatalogResolveResult(items: list[CatalogField])

Bases: SerializableModel

Результат актуализации параметров автокаталога.

ExternalItemPreviewRequest dataclass

ExternalItemPreviewRequest(item_id: str, site: str)

Запрос превью по внешнему объявлению.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос внешнего объявления.

ItemIdRequest dataclass

ItemIdRequest(item_id: int)

Запрос по идентификатору объявления.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос по item id.

LeadsRequest dataclass

LeadsRequest(limit: int)

Запрос событий сервиса Сигнал.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос событий Сигнал.

MonitoringBucketRequest dataclass

MonitoringBucketRequest(vehicles: list[str])

Запрос изменения списка мониторинга.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос изменения списка мониторинга.

MonitoringBucketResult dataclass

MonitoringBucketResult(
    success: bool,
    invalid_vehicles: list[MonitoringInvalidVehicle],
)

Bases: SerializableModel

Результат изменения списка мониторинга.

MonitoringEvent dataclass

MonitoringEvent(
    vehicle_id: str | None,
    brand: str | None,
    model: str | None,
    year: int | None,
    operation_code: int | None,
    operation_date_from: str | None,
    operation_date_to: str | None,
    owner_code: int | None,
    actual_at: int | None,
)

Bases: SerializableModel

Событие мониторинга регистрационных действий.

MonitoringEventsQuery dataclass

MonitoringEventsQuery(limit: int | None = None)

Query событий мониторинга.

to_params

to_params() -> dict[str, object]

Сериализует query событий мониторинга.

MonitoringEventsResult dataclass

MonitoringEventsResult(
    items: list[MonitoringEvent],
    has_next: bool | None = None,
    next_cursor: str | None = None,
    next_link: str | None = None,
)

Bases: SerializableModel

Список событий мониторинга.

MonitoringInvalidVehicle dataclass

MonitoringInvalidVehicle(
    vehicle_id: str | None, description: str | None
)

Bases: SerializableModel

Невалидный идентификатор авто в запросах мониторинга.

PlateNumberRequest dataclass

PlateNumberRequest(plate_number: str)

Запрос по номерному знаку.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос по номерному знаку.

PreviewReportRequest dataclass

PreviewReportRequest(preview_id: int)

Запрос отчета по preview id.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос отчета по preview id.

RegNumberRequest dataclass

RegNumberRequest(reg_number: str)

Запрос по государственному номеру.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос по госномеру.

TeaserCreateRequest dataclass

TeaserCreateRequest(vehicle_id: str)

Запрос создания тизера.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос создания тизера.

ValuationBySpecificationRequest dataclass

ValuationBySpecificationRequest(
    specification_id: int, mileage: int
)

Запрос оценки автомобиля по specification id.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос оценки автомобиля.

VehicleIdRequest dataclass

VehicleIdRequest(vehicle_id: str)

Запрос по идентификатору автомобиля.

to_payload

to_payload() -> dict[str, object]

Сериализует запрос по vehicle id.

VinRequest dataclass

VinRequest(vin: str)

Запрос по VIN.

to_payload

to_payload() -> dict[str, object]

Сериализует VIN-запрос.