Comments

UpdateCommentResponse ¶

Bases: ITDBaseModel

id ¶

id: UUID

content ¶

content: str

edited_at ¶

edited_at: ITDDatetime | None

Comment ¶

Comment(
    comment_id: UUID | str | None = None,
    client: Optional[AsyncITDClient] = None,
    **data,
)

Bases: CommentRef

id ¶

id: UUID

content ¶

content: str

author ¶

author: UserWithPin

attachments ¶

attachments: list[Attachment]

likes_count ¶

likes_count: int

created_at ¶

created_at: ITDDatetime

is_liked ¶

is_liked: bool

replies_count ¶

replies_count: int

replies ¶

replies: list[Reply]

client ¶

client: Optional[AsyncITDClient] = None

edit ¶

edit(content: str, **kwargs) -> UpdateCommentResponse

Редактировать комментарий.

PARAMETER	DESCRIPTION
`content`	новый текст комментария TYPE: `str`

RETURNS	DESCRIPTION
`UpdateCommentResponse`	Обновлённый комментарий (содержит дату редактирования)

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ForbiddenError`	нет прав на редактирование этого комментария
`ParamsValidationError`	1 <= len(content) <= 1_000

delete ¶

delete(**kwargs) -> None

Удалить комментарий.

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ForbiddenError`	нет прав на удаление комментария

restore ¶

restore(**kwargs) -> None

Восстановить удалённый комментарий.

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ForbiddenError`	нет прав на восстановление комментария

like ¶

like(**kwargs) -> int

Поставить лайк на комментарий.

RETURNS	DESCRIPTION
`int`	Обновлённое количество лайков

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден

unlike ¶

unlike(**kwargs) -> int

Убрать лайк с комментария.

RETURNS	DESCRIPTION
`int`	Обновлённое количество лайков

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден

reply ¶

reply(
    content: str = "",
    replay_to_user_id: Union[
        UUID, str, UserRef, None
    ] = None,
    attachment_ids: Union[
        list[Union[UUID, str, FileRef]], None
    ] = None,
    **kwargs,
) -> Reply

Ответить на этот комментарий.

PARAMETER	DESCRIPTION
`content`	текст ответа TYPE: `str` DEFAULT: `''`
`replay_to_user_id`	пользователь, которому адресован ответ (можно передать UserRef) TYPE: `Union[UUID, str, UserRef, None]` DEFAULT: `None`
`attachment_ids`	список прикреплённых файлов (можно передать FileRef) TYPE: `Union[list[Union[UUID, str, FileRef]], None]` DEFAULT: `None`

RETURNS	DESCRIPTION
`Reply`	Созданный ответ

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ValidationError`	нельзя создать пустой ответ (без текста и вложений)
`ITDError`	файл с указанным UUID не существует
`ParamsValidationError`	len(attachment_ids) <= 4
`ParamsValidationError`	len(content) <= 1_000

report ¶

report(
    reason: Reason
    | Literal[
        "spam",
        "violence",
        "hate",
        "adult",
        "misinfo",
        "other",
    ] = "other",
    description: str = "",
    **kwargs,
) -> Report

Написать донос на комментарий.

PARAMETER	DESCRIPTION
`reason`	причина TYPE: `Reason \| Literal['spam', 'violence', 'hate', 'adult', 'misinfo', 'other']` DEFAULT: `'other'`
`description`	текст репорта TYPE: `str` DEFAULT: `''`

RETURNS	DESCRIPTION
`Report`	Донос

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`ValidationError`	не найден пост, пользователь или комментарий по target_id
`ValidationError`	нельзя отправить жалобу на один и тот же контент
`ParamsValidationError`	len(description) <= 1000

get_comment_replies ¶

get_comment_replies(
    limit: int = 100, page: int = 1, **kwargs
) -> tuple[PagePagination, list[Reply]]

Получить ответы на комментарий.

PARAMETER	DESCRIPTION
`limit`	максимальное количество ответов на странице (1 <= limit <= 100) TYPE: `int` DEFAULT: `100`
`page`	номер страницы (page >= 1) TYPE: `int` DEFAULT: `1`

RETURNS	DESCRIPTION
`tuple[PagePagination, list[Reply]]`	Ответы на комментарий

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден

