Skip to content

Latest commit

 

History

History
142 lines (87 loc) · 4.31 KB

File metadata and controls

142 lines (87 loc) · 4.31 KB

NotificationsApi

All URIs are relative to http://localhost

Method HTTP request Description
createNotification POST /api/v1/notifications Creates a new notification.
deleteNotification DELETE /api/v1/notifications/{notification_id} Deletes a notification by ID.
getNotification GET /api/v1/notifications/{notification_id} Retrieves details of a specific notification by ID.
listNotifications GET /api/v1/notifications Notification routes implementation
updateNotification PATCH /api/v1/notifications/{notification_id} Updates an existing notification.

createNotification

ApiResponse_NotificationResponse createNotification(NotificationCreateRequest)

Creates a new notification.

Parameters

Name Type Description Notes
NotificationCreateRequest NotificationCreateRequest

Return type

ApiResponse_NotificationResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteNotification

ApiResponse_String deleteNotification(notification_id)

Deletes a notification by ID.

Parameters

Name Type Description Notes
notification_id String Notification ID [default to null]

Return type

ApiResponse_String

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getNotification

ApiResponse_NotificationResponse getNotification(notification_id)

Retrieves details of a specific notification by ID.

Parameters

Name Type Description Notes
notification_id String Notification ID [default to null]

Return type

ApiResponse_NotificationResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listNotifications

ApiResponse_Vec_NotificationResponse listNotifications(page, per_page)

Notification routes implementation

Note: OpenAPI documentation for these endpoints can be found in the `openapi.rs` file  Lists all notifications with pagination support.

Parameters

Name Type Description Notes
page Integer Page number for pagination (starts at 1) [optional] [default to null]
per_page Integer Number of items per page (default: 10) [optional] [default to null]

Return type

ApiResponse_Vec_NotificationResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateNotification

ApiResponse_NotificationResponse updateNotification(notification_id, NotificationUpdateRequest)

Updates an existing notification.

Parameters

Name Type Description Notes
notification_id String Notification ID [default to null]
NotificationUpdateRequest NotificationUpdateRequest

Return type

ApiResponse_NotificationResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json