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
// this file is @generated
#![allow(clippy::doc_markdown, clippy::default_trait_access)]
#[allow(unused_imports, clippy::wildcard_imports)]
use crate::{error::Result, models::*, Configuration};
/// Query and header parameters of [`Customers::list`].
#[derive(Clone, Debug, Default)]
#[non_exhaustive]
pub struct CustomersListOptions {
/// Sort order. Format: `column.direction`. Allowed columns: `name`, `email`, `alias`, `created_at`. Direction: `asc` or `desc`. Default: `created_at.desc`.
pub order_by: Option<String>,
/// Page number (0-indexed)
pub page: Option<i32>,
/// Number of items per page
pub per_page: Option<i32>,
/// The `search` query parameter.
pub search: Option<String>,
/// The `archived` query parameter.
pub archived: Option<bool>,
}
impl CustomersListOptions {
/// Options with no parameter set.
#[must_use]
pub fn new() -> Self {
Self {
order_by: None,
page: None,
per_page: None,
search: None,
archived: None,
}
}
/// Sets the `order_by` query parameter.
#[must_use]
pub fn order_by(mut self, order_by: impl Into<String>) -> Self {
self.order_by = Some(order_by.into());
self
}
/// Sets the `order_by` query parameter, or unsets it with `None`.
#[must_use]
pub fn maybe_order_by(mut self, order_by: Option<String>) -> Self {
self.order_by = order_by;
self
}
/// Sets the `page` query parameter.
#[must_use]
pub fn page(mut self, page: impl Into<i32>) -> Self {
self.page = Some(page.into());
self
}
/// Sets the `page` query parameter, or unsets it with `None`.
#[must_use]
pub fn maybe_page(mut self, page: Option<i32>) -> Self {
self.page = page;
self
}
/// Sets the `per_page` query parameter.
#[must_use]
pub fn per_page(mut self, per_page: impl Into<i32>) -> Self {
self.per_page = Some(per_page.into());
self
}
/// Sets the `per_page` query parameter, or unsets it with `None`.
#[must_use]
pub fn maybe_per_page(mut self, per_page: Option<i32>) -> Self {
self.per_page = per_page;
self
}
/// Sets the `search` query parameter.
#[must_use]
pub fn search(mut self, search: impl Into<String>) -> Self {
self.search = Some(search.into());
self
}
/// Sets the `search` query parameter, or unsets it with `None`.
#[must_use]
pub fn maybe_search(mut self, search: Option<String>) -> Self {
self.search = search;
self
}
/// Sets the `archived` query parameter.
#[must_use]
pub fn archived(mut self, archived: impl Into<bool>) -> Self {
self.archived = Some(archived.into());
self
}
/// Sets the `archived` query parameter, or unsets it with `None`.
#[must_use]
pub fn maybe_archived(mut self, archived: Option<bool>) -> Self {
self.archived = archived;
self
}
}
/// The customers API, from the client's
/// [`customers`](crate::api::Meteroid::customers).
#[derive(Clone)]
pub struct Customers {
cfg: std::sync::Arc<Configuration>,
options: crate::api::RequestOptions,
}
impl std::fmt::Debug for Customers {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Customers")
.field("options", &self.options)
.finish_non_exhaustive()
}
}
impl Customers {
pub(super) fn new(cfg: std::sync::Arc<Configuration>) -> Self {
Self {
cfg,
options: crate::api::RequestOptions::default(),
}
}
/// Applies `options` (headers, timeout, retries, idempotency key) to the calls made
/// through the returned value.
#[must_use]
pub fn with_options(mut self, options: crate::api::RequestOptions) -> Self {
self.options = options;
self
}
fn list_request(
&self,
options: impl Into<Option<CustomersListOptions>>,
) -> crate::api::Call<crate::models::CustomerListResponse> {
let CustomersListOptions {
order_by,
page,
per_page,
search,
archived,
} = options.into().unwrap_or_default();
crate::request::Request::new(http::Method::GET, "/api/v1/customers")
.with_optional_query_param("order_by", order_by)
.with_optional_query_param("page", page)
.with_optional_query_param("per_page", per_page)
.with_optional_query_param("search", search)
.with_optional_query_param("archived", archived)
.with_options(&self.options)
.json(&self.cfg)
}
/// List customers with optional pagination and search filtering.
///
/// `GET /api/v1/customers`, a page at a time: awaiting the call gives the first
/// [`Page`](crate::api::Page), [`items`](crate::api::PageCall::items) every
/// [`Customer`](crate::models::Customer) across pages
/// and [`pages`](crate::api::PageCall::pages) every page.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (401, 429, 500).
pub fn list(
&self,
options: impl Into<Option<CustomersListOptions>>,
) -> crate::api::PageCall<crate::models::CustomerListResponse, crate::models::Customer> {
static WALK: crate::api::pagination::Walk<CustomersListOptions> =
crate::api::pagination::Walk::Page {
first: 0,
get: |options| options.page.map(i64::from),
set: |options, position| options.page = i32::try_from(position).ok(),
};
let this = self.clone();
let call = move |options: CustomersListOptions| this.list_request(options);
crate::api::PageCall::new(
options.into().unwrap_or_default(),
WALK,
crate::api::pages::CUSTOMERS_LIST,
call,
)
}
/// Create customer
///
/// `POST /api/v1/customers`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (400, 401, 409, 429, 500).
pub fn create(
&self,
customer_create_request: crate::models::CustomerCreateRequest,
) -> crate::api::Call<crate::models::Customer> {
crate::request::Request::new(http::Method::POST, "/api/v1/customers")
.with_body_param(customer_create_request)
.with_options(&self.options)
.json(&self.cfg)
}
/// Get customer
///
/// Retrieve a single customer by ID or alias.
///
/// `GET /api/v1/customers/{id_or_alias}`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (401, 404, 429, 500).
pub fn retrieve(&self, id_or_alias: &str) -> crate::api::Call<crate::models::Customer> {
crate::request::Request::new(http::Method::GET, "/api/v1/customers/{id_or_alias}")
.with_path_param("id_or_alias", id_or_alias)
.with_options(&self.options)
.json(&self.cfg)
}
/// Update customer
///
/// `PUT /api/v1/customers/{id_or_alias}`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (400, 401, 404, 429, 500).
pub fn replace(
&self,
id_or_alias: &str,
customer_update_request: crate::models::CustomerUpdateRequest,
) -> crate::api::Call<crate::models::Customer> {
crate::request::Request::new(http::Method::PUT, "/api/v1/customers/{id_or_alias}")
.with_path_param("id_or_alias", id_or_alias)
.with_body_param(customer_update_request)
.with_options(&self.options)
.json(&self.cfg)
}
/// Archive a customer
///
/// No linked entity will be deleted. You need to terminate all active subscriptions before archiving a customer, or the call will fail.
///
/// `DELETE /api/v1/customers/{id_or_alias}`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (401, 404, 429, 500).
pub fn archive(&self, id_or_alias: &str) -> crate::api::Call<()> {
crate::request::Request::new(http::Method::DELETE, "/api/v1/customers/{id_or_alias}")
.with_path_param("id_or_alias", id_or_alias)
.with_options(&self.options)
.empty(&self.cfg)
}
/// Patch customer
///
/// Partially update a customer. Only provided fields will be updated.
///
/// `PATCH /api/v1/customers/{id_or_alias}`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (400, 401, 404, 429, 500).
pub fn update(
&self,
id_or_alias: &str,
customer_patch_request: crate::models::CustomerPatchRequest,
) -> crate::api::Call<crate::models::Customer> {
crate::request::Request::new(http::Method::PATCH, "/api/v1/customers/{id_or_alias}")
.with_path_param("id_or_alias", id_or_alias)
.with_body_param(customer_patch_request)
.with_options(&self.options)
.json(&self.cfg)
}
/// List customer entitlements
///
/// `GET /api/v1/customers/{id_or_alias}/entitlements`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (401, 404, 429).
pub fn list_entitlements(
&self,
id_or_alias: &str,
) -> crate::api::Call<crate::models::EffectiveEntitlementListResponse> {
crate::request::Request::new(
http::Method::GET,
"/api/v1/customers/{id_or_alias}/entitlements",
)
.with_path_param("id_or_alias", id_or_alias)
.with_options(&self.options)
.json(&self.cfg)
}
/// Generate a portal token for a customer
///
/// Generates an opaque token that grants access to the customer portal. A call may return the
/// token of an earlier call with the same scopes, with up to 10% less lifetime: rely on `expires_at`.
/// The token can be used to access invoices, payment methods, and other portal features.
///
/// `POST /api/v1/customers/{id_or_alias}/portal-token`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (400, 401, 404, 429, 500).
pub fn create_portal_token(
&self,
id_or_alias: &str,
customer_portal_token_request: crate::models::CustomerPortalTokenRequest,
) -> crate::api::Call<crate::models::CustomerPortalTokenResponse> {
crate::request::Request::new(
http::Method::POST,
"/api/v1/customers/{id_or_alias}/portal-token",
)
.with_path_param("id_or_alias", id_or_alias)
.with_body_param(customer_portal_token_request)
.with_options(&self.options)
.json(&self.cfg)
}
/// Restore an archived customer
///
/// `POST /api/v1/customers/{id_or_alias}/unarchive`.
///
/// # Errors
///
/// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (401, 404, 429, 500).
pub fn unarchive(&self, id_or_alias: &str) -> crate::api::Call<()> {
crate::request::Request::new(
http::Method::POST,
"/api/v1/customers/{id_or_alias}/unarchive",
)
.with_path_param("id_or_alias", id_or_alias)
.with_options(&self.options)
.empty(&self.cfg)
}
}