cpa¶

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

Enum¶

CpaCallStatusId

Bases: DomainObject

Доменный объект CallTracking.

get ¶

get(
    *,
    call_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallTrackingCallResponse

Возвращает call tracking звонков.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list ¶

list(
    *,
    date_time_from: DateInput,
    date_time_to: DateInput,
    limit: int | None = None,
    offset: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallTrackingCallsResult

Возвращает список call tracking звонков.

Аргументы

date_time_from: задает начало временного интервала. date_time_to: задает конец временного интервала. limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

download ¶

download(
    *,
    call_id: int | str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallTrackingRecord

Скачивает запись call tracking звонка.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: DomainObject

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

get_call ¶

get_call(
    *,
    call_id: int | str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaAudioRecord

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

Deprecated: используйте call_tracking_call().download; удаление в версии 1.3.0.

Аргументы

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

Возвращает

CpaAudioRecord с бинарной записью звонка.

Поведение

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

Исключения

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

get_balance_info ¶

get_balance_info(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaBalanceInfo

Получает архивный баланс CPA.

Deprecated: используйте cpa_lead().get_balance_info; удаление в версии 1.3.0.

Аргументы

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

Возвращает

CpaBalanceInfo с архивной информацией о балансе CPA.

Поведение

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

Исключения

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

get_call_by_id ¶

get_call_by_id(
    *,
    call_id: int,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaCallInfo

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

Deprecated: используйте call_tracking_call().get; удаление в версии 1.3.0.

Аргументы

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

Возвращает

CpaCallInfo с архивными данными звонка.

Поведение

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

Исключения

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

Bases: DomainObject

Доменный объект CPA-звонка.

list ¶

list(
    *,
    date_time_from: DateInput,
    limit: int,
    offset: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaCallsResult

Возвращает список CPA-звонков.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

create_complaint ¶

create_complaint(
    *,
    call_id: int,
    reason: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaActionResult

Создает жалобу по CPA-звонку.

Аргументы

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

Возвращает

CpaActionResult со статусом выполнения операции.

Поведение

Без idempotency_key write-вызов не повторяется при сетевых ошибках. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

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

Bases: DomainObject

Доменный объект CPA-чата.

get ¶

get(
    *,
    action_id: int | str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaChatInfo

Возвращает CPA-чатов.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list ¶

list(
    *,
    created_at_from: DateInput,
    limit: int,
    offset: int,
    version: int = 2,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaChatsResult

Возвращает список CPA-чатов.

Аргументы

created_at_from: задает нижнюю границу времени создания. limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. version: задает версию upstream-контракта, если операция ее поддерживает. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

list_classic ¶

list_classic(
    *,
    created_at_from: DateInput,
    limit: int,
    offset: int,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaChatsResult

Выполняет legacy-операцию списка CPA-чатов v1 и возвращает типизированную SDK-модель.

Аргументы

created_at_from: фильтрует CPA-чаты по нижней границе даты создания. limit: задает максимальное число записей в ответе. offset: задает смещение выборки. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CpaChatsResult со списком CPA-чатов legacy API.

Поведение

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

Исключения

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

get_phones_info_from_chats ¶

get_phones_info_from_chats(
    *,
    date_time_from: DateInput,
    limit: int,
    offset: int,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaPhonesResult

Возвращает phones info from chats для CPA-чатов.

Аргументы

date_time_from: задает нижнюю границу времени поиска. limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

Bases: DomainObject

Доменный объект CPA-лида и связанных lead-операций.

create_complaint_by_action_id ¶

create_complaint_by_action_id(
    *,
    action_id: int,
    reason: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaActionResult

Создает жалобу по идентификатору CPA-действия.

Аргументы

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

Возвращает

CpaActionResult со статусом выполнения операции.

Поведение

Без idempotency_key write-вызов не повторяется при сетевых ошибках. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

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

get_balance_info ¶

get_balance_info(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaBalanceInfo

Возвращает balance info для CPA-лидов.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

Доменный объект CallTracking.

get `async` ¶

get(
    *,
    call_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallTrackingCallResponse

Возвращает call tracking звонков.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list `async` ¶

list(
    *,
    date_time_from: DateInput,
    date_time_to: DateInput,
    limit: int | None = None,
    offset: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallTrackingCallsResult

Возвращает список call tracking звонков.

Аргументы

date_time_from: задает начало временного интервала. date_time_to: задает конец временного интервала. limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

download `async` ¶

download(
    *,
    call_id: int | str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallTrackingRecord

Скачивает запись call tracking звонка.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

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

get_call `async` ¶

get_call(
    *,
    call_id: int | str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaAudioRecord

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

Deprecated: используйте call_tracking_call().download; удаление в версии 1.3.0.

Аргументы

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

Возвращает

CpaAudioRecord с бинарной записью звонка.

Поведение

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

Исключения

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

get_balance_info `async` ¶

get_balance_info(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaBalanceInfo

Получает архивный баланс CPA.

Deprecated: используйте cpa_lead().get_balance_info; удаление в версии 1.3.0.

Аргументы

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

Возвращает

CpaBalanceInfo с архивной информацией о балансе CPA.

Поведение

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

Исключения

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

get_call_by_id `async` ¶

get_call_by_id(
    *,
    call_id: int,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaCallInfo

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

Deprecated: используйте call_tracking_call().get; удаление в версии 1.3.0.

Аргументы

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

Возвращает

CpaCallInfo с архивными данными звонка.

Поведение

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

Исключения

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

Bases: AsyncDomainObject

Доменный объект CPA-звонка.

list `async` ¶

list(
    *,
    date_time_from: DateInput,
    limit: int,
    offset: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaCallsResult

Возвращает список CPA-звонков.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

create_complaint `async` ¶

create_complaint(
    *,
    call_id: int,
    reason: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaActionResult

Создает жалобу по CPA-звонку.

Аргументы

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

Возвращает

CpaActionResult со статусом выполнения операции.

Поведение

Без idempotency_key write-вызов не повторяется при сетевых ошибках. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

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

Bases: AsyncDomainObject

Доменный объект CPA-чата.

get `async` ¶

get(
    *,
    action_id: int | str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaChatInfo

Возвращает CPA-чатов.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list `async` ¶

list(
    *,
    created_at_from: DateInput,
    limit: int,
    offset: int,
    version: int = 2,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaChatsResult

Возвращает список CPA-чатов.

Аргументы

created_at_from: задает нижнюю границу времени создания. limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. version: задает версию upstream-контракта, если операция ее поддерживает. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

list_classic `async` ¶

list_classic(
    *,
    created_at_from: DateInput,
    limit: int,
    offset: int,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaChatsResult

Выполняет legacy-операцию списка CPA-чатов v1 и возвращает типизированную SDK-модель.

Аргументы

created_at_from: фильтрует CPA-чаты по нижней границе даты создания. limit: задает максимальное число записей в ответе. offset: задает смещение выборки. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CpaChatsResult со списком CPA-чатов legacy API.

Поведение

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

Исключения

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

get_phones_info_from_chats `async` ¶

get_phones_info_from_chats(
    *,
    date_time_from: DateInput,
    limit: int,
    offset: int,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaPhonesResult

Возвращает phones info from chats для CPA-чатов.

Аргументы

date_time_from: задает нижнюю границу времени поиска. limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

Доменный объект CPA-лида и связанных lead-операций.

create_complaint_by_action_id `async` ¶

create_complaint_by_action_id(
    *,
    action_id: int,
    reason: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaActionResult

Создает жалобу по идентификатору CPA-действия.

Аргументы

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

Возвращает

CpaActionResult со статусом выполнения операции.

Поведение

Без idempotency_key write-вызов не повторяется при сетевых ошибках. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

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

get_balance_info `async` ¶

get_balance_info(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaBalanceInfo

Возвращает balance info для CPA-лидов.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

cpa¶

Enum¶

get ¶

list ¶

download ¶

get_call ¶

get_balance_info ¶

get_call_by_id ¶

list ¶

create_complaint ¶

get ¶

list ¶

list_classic ¶

get_phones_info_from_chats ¶

create_complaint_by_action_id ¶

get_balance_info ¶

get async ¶

list async ¶

download async ¶

get_call async ¶

get_balance_info async ¶

get_call_by_id async ¶

list async ¶

create_complaint async ¶

get async ¶

list async ¶

list_classic async ¶

get_phones_info_from_chats async ¶

create_complaint_by_action_id async ¶

get_balance_info async ¶

get `async` ¶

list `async` ¶

download `async` ¶

get_call `async` ¶

get_balance_info `async` ¶

get_call_by_id `async` ¶

list `async` ¶

create_complaint `async` ¶

get `async` ¶

list `async` ¶

list_classic `async` ¶

get_phones_info_from_chats `async` ¶

create_complaint_by_action_id `async` ¶

get_balance_info `async` ¶