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
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
pub struct PaymentMethodsClient {
pub http_client: HttpClient,
}
impl PaymentMethodsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Returns a paginated list of payment methods for a member or company, or for the authenticated user when neither is given, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card, bank account, or digital wallet.
///
/// Required permissions:
/// - `member:payment_methods: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.
/// * `member_id` - The unique identifier of the member to list payment methods for. Omit this and company_id to list your own saved payment methods.
/// * `company_id` - The unique identifier of the company. Provide either this or member_id, not both. Omit both to address your own saved payment methods.
/// * `created_before` - Only return payment methods created before this timestamp.
/// * `created_after` - Only return payment methods created after this timestamp.
/// * `payment_method_types` - Only return payment methods of these types. Pass the eligible `type` values from the payment method types catalogue so the list holds nothing the purchase cannot take. An empty list returns no payment methods.
/// * `card_brands` - Only return cards on these networks, such as the networks the seller accepts. Payment methods that are not cards are unaffected.
/// * `card_funding_types` - Only return cards funded this way. A card whose funding could not be determined is excluded, and payment methods that are not cards are unaffected.
/// * `has_payer_document` - Filter cards by whether they carry the payer identity document their payment provider requires. Payment methods that are not cards are unaffected.
/// * `expired` - Filter by expiry. Only a card can expire, so `false` keeps every payment method that is not past its expiration month and `true` returns expired cards alone.
/// * `broken` - Filter by whether the stored credential has permanently stopped charging, such as a vault entry its provider closed.
/// * `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
/// .payment_methods
/// .list(
/// &PaymentMethodsListQueryRequest {
/// first: Some(42),
/// last: Some(42),
/// member_id: Some("mber_xxxxxxxxxxxxx".to_string()),
/// company_id: Some("biz_xxxxxxxxxxxxxx".to_string()),
/// created_before: Some(DateTime::parse_from_rfc3339("2023-12-01T05:00:00Z").unwrap()),
/// created_after: Some(DateTime::parse_from_rfc3339("2023-12-01T05:00:00Z").unwrap()),
/// after: None,
/// before: None,
/// direction: None,
/// future_usage: None,
/// payment_method_types: vec![],
/// card_brands: vec![],
/// card_funding_types: vec![],
/// has_payer_document: None,
/// expired: None,
/// broken: None,
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn list(
&self,
request: &PaymentMethodsListQueryRequest,
options: Option<RequestOptions>,
) -> Result<ListPaymentMethodsResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"payment_methods",
None,
QueryBuilder::new()
.string("after", request.after.clone())
.string("before", request.before.clone())
.int("first", request.first.clone())
.int("last", request.last.clone())
.string("member_id", request.member_id.clone())
.string("company_id", request.company_id.clone())
.serialize("direction", request.direction.clone())
.datetime("created_before", request.created_before.clone())
.datetime("created_after", request.created_after.clone())
.serialize("future_usage", request.future_usage.clone())
.serialize_array("payment_method_types", request.payment_method_types.clone())
.serialize_array("card_brands", request.card_brands.clone())
.serialize_array("card_funding_types", request.card_funding_types.clone())
.bool("has_payer_document", request.has_payer_document.clone())
.bool("expired", request.expired.clone())
.bool("broken", request.broken.clone())
.build(),
options,
)
.await
}
/// Retrieves the details of an existing payment method. Addresses a member's wallet when member_id or company_id is given, otherwise your own.
///
/// Required permissions:
/// - `member:payment_methods:read`
///
/// # Arguments
///
/// * `id` - The unique identifier of the payment method.
/// * `company_id` - The unique identifier of the company. Provide either this or member_id, not both. Omit both to address your own saved payment methods.
/// * `member_id` - The unique identifier of the member. Provide either this or company_id, not both. Omit both to address your own saved payment methods.
/// * `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
/// .payment_methods
/// .retrieve(
/// &"payt_xxxxxxxxxxxxx".to_string(),
/// &PaymentMethodsRetrieveQueryRequest {
/// company_id: Some("biz_xxxxxxxxxxxxxx".to_string()),
/// member_id: Some("mber_xxxxxxxxxxxxx".to_string()),
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn retrieve(
&self,
id: &str,
request: &PaymentMethodsRetrieveQueryRequest,
options: Option<RequestOptions>,
) -> Result<PaymentMethod, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("payment_methods/{}", id),
None,
QueryBuilder::new()
.string("company_id", request.company_id.clone())
.string("member_id", request.member_id.clone())
.build(),
options,
)
.await
}
/// Delete a saved payment method. Cannot delete a payment method attached to an active subscription.
///
/// Required permissions:
/// - `member:payment_methods:manage`
///
/// # Arguments
///
/// * `id` - The unique identifier of the payment method to delete.
/// * `company_id` - The unique identifier of the company. Provide either this or member_id, not both. Omit both to address your own saved payment methods.
/// * `member_id` - The unique identifier of the member. Provide either this or company_id, not both. Omit both to address your own saved payment methods.
/// * `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
/// .payment_methods
/// .delete_payment_method(
/// &"payt_xxxxxxxxxxxxx".to_string(),
/// &DeletePaymentMethodQueryRequest {
/// company_id: Some("biz_xxxxxxxxxxxxxx".to_string()),
/// member_id: Some("mber_xxxxxxxxxxxxx".to_string()),
/// ..Default::default()
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn delete_payment_method(
&self,
id: &str,
request: &DeletePaymentMethodQueryRequest,
options: Option<RequestOptions>,
) -> Result<bool, ApiError> {
self.http_client
.execute_request(
Method::DELETE,
&format!("payment_methods/{}", id),
None,
QueryBuilder::new()
.string("company_id", request.company_id.clone())
.string("member_id", request.member_id.clone())
.build(),
options,
)
.await
}
}