accounts¶

Публичный доменный пакет SDK: accounts.

Enum¶

Bases: DomainObject

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

get_self ¶

get_self(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AccountProfile

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

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AccountProfile с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_balance ¶

get_balance(
    *,
    user_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AccountBalance

Получает баланс пользователя по явно заданному или настроенному user_id.

Аргументы

user_id: идентификатор пользователя; если не передан, используется user_id фабрики, AVITO_USER_ID или get_self(). timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AccountBalance с реальным, бонусным и суммарным балансом.

Поведение

user_id является keyword-only, чтобы вызов явно показывал источник аккаунта. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_operations_history ¶

get_operations_history(
    *,
    date_from: datetime,
    date_to: datetime,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PaginatedList[OperationRecord]

Возвращает историю операций аккаунта за выбранный период.

Аргументы

date_from: задает начальную дату периода. date_to: задает конечную дату периода. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

Ленивый PaginatedList[OperationRecord]; первая страница загружается при создании, следующие страницы - при итерации.

Поведение

Параметры пагинации ограничивают объем данных без изменения модели ответа. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

get_status ¶

get_status(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AhUserStatus

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

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AhUserStatus с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_employees ¶

list_employees(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> EmployeesResult

Возвращает сотрудников компании в иерархии аккаунта.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

EmployeesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_company_phones ¶

list_company_phones(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CompanyPhonesResult

Возвращает телефоны компании из иерархии аккаунта.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CompanyPhonesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AccountActionResult

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

Аргументы

employee_id: идентификатор сотрудника, к которому прикрепляются объявления. item_ids: список идентификаторов объявлений. source_employee_id: идентификатор сотрудника-источника, если объявления переносятся между сотрудниками. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AccountActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_items_by_employee ¶

list_items_by_employee(
    *,
    employee_id: int,
    category_id: int,
    last_item_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PaginatedList[EmployeeItem]

Возвращает объявления, закрепленные за сотрудником компании.

Аргументы

employee_id: идентифицирует сотрудника аккаунта. category_id: ограничивает объявления категорией из справочника Авито. last_item_id: задает курсор для продолжения выборки. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

Ленивый PaginatedList[EmployeeItem]; первая страница загружается при создании, следующие страницы - при итерации.

Поведение

Параметры пагинации ограничивают объем данных без изменения модели ответа. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get_self `async` ¶

get_self(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AccountProfile

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

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AccountProfile с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_balance `async` ¶

get_balance(
    *,
    user_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AccountBalance

Получает баланс пользователя по явно заданному или настроенному user_id асинхронно.

Аргументы

user_id: идентификатор пользователя; если не передан, используется user_id фабрики, AVITO_USER_ID или get_self(). timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AccountBalance с реальным, бонусным и суммарным балансом.

Поведение

user_id является keyword-only, чтобы вызов явно показывал источник аккаунта. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_operations_history `async` ¶

get_operations_history(
    *,
    date_from: datetime,
    date_to: datetime,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AsyncPaginatedList[OperationRecord]

Возвращает историю операций аккаунта за выбранный период асинхронно.

Аргументы

date_from: задает начальную дату периода. date_to: задает конечную дату периода. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

Ленивый AsyncPaginatedList[OperationRecord]; первая страница загружается при создании, следующие страницы - при async-итерации.

Поведение

Параметры пагинации ограничивают объем данных без изменения модели ответа. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get_status `async` ¶

get_status(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AhUserStatus

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

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AhUserStatus с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_employees `async` ¶

list_employees(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> EmployeesResult

Возвращает сотрудников компании в иерархии аккаунта асинхронно.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

EmployeesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_company_phones `async` ¶

list_company_phones(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CompanyPhonesResult

Возвращает телефоны компании из иерархии аккаунта асинхронно.

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CompanyPhonesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

link_items `async` ¶

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

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

Аргументы

employee_id: идентификатор сотрудника, к которому прикрепляются объявления. item_ids: список идентификаторов объявлений. source_employee_id: идентификатор сотрудника-источника, если объявления переносятся между сотрудниками. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AccountActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_items_by_employee `async` ¶

list_items_by_employee(
    *,
    employee_id: int,
    category_id: int,
    last_item_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AsyncPaginatedList[EmployeeItem]

Возвращает объявления, закрепленные за сотрудником компании, асинхронно.

Аргументы

employee_id: идентифицирует сотрудника аккаунта. category_id: ограничивает объявления категорией из справочника Авито. last_item_id: задает курсор для продолжения выборки. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

Ленивый AsyncPaginatedList[EmployeeItem]; первая страница загружается при создании, следующие страницы - при async-итерации.

Поведение

Параметры пагинации ограничивают объем данных без изменения модели ответа. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

accounts¶

Enum¶

get_self ¶

get_balance ¶

get_operations_history ¶

get_status ¶

list_employees ¶

list_company_phones ¶

link_items ¶

list_items_by_employee ¶

get_self async ¶

get_balance async ¶

get_operations_history async ¶

get_status async ¶

list_employees async ¶

list_company_phones async ¶

link_items async ¶

list_items_by_employee async ¶

get_self `async` ¶

get_balance `async` ¶

get_operations_history `async` ¶

get_status `async` ¶

list_employees `async` ¶

list_company_phones `async` ¶

link_items `async` ¶

list_items_by_employee `async` ¶