lago-types 0.1.25

Types definitions for Lago API
Documentation
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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
use serde::{Deserialize, Serialize};

use crate::models::{ChargeModel, FixedChargeModel, PaginationParams};

// ─── Charge input types ──────────────────────────────────────────────────────

/// Input data for creating a standalone charge on a plan.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateChargeInput {
    /// The billable metric ID to reference.
    pub billable_metric_id: String,
    /// The charge model to use.
    pub charge_model: ChargeModel,
    /// Unique code for the charge.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub code: Option<String>,
    /// Display name for the charge on invoices.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoice_display_name: Option<String>,
    /// Whether the charge is billed in advance.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pay_in_advance: Option<bool>,
    /// Whether the charge is invoiceable.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoiceable: Option<bool>,
    /// Whether the charge is prorated.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prorated: Option<bool>,
    /// Minimum amount in cents for this charge.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_amount_cents: Option<i64>,
    /// Charge properties (model-specific configuration).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<serde_json::Value>,
    /// Filters for differentiated pricing.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filters: Option<Vec<ChargeFilterInputValue>>,
    /// Tax codes for this charge.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_codes: Option<Vec<String>>,
    /// The regroup paid fees option.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub regroup_paid_fees: Option<String>,
    /// Applied pricing unit for this charge.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub applied_pricing_unit: Option<serde_json::Value>,
    /// Whether the charge accepts a target wallet.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub accepts_target_wallet: Option<bool>,
    /// Whether to cascade updates to existing subscriptions.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cascade_updates: Option<bool>,
}

impl CreateChargeInput {
    pub fn new(billable_metric_id: String, charge_model: ChargeModel) -> Self {
        Self {
            billable_metric_id,
            charge_model,
            code: None,
            invoice_display_name: None,
            pay_in_advance: None,
            invoiceable: None,
            prorated: None,
            min_amount_cents: None,
            properties: None,
            filters: None,
            tax_codes: None,
            regroup_paid_fees: None,
            applied_pricing_unit: None,
            accepts_target_wallet: None,
            cascade_updates: None,
        }
    }

    pub fn with_code(mut self, code: String) -> Self {
        self.code = Some(code);
        self
    }

    pub fn with_properties(mut self, properties: serde_json::Value) -> Self {
        self.properties = Some(properties);
        self
    }

    pub fn with_tax_codes(mut self, tax_codes: Vec<String>) -> Self {
        self.tax_codes = Some(tax_codes);
        self
    }
}

/// Input data for updating a standalone charge.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateChargeInput {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoice_display_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pay_in_advance: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoiceable: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prorated: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_amount_cents: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filters: Option<Vec<ChargeFilterInputValue>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_codes: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub applied_pricing_unit: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub accepts_target_wallet: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cascade_updates: Option<bool>,
}

impl UpdateChargeInput {
    pub fn new() -> Self {
        Self::default()
    }
}

/// Filter values used in charge input.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ChargeFilterInputValue {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoice_display_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub values: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cascade_updates: Option<bool>,
}

// ─── Fixed charge input types ────────────────────────────────────────────────

/// Input data for creating a standalone fixed charge on a plan.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFixedChargeInput {
    /// The add-on ID to reference.
    pub add_on_id: String,
    /// The charge model to use.
    pub charge_model: FixedChargeModel,
    /// Unique code for the fixed charge.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub code: Option<String>,
    /// Display name for the fixed charge on invoices.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoice_display_name: Option<String>,
    /// Whether the fixed charge is billed in advance.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pay_in_advance: Option<bool>,
    /// Whether the fixed charge is prorated.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prorated: Option<bool>,
    /// Number of units.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub units: Option<f64>,
    /// Whether to apply units immediately.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apply_units_immediately: Option<bool>,
    /// Fixed charge properties (model-specific configuration).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<serde_json::Value>,
    /// Tax codes for this fixed charge.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_codes: Option<Vec<String>>,
    /// Whether to cascade updates to existing subscriptions.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cascade_updates: Option<bool>,
}

impl CreateFixedChargeInput {
    pub fn new(add_on_id: String, charge_model: FixedChargeModel) -> Self {
        Self {
            add_on_id,
            charge_model,
            code: None,
            invoice_display_name: None,
            pay_in_advance: None,
            prorated: None,
            units: None,
            apply_units_immediately: None,
            properties: None,
            tax_codes: None,
            cascade_updates: None,
        }
    }

    pub fn with_code(mut self, code: String) -> Self {
        self.code = Some(code);
        self
    }

    pub fn with_units(mut self, units: f64) -> Self {
        self.units = Some(units);
        self
    }
}

/// Input data for updating a standalone fixed charge.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateFixedChargeInput {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoice_display_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub units: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apply_units_immediately: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tax_codes: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cascade_updates: Option<bool>,
}

