1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
pub mod topics;
pub use topics::TopicsClient;
pub struct NotificationsClient {
pub http_client: HttpClient,
pub topics: TopicsClient,
}
impl NotificationsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
topics: TopicsClient::new(config.clone())?,
})
}
/// Lists the authenticated user's notifications, newest first. Requires a user credential — an account API key has no notification feed. Without filters the feed spans every experience the user belongs to plus the teams they are a member of.
///
/// # Arguments
///
/// * `unread` - Only return notifications created since the user last viewed their source.
/// * `experience_id` - Only return notifications from this experience (`exp_` tag).
/// * `account_id` - Only return team notifications for this account (`biz_` tag).
/// * `mentions` - Only return notifications that mention the user directly.
/// * `first` - The number of notifications to return (default 20, max 100).
/// * `after` - A cursor (a notification `id` from a previous page); returns notifications older than it.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use whop_sdk::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// token: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Whop::new(config).expect("Failed to build client");
/// client
/// .notifications
/// .list(
/// &NotificationsListQueryRequest {
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn list(
&self,
request: &NotificationsListQueryRequest,
options: Option<RequestOptions>,
) -> Result<ListNotificationsResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"notifications",
None,
QueryBuilder::new()
.bool("unread", request.unread.clone())
.string("experience_id", request.experience_id.clone())
.string("account_id", request.account_id.clone())
.bool("mentions", request.mentions.clone())
.int("first", request.first.clone())
.string("after", request.after.clone())
.build(),
options,
)
.await
}
/// Queues a notification to every user of an experience or to an account's team, processed asynchronously. Every send is attributed to an app: use an app API key, or a credential acting on behalf of an app. Narrow the audience with `user_ids` to send a mention.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use whop_sdk::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// token: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Whop::new(config).expect("Failed to build client");
/// client
/// .notifications
/// .create(
/// &CreateNotificationsRequest {
/// content: "Drop off at 4180 Burnet Rd. Plan on two days for the full coating."
/// .to_string(),
/// title: "Your ceramic coating is booked".to_string(),
/// account_id: None,
/// experience_id: None,
/// icon_user_id: None,
/// rest_path: None,
/// subtitle: None,
/// user_ids: None,
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn create(
&self,
request: &CreateNotificationsRequest,
options: Option<RequestOptions>,
) -> Result<CreateNotificationsResponse, ApiError> {
self.http_client
.execute_request(
Method::POST,
"notifications",
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Lists the authenticated user's per-experience unread badge state. Requires a user credential. Returns one row per experience the user belongs to (or per requested experience).
///
/// # Arguments
///
/// * `experience_ids` - Only return badges for these experiences (`exp_` tags).
/// * `last_fetched_at` - The client's last fetched-at ISO 8601 timestamp, used to partially refresh badges after a websocket message.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use whop_sdk::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// token: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Whop::new(config).expect("Failed to build client");
/// client
/// .notifications
/// .badges(
/// &BadgesQueryRequest {
/// experience_ids: vec![Some("exp_xxxxxxxxxxxxxx".to_string())],
/// last_fetched_at: None,
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn badges(
&self,
request: &BadgesQueryRequest,
options: Option<RequestOptions>,
) -> Result<BadgesNotificationsResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"notifications/badges",
None,
QueryBuilder::new()
.string_array("experience_ids", request.experience_ids.clone())
.string("last_fetched_at", request.last_fetched_at.clone())
.build(),
options,
)
.await
}
/// Marks the authenticated user's notifications as read: one experience's (`experience_id`) or everything (`all: true`) — exactly one of the two. Requires a user credential. Responds with the refreshed badge rows for the affected scope.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use whop_sdk::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// token: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Whop::new(config).expect("Failed to build client");
/// client
/// .notifications
/// .mark_read(
/// &MarkReadNotificationsRequest {
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn mark_read(
&self,
request: &MarkReadNotificationsRequest,
options: Option<RequestOptions>,
) -> Result<MarkReadNotificationsResponse, ApiError> {
self.http_client
.execute_request(
Method::POST,
"notifications/mark_read",
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Retrieves a single notification by id — either an `id` returned by List Notifications, or the ephemeral id delivered with a push/websocket event. Requires a user credential.
///
/// # Arguments
///
/// * `id` - A notification `id` from List Notifications, or the id delivered with a push/websocket event.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use whop_sdk::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// token: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Whop::new(config).expect("Failed to build client");
/// client.notifications.retrieve(&"id".to_string(), None).await;
/// }
/// ```
pub async fn retrieve(
&self,
id: &str,
options: Option<RequestOptions>,
) -> Result<Notification, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("notifications/{}", id),
None,
None,
options,
)
.await
}
}