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
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
pub struct ForumsClient {
pub http_client: HttpClient,
}
impl ForumsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Returns a paginated list of forums within a specific company, with optional filtering by product.
///
/// Required permissions:
/// - `forum: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.
/// * `company_id` - The unique identifier of the company to list forums for.
/// * `product_id` - The unique identifier of a product to filter by. When set, only forums connected to this product are returned.
/// * `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
/// .forums
/// .list(
/// &ForumsListQueryRequest {
/// first: Some(42),
/// last: Some(42),
/// company_id: "biz_xxxxxxxxxxxxxx".to_string(),
/// product_id: Some("prod_xxxxxxxxxxxxx".to_string()),
/// after: None,
/// before: None,
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn list(
&self,
request: &ForumsListQueryRequest,
options: Option<RequestOptions>,
) -> Result<ListForumsResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"forums",
None,
QueryBuilder::new()
.string("after", request.after.clone())
.string("before", request.before.clone())
.int("first", request.first.clone())
.int("last", request.last.clone())
.string("company_id", request.company_id.clone())
.string("product_id", request.product_id.clone())
.build(),
options,
)
.await
}
/// Retrieves the details of an existing forum.
///
/// Required permissions:
/// - `forum:read`
///
/// # Arguments
///
/// * `id` - The unique identifier of the forum or experience 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.forums.retrieve(&"id".to_string(), None).await;
/// }
/// ```
pub async fn retrieve(
&self,
id: &str,
options: Option<RequestOptions>,
) -> Result<Forum, ApiError> {
self.http_client
.execute_request(Method::GET, &format!("forums/{}", id), None, None, options)
.await
}
/// Update moderation and notification settings for a forum, such as who can post, who can comment, and email notification preferences.
///
/// Required permissions:
/// - `forum:moderate`
///
/// # Arguments
///
/// * `id` - The unique identifier of the forum to update. Accepts either an experience ID (e.g. 'exp_xxxxx') or a forum 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
/// .forums
/// .update(
/// &"id".to_string(),
/// &UpdateForumsRequest {
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn update(
&self,
id: &str,
request: &UpdateForumsRequest,
options: Option<RequestOptions>,
) -> Result<Forum, ApiError> {
self.http_client
.execute_request(
Method::PATCH,
&format!("forums/{}", id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
}