mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
3ae55bbbf4
This PR is part of the inbox notifications topic, and rely on previous PRs merged - it adds : - Endpoints to : - WS : watch new inbox notifications - REST : list inbox notifications - REST : update the read status of a notification Also, this PR acts as a follow-up PR from previous work and : - fix DB query issues - fix DBMem logic to match DB
112 lines
3.5 KiB
Go
112 lines
3.5 KiB
Go
package codersdk
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
)
|
|
|
|
type InboxNotification struct {
|
|
ID uuid.UUID `json:"id" format:"uuid"`
|
|
UserID uuid.UUID `json:"user_id" format:"uuid"`
|
|
TemplateID uuid.UUID `json:"template_id" format:"uuid"`
|
|
Targets []uuid.UUID `json:"targets" format:"uuid"`
|
|
Title string `json:"title"`
|
|
Content string `json:"content"`
|
|
Icon string `json:"icon"`
|
|
Actions []InboxNotificationAction `json:"actions"`
|
|
ReadAt *time.Time `json:"read_at"`
|
|
CreatedAt time.Time `json:"created_at" format:"date-time"`
|
|
}
|
|
|
|
type InboxNotificationAction struct {
|
|
Label string `json:"label"`
|
|
URL string `json:"url"`
|
|
}
|
|
|
|
type GetInboxNotificationResponse struct {
|
|
Notification InboxNotification `json:"notification"`
|
|
UnreadCount int `json:"unread_count"`
|
|
}
|
|
|
|
type ListInboxNotificationsRequest struct {
|
|
Targets string `json:"targets,omitempty"`
|
|
Templates string `json:"templates,omitempty"`
|
|
ReadStatus string `json:"read_status,omitempty"`
|
|
StartingBefore string `json:"starting_before,omitempty"`
|
|
}
|
|
|
|
type ListInboxNotificationsResponse struct {
|
|
Notifications []InboxNotification `json:"notifications"`
|
|
UnreadCount int `json:"unread_count"`
|
|
}
|
|
|
|
func ListInboxNotificationsRequestToQueryParams(req ListInboxNotificationsRequest) []RequestOption {
|
|
var opts []RequestOption
|
|
if req.Targets != "" {
|
|
opts = append(opts, WithQueryParam("targets", req.Targets))
|
|
}
|
|
if req.Templates != "" {
|
|
opts = append(opts, WithQueryParam("templates", req.Templates))
|
|
}
|
|
if req.ReadStatus != "" {
|
|
opts = append(opts, WithQueryParam("read_status", req.ReadStatus))
|
|
}
|
|
if req.StartingBefore != "" {
|
|
opts = append(opts, WithQueryParam("starting_before", req.StartingBefore))
|
|
}
|
|
|
|
return opts
|
|
}
|
|
|
|
func (c *Client) ListInboxNotifications(ctx context.Context, req ListInboxNotificationsRequest) (ListInboxNotificationsResponse, error) {
|
|
res, err := c.Request(
|
|
ctx, http.MethodGet,
|
|
"/api/v2/notifications/inbox",
|
|
nil, ListInboxNotificationsRequestToQueryParams(req)...,
|
|
)
|
|
if err != nil {
|
|
return ListInboxNotificationsResponse{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return ListInboxNotificationsResponse{}, ReadBodyAsError(res)
|
|
}
|
|
|
|
var listInboxNotificationsResponse ListInboxNotificationsResponse
|
|
return listInboxNotificationsResponse, json.NewDecoder(res.Body).Decode(&listInboxNotificationsResponse)
|
|
}
|
|
|
|
type UpdateInboxNotificationReadStatusRequest struct {
|
|
IsRead bool `json:"is_read"`
|
|
}
|
|
|
|
type UpdateInboxNotificationReadStatusResponse struct {
|
|
Notification InboxNotification `json:"notification"`
|
|
UnreadCount int `json:"unread_count"`
|
|
}
|
|
|
|
func (c *Client) UpdateInboxNotificationReadStatus(ctx context.Context, notifID string, req UpdateInboxNotificationReadStatusRequest) (UpdateInboxNotificationReadStatusResponse, error) {
|
|
res, err := c.Request(
|
|
ctx, http.MethodPut,
|
|
fmt.Sprintf("/api/v2/notifications/inbox/%v/read-status", notifID),
|
|
req,
|
|
)
|
|
if err != nil {
|
|
return UpdateInboxNotificationReadStatusResponse{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return UpdateInboxNotificationReadStatusResponse{}, ReadBodyAsError(res)
|
|
}
|
|
|
|
var resp UpdateInboxNotificationReadStatusResponse
|
|
return resp, json.NewDecoder(res.Body).Decode(&resp)
|
|
}
|