Skip to content

threads

Accessed as client.notifications.threads; the async client mirrors it.

NotificationsThreads

The notifications.threads namespace.

get

get(id: int) -> NotificationThread

Get notification thread by ID.

Parameters:

Name Type Description Default
id int

id of notification thread

required

Returns:

Type Description
NotificationThread

NotificationThread.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: notifyGetThread

update

update(id: int, *, to_status: str | None = None) -> None

Mark notification thread as read by ID.

Parameters:

Name Type Description Default
id int

id of notification thread

required
to_status str | None

Status to mark notifications as

None

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: notifyReadThread

AsyncNotificationsThreads

The notifications.threads namespace.

get

get(id: int) -> NotificationThread

Get notification thread by ID.

Parameters:

Name Type Description Default
id int

id of notification thread

required

Returns:

Type Description
NotificationThread

NotificationThread.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: notifyGetThread

update

update(id: int, *, to_status: str | None = None) -> None

Mark notification thread as read by ID.

Parameters:

Name Type Description Default
id int

id of notification thread

required
to_status str | None

Status to mark notifications as

None

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: notifyReadThread