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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
pub struct AppsClient {
pub http_client: HttpClient,
}
impl AppsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Lists apps on the Whop platform: the app store's live apps, or — with `account_id` and developer access to that account — every app the account owns. Requires authentication, except for the publicly readable lists: `verified_apps_only=true`, and `app_type=website` with no `account_id`, which returns every live deployed website that Whop has not verified — verified templates are the curated `verified_apps_only=true` list instead.
///
/// # Arguments
///
/// * `account_id` - Only return apps created by this account (`biz_` tag). With developer access to the account this includes its unlisted and hidden apps.
/// * `app_type` - Filter apps by the type of end-user they are built for. Apps of type `website` are left out unless you ask for them by name.
/// * `view_type` - Only return apps supporting this view type, such as `dashboard` or `hub`.
/// * `verified_apps_only` - Whether to only return apps verified by Whop. Verified website templates — websites with a published web build — are included, even though websites are otherwise left out of app lists.
/// * `query` - A search string matched against app names.
/// * `order` - The field to sort apps by. Defaults to discoverable_at, showing the most recently published apps first. `template_usage` ranks Whop-verified apps first, then apps with a banner image, then by how many apps were created from each app as a template.
/// * `direction` - Sort direction.
/// * `first` - The number of apps to return (default 20, max 100).
/// * `after` - A cursor; returns apps after this position.
/// * `last` - The number of apps to return from the end of the range.
/// * `before` - A cursor; returns apps before this position.
/// * `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
/// .apps
/// .list(
/// &AppsListQueryRequest {
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn list(
&self,
request: &AppsListQueryRequest,
options: Option<RequestOptions>,
) -> Result<ListAppsResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"apps",
None,
QueryBuilder::new()
.string("account_id", request.account_id.clone())
.serialize("app_type", request.app_type.clone())
.serialize("view_type", request.view_type.clone())
.bool("verified_apps_only", request.verified_apps_only.clone())
.structured_query("query", request.query.clone())
.serialize("order", request.order.clone())
.serialize("direction", request.direction.clone())
.int("first", request.first.clone())
.string("after", request.after.clone())
.int("last", request.last.clone())
.string("before", request.before.clone())
.build(),
options,
)
.await
}
/// Registers a new app on the Whop developer platform. Apps provide custom experiences that can be added to products.
///
/// # 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
/// .apps
/// .create(
/// &CreateAppsRequest {
/// name: "Shine Time Booking".to_string(),
/// account_id: None,
/// app_type: None,
/// base_url: None,
/// icon: None,
/// redirect_uris: None,
/// route: None,
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn create(
&self,
request: &CreateAppsRequest,
options: Option<RequestOptions>,
) -> Result<App, ApiError> {
self.http_client
.execute_request(
Method::POST,
"apps",
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Updates the permission requirements for an app
///
/// Required permissions:
/// - `developer:update_app_authorization`
///
/// # Arguments
///
/// * `app_id` - The ID of the app the permission requirements are being updated for
/// * `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
/// .apps
/// .update_permissions_app(
/// &"app_id".to_string(),
/// &UpdatePermissionsAppRequest {
/// requested_permissions: vec![UpdatePermissionsAppRequestRequestedPermissionsItem {
/// action: "action".to_string(),
/// is_required: true,
/// justification: "justification".to_string(),
/// ..Default::default()
/// }],
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn update_permissions_app(
&self,
app_id: &str,
request: &UpdatePermissionsAppRequest,
options: Option<RequestOptions>,
) -> Result<bool, ApiError> {
self.http_client
.execute_request(
Method::PATCH,
&format!("apps/{}/permissions", app_id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Retrieves an app by ID, claimed route, or proxy domain id. Credential fields (api_key, default_api_key, secrets) render `null` unless the caller has the corresponding developer permission on the owning account.
///
/// # Arguments
///
/// * `id` - App ID (prefixed `app_`), the app's claimed route, or its proxy domain id.
/// * `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.apps.retrieve(&"id".to_string(), None).await;
/// }
/// ```
pub async fn retrieve(
&self,
id: &str,
options: Option<RequestOptions>,
) -> Result<App, ApiError> {
self.http_client
.execute_request(Method::GET, &format!("apps/{}", id), None, None, options)
.await
}
/// Deletes an app. The app stops resolving within seconds — a website's site stops serving, and any claimed subdomain is reserved for a month before it can be claimed again.
///
/// # Arguments
///
/// * `id` - App ID (prefixed `app_`), the app's claimed route, or its proxy domain id.
/// * `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.apps.delete(&"id".to_string(), None).await;
/// }
/// ```
pub async fn delete(
&self,
id: &str,
options: Option<RequestOptions>,
) -> Result<DeleteAppsResponse, ApiError> {
self.http_client
.execute_request(Method::DELETE, &format!("apps/{}", id), None, None, options)
.await
}
/// Updates the settings, metadata, or status of an app. Fields that are omitted keep their current value.
///
/// # Arguments
///
/// * `id` - App ID (prefixed `app_`), the app's claimed route, or its proxy domain id.
/// * `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
/// .apps
/// .update(
/// &"id".to_string(),
/// &UpdateAppsRequest {
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn update(
&self,
id: &str,
request: &UpdateAppsRequest,
options: Option<RequestOptions>,
) -> Result<App, ApiError> {
self.http_client
.execute_request(
Method::PATCH,
&format!("apps/{}", id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Builds the app's current source and ships it. Returns the run it started, so the caller can render progress from this response and then follow it on the app's `deployment` field. Only one deployment runs per app at a time — calling this while one is in flight reports that run rather than starting a second, and calling it with nothing to publish reports that instead of starting one.
///
/// # Arguments
///
/// * `id` - The app to deploy, prefixed `app_`.
/// * `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
/// .apps
/// .deploy(
/// &"id".to_string(),
/// &DeployAppsRequest {
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn deploy(
&self,
id: &str,
request: &DeployAppsRequest,
options: Option<RequestOptions>,
) -> Result<AppDeployment, ApiError> {
self.http_client
.execute_request(
Method::POST,
&format!("apps/{}/deploy", id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Lists a hosted app's server runtime logs, most recent first: console output, uncaught exceptions, and failed-request summaries captured on whop.app hosting. Logs are retained for 7 days.
///
/// # Arguments
///
/// * `id` - The ID of the app, which will look like app_*************.
/// * `app_build_id` - Only return logs from this build.
/// * `level` - Only return console lines of this level.
/// * `query` - Only return logs whose message contains this text (case-insensitive).
/// * `created_after` - Start of the time window as an ISO 8601 timestamp. Defaults to 7 days before created_before.
/// * `created_before` - End of the time window as an ISO 8601 timestamp. Defaults to now.
/// * `first` - The number of log lines to return (max 500).
/// * `after` - A cursor for fetching logs after a previous page.
/// * `before` - A cursor for fetching logs before a later page.
/// * `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
/// .apps
/// .logs(
/// &"id".to_string(),
/// &LogsQueryRequest {
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn logs(
&self,
id: &str,
request: &LogsQueryRequest,
options: Option<RequestOptions>,
) -> Result<LogsAppsResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("apps/{}/logs", id),
None,
QueryBuilder::new()
.string("app_build_id", request.app_build_id.clone())
.serialize("level", request.level.clone())
.structured_query("query", request.query.clone())
.datetime("created_after", request.created_after.clone())
.datetime("created_before", request.created_before.clone())
.int("first", request.first.clone())
.string("after", request.after.clone())
.string("before", request.before.clone())
.build(),
options,
)
.await
}
/// Replaces the set of permissions the app requests from users when they install it. Requires a user session: the `developer:update_app_authorization` scope cannot be delegated to API keys. Sensitive permissions require step-up verification.
///
/// # Arguments
///
/// * `id` - App ID, prefixed `app_`.
/// * `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
/// .apps
/// .update_permissions(
/// &"id".to_string(),
/// &UpdatePermissionsAppsRequest {
/// requested_permissions: vec![UpdatePermissionsAppsRequestRequestedPermissionsItem {
/// action: "company:basic:read".to_string(),
/// is_required: true,
/// justification: "Reads basic account info to render the dashboard home."
/// .to_string(),
/// ..Default::default()
/// }],
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn update_permissions(
&self,
id: &str,
request: &UpdatePermissionsAppsRequest,
options: Option<RequestOptions>,
) -> Result<App, ApiError> {
self.http_client
.execute_request(
Method::PATCH,
&format!("apps/{}/permissions", id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
}