CitraClient.Alerts (citra_client v0.3.0)
View SourceGenerated operations for OpenAPI tag alerts.
Summary
Functions
Delete Alert
Delete All Alerts
Get Alert
Get Unread Count
List User Alerts
Mark Alert As Read
Mark All Alerts As Read
Functions
Delete Alert
Delete an alert
DELETE /my/alerts/{alert_id}
Path parameters
alert_id(path)
Delete All Alerts
Delete alerts for the current user, respecting any filters/quick_filter provided
DELETE /my/alerts
Options (passed via keyword list)
:page:page_size:sort— JSON array of sort items:filters— JSON array of filter items:filter_logic— Filter logic operator (and/or):quick_filter:show_decayed:show_all_review_statuses
Get Alert
Get a single alert by ID
GET /my/alerts/{alert_id}
Path parameters
alert_id(path)
Get Unread Count
Get the count of unread alerts for the current user
GET /my/alerts/unread-count
List User Alerts
List current user's alerts with pagination, sorting, and filtering
GET /my/alerts
Options (passed via keyword list)
:page:page_size:sort— JSON array of sort items:filters— JSON array of filter items:filter_logic— Filter logic operator (and/or):quick_filter:show_decayed:show_all_review_statuses
Mark Alert As Read
Mark an alert as read
PUT /my/alerts/{alert_id}/read
Path parameters
alert_id(path)
Mark All Alerts As Read
Mark alerts as read for the current user, respecting any filters/quick_filter provided
PUT /my/alerts/mark-all-read
Options (passed via keyword list)
:page:page_size:sort— JSON array of sort items:filters— JSON array of filter items:filter_logic— Filter logic operator (and/or):quick_filter:show_decayed:show_all_review_statuses