impl UpdateFixedChargeInput {
    pub fn new() -> Self {
        Self::default()
    }
}

// ─── Charge filter input types ───────────────────────────────────────────────

/// Input data for creating/updating a standalone charge filter.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ChargeFilterInput {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub invoice_display_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub values: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cascade_updates: Option<bool>,
}

impl ChargeFilterInput {
    pub fn new() -> Self {
        Self::default()
    }
}

// ─── Plan charge requests ────────────────────────────────────────────────────

/// Request for listing charges on a plan.
#[derive(Debug, Clone)]
pub struct ListPlanChargesRequest {
    pub plan_code: String,
    pub pagination: PaginationParams,
}

impl ListPlanChargesRequest {
    pub fn new(plan_code: String) -> Self {
        Self {
            plan_code,
            pagination: PaginationParams::default(),
        }
    }

    pub fn with_pagination(mut self, pagination: PaginationParams) -> Self {
        self.pagination = pagination;
        self
    }

    pub fn to_query_params(&self) -> Vec<(&str, String)> {
        self.pagination.to_query_params()
    }
}

/// Request for retrieving a specific charge on a plan.
#[derive(Debug, Clone)]
pub struct GetPlanChargeRequest {
    pub plan_code: String,
    pub charge_code: String,
}

impl GetPlanChargeRequest {
    pub fn new(plan_code: String, charge_code: String) -> Self {
        Self {
            plan_code,
            charge_code,
        }
    }
}

/// Request for creating a charge on a plan.
#[derive(Debug, Clone, Serialize)]
pub struct CreatePlanChargeRequest {
    #[serde(skip)]
    pub plan_code: String,
    pub charge: CreateChargeInput,
}

impl CreatePlanChargeRequest {
    pub fn new(plan_code: String, input: CreateChargeInput) -> Self {
        Self {
            plan_code,
            charge: input,
        }
    }
}

/// Request for updating a charge on a plan.
#[derive(Debug, Clone, Serialize)]
pub struct UpdatePlanChargeRequest {
    #[serde(skip)]
    pub plan_code: String,
    #[serde(skip)]
    pub charge_code: String,
    pub charge: UpdateChargeInput,
}

impl UpdatePlanChargeRequest {
    pub fn new(plan_code: String, charge_code: String, input: UpdateChargeInput) -> Self {
        Self {
            plan_code,
            charge_code,
            charge: input,
        }
    }
}

/// Request for deleting a charge on a plan.
#[derive(Debug, Clone)]
pub struct DeletePlanChargeRequest {
    pub plan_code: String,
    pub charge_code: String,
    pub cascade_updates: Option<bool>,
}

impl DeletePlanChargeRequest {
    pub fn new(plan_code: String, charge_code: String) -> Self {
        Self {
            plan_code,
            charge_code,
            cascade_updates: None,
        }
    }

    pub fn with_cascade_updates(mut self, cascade_updates: bool) -> Self {
        self.cascade_updates = Some(cascade_updates);
        self
    }

    pub fn to_query_params(&self) -> Vec<(&str, String)> {
        let mut params = Vec::new();
        if let Some(cascade) = self.cascade_updates {
            params.push(("cascade_updates", cascade.to_string()));
        }
        params
    }
}

// ─── Plan fixed charge requests ──────────────────────────────────────────────

/// Request for listing fixed charges on a plan.
#[derive(Debug, Clone)]
pub struct ListPlanFixedChargesRequest {
    pub plan_code: String,
    pub pagination: PaginationParams,
}

impl ListPlanFixedChargesRequest {
    pub fn new(plan_code: String) -> Self {
        Self {
            plan_code,
            pagination: PaginationParams::default(),
        }
    }

    pub fn with_pagination(mut self, pagination: PaginationParams) -> Self {
        self.pagination = pagination;
        self
    }

    pub fn to_query_params(&self) -> Vec<(&str, String)> {
        self.pagination.to_query_params()
    }
}

/// Request for retrieving a specific fixed charge on a plan.
#[derive(Debug, Clone)]
pub struct GetPlanFixedChargeRequest {
    pub plan_code: String,
    pub fixed_charge_code: String,
}

impl GetPlanFixedChargeRequest {
    pub fn new(plan_code: String, fixed_charge_code: String) -> Self {
        Self {
            plan_code,
            fixed_charge_code,
        }
    }
}

/// Request for creating a fixed charge on a plan.
#[derive(Debug, Clone, Serialize)]
pub struct CreatePlanFixedChargeRequest {
    #[serde(skip)]
    pub plan_code: String,
    pub fixed_charge: CreateFixedChargeInput,
}

impl CreatePlanFixedChargeRequest {
    pub fn new(plan_code: String, input: CreateFixedChargeInput) -> Self {
        Self {
            plan_code,
            fixed_charge: input,
        }
    }
}

