basaltic-sdk-rust 0.9.1

Official typed asynchronous Rust SDK for Basaltic
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
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
//! Generated typed wire models. Unknown string enum values are retained.
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct BillingProfileResponse {
    #[serde(rename = "billing_profile")]
    pub billing_profile: BillingProfile,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct BillingProfile {
    #[serde(rename = "customer_type")]
    pub customer_type: BillingProfileCustomerType,
    /// Full legal name of the individual or company.
    #[serde(rename = "company_name")]
    pub company_name: String,
    /// The recipient's tax identifier in the country — CPF or CNPJ in Brazil, an EIN, a VAT number. Stored without separators and upper-cased.
    #[serde(rename = "tax_id")]
    pub tax_id: String,
    /// The country rule the identifier satisfied, such as `br_cpf`, `br_cnpj`, `us_ein` or `other`. Empty when there is no identifier.
    #[serde(rename = "tax_id_kind")]
    pub tax_id_kind: String,
    /// Why there is no identifier, where the country's rule does not require one.
    #[serde(rename = "no_tax_id_reason")]
    pub no_tax_id_reason: String,
    /// Billing email for fiscal invoice delivery. The onboarding form prefills this from the signed-in user's email.
    #[serde(rename = "email")]
    pub email: String,
    /// E.164 phone number, or empty.
    #[serde(rename = "phone")]
    pub phone: String,

    #[serde(rename = "country")]
    pub country: ResourceRef,
    /// The catalog state, where the country lists states. Otherwise the state is text in `address.state`.
    #[serde(rename = "state")]
    pub state: BillingProfileState,
    /// The catalog city, where the country lists cities. Otherwise the city is text in `address.city`.
    #[serde(rename = "city")]
    pub city: BillingProfileCity,

    #[serde(rename = "address")]
    pub address: BillingAddress,

    #[serde(rename = "ready")]
    pub ready: bool,
    /// What stops the profile from being ready: `customer_type`, `company_name`, `email`, `tax_id`, `tax_id_or_reason`, or an address key. A stored value that no longer satisfies the country's rules is listed as missing.
    #[serde(rename = "missing_fields")]
    pub missing_fields: Vec<String>,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum BillingProfileCustomerType {
    Value,
    Individual,
    Company,
    Unknown(String),
}
impl BillingProfileCustomerType {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Value => "",
            Self::Individual => "individual",
            Self::Company => "company",
            Self::Unknown(value) => value,
        }
    }
}
impl serde::Serialize for BillingProfileCustomerType {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for BillingProfileCustomerType {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <String as serde::Deserialize>::deserialize(deserializer)?;
        Ok(match value.as_str() {
            "" => Self::Value,
            "individual" => Self::Individual,
            "company" => Self::Company,
            _ => Self::Unknown(value),
        })
    }
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct ResourceRef {
    #[serde(rename = "id")]
    pub id: String,

    #[serde(rename = "crn")]
    pub crn: String,
    /// Display label at response time — the resource's name where it has one, otherwise its human label (an invoice number, an account display name). Absent when the target is gone. Not a lookup key.
    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
#[serde(untagged)]
pub enum BillingProfileState {
    Variant1(Box<ResourceRef>),
    Variant2(Box<crate::Nullable<serde_json::Value>>),
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
#[serde(untagged)]
pub enum BillingProfileCity {
    Variant1(Box<ResourceRef>),
    Variant2(Box<crate::Nullable<serde_json::Value>>),
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct BillingAddress {
    #[serde(
        rename = "street_name",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub street_name: Option<String>,

    #[serde(
        rename = "street_number",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub street_number: Option<String>,

    #[serde(
        rename = "complement",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub complement: Option<String>,

    #[serde(
        rename = "neighborhood",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub neighborhood: Option<String>,

    #[serde(rename = "city", default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,

    #[serde(rename = "state", default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// Stored without mask literals.
    #[serde(
        rename = "postal_code",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
}

pub type GetBillingProfileResponse = BillingProfileResponse;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct CurrentUsage {
    /// Unbilled usage accrued this UTC month, 2-decimal string.
    #[serde(rename = "amount")]
    pub amount: String,

    #[serde(rename = "period_start")]
    pub period_start: String,
    /// Per-SKU breakdown, ordered by cost.
    #[serde(rename = "items")]
    pub items: Vec<UsageLine>,
    /// Independent organization-wide monthly allowance pools; empty before activation.
    #[serde(rename = "included_usage")]
    pub included_usage: Vec<IncludedUsage>,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct UsageLine {
    #[serde(rename = "sku")]
    pub sku: String,

    #[serde(rename = "description")]
    pub description: String,
    /// Billable quantity after included usage; may be zero.
    #[serde(rename = "quantity")]
    pub quantity: String,

    #[serde(rename = "unit")]
    pub unit: String,
    /// Accrued cost at 4-decimal precision (sub-centavo lines stay visible mid-month).
    #[serde(rename = "amount")]
    pub amount: String,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct IncludedUsage {
    #[serde(rename = "code")]
    pub code: String,

    #[serde(rename = "name")]
    pub name: String,

    #[serde(rename = "unit")]
    pub unit: String,

    #[serde(rename = "period_start")]
    pub period_start: String,
    /// Exclusive UTC month end. Unused allowance does not roll over.
    #[serde(rename = "period_end")]
    pub period_end: String,
    /// Later of month start and policy activation. Earlier usage retains its original charges.
    #[serde(rename = "counted_from")]
    pub counted_from: String,
    /// Monthly organization grant.
    #[serde(rename = "base")]
    pub base: String,
    /// Allowance earned by rated instance-hours, prorated by this UTC month's actual hour count.
    #[serde(rename = "contributed")]
    pub contributed: String,
    /// Base plus earned contributions.
    #[serde(rename = "total")]
    pub total: String,
    /// Gross eligible usage since counted_from; excludes inbound and unmetered private traffic.
    #[serde(rename = "used")]
    pub used: String,
    /// Persisted allowance allocations, including any already invoiced.
    #[serde(rename = "included_used")]
    pub included_used: String,
    /// Nonnegative unused allowance.
    #[serde(rename = "remaining")]
    pub remaining: String,
    /// Usage exceeding included allocations, before money credits. Can fall as instance allowance accrues.
    #[serde(rename = "overage")]
    pub overage: String,
}

pub type GetCurrentUsageResponse = CurrentUsage;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct InvoiceResponse {
    #[serde(rename = "invoice")]
    pub invoice: Invoice,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct Invoice {
    /// Global organization-scoped invoice identity.
    #[serde(rename = "crn")]
    pub crn: String,

    #[serde(rename = "id")]
    pub id: String,

    #[serde(rename = "invoice_number")]
    pub invoice_number: String,
    /// First day of the billed UTC month.
    #[serde(rename = "period_start")]
    pub period_start: String,
    /// Exclusive end (first day of the following month).
    #[serde(rename = "period_end")]
    pub period_end: String,

    #[serde(rename = "subtotal")]
    pub subtotal: String,

    #[serde(rename = "credits_applied")]
    pub credits_applied: String,

    #[serde(rename = "total")]
    pub total: String,

    #[serde(rename = "currency")]
    pub currency: String,
    /// Confirmed refunds less failed-refund reversals, in BRL.
    #[serde(rename = "refunded_amount")]
    pub refunded_amount: String,
    /// Dispute principal withdrawn less funds reinstated; excludes provider fees.
    #[serde(rename = "disputed_amount")]
    pub disputed_amount: String,

    #[serde(rename = "status")]
    pub status: InvoiceStatus,

    #[serde(
        rename = "issued_at",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub issued_at: Option<crate::Nullable<String>>,

    #[serde(
        rename = "due_at",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub due_at: Option<crate::Nullable<String>>,

    #[serde(
        rename = "paid_at",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub paid_at: Option<crate::Nullable<String>>,

    #[serde(rename = "created_at")]
    pub created_at: String,
    /// Path of the PDF statement, rendered on demand by GET /v1/invoices/{invoice_id}/pdf under the same authorization as this document.
    #[serde(rename = "pdf_url", default, skip_serializing_if = "Option::is_none")]
    pub pdf_url: Option<String>,
    /// Line items; present only on the detail endpoint.
    #[serde(rename = "items", default, skip_serializing_if = "Option::is_none")]
    pub items: Option<Vec<InvoiceItem>>,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum InvoiceStatus {
    Open,
    Paid,
    PastDue,
    Uncollectible,
    Void,
    Unknown(String),
}
impl InvoiceStatus {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Open => "open",
            Self::Paid => "paid",
            Self::PastDue => "past_due",
            Self::Uncollectible => "uncollectible",
            Self::Void => "void",
            Self::Unknown(value) => value,
        }
    }
}
impl serde::Serialize for InvoiceStatus {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for InvoiceStatus {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <String as serde::Deserialize>::deserialize(deserializer)?;
        Ok(match value.as_str() {
            "open" => Self::Open,
            "paid" => Self::Paid,
            "past_due" => Self::PastDue,
            "uncollectible" => Self::Uncollectible,
            "void" => Self::Void,
            _ => Self::Unknown(value),
        })
    }
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct InvoiceItem {
    #[serde(rename = "kind")]
    pub kind: InvoiceItemKind,

    #[serde(
        rename = "sku",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub sku: Option<crate::Nullable<String>>,

    #[serde(rename = "description")]
    pub description: String,

    #[serde(rename = "quantity")]
    pub quantity: String,

    #[serde(
        rename = "unit",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub unit: Option<crate::Nullable<String>>,

    #[serde(rename = "unit_price")]
    pub unit_price: String,
    /// Rounded line total; negative for credit lines.
    #[serde(rename = "amount")]
    pub amount: String,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum InvoiceItemKind {
    Usage,
    Credit,
    Unknown(String),
}
impl InvoiceItemKind {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Usage => "usage",
            Self::Credit => "credit",
            Self::Unknown(value) => value,
        }
    }
}
impl serde::Serialize for InvoiceItemKind {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for InvoiceItemKind {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <String as serde::Deserialize>::deserialize(deserializer)?;
        Ok(match value.as_str() {
            "usage" => Self::Usage,
            "credit" => Self::Credit,
            _ => Self::Unknown(value),
        })
    }
}

pub type GetInvoiceResponse = InvoiceResponse;

pub type GetInvoiceResource = Invoice;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct GetInvoiceScope {
    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct ListCreditsParameters {
    #[serde(rename = "crn", default, skip_serializing_if = "Option::is_none")]
    pub crn: Option<String>,

    #[serde(rename = "marker", default, skip_serializing_if = "Option::is_none")]
    pub marker: Option<String>,

    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}

pub type ListCreditsQuery = ListCreditsParameters;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct CreditListResponse {
    #[serde(rename = "credits")]
    pub credits: Vec<Credit>,

    #[serde(rename = "meta")]
    pub meta: PaginationMeta,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct Credit {
    /// Global organization-scoped credit identity.
    #[serde(rename = "crn")]
    pub crn: String,

    #[serde(rename = "id")]
    pub id: String,

    #[serde(rename = "source")]
    pub source: CreditSource,

    #[serde(rename = "description")]
    pub description: String,

    #[serde(rename = "amount")]
    pub amount: String,

    #[serde(rename = "remaining")]
    pub remaining: String,

    #[serde(
        rename = "expires_at",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub expires_at: Option<crate::Nullable<String>>,

    #[serde(rename = "created_at")]
    pub created_at: String,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum CreditSource {
    Promo,
    Coupon,
    Adjustment,
    Migration,
    Unknown(String),
}
impl CreditSource {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Promo => "promo",
            Self::Coupon => "coupon",
            Self::Adjustment => "adjustment",
            Self::Migration => "migration",
            Self::Unknown(value) => value,
        }
    }
}
impl serde::Serialize for CreditSource {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for CreditSource {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <String as serde::Deserialize>::deserialize(deserializer)?;
        Ok(match value.as_str() {
            "promo" => Self::Promo,
            "coupon" => Self::Coupon,
            "adjustment" => Self::Adjustment,
            "migration" => Self::Migration,
            _ => Self::Unknown(value),
        })
    }
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct PaginationMeta {
    /// Total number of items
    #[serde(rename = "total", default, skip_serializing_if = "Option::is_none")]
    pub total: Option<i64>,
    /// Number of items per page
    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    /// Opaque cursor for the next page. Pass it back as the `marker` query parameter; treat it as a token, not a value to parse.
    #[serde(rename = "marker", default, skip_serializing_if = "Option::is_none")]
    pub marker: Option<String>,
    /// Whether there are more items
    #[serde(rename = "has_more", default, skip_serializing_if = "Option::is_none")]
    pub has_more: Option<bool>,
}

pub type ListCreditsResponse = CreditListResponse;

pub type ListCreditsItem = Credit;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct ListFiscalInvoicesParameters {
    #[serde(rename = "invoice", default, skip_serializing_if = "Option::is_none")]
    pub invoice: Option<String>,

    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,

    #[serde(rename = "marker", default, skip_serializing_if = "Option::is_none")]
    pub marker: Option<String>,
}

pub type ListFiscalInvoicesQuery = ListFiscalInvoicesParameters;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct FiscalInvoiceListResponse {
    #[serde(rename = "fiscal_invoices")]
    pub fiscal_invoices: Vec<FiscalInvoice>,

    #[serde(rename = "meta")]
    pub meta: PaginationMeta,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct FiscalInvoice {
    #[serde(rename = "id")]
    pub id: String,
    /// Actual amount received in BRL, not the billing invoice total.
    #[serde(rename = "amount")]
    pub amount: String,

    #[serde(rename = "number")]
    pub number: String,

    #[serde(rename = "verification_code")]
    pub verification_code: String,
    /// Municipal view/print link available after issuance.
    #[serde(rename = "url")]
    pub url: String,

    #[serde(rename = "issued_at")]
    pub issued_at: crate::Nullable<String>,

    #[serde(rename = "created_at")]
    pub created_at: String,
    /// Global organization-scoped fiscal invoice identity.
    #[serde(rename = "crn")]
    pub crn: String,

    #[serde(rename = "payment")]
    pub payment: ResourceRef,
    /// Related billing invoice, or null for a payment without an invoice. Deleted invoices retain their identity without a name.
    #[serde(rename = "invoice")]
    pub invoice: FiscalInvoiceInvoice,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
#[serde(untagged)]
pub enum FiscalInvoiceInvoice {
    Variant1(Box<ResourceRef>),
    Variant2(Box<crate::Nullable<serde_json::Value>>),
}

pub type ListFiscalInvoicesResponse = FiscalInvoiceListResponse;

pub type ListFiscalInvoicesItem = FiscalInvoice;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct ListInvoicesParameters {
    #[serde(rename = "crn", default, skip_serializing_if = "Option::is_none")]
    pub crn: Option<String>,

    #[serde(rename = "marker", default, skip_serializing_if = "Option::is_none")]
    pub marker: Option<String>,

    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}

pub type ListInvoicesQuery = ListInvoicesParameters;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct InvoiceListResponse {
    #[serde(rename = "invoices")]
    pub invoices: Vec<Invoice>,

    #[serde(rename = "meta")]
    pub meta: PaginationMeta,
}

pub type ListInvoicesResponse = InvoiceListResponse;

pub type ListInvoicesItem = Invoice;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct ListPaymentsParameters {
    #[serde(rename = "crn", default, skip_serializing_if = "Option::is_none")]
    pub crn: Option<String>,

    #[serde(rename = "marker", default, skip_serializing_if = "Option::is_none")]
    pub marker: Option<String>,

    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}

pub type ListPaymentsQuery = ListPaymentsParameters;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct PaymentListResponse {
    #[serde(rename = "payments")]
    pub payments: Vec<Payment>,

    #[serde(rename = "meta")]
    pub meta: PaginationMeta,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct Payment {
    /// Global organization-scoped payment identity.
    #[serde(rename = "crn")]
    pub crn: String,

    #[serde(rename = "id")]
    pub id: String,
    /// Related invoice. Null only when the payment has no invoice; a deleted invoice retains id and crn without name.
    #[serde(rename = "invoice")]
    pub invoice: PaymentInvoice,

    #[serde(rename = "amount")]
    pub amount: String,
    /// Confirmed refunds less failed-refund reversals, in BRL.
    #[serde(rename = "refunded_amount")]
    pub refunded_amount: String,
    /// Dispute principal withdrawn less funds reinstated; excludes provider fees.
    #[serde(rename = "disputed_amount")]
    pub disputed_amount: String,
    /// Settled receipt less refunds and disputed funds. Zero for an unsettled attempt; may be negative if the provider has withdrawn overlapping reversals. Does not change invoice collection status.
    #[serde(rename = "retained_amount")]
    pub retained_amount: String,

    #[serde(rename = "status")]
    pub status: PaymentStatus,
    /// 1-based dunning attempt this payment row belongs to.
    #[serde(rename = "attempt")]
    pub attempt: i64,

    #[serde(
        rename = "completed_at",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub completed_at: Option<crate::Nullable<String>>,

    #[serde(rename = "created_at")]
    pub created_at: String,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
#[serde(untagged)]
pub enum PaymentInvoice {
    Variant1(Box<ResourceRef>),
    Variant2(Box<crate::Nullable<serde_json::Value>>),
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum PaymentStatus {
    Pending,
    Processing,
    Succeeded,
    Failed,
    Refunded,
    Unknown(String),
}
impl PaymentStatus {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Pending => "pending",
            Self::Processing => "processing",
            Self::Succeeded => "succeeded",
            Self::Failed => "failed",
            Self::Refunded => "refunded",
            Self::Unknown(value) => value,
        }
    }
}
impl serde::Serialize for PaymentStatus {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for PaymentStatus {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <String as serde::Deserialize>::deserialize(deserializer)?;
        Ok(match value.as_str() {
            "pending" => Self::Pending,
            "processing" => Self::Processing,
            "succeeded" => Self::Succeeded,
            "failed" => Self::Failed,
            "refunded" => Self::Refunded,
            _ => Self::Unknown(value),
        })
    }
}

pub type ListPaymentsResponse = PaymentListResponse;

pub type ListPaymentsItem = Payment;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct ListPricesParameters {
    #[serde(rename = "service", default, skip_serializing_if = "Option::is_none")]
    pub service: Option<String>,

    #[serde(
        rename = "resource_type",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub resource_type: Option<String>,

    #[serde(rename = "sku", default, skip_serializing_if = "Option::is_none")]
    pub sku: Option<String>,

    #[serde(rename = "family", default, skip_serializing_if = "Option::is_none")]
    pub family: Option<String>,

    #[serde(rename = "at", default, skip_serializing_if = "Option::is_none")]
    pub at: Option<String>,
}

pub type ListPricesQuery = ListPricesParameters;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct PriceListResponse {
    #[serde(rename = "prices")]
    pub prices: Vec<Price>,
    /// The instant the catalog was read as of — the `at` that was asked for, or the server's clock when none was.
    #[serde(rename = "as_of")]
    pub as_of: String,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct Price {
    /// Stable catalog key, `{service}.{resource_type}.{variant}`. This is the public identity of a price — the row id is not published.
    #[serde(rename = "sku")]
    pub sku: String,
    /// Which service bills this SKU.
    #[serde(rename = "service")]
    pub service: String,

    #[serde(rename = "resource_type")]
    pub resource_type: String,
    /// Display name. For compute SKUs this is the flavor name.
    #[serde(rename = "name")]
    pub name: String,

    #[serde(
        rename = "description",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub description: Option<crate::Nullable<String>>,
    /// What one unit of `unit_price` buys.
    #[serde(rename = "unit")]
    pub unit: String,
    /// Price for one `unit`, as an exact decimal string.
    #[serde(rename = "unit_price")]
    pub unit_price: String,

    #[serde(rename = "currency")]
    pub currency: String,
    /// Extra facts about the SKU — `class`, `family`, `vcpus`, `memory_gb`, `storage_type`, … `family` separates the managed products (load balancer replicas, database cluster nodes) from the general compute flavors they share a `resource_type` with.
    #[serde(rename = "metadata")]
    pub metadata: std::collections::BTreeMap<String, serde_json::Value>,
    /// Active allowance contributions for this plan, omitted when none apply.
    #[serde(
        rename = "included_usage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub included_usage: Option<Vec<CatalogAllowance>>,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct CatalogAllowance {
    #[serde(rename = "policy_code")]
    pub policy_code: String,

    #[serde(rename = "unit")]
    pub unit: String,
    /// Full-month contribution per instance; prorated by billed hours in the actual calendar month.
    #[serde(rename = "monthly_quantity")]
    pub monthly_quantity: String,
    /// One grant per billing organization, not per instance, account region or bucket.
    #[serde(rename = "monthly_base")]
    pub monthly_base: String,
}

pub type ListPricesResponse = PriceListResponse;

pub type ListPricesItem = Price;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct ListTransactionsParameters {
    #[serde(rename = "crn", default, skip_serializing_if = "Option::is_none")]
    pub crn: Option<String>,

    #[serde(rename = "marker", default, skip_serializing_if = "Option::is_none")]
    pub marker: Option<String>,

    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}

pub type ListTransactionsQuery = ListTransactionsParameters;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct TransactionListResponse {
    #[serde(rename = "transactions")]
    pub transactions: Vec<Transaction>,

    #[serde(rename = "meta")]
    pub meta: PaginationMeta,
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct Transaction {
    /// Global organization-scoped transaction identity.
    #[serde(rename = "crn")]
    pub crn: String,

    #[serde(rename = "id")]
    pub id: String,
    /// Ledger entry type.
    #[serde(rename = "type")]
    pub type_: TransactionType,
    /// Always positive; the direction lives in the type.
    #[serde(rename = "amount")]
    pub amount: String,

    #[serde(
        rename = "description",
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "crate::response::present_nullable"
    )]
    pub description: Option<crate::Nullable<String>>,
    /// Organization-scoped invoice, payment, or credit related to this ledger entry. Null for manual entries, unsupported types, or absent identities. Deleted targets retain id and crn without name.
    #[serde(rename = "reference")]
    pub reference: TransactionReference,

    #[serde(rename = "created_at")]
    pub created_at: String,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum TransactionType {
    Payment,
    Refund,
    RefundReversal,
    Dispute,
    DisputeReversal,
    Adjustment,
    CreditGrant,
    CreditApplied,
    Unknown(String),
}
impl TransactionType {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Payment => "payment",
            Self::Refund => "refund",
            Self::RefundReversal => "refund_reversal",
            Self::Dispute => "dispute",
            Self::DisputeReversal => "dispute_reversal",
            Self::Adjustment => "adjustment",
            Self::CreditGrant => "credit_grant",
            Self::CreditApplied => "credit_applied",
            Self::Unknown(value) => value,
        }
    }
}
impl serde::Serialize for TransactionType {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for TransactionType {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <String as serde::Deserialize>::deserialize(deserializer)?;
        Ok(match value.as_str() {
            "payment" => Self::Payment,
            "refund" => Self::Refund,
            "refund_reversal" => Self::RefundReversal,
            "dispute" => Self::Dispute,
            "dispute_reversal" => Self::DisputeReversal,
            "adjustment" => Self::Adjustment,
            "credit_grant" => Self::CreditGrant,
            "credit_applied" => Self::CreditApplied,
            _ => Self::Unknown(value),
        })
    }
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
#[serde(untagged)]
pub enum TransactionReference {
    Variant1(Box<ResourceRef>),
    Variant2(Box<crate::Nullable<serde_json::Value>>),
}

pub type ListTransactionsResponse = TransactionListResponse;

pub type ListTransactionsItem = Transaction;

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct BillingProfileUpdateInput {
    #[serde(
        rename = "customer_type",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub customer_type: Option<BillingProfileUpdateInputCustomerType>,

    #[serde(
        rename = "company_name",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub company_name: Option<String>,
    /// Separators and case are ignored; the identifier is checked against the country's rules, including check digits where one is named.
    #[serde(rename = "tax_id", default, skip_serializing_if = "Option::is_none")]
    pub tax_id: Option<String>,
    /// Needed only when a customer type accepts more than one kind; otherwise the matching kind is chosen.
    #[serde(
        rename = "tax_id_kind",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub tax_id_kind: Option<String>,

    #[serde(
        rename = "no_tax_id_reason",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub no_tax_id_reason: Option<String>,

    #[serde(rename = "email", default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Phone with its country calling code. Spaces, dots, dashes and parentheses are ignored; stored as E.164.
    #[serde(rename = "phone", default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Country UUID, CRN, or ISO alpha-2 or alpha-3 code. Defaults to Brazil.
    #[serde(rename = "country", default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// State UUID, CRN, or code, where the country lists states. Omit when a city is given; the city implies it.
    #[serde(rename = "state", default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// City UUID or CRN, where the country lists cities.
    #[serde(rename = "city", default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,

    #[serde(rename = "address", default, skip_serializing_if = "Option::is_none")]
    pub address: Option<BillingAddressInput>,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum BillingProfileUpdateInputCustomerType {
    Value,
    Individual,
    Company,
    Unknown(String),
}
impl BillingProfileUpdateInputCustomerType {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Value => "",
            Self::Individual => "individual",
            Self::Company => "company",
            Self::Unknown(value) => value,
        }
    }
}
impl serde::Serialize for BillingProfileUpdateInputCustomerType {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for BillingProfileUpdateInputCustomerType {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let value = <String as serde::Deserialize>::deserialize(deserializer)?;
        Ok(match value.as_str() {
            "" => Self::Value,
            "individual" => Self::Individual,
            "company" => Self::Company,
            _ => Self::Unknown(value),
        })
    }
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Default)]
pub struct BillingAddressInput {
    #[serde(
        rename = "street_name",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub street_name: Option<String>,

    #[serde(
        rename = "street_number",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub street_number: Option<String>,

    #[serde(
        rename = "complement",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub complement: Option<String>,

    #[serde(
        rename = "neighborhood",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub neighborhood: Option<String>,

    #[serde(rename = "city", default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,

    #[serde(rename = "state", default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// Stored without mask literals.
    #[serde(
        rename = "postal_code",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
}

pub type UpdateBillingProfileBody = BillingProfileUpdateInput;

pub type UpdateBillingProfileResponse = BillingProfileResponse;