accounts

Источник API: ИерархияАккаунтов.json, Информацияопользователе.json.

Enum

• AccountHierarchyRole
• EmployeeItemStatus
• OperationStatus
• OperationType

Пакет accounts.

Account dataclass

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

Bases: DomainObject

Доменный объект операций аккаунта.

get_self

get_self() -> AccountProfile

Получает профиль авторизованного пользователя.

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

get_balance

get_balance(user_id: int | None = None) -> AccountBalance

Получает баланс пользователя.

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

get_operations_history

get_operations_history(
    *,
    date_from: datetime | None = None,
    date_to: datetime | None = None,
    limit: int | None = None,
    offset: int | None = None,
) -> PaginatedList[OperationRecord]

Получает историю операций пользователя.

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

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

AccountHierarchy dataclass

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

Bases: DomainObject

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

get_status

get_status() -> AhUserStatus

Получает статус пользователя в ИА.

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

list_employees

list_employees() -> EmployeesResult

Получает список сотрудников иерархии.

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

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

list_company_phones

list_company_phones() -> CompanyPhonesResult

Получает список телефонов компании.

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

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

link_items

link_items(
    *,
    employee_id: int,
    item_ids: Sequence[int],
    source_employee_id: int | None = None,
    idempotency_key: str | None = None,
) -> AccountActionResult

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

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

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

list_items_by_employee

list_items_by_employee(
    *,
    employee_id: int,
    limit: int | None = None,
    offset: int | None = None,
) -> PaginatedList[EmployeeItem]

Получает список объявлений сотрудника.

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

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

AccountHierarchyRole

Bases: str, Enum

Роль пользователя в иерархии аккаунтов.

EmployeeItemStatus

Bases: str, Enum

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

OperationStatus

Bases: str, Enum

Статус операции по аккаунту.

OperationType

Bases: str, Enum

Тип операции по аккаунту.

AccountActionResult dataclass

AccountActionResult(
    success: bool, message: str | None = None
)

Bases: SerializableModel

Результат мутационной операции accounts.

AccountBalance dataclass

AccountBalance(
    user_id: int | None,
    real: float | None,
    bonus: float | None,
    total: float | None,
    currency: str | None,
)

Bases: SerializableModel

Баланс кошелька пользователя.

AccountProfile dataclass

AccountProfile(
    user_id: int | None,
    name: str | None,
    email: str | None,
    phone: str | None,
)

Bases: SerializableModel

Профиль авторизованного пользователя.

AhUserStatus dataclass

AhUserStatus(
    user_id: int | None,
    is_active: bool | None,
    role: AccountHierarchyRole | None,
)

Bases: SerializableModel

Статус пользователя в иерархии аккаунтов.

CompanyPhone dataclass

CompanyPhone(
    phone_id: int | None,
    phone: str | None,
    comment: str | None,
)

Bases: SerializableModel

Телефон компании.

CompanyPhonesResult dataclass

CompanyPhonesResult(items: list[CompanyPhone])

Bases: SerializableModel

Список телефонов компании.

Employee dataclass

Employee(
    employee_id: int | None,
    user_id: int | None,
    name: str | None,
    phone: str | None,
    email: str | None,
)

Bases: SerializableModel

Сотрудник иерархии аккаунтов.

EmployeeItem dataclass

EmployeeItem(
    item_id: int | None,
    title: str | None,
    status: EmployeeItemStatus | None,
    price: float | None,
)

Bases: SerializableModel

Объявление сотрудника в иерархии.

EmployeesResult dataclass

EmployeesResult(
    items: list[Employee], total: int | None = None
)

Bases: SerializableModel

Список сотрудников иерархии.

OperationRecord dataclass

OperationRecord(
    id: str | None,
    created_at: datetime | None,
    amount: float | None,
    operation_type: OperationType | None,
    status: OperationStatus | None,
    description: str | None,
)

Bases: SerializableModel

Операция по аккаунту.