/// Request for updating a fixed charge on a plan.
#[derive(Debug, Clone, Serialize)]
pub struct UpdatePlanFixedChargeRequest {
    #[serde(skip)]
    pub plan_code: String,
    #[serde(skip)]
    pub fixed_charge_code: String,
    pub fixed_charge: UpdateFixedChargeInput,
}

impl UpdatePlanFixedChargeRequest {
    pub fn new(
        plan_code: String,
        fixed_charge_code: String,
        input: UpdateFixedChargeInput,
    ) -> Self {
        Self {
            plan_code,
            fixed_charge_code,
            fixed_charge: input,
        }
    }
}

/// Request for deleting a fixed charge on a plan.
#[derive(Debug, Clone)]
pub struct DeletePlanFixedChargeRequest {
    pub plan_code: String,
    pub fixed_charge_code: String,
    pub cascade_updates: Option<bool>,
}

impl DeletePlanFixedChargeRequest {
    pub fn new(plan_code: String, fixed_charge_code: String) -> Self {
        Self {
            plan_code,
            fixed_charge_code,
            cascade_updates: None,
        }
    }

    pub fn with_cascade_updates(mut self, cascade_updates: bool) -> Self {
        self.cascade_updates = Some(cascade_updates);
        self
    }

    pub fn to_query_params(&self) -> Vec<(&str, String)> {
        let mut params = Vec::new();
        if let Some(cascade) = self.cascade_updates {
            params.push(("cascade_updates", cascade.to_string()));
        }
        params
    }
}

// ─── Plan charge filter requests ─────────────────────────────────────────────

/// Request for listing charge filters on a plan charge.
#[derive(Debug, Clone)]
pub struct ListPlanChargeFiltersRequest {
    pub plan_code: String,
    pub charge_code: String,
    pub pagination: PaginationParams,
}

impl ListPlanChargeFiltersRequest {
    pub fn new(plan_code: String, charge_code: String) -> Self {
        Self {
            plan_code,
            charge_code,
            pagination: PaginationParams::default(),
        }
    }

    pub fn with_pagination(mut self, pagination: PaginationParams) -> Self {
        self.pagination = pagination;
        self
    }

    pub fn to_query_params(&self) -> Vec<(&str, String)> {
        self.pagination.to_query_params()
    }
}

/// Request for retrieving a specific charge filter.
#[derive(Debug, Clone)]
pub struct GetPlanChargeFilterRequest {
    pub plan_code: String,
    pub charge_code: String,
    pub filter_id: String,
}

impl GetPlanChargeFilterRequest {
    pub fn new(plan_code: String, charge_code: String, filter_id: String) -> Self {
        Self {
            plan_code,
            charge_code,
            filter_id,
        }
    }
}

/// Request for creating a charge filter on a plan charge.
#[derive(Debug, Clone, Serialize)]
pub struct CreatePlanChargeFilterRequest {
    #[serde(skip)]
    pub plan_code: String,
    #[serde(skip)]
    pub charge_code: String,
    pub filter: ChargeFilterInput,
}

impl CreatePlanChargeFilterRequest {
    pub fn new(plan_code: String, charge_code: String, input: ChargeFilterInput) -> Self {
        Self {
            plan_code,
            charge_code,
            filter: input,
        }
    }
}

/// Request for updating a charge filter on a plan charge.
#[derive(Debug, Clone, Serialize)]
pub struct UpdatePlanChargeFilterRequest {
    #[serde(skip)]
    pub plan_code: String,
    #[serde(skip)]
    pub charge_code: String,
    #[serde(skip)]
    pub filter_id: String,
    pub filter: ChargeFilterInput,
}

impl UpdatePlanChargeFilterRequest {
    pub fn new(
        plan_code: String,
        charge_code: String,
        filter_id: String,
        input: ChargeFilterInput,
    ) -> Self {
        Self {
            plan_code,
            charge_code,
            filter_id,
            filter: input,
        }
    }
}

/// Request for deleting a charge filter on a plan charge.
#[derive(Debug, Clone)]
pub struct DeletePlanChargeFilterRequest {
    pub plan_code: String,
    pub charge_code: String,
    pub filter_id: String,
    pub cascade_updates: Option<bool>,
}

impl DeletePlanChargeFilterRequest {
    pub fn new(plan_code: String, charge_code: String, filter_id: String) -> Self {
        Self {
            plan_code,
            charge_code,
            filter_id,
            cascade_updates: None,
        }
    }

    pub fn with_cascade_updates(mut self, cascade_updates: bool) -> Self {
        self.cascade_updates = Some(cascade_updates);
        self
    }

    pub fn to_query_params(&self) -> Vec<(&str, String)> {
        let mut params = Vec::new();
        if let Some(cascade) = self.cascade_updates {
            params.push(("cascade_updates", cascade.to_string()));
        }
        params
    }
}