Reply ¶

Reply(
    comment_id: UUID | str | None = None,
    client: Optional[AsyncITDClient] = None,
    **data,
)

Bases: Comment

reply_to ¶

reply_to: UserStab | None

id ¶

id: UUID

client ¶

client: Optional[AsyncITDClient] = None

content ¶

content: str

author ¶

author: UserWithPin

attachments ¶

attachments: list[Attachment]

likes_count ¶

likes_count: int

created_at ¶

created_at: ITDDatetime

is_liked ¶

is_liked: bool

replies_count ¶

replies_count: int

replies ¶

replies: list[Reply]

edit ¶

edit(content: str, **kwargs) -> UpdateCommentResponse

Редактировать комментарий.

PARAMETER	DESCRIPTION
`content`	новый текст комментария TYPE: `str`

RETURNS	DESCRIPTION
`UpdateCommentResponse`	Обновлённый комментарий (содержит дату редактирования)

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ForbiddenError`	нет прав на редактирование этого комментария
`ParamsValidationError`	1 <= len(content) <= 1_000

delete ¶

delete(**kwargs) -> None

Удалить комментарий.

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ForbiddenError`	нет прав на удаление комментария

restore ¶

restore(**kwargs) -> None

Восстановить удалённый комментарий.

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ForbiddenError`	нет прав на восстановление комментария

like ¶

like(**kwargs) -> int

Поставить лайк на комментарий.

RETURNS	DESCRIPTION
`int`	Обновлённое количество лайков

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден

unlike ¶

unlike(**kwargs) -> int

Убрать лайк с комментария.

RETURNS	DESCRIPTION
`int`	Обновлённое количество лайков

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден

reply ¶

reply(
    content: str = "",
    replay_to_user_id: Union[
        UUID, str, UserRef, None
    ] = None,
    attachment_ids: Union[
        list[Union[UUID, str, FileRef]], None
    ] = None,
    **kwargs,
) -> Reply

Ответить на этот комментарий.

PARAMETER	DESCRIPTION
`content`	текст ответа TYPE: `str` DEFAULT: `''`
`replay_to_user_id`	пользователь, которому адресован ответ (можно передать UserRef) TYPE: `Union[UUID, str, UserRef, None]` DEFAULT: `None`
`attachment_ids`	список прикреплённых файлов (можно передать FileRef) TYPE: `Union[list[Union[UUID, str, FileRef]], None]` DEFAULT: `None`

RETURNS	DESCRIPTION
`Reply`	Созданный ответ

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден
`ValidationError`	нельзя создать пустой ответ (без текста и вложений)
`ITDError`	файл с указанным UUID не существует
`ParamsValidationError`	len(attachment_ids) <= 4
`ParamsValidationError`	len(content) <= 1_000

report ¶

report(
    reason: Reason
    | Literal[
        "spam",
        "violence",
        "hate",
        "adult",
        "misinfo",
        "other",
    ] = "other",
    description: str = "",
    **kwargs,
) -> Report

Написать донос на комментарий.

PARAMETER	DESCRIPTION
`reason`	причина TYPE: `Reason \| Literal['spam', 'violence', 'hate', 'adult', 'misinfo', 'other']` DEFAULT: `'other'`
`description`	текст репорта TYPE: `str` DEFAULT: `''`

RETURNS	DESCRIPTION
`Report`	Донос

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`ValidationError`	не найден пост, пользователь или комментарий по target_id
`ValidationError`	нельзя отправить жалобу на один и тот же контент
`ParamsValidationError`	len(description) <= 1000

get_comment_replies ¶

get_comment_replies(
    limit: int = 100, page: int = 1, **kwargs
) -> tuple[PagePagination, list[Reply]]

Получить ответы на комментарий.

PARAMETER	DESCRIPTION
`limit`	максимальное количество ответов на странице (1 <= limit <= 100) TYPE: `int` DEFAULT: `100`
`page`	номер страницы (page >= 1) TYPE: `int` DEFAULT: `1`

RETURNS	DESCRIPTION
`tuple[PagePagination, list[Reply]]`	Ответы на комментарий

RAISES	DESCRIPTION
`UnauthorizedError`	ошибка авторизации
`NotFoundError`	комментарий не найден