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
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
pub struct CourseStudentsClient {
pub http_client: HttpClient,
}
impl CourseStudentsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Returns a paginated list of students enrolled in a course, with optional name filtering.
///
/// Required permissions:
/// - `courses:read`
/// - `course_analytics:read`
///
/// # Arguments
///
/// * `after` - Returns the elements in the list that come after the specified cursor.
/// * `before` - Returns the elements in the list that come before the specified cursor.
/// * `first` - Returns the first _n_ elements from the list.
/// * `last` - Returns the last _n_ elements from the list.
/// * `course_id` - The unique identifier of the course to list enrolled students for.
/// * `keyword` - A search term to filter students by name or username.
/// * `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
/// .course_students
/// .list(
/// &CourseStudentsListQueryRequest {
/// first: Some(42),
/// last: Some(42),
/// course_id: "cors_xxxxxxxxxxxxx".to_string(),
/// after: None,
/// before: None,
/// keyword: None,
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn list(
&self,
request: &CourseStudentsListQueryRequest,
options: Option<RequestOptions>,
) -> Result<ListCourseStudentsResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"course_students",
None,
QueryBuilder::new()
.string("after", request.after.clone())
.string("before", request.before.clone())
.int("first", request.first.clone())
.int("last", request.last.clone())
.string("course_id", request.course_id.clone())
.string("keyword", request.keyword.clone())
.build(),
options,
)
.await
}
/// Retrieves the details of an existing course student.
///
/// Required permissions:
/// - `courses:read`
/// - `course_analytics:read`
///
/// # Arguments
///
/// * `id` - The unique identifier of the course student record to retrieve.
/// * `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
/// .course_students
/// .retrieve(&"id".to_string(), None)
/// .await;
/// }
/// ```
pub async fn retrieve(
&self,
id: &str,
options: Option<RequestOptions>,
) -> Result<CourseStudent, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("course_students/{}", id),
None,
None,
options,
)
.await
}
}