lago-javascript-client 0.45.0-beta → 0.48.0-beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/{types → esm}/openapi/client.d.ts +156 -710
- package/esm/openapi/client.js +1 -555
- package/package.json +6 -13
- package/script/mod.d.ts +5 -0
- package/script/openapi/client.d.ts +4465 -0
- package/script/openapi/client.js +2 -556
- /package/{types → esm}/mod.d.ts +0 -0
|
@@ -141,72 +141,6 @@ export interface ApiErrorNotFound {
|
|
|
141
141
|
/** @example "object_not_found" */
|
|
142
142
|
code: string;
|
|
143
143
|
}
|
|
144
|
-
export interface AppliedAddOn {
|
|
145
|
-
applied_add_on: AppliedAddOnObject;
|
|
146
|
-
}
|
|
147
|
-
export interface AppliedAddOnInput {
|
|
148
|
-
applied_add_on: {
|
|
149
|
-
/**
|
|
150
|
-
* The customer external unique identifier (provided by your own application)
|
|
151
|
-
* @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
|
|
152
|
-
*/
|
|
153
|
-
external_customer_id: string;
|
|
154
|
-
/**
|
|
155
|
-
* Unique code used to identify the add-on.
|
|
156
|
-
* @example "setup_fee"
|
|
157
|
-
*/
|
|
158
|
-
add_on_code: string;
|
|
159
|
-
/**
|
|
160
|
-
* The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.
|
|
161
|
-
* @example 50000
|
|
162
|
-
*/
|
|
163
|
-
amount_cents?: number | null;
|
|
164
|
-
/** The currency of the add-on. */
|
|
165
|
-
amount_currency?: Currency;
|
|
166
|
-
};
|
|
167
|
-
}
|
|
168
|
-
export interface AppliedAddOnObject {
|
|
169
|
-
/**
|
|
170
|
-
* Unique identifier of the applied add-on created by Lago.
|
|
171
|
-
* @format uuid
|
|
172
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
173
|
-
*/
|
|
174
|
-
lago_id: string;
|
|
175
|
-
/**
|
|
176
|
-
* Unique identifier of the add-on created by Lago.
|
|
177
|
-
* @format uuid
|
|
178
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
179
|
-
*/
|
|
180
|
-
lago_add_on_id: string;
|
|
181
|
-
/**
|
|
182
|
-
* Unique code used to identify the add-on.
|
|
183
|
-
* @example "setup_fee"
|
|
184
|
-
*/
|
|
185
|
-
add_on_code: string;
|
|
186
|
-
/**
|
|
187
|
-
* Unique identifier of the customer created by Lago.
|
|
188
|
-
* @format uuid
|
|
189
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
190
|
-
*/
|
|
191
|
-
lago_customer_id: string;
|
|
192
|
-
/**
|
|
193
|
-
* The customer external unique identifier (provided by your own application)
|
|
194
|
-
* @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
|
|
195
|
-
*/
|
|
196
|
-
external_customer_id: string;
|
|
197
|
-
/**
|
|
198
|
-
* The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.
|
|
199
|
-
* @example 50000
|
|
200
|
-
*/
|
|
201
|
-
amount_cents: number;
|
|
202
|
-
/** The currency of the add-on. */
|
|
203
|
-
amount_currency: Currency;
|
|
204
|
-
/**
|
|
205
|
-
* @format date-time
|
|
206
|
-
* @example "2022-09-14T16:35:31Z"
|
|
207
|
-
*/
|
|
208
|
-
created_at: string;
|
|
209
|
-
}
|
|
210
144
|
export interface AppliedCoupon {
|
|
211
145
|
applied_coupon: AppliedCouponObject;
|
|
212
146
|
}
|
|
@@ -245,7 +179,7 @@ export interface AppliedCouponInput {
|
|
|
245
179
|
amount_currency?: Currency;
|
|
246
180
|
/**
|
|
247
181
|
* The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
|
|
248
|
-
* @
|
|
182
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
249
183
|
* @example null
|
|
250
184
|
*/
|
|
251
185
|
percentage_rate?: string | null;
|
|
@@ -304,7 +238,7 @@ export interface AppliedCouponObject {
|
|
|
304
238
|
amount_currency?: Currency;
|
|
305
239
|
/**
|
|
306
240
|
* The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
|
|
307
|
-
* @
|
|
241
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
308
242
|
* @example null
|
|
309
243
|
*/
|
|
310
244
|
percentage_rate?: string | null;
|
|
@@ -449,7 +383,12 @@ export interface BillableMetricObject {
|
|
|
449
383
|
* Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`.
|
|
450
384
|
* @example "sum_agg"
|
|
451
385
|
*/
|
|
452
|
-
aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg";
|
|
386
|
+
aggregation_type: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg";
|
|
387
|
+
/**
|
|
388
|
+
* Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.
|
|
389
|
+
* @example "seconds"
|
|
390
|
+
*/
|
|
391
|
+
weighted_interval?: "seconds" | null;
|
|
453
392
|
/** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
|
|
454
393
|
group?: BillableMetricGroup;
|
|
455
394
|
/**
|
|
@@ -502,7 +441,12 @@ export interface BillableMetricBaseInput {
|
|
|
502
441
|
* Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`.
|
|
503
442
|
* @example "sum_agg"
|
|
504
443
|
*/
|
|
505
|
-
aggregation_type?: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg";
|
|
444
|
+
aggregation_type?: "count_agg" | "sum_agg" | "max_agg" | "unique_count_agg" | "weighted_sum_agg";
|
|
445
|
+
/**
|
|
446
|
+
* Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.
|
|
447
|
+
* @example "seconds"
|
|
448
|
+
*/
|
|
449
|
+
weighted_interval?: "seconds" | null;
|
|
506
450
|
/** Group with one or two dimensions, used to apply differentiated pricing based on additional properties of the billable metric. */
|
|
507
451
|
group?: BillableMetricGroup;
|
|
508
452
|
}
|
|
@@ -614,13 +558,13 @@ export interface ChargeProperties {
|
|
|
614
558
|
to_value: number | null;
|
|
615
559
|
/**
|
|
616
560
|
* The flat amount for a whole tier, excluding tax, for a `graduated` charge model. It is expressed as a decimal value.
|
|
617
|
-
* @
|
|
561
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
618
562
|
* @example "10"
|
|
619
563
|
*/
|
|
620
564
|
flat_amount: string;
|
|
621
565
|
/**
|
|
622
566
|
* The unit price, excluding tax, for a specific tier of a `graduated` charge model. It is expressed as a decimal value.
|
|
623
|
-
* @
|
|
567
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
624
568
|
* @example "0.5"
|
|
625
569
|
*/
|
|
626
570
|
per_unit_amount: string;
|
|
@@ -655,7 +599,7 @@ export interface ChargeProperties {
|
|
|
655
599
|
/**
|
|
656
600
|
* - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.
|
|
657
601
|
* - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.
|
|
658
|
-
* @
|
|
602
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
659
603
|
* @example "30"
|
|
660
604
|
*/
|
|
661
605
|
amount?: string;
|
|
@@ -671,13 +615,13 @@ export interface ChargeProperties {
|
|
|
671
615
|
package_size?: number;
|
|
672
616
|
/**
|
|
673
617
|
* The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.
|
|
674
|
-
* @
|
|
618
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
675
619
|
* @example "1"
|
|
676
620
|
*/
|
|
677
621
|
rate?: string;
|
|
678
622
|
/**
|
|
679
623
|
* The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.
|
|
680
|
-
* @
|
|
624
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
681
625
|
* @example "0.5"
|
|
682
626
|
*/
|
|
683
627
|
fixed_amount?: string;
|
|
@@ -688,10 +632,22 @@ export interface ChargeProperties {
|
|
|
688
632
|
free_units_per_events?: number | null;
|
|
689
633
|
/**
|
|
690
634
|
* The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.
|
|
691
|
-
* @
|
|
635
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
692
636
|
* @example "500"
|
|
693
637
|
*/
|
|
694
638
|
free_units_per_total_aggregation?: string | null;
|
|
639
|
+
/**
|
|
640
|
+
* Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.
|
|
641
|
+
* @format ^[0-9]+.?[0-9]*$
|
|
642
|
+
* @example "3.75"
|
|
643
|
+
*/
|
|
644
|
+
per_transaction_max_amount?: string | null;
|
|
645
|
+
/**
|
|
646
|
+
* Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.
|
|
647
|
+
* @format ^[0-9]+.?[0-9]*$
|
|
648
|
+
* @example "1.75"
|
|
649
|
+
*/
|
|
650
|
+
per_transaction_min_amount?: string | null;
|
|
695
651
|
/** Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. */
|
|
696
652
|
volume_ranges?: {
|
|
697
653
|
/**
|
|
@@ -708,270 +664,20 @@ export interface ChargeProperties {
|
|
|
708
664
|
to_value: number | null;
|
|
709
665
|
/**
|
|
710
666
|
* The unit price, excluding tax, for a specific tier of a `volume` charge model. It is expressed as a decimal value.
|
|
711
|
-
* @
|
|
667
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
712
668
|
* @example "10"
|
|
713
669
|
*/
|
|
714
670
|
flat_amount: string;
|
|
715
671
|
/**
|
|
716
672
|
* The flat amount for a whole tier, excluding tax, for a `volume` charge model. It is expressed as a decimal value.
|
|
717
|
-
* @
|
|
673
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
718
674
|
* @example "0.5"
|
|
719
675
|
*/
|
|
720
676
|
per_unit_amount: string;
|
|
721
677
|
}[];
|
|
722
678
|
}
|
|
723
679
|
/** @example "US" */
|
|
724
|
-
export
|
|
725
|
-
AD = "AD",
|
|
726
|
-
AE = "AE",
|
|
727
|
-
AF = "AF",
|
|
728
|
-
AG = "AG",
|
|
729
|
-
AI = "AI",
|
|
730
|
-
AL = "AL",
|
|
731
|
-
AM = "AM",
|
|
732
|
-
AO = "AO",
|
|
733
|
-
AQ = "AQ",
|
|
734
|
-
AR = "AR",
|
|
735
|
-
AS = "AS",
|
|
736
|
-
AT = "AT",
|
|
737
|
-
AU = "AU",
|
|
738
|
-
AW = "AW",
|
|
739
|
-
AX = "AX",
|
|
740
|
-
AZ = "AZ",
|
|
741
|
-
BA = "BA",
|
|
742
|
-
BB = "BB",
|
|
743
|
-
BD = "BD",
|
|
744
|
-
BE = "BE",
|
|
745
|
-
BF = "BF",
|
|
746
|
-
BG = "BG",
|
|
747
|
-
BH = "BH",
|
|
748
|
-
BI = "BI",
|
|
749
|
-
BJ = "BJ",
|
|
750
|
-
BL = "BL",
|
|
751
|
-
BM = "BM",
|
|
752
|
-
BN = "BN",
|
|
753
|
-
BO = "BO",
|
|
754
|
-
BQ = "BQ",
|
|
755
|
-
BR = "BR",
|
|
756
|
-
BS = "BS",
|
|
757
|
-
BT = "BT",
|
|
758
|
-
BV = "BV",
|
|
759
|
-
BW = "BW",
|
|
760
|
-
BY = "BY",
|
|
761
|
-
BZ = "BZ",
|
|
762
|
-
CA = "CA",
|
|
763
|
-
CC = "CC",
|
|
764
|
-
CD = "CD",
|
|
765
|
-
CF = "CF",
|
|
766
|
-
CG = "CG",
|
|
767
|
-
CH = "CH",
|
|
768
|
-
CI = "CI",
|
|
769
|
-
CK = "CK",
|
|
770
|
-
CL = "CL",
|
|
771
|
-
CM = "CM",
|
|
772
|
-
CN = "CN",
|
|
773
|
-
CO = "CO",
|
|
774
|
-
CR = "CR",
|
|
775
|
-
CU = "CU",
|
|
776
|
-
CV = "CV",
|
|
777
|
-
CW = "CW",
|
|
778
|
-
CX = "CX",
|
|
779
|
-
CY = "CY",
|
|
780
|
-
CZ = "CZ",
|
|
781
|
-
DE = "DE",
|
|
782
|
-
DJ = "DJ",
|
|
783
|
-
DK = "DK",
|
|
784
|
-
DM = "DM",
|
|
785
|
-
DO = "DO",
|
|
786
|
-
DZ = "DZ",
|
|
787
|
-
EC = "EC",
|
|
788
|
-
EE = "EE",
|
|
789
|
-
EG = "EG",
|
|
790
|
-
EH = "EH",
|
|
791
|
-
ER = "ER",
|
|
792
|
-
ES = "ES",
|
|
793
|
-
ET = "ET",
|
|
794
|
-
FI = "FI",
|
|
795
|
-
FJ = "FJ",
|
|
796
|
-
FK = "FK",
|
|
797
|
-
FM = "FM",
|
|
798
|
-
FO = "FO",
|
|
799
|
-
FR = "FR",
|
|
800
|
-
GA = "GA",
|
|
801
|
-
GB = "GB",
|
|
802
|
-
GD = "GD",
|
|
803
|
-
GE = "GE",
|
|
804
|
-
GF = "GF",
|
|
805
|
-
GG = "GG",
|
|
806
|
-
GH = "GH",
|
|
807
|
-
GI = "GI",
|
|
808
|
-
GL = "GL",
|
|
809
|
-
GM = "GM",
|
|
810
|
-
GN = "GN",
|
|
811
|
-
GP = "GP",
|
|
812
|
-
GQ = "GQ",
|
|
813
|
-
GR = "GR",
|
|
814
|
-
GS = "GS",
|
|
815
|
-
GT = "GT",
|
|
816
|
-
GU = "GU",
|
|
817
|
-
GW = "GW",
|
|
818
|
-
GY = "GY",
|
|
819
|
-
HK = "HK",
|
|
820
|
-
HM = "HM",
|
|
821
|
-
HN = "HN",
|
|
822
|
-
HR = "HR",
|
|
823
|
-
HT = "HT",
|
|
824
|
-
HU = "HU",
|
|
825
|
-
ID = "ID",
|
|
826
|
-
IE = "IE",
|
|
827
|
-
IL = "IL",
|
|
828
|
-
IM = "IM",
|
|
829
|
-
IN = "IN",
|
|
830
|
-
IO = "IO",
|
|
831
|
-
IQ = "IQ",
|
|
832
|
-
IR = "IR",
|
|
833
|
-
IS = "IS",
|
|
834
|
-
IT = "IT",
|
|
835
|
-
JE = "JE",
|
|
836
|
-
JM = "JM",
|
|
837
|
-
JO = "JO",
|
|
838
|
-
JP = "JP",
|
|
839
|
-
KE = "KE",
|
|
840
|
-
KG = "KG",
|
|
841
|
-
KH = "KH",
|
|
842
|
-
KI = "KI",
|
|
843
|
-
KM = "KM",
|
|
844
|
-
KN = "KN",
|
|
845
|
-
KP = "KP",
|
|
846
|
-
KR = "KR",
|
|
847
|
-
KW = "KW",
|
|
848
|
-
KY = "KY",
|
|
849
|
-
KZ = "KZ",
|
|
850
|
-
LA = "LA",
|
|
851
|
-
LB = "LB",
|
|
852
|
-
LC = "LC",
|
|
853
|
-
LI = "LI",
|
|
854
|
-
LK = "LK",
|
|
855
|
-
LR = "LR",
|
|
856
|
-
LS = "LS",
|
|
857
|
-
LT = "LT",
|
|
858
|
-
LU = "LU",
|
|
859
|
-
LV = "LV",
|
|
860
|
-
LY = "LY",
|
|
861
|
-
MA = "MA",
|
|
862
|
-
MC = "MC",
|
|
863
|
-
MD = "MD",
|
|
864
|
-
ME = "ME",
|
|
865
|
-
MF = "MF",
|
|
866
|
-
MG = "MG",
|
|
867
|
-
MH = "MH",
|
|
868
|
-
MK = "MK",
|
|
869
|
-
ML = "ML",
|
|
870
|
-
MM = "MM",
|
|
871
|
-
MN = "MN",
|
|
872
|
-
MO = "MO",
|
|
873
|
-
MP = "MP",
|
|
874
|
-
MQ = "MQ",
|
|
875
|
-
MR = "MR",
|
|
876
|
-
MS = "MS",
|
|
877
|
-
MT = "MT",
|
|
878
|
-
MU = "MU",
|
|
879
|
-
MV = "MV",
|
|
880
|
-
MW = "MW",
|
|
881
|
-
MX = "MX",
|
|
882
|
-
MY = "MY",
|
|
883
|
-
MZ = "MZ",
|
|
884
|
-
NA = "NA",
|
|
885
|
-
NC = "NC",
|
|
886
|
-
NE = "NE",
|
|
887
|
-
NF = "NF",
|
|
888
|
-
NG = "NG",
|
|
889
|
-
NI = "NI",
|
|
890
|
-
NL = "NL",
|
|
891
|
-
NO = "NO",
|
|
892
|
-
NP = "NP",
|
|
893
|
-
NR = "NR",
|
|
894
|
-
NU = "NU",
|
|
895
|
-
NZ = "NZ",
|
|
896
|
-
OM = "OM",
|
|
897
|
-
PA = "PA",
|
|
898
|
-
PE = "PE",
|
|
899
|
-
PF = "PF",
|
|
900
|
-
PG = "PG",
|
|
901
|
-
PH = "PH",
|
|
902
|
-
PK = "PK",
|
|
903
|
-
PL = "PL",
|
|
904
|
-
PM = "PM",
|
|
905
|
-
PN = "PN",
|
|
906
|
-
PR = "PR",
|
|
907
|
-
PS = "PS",
|
|
908
|
-
PT = "PT",
|
|
909
|
-
PW = "PW",
|
|
910
|
-
PY = "PY",
|
|
911
|
-
QA = "QA",
|
|
912
|
-
RE = "RE",
|
|
913
|
-
RO = "RO",
|
|
914
|
-
RS = "RS",
|
|
915
|
-
RU = "RU",
|
|
916
|
-
RW = "RW",
|
|
917
|
-
SA = "SA",
|
|
918
|
-
SB = "SB",
|
|
919
|
-
SC = "SC",
|
|
920
|
-
SD = "SD",
|
|
921
|
-
SE = "SE",
|
|
922
|
-
SG = "SG",
|
|
923
|
-
SH = "SH",
|
|
924
|
-
SI = "SI",
|
|
925
|
-
SJ = "SJ",
|
|
926
|
-
SK = "SK",
|
|
927
|
-
SL = "SL",
|
|
928
|
-
SM = "SM",
|
|
929
|
-
SN = "SN",
|
|
930
|
-
SO = "SO",
|
|
931
|
-
SR = "SR",
|
|
932
|
-
SS = "SS",
|
|
933
|
-
ST = "ST",
|
|
934
|
-
SV = "SV",
|
|
935
|
-
SX = "SX",
|
|
936
|
-
SY = "SY",
|
|
937
|
-
SZ = "SZ",
|
|
938
|
-
TC = "TC",
|
|
939
|
-
TD = "TD",
|
|
940
|
-
TF = "TF",
|
|
941
|
-
TG = "TG",
|
|
942
|
-
TH = "TH",
|
|
943
|
-
TJ = "TJ",
|
|
944
|
-
TK = "TK",
|
|
945
|
-
TL = "TL",
|
|
946
|
-
TM = "TM",
|
|
947
|
-
TN = "TN",
|
|
948
|
-
TO = "TO",
|
|
949
|
-
TR = "TR",
|
|
950
|
-
TT = "TT",
|
|
951
|
-
TV = "TV",
|
|
952
|
-
TW = "TW",
|
|
953
|
-
TZ = "TZ",
|
|
954
|
-
UA = "UA",
|
|
955
|
-
UG = "UG",
|
|
956
|
-
UM = "UM",
|
|
957
|
-
US = "US",
|
|
958
|
-
UY = "UY",
|
|
959
|
-
UZ = "UZ",
|
|
960
|
-
VA = "VA",
|
|
961
|
-
VC = "VC",
|
|
962
|
-
VE = "VE",
|
|
963
|
-
VG = "VG",
|
|
964
|
-
VI = "VI",
|
|
965
|
-
VN = "VN",
|
|
966
|
-
VU = "VU",
|
|
967
|
-
WF = "WF",
|
|
968
|
-
WS = "WS",
|
|
969
|
-
YE = "YE",
|
|
970
|
-
YT = "YT",
|
|
971
|
-
ZA = "ZA",
|
|
972
|
-
ZM = "ZM",
|
|
973
|
-
ZW = "ZW"
|
|
974
|
-
}
|
|
680
|
+
export type Country = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
|
|
975
681
|
export interface Coupon {
|
|
976
682
|
coupon: CouponObject;
|
|
977
683
|
}
|
|
@@ -1013,7 +719,7 @@ export interface CouponBaseInput {
|
|
|
1013
719
|
reusable?: boolean;
|
|
1014
720
|
/**
|
|
1015
721
|
* The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
|
|
1016
|
-
* @
|
|
722
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
1017
723
|
* @example null
|
|
1018
724
|
*/
|
|
1019
725
|
percentage_rate?: string | null;
|
|
@@ -1126,7 +832,7 @@ export interface CouponObject {
|
|
|
1126
832
|
billable_metric_codes?: string[];
|
|
1127
833
|
/**
|
|
1128
834
|
* The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.
|
|
1129
|
-
* @
|
|
835
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
1130
836
|
* @example null
|
|
1131
837
|
*/
|
|
1132
838
|
percentage_rate?: string | null;
|
|
@@ -1164,6 +870,12 @@ export interface CouponObject {
|
|
|
1164
870
|
* @example "2022-04-29T08:59:51Z"
|
|
1165
871
|
*/
|
|
1166
872
|
created_at: string;
|
|
873
|
+
/**
|
|
874
|
+
* This field indicates if the coupon has been terminated and is no longer usable. If it's not null, it won't be removed for existing customers using it, but it prevents the coupon from being applied in the future.
|
|
875
|
+
* @format date-time
|
|
876
|
+
* @example "2022-08-08T23:59:59Z"
|
|
877
|
+
*/
|
|
878
|
+
terminated_at?: string;
|
|
1167
879
|
}
|
|
1168
880
|
export interface CouponsPaginated {
|
|
1169
881
|
coupons: CouponObject[];
|
|
@@ -1198,7 +910,7 @@ export interface CreditObject {
|
|
|
1198
910
|
* @format uuid
|
|
1199
911
|
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1200
912
|
*/
|
|
1201
|
-
|
|
913
|
+
lago_item_id: string;
|
|
1202
914
|
/**
|
|
1203
915
|
* The type of credit applied. Possible values are `coupon` or `credit_note`.
|
|
1204
916
|
* @example "coupon"
|
|
@@ -1446,145 +1158,7 @@ export interface CreditNoteUpdateInput {
|
|
|
1446
1158
|
};
|
|
1447
1159
|
}
|
|
1448
1160
|
/** @example "USD" */
|
|
1449
|
-
export
|
|
1450
|
-
AED = "AED",
|
|
1451
|
-
AFN = "AFN",
|
|
1452
|
-
ALL = "ALL",
|
|
1453
|
-
AMD = "AMD",
|
|
1454
|
-
ANG = "ANG",
|
|
1455
|
-
AOA = "AOA",
|
|
1456
|
-
ARS = "ARS",
|
|
1457
|
-
AUD = "AUD",
|
|
1458
|
-
AWG = "AWG",
|
|
1459
|
-
AZN = "AZN",
|
|
1460
|
-
BAM = "BAM",
|
|
1461
|
-
BBD = "BBD",
|
|
1462
|
-
BDT = "BDT",
|
|
1463
|
-
BGN = "BGN",
|
|
1464
|
-
BIF = "BIF",
|
|
1465
|
-
BMD = "BMD",
|
|
1466
|
-
BND = "BND",
|
|
1467
|
-
BOB = "BOB",
|
|
1468
|
-
BRL = "BRL",
|
|
1469
|
-
BSD = "BSD",
|
|
1470
|
-
BWP = "BWP",
|
|
1471
|
-
BYN = "BYN",
|
|
1472
|
-
BZD = "BZD",
|
|
1473
|
-
CAD = "CAD",
|
|
1474
|
-
CDF = "CDF",
|
|
1475
|
-
CHF = "CHF",
|
|
1476
|
-
CLF = "CLF",
|
|
1477
|
-
CLP = "CLP",
|
|
1478
|
-
CNY = "CNY",
|
|
1479
|
-
COP = "COP",
|
|
1480
|
-
CRC = "CRC",
|
|
1481
|
-
CVE = "CVE",
|
|
1482
|
-
CZK = "CZK",
|
|
1483
|
-
DJF = "DJF",
|
|
1484
|
-
DKK = "DKK",
|
|
1485
|
-
DOP = "DOP",
|
|
1486
|
-
DZD = "DZD",
|
|
1487
|
-
EGP = "EGP",
|
|
1488
|
-
ETB = "ETB",
|
|
1489
|
-
EUR = "EUR",
|
|
1490
|
-
FJD = "FJD",
|
|
1491
|
-
FKP = "FKP",
|
|
1492
|
-
GBP = "GBP",
|
|
1493
|
-
GEL = "GEL",
|
|
1494
|
-
GIP = "GIP",
|
|
1495
|
-
GMD = "GMD",
|
|
1496
|
-
GNF = "GNF",
|
|
1497
|
-
GTQ = "GTQ",
|
|
1498
|
-
GYD = "GYD",
|
|
1499
|
-
HKD = "HKD",
|
|
1500
|
-
HNL = "HNL",
|
|
1501
|
-
HRK = "HRK",
|
|
1502
|
-
HTG = "HTG",
|
|
1503
|
-
HUF = "HUF",
|
|
1504
|
-
IDR = "IDR",
|
|
1505
|
-
ILS = "ILS",
|
|
1506
|
-
INR = "INR",
|
|
1507
|
-
ISK = "ISK",
|
|
1508
|
-
JMD = "JMD",
|
|
1509
|
-
JPY = "JPY",
|
|
1510
|
-
KES = "KES",
|
|
1511
|
-
KGS = "KGS",
|
|
1512
|
-
KHR = "KHR",
|
|
1513
|
-
KMF = "KMF",
|
|
1514
|
-
KRW = "KRW",
|
|
1515
|
-
KYD = "KYD",
|
|
1516
|
-
KZT = "KZT",
|
|
1517
|
-
LAK = "LAK",
|
|
1518
|
-
LBP = "LBP",
|
|
1519
|
-
LKR = "LKR",
|
|
1520
|
-
LRD = "LRD",
|
|
1521
|
-
LSL = "LSL",
|
|
1522
|
-
MAD = "MAD",
|
|
1523
|
-
MDL = "MDL",
|
|
1524
|
-
MGA = "MGA",
|
|
1525
|
-
MKD = "MKD",
|
|
1526
|
-
MMK = "MMK",
|
|
1527
|
-
MNT = "MNT",
|
|
1528
|
-
MOP = "MOP",
|
|
1529
|
-
MRO = "MRO",
|
|
1530
|
-
MUR = "MUR",
|
|
1531
|
-
MVR = "MVR",
|
|
1532
|
-
MWK = "MWK",
|
|
1533
|
-
MXN = "MXN",
|
|
1534
|
-
MYR = "MYR",
|
|
1535
|
-
MZN = "MZN",
|
|
1536
|
-
NAD = "NAD",
|
|
1537
|
-
NGN = "NGN",
|
|
1538
|
-
NIO = "NIO",
|
|
1539
|
-
NOK = "NOK",
|
|
1540
|
-
NPR = "NPR",
|
|
1541
|
-
NZD = "NZD",
|
|
1542
|
-
PAB = "PAB",
|
|
1543
|
-
PEN = "PEN",
|
|
1544
|
-
PGK = "PGK",
|
|
1545
|
-
PHP = "PHP",
|
|
1546
|
-
PKR = "PKR",
|
|
1547
|
-
PLN = "PLN",
|
|
1548
|
-
PYG = "PYG",
|
|
1549
|
-
QAR = "QAR",
|
|
1550
|
-
RON = "RON",
|
|
1551
|
-
RSD = "RSD",
|
|
1552
|
-
RUB = "RUB",
|
|
1553
|
-
RWF = "RWF",
|
|
1554
|
-
SAR = "SAR",
|
|
1555
|
-
SBD = "SBD",
|
|
1556
|
-
SCR = "SCR",
|
|
1557
|
-
SEK = "SEK",
|
|
1558
|
-
SGD = "SGD",
|
|
1559
|
-
SHP = "SHP",
|
|
1560
|
-
SLL = "SLL",
|
|
1561
|
-
SOS = "SOS",
|
|
1562
|
-
SRD = "SRD",
|
|
1563
|
-
STD = "STD",
|
|
1564
|
-
SZL = "SZL",
|
|
1565
|
-
THB = "THB",
|
|
1566
|
-
TJS = "TJS",
|
|
1567
|
-
TOP = "TOP",
|
|
1568
|
-
TRY = "TRY",
|
|
1569
|
-
TTD = "TTD",
|
|
1570
|
-
TWD = "TWD",
|
|
1571
|
-
TZS = "TZS",
|
|
1572
|
-
UAH = "UAH",
|
|
1573
|
-
UGX = "UGX",
|
|
1574
|
-
USD = "USD",
|
|
1575
|
-
UYU = "UYU",
|
|
1576
|
-
UZS = "UZS",
|
|
1577
|
-
VND = "VND",
|
|
1578
|
-
VUV = "VUV",
|
|
1579
|
-
WST = "WST",
|
|
1580
|
-
XAF = "XAF",
|
|
1581
|
-
XCD = "XCD",
|
|
1582
|
-
XOF = "XOF",
|
|
1583
|
-
XPF = "XPF",
|
|
1584
|
-
YER = "YER",
|
|
1585
|
-
ZAR = "ZAR",
|
|
1586
|
-
ZMW = "ZMW"
|
|
1587
|
-
}
|
|
1161
|
+
export type Currency = "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "ISK" | "JMD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "STD" | "SZL" | "THB" | "TJS" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW";
|
|
1588
1162
|
export interface Customer {
|
|
1589
1163
|
customer: CustomerObjectExtended;
|
|
1590
1164
|
}
|
|
@@ -1630,7 +1204,7 @@ export interface CustomerBillingConfiguration {
|
|
|
1630
1204
|
export interface CustomerChargeUsageObject {
|
|
1631
1205
|
/**
|
|
1632
1206
|
* The number of units consumed by the customer for a specific charge item.
|
|
1633
|
-
* @
|
|
1207
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
1634
1208
|
* @example "1.0"
|
|
1635
1209
|
*/
|
|
1636
1210
|
units: string;
|
|
@@ -1699,7 +1273,7 @@ export interface CustomerChargeUsageObject {
|
|
|
1699
1273
|
value?: string;
|
|
1700
1274
|
/**
|
|
1701
1275
|
* The number of units consumed for a specific group related to a charge item.
|
|
1702
|
-
* @
|
|
1276
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
1703
1277
|
* @example "0.9"
|
|
1704
1278
|
*/
|
|
1705
1279
|
units?: string;
|
|
@@ -2110,19 +1684,17 @@ export interface EventInput {
|
|
|
2110
1684
|
*/
|
|
2111
1685
|
code: string;
|
|
2112
1686
|
/**
|
|
2113
|
-
* This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).
|
|
2114
|
-
*
|
|
1687
|
+
* This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).
|
|
1688
|
+
* If this timestamp is not provided, the API will automatically set it to the time of event reception.
|
|
1689
|
+
* You can also provide miliseconds precision by appending decimals to the timestamp.
|
|
1690
|
+
* @example "1651240791.123"
|
|
2115
1691
|
*/
|
|
2116
|
-
timestamp?: number;
|
|
1692
|
+
timestamp?: number | string;
|
|
2117
1693
|
/**
|
|
2118
1694
|
* This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.
|
|
2119
1695
|
* @example {"gb":10}
|
|
2120
1696
|
*/
|
|
2121
|
-
properties?:
|
|
2122
|
-
/** The `operation_type` field is only necessary when adding or removing a specific unit when the targeted billable metric adopts a `unique_count_agg` aggregation method. In other cases, the `operation_type` field is not required. The valid values for the `operation_type` field are `add` or `remove`, which indicate whether the unit is being added or removed from the unique count aggregation, respectively. */
|
|
2123
|
-
operation_type?: "add" | "remove";
|
|
2124
|
-
[key: string]: any;
|
|
2125
|
-
};
|
|
1697
|
+
properties?: Record<string, string>;
|
|
2126
1698
|
};
|
|
2127
1699
|
}
|
|
2128
1700
|
export interface EventObject {
|
|
@@ -2156,7 +1728,7 @@ export interface EventObject {
|
|
|
2156
1728
|
/**
|
|
2157
1729
|
* This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.
|
|
2158
1730
|
* @format date-time
|
|
2159
|
-
* @example "2022-04-29T08:59:
|
|
1731
|
+
* @example "2022-04-29T08:59:51.123Z"
|
|
2160
1732
|
*/
|
|
2161
1733
|
timestamp: string;
|
|
2162
1734
|
/**
|
|
@@ -2603,7 +2175,7 @@ export interface InvoiceOneOffCreateInput {
|
|
|
2603
2175
|
unit_amount_cents?: number | null;
|
|
2604
2176
|
/**
|
|
2605
2177
|
* The quantity of units associated with the fee. By default, only 1 unit is added to the invoice.
|
|
2606
|
-
* @
|
|
2178
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
2607
2179
|
* @example "2.5"
|
|
2608
2180
|
*/
|
|
2609
2181
|
units?: string | null;
|
|
@@ -3192,6 +2764,12 @@ export interface SubscriptionCreateInput {
|
|
|
3192
2764
|
* @example "anniversary"
|
|
3193
2765
|
*/
|
|
3194
2766
|
billing_time?: "calendar" | "anniversary";
|
|
2767
|
+
/**
|
|
2768
|
+
* The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).
|
|
2769
|
+
* @format date-time
|
|
2770
|
+
* @example "2022-10-08T00:00:00Z"
|
|
2771
|
+
*/
|
|
2772
|
+
ending_at?: string;
|
|
3195
2773
|
/**
|
|
3196
2774
|
* The start date for the subscription, allowing for the creation of subscriptions that can begin in the past or future. Please note that it cannot be used to update the start date of a pending subscription or schedule an upgrade/downgrade. The start_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
3197
2775
|
* @format date-time
|
|
@@ -3207,6 +2785,12 @@ export interface SubscriptionUpdateInput {
|
|
|
3207
2785
|
* @example "Repository B"
|
|
3208
2786
|
*/
|
|
3209
2787
|
name?: string | null;
|
|
2788
|
+
/**
|
|
2789
|
+
* The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).
|
|
2790
|
+
* @format date-time
|
|
2791
|
+
* @example "2022-10-08T00:00:00Z"
|
|
2792
|
+
*/
|
|
2793
|
+
ending_at?: string;
|
|
3210
2794
|
/**
|
|
3211
2795
|
* The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
3212
2796
|
* @format date-time
|
|
@@ -3280,6 +2864,12 @@ export interface SubscriptionObject {
|
|
|
3280
2864
|
* @example "2022-08-08T00:00:00Z"
|
|
3281
2865
|
*/
|
|
3282
2866
|
started_at?: string | null;
|
|
2867
|
+
/**
|
|
2868
|
+
* The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).
|
|
2869
|
+
* @format date-time
|
|
2870
|
+
* @example "2022-10-08T00:00:00Z"
|
|
2871
|
+
*/
|
|
2872
|
+
ending_at?: string;
|
|
3283
2873
|
/**
|
|
3284
2874
|
* The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
3285
2875
|
* @format date-time
|
|
@@ -3329,7 +2919,7 @@ export interface TaxBaseInput {
|
|
|
3329
2919
|
code?: string;
|
|
3330
2920
|
/**
|
|
3331
2921
|
* The percentage rate of the tax
|
|
3332
|
-
* @
|
|
2922
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3333
2923
|
* @example "20.0"
|
|
3334
2924
|
*/
|
|
3335
2925
|
rate?: string;
|
|
@@ -3414,143 +3004,7 @@ export interface TaxUpdateInput {
|
|
|
3414
3004
|
tax: TaxBaseInput;
|
|
3415
3005
|
}
|
|
3416
3006
|
/** @example "America/Los_Angeles" */
|
|
3417
|
-
export
|
|
3418
|
-
UTC = "UTC",
|
|
3419
|
-
AfricaAlgiers = "Africa/Algiers",
|
|
3420
|
-
AfricaCairo = "Africa/Cairo",
|
|
3421
|
-
AfricaCasablanca = "Africa/Casablanca",
|
|
3422
|
-
AfricaHarare = "Africa/Harare",
|
|
3423
|
-
AfricaJohannesburg = "Africa/Johannesburg",
|
|
3424
|
-
AfricaMonrovia = "Africa/Monrovia",
|
|
3425
|
-
AfricaNairobi = "Africa/Nairobi",
|
|
3426
|
-
AmericaArgentinaBuenosAires = "America/Argentina/Buenos_Aires",
|
|
3427
|
-
AmericaBogota = "America/Bogota",
|
|
3428
|
-
AmericaCaracas = "America/Caracas",
|
|
3429
|
-
AmericaChicago = "America/Chicago",
|
|
3430
|
-
AmericaChihuahua = "America/Chihuahua",
|
|
3431
|
-
AmericaDenver = "America/Denver",
|
|
3432
|
-
AmericaGodthab = "America/Godthab",
|
|
3433
|
-
AmericaGuatemala = "America/Guatemala",
|
|
3434
|
-
AmericaGuyana = "America/Guyana",
|
|
3435
|
-
AmericaHalifax = "America/Halifax",
|
|
3436
|
-
AmericaIndianaIndianapolis = "America/Indiana/Indianapolis",
|
|
3437
|
-
AmericaJuneau = "America/Juneau",
|
|
3438
|
-
AmericaLaPaz = "America/La_Paz",
|
|
3439
|
-
AmericaLima = "America/Lima",
|
|
3440
|
-
AmericaLosAngeles = "America/Los_Angeles",
|
|
3441
|
-
AmericaMazatlan = "America/Mazatlan",
|
|
3442
|
-
AmericaMexicoCity = "America/Mexico_City",
|
|
3443
|
-
AmericaMonterrey = "America/Monterrey",
|
|
3444
|
-
AmericaMontevideo = "America/Montevideo",
|
|
3445
|
-
AmericaNewYork = "America/New_York",
|
|
3446
|
-
AmericaPhoenix = "America/Phoenix",
|
|
3447
|
-
AmericaPuertoRico = "America/Puerto_Rico",
|
|
3448
|
-
AmericaRegina = "America/Regina",
|
|
3449
|
-
AmericaSantiago = "America/Santiago",
|
|
3450
|
-
AmericaSaoPaulo = "America/Sao_Paulo",
|
|
3451
|
-
AmericaStJohns = "America/St_Johns",
|
|
3452
|
-
AmericaTijuana = "America/Tijuana",
|
|
3453
|
-
AsiaAlmaty = "Asia/Almaty",
|
|
3454
|
-
AsiaBaghdad = "Asia/Baghdad",
|
|
3455
|
-
AsiaBaku = "Asia/Baku",
|
|
3456
|
-
AsiaBangkok = "Asia/Bangkok",
|
|
3457
|
-
AsiaChongqing = "Asia/Chongqing",
|
|
3458
|
-
AsiaColombo = "Asia/Colombo",
|
|
3459
|
-
AsiaDhaka = "Asia/Dhaka",
|
|
3460
|
-
AsiaHongKong = "Asia/Hong_Kong",
|
|
3461
|
-
AsiaIrkutsk = "Asia/Irkutsk",
|
|
3462
|
-
AsiaJakarta = "Asia/Jakarta",
|
|
3463
|
-
AsiaJerusalem = "Asia/Jerusalem",
|
|
3464
|
-
AsiaKabul = "Asia/Kabul",
|
|
3465
|
-
AsiaKamchatka = "Asia/Kamchatka",
|
|
3466
|
-
AsiaKarachi = "Asia/Karachi",
|
|
3467
|
-
AsiaKathmandu = "Asia/Kathmandu",
|
|
3468
|
-
AsiaKolkata = "Asia/Kolkata",
|
|
3469
|
-
AsiaKrasnoyarsk = "Asia/Krasnoyarsk",
|
|
3470
|
-
AsiaKualaLumpur = "Asia/Kuala_Lumpur",
|
|
3471
|
-
AsiaKuwait = "Asia/Kuwait",
|
|
3472
|
-
AsiaMagadan = "Asia/Magadan",
|
|
3473
|
-
AsiaMuscat = "Asia/Muscat",
|
|
3474
|
-
AsiaNovosibirsk = "Asia/Novosibirsk",
|
|
3475
|
-
AsiaRangoon = "Asia/Rangoon",
|
|
3476
|
-
AsiaRiyadh = "Asia/Riyadh",
|
|
3477
|
-
AsiaSeoul = "Asia/Seoul",
|
|
3478
|
-
AsiaShanghai = "Asia/Shanghai",
|
|
3479
|
-
AsiaSingapore = "Asia/Singapore",
|
|
3480
|
-
AsiaSrednekolymsk = "Asia/Srednekolymsk",
|
|
3481
|
-
AsiaTaipei = "Asia/Taipei",
|
|
3482
|
-
AsiaTashkent = "Asia/Tashkent",
|
|
3483
|
-
AsiaTbilisi = "Asia/Tbilisi",
|
|
3484
|
-
AsiaTehran = "Asia/Tehran",
|
|
3485
|
-
AsiaTokyo = "Asia/Tokyo",
|
|
3486
|
-
AsiaUlaanbaatar = "Asia/Ulaanbaatar",
|
|
3487
|
-
AsiaUrumqi = "Asia/Urumqi",
|
|
3488
|
-
AsiaVladivostok = "Asia/Vladivostok",
|
|
3489
|
-
AsiaYakutsk = "Asia/Yakutsk",
|
|
3490
|
-
AsiaYekaterinburg = "Asia/Yekaterinburg",
|
|
3491
|
-
AsiaYerevan = "Asia/Yerevan",
|
|
3492
|
-
AtlanticAzores = "Atlantic/Azores",
|
|
3493
|
-
AtlanticCapeVerde = "Atlantic/Cape_Verde",
|
|
3494
|
-
AtlanticSouthGeorgia = "Atlantic/South_Georgia",
|
|
3495
|
-
AustraliaAdelaide = "Australia/Adelaide",
|
|
3496
|
-
AustraliaBrisbane = "Australia/Brisbane",
|
|
3497
|
-
AustraliaDarwin = "Australia/Darwin",
|
|
3498
|
-
AustraliaHobart = "Australia/Hobart",
|
|
3499
|
-
AustraliaMelbourne = "Australia/Melbourne",
|
|
3500
|
-
AustraliaPerth = "Australia/Perth",
|
|
3501
|
-
AustraliaSydney = "Australia/Sydney",
|
|
3502
|
-
EuropeAmsterdam = "Europe/Amsterdam",
|
|
3503
|
-
EuropeAthens = "Europe/Athens",
|
|
3504
|
-
EuropeBelgrade = "Europe/Belgrade",
|
|
3505
|
-
EuropeBerlin = "Europe/Berlin",
|
|
3506
|
-
EuropeBratislava = "Europe/Bratislava",
|
|
3507
|
-
EuropeBrussels = "Europe/Brussels",
|
|
3508
|
-
EuropeBucharest = "Europe/Bucharest",
|
|
3509
|
-
EuropeBudapest = "Europe/Budapest",
|
|
3510
|
-
EuropeCopenhagen = "Europe/Copenhagen",
|
|
3511
|
-
EuropeDublin = "Europe/Dublin",
|
|
3512
|
-
EuropeHelsinki = "Europe/Helsinki",
|
|
3513
|
-
EuropeIstanbul = "Europe/Istanbul",
|
|
3514
|
-
EuropeKaliningrad = "Europe/Kaliningrad",
|
|
3515
|
-
EuropeKiev = "Europe/Kiev",
|
|
3516
|
-
EuropeLisbon = "Europe/Lisbon",
|
|
3517
|
-
EuropeLjubljana = "Europe/Ljubljana",
|
|
3518
|
-
EuropeLondon = "Europe/London",
|
|
3519
|
-
EuropeMadrid = "Europe/Madrid",
|
|
3520
|
-
EuropeMinsk = "Europe/Minsk",
|
|
3521
|
-
EuropeMoscow = "Europe/Moscow",
|
|
3522
|
-
EuropeParis = "Europe/Paris",
|
|
3523
|
-
EuropePrague = "Europe/Prague",
|
|
3524
|
-
EuropeRiga = "Europe/Riga",
|
|
3525
|
-
EuropeRome = "Europe/Rome",
|
|
3526
|
-
EuropeSamara = "Europe/Samara",
|
|
3527
|
-
EuropeSarajevo = "Europe/Sarajevo",
|
|
3528
|
-
EuropeSkopje = "Europe/Skopje",
|
|
3529
|
-
EuropeSofia = "Europe/Sofia",
|
|
3530
|
-
EuropeStockholm = "Europe/Stockholm",
|
|
3531
|
-
EuropeTallinn = "Europe/Tallinn",
|
|
3532
|
-
EuropeVienna = "Europe/Vienna",
|
|
3533
|
-
EuropeVilnius = "Europe/Vilnius",
|
|
3534
|
-
EuropeVolgograd = "Europe/Volgograd",
|
|
3535
|
-
EuropeWarsaw = "Europe/Warsaw",
|
|
3536
|
-
EuropeZagreb = "Europe/Zagreb",
|
|
3537
|
-
EuropeZurich = "Europe/Zurich",
|
|
3538
|
-
GMT12 = "GMT+12",
|
|
3539
|
-
PacificApia = "Pacific/Apia",
|
|
3540
|
-
PacificAuckland = "Pacific/Auckland",
|
|
3541
|
-
PacificChatham = "Pacific/Chatham",
|
|
3542
|
-
PacificFakaofo = "Pacific/Fakaofo",
|
|
3543
|
-
PacificFiji = "Pacific/Fiji",
|
|
3544
|
-
PacificGuadalcanal = "Pacific/Guadalcanal",
|
|
3545
|
-
PacificGuam = "Pacific/Guam",
|
|
3546
|
-
PacificHonolulu = "Pacific/Honolulu",
|
|
3547
|
-
PacificMajuro = "Pacific/Majuro",
|
|
3548
|
-
PacificMidway = "Pacific/Midway",
|
|
3549
|
-
PacificNoumea = "Pacific/Noumea",
|
|
3550
|
-
PacificPagoPago = "Pacific/Pago_Pago",
|
|
3551
|
-
PacificPortMoresby = "Pacific/Port_Moresby",
|
|
3552
|
-
PacificTongatapu = "Pacific/Tongatapu"
|
|
3553
|
-
}
|
|
3007
|
+
export type Timezone = "UTC" | "Africa/Algiers" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Monrovia" | "Africa/Nairobi" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/Chihuahua" | "America/Denver" | "America/Godthab" | "America/Guatemala" | "America/Guyana" | "America/Halifax" | "America/Indiana/Indianapolis" | "America/Juneau" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Mazatlan" | "America/Mexico_City" | "America/Monterrey" | "America/Montevideo" | "America/New_York" | "America/Phoenix" | "America/Puerto_Rico" | "America/Regina" | "America/Santiago" | "America/Sao_Paulo" | "America/St_Johns" | "America/Tijuana" | "Asia/Almaty" | "Asia/Baghdad" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Magadan" | "Asia/Muscat" | "Asia/Novosibirsk" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Atlantic/South_Georgia" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Darwin" | "Australia/Hobart" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Madrid" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "GMT+12" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Majuro" | "Pacific/Midway" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Port_Moresby" | "Pacific/Tongatapu";
|
|
3554
3008
|
export interface Wallet {
|
|
3555
3009
|
wallet: WalletObject;
|
|
3556
3010
|
}
|
|
@@ -3563,7 +3017,7 @@ export interface WalletCreateInput {
|
|
|
3563
3017
|
name?: string;
|
|
3564
3018
|
/**
|
|
3565
3019
|
* The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.
|
|
3566
|
-
* @
|
|
3020
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3567
3021
|
* @example "1.5"
|
|
3568
3022
|
*/
|
|
3569
3023
|
rate_amount: string;
|
|
@@ -3571,13 +3025,13 @@ export interface WalletCreateInput {
|
|
|
3571
3025
|
currency: Currency;
|
|
3572
3026
|
/**
|
|
3573
3027
|
* The number of paid credits. Required only if there is no granted credits.
|
|
3574
|
-
* @
|
|
3028
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3575
3029
|
* @example "20.0"
|
|
3576
3030
|
*/
|
|
3577
3031
|
paid_credits?: string | null;
|
|
3578
3032
|
/**
|
|
3579
3033
|
* The number of free granted credits. Required only if there is no paid credits.
|
|
3580
|
-
* @
|
|
3034
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3581
3035
|
* @example "10.0"
|
|
3582
3036
|
*/
|
|
3583
3037
|
granted_credits?: string | null;
|
|
@@ -3626,13 +3080,13 @@ export interface WalletObject {
|
|
|
3626
3080
|
name?: string;
|
|
3627
3081
|
/**
|
|
3628
3082
|
* The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.
|
|
3629
|
-
* @
|
|
3083
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3630
3084
|
* @example "1.5"
|
|
3631
3085
|
*/
|
|
3632
3086
|
rate_amount: string;
|
|
3633
3087
|
/**
|
|
3634
3088
|
* The current wallet balance expressed in credits.
|
|
3635
|
-
* @
|
|
3089
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3636
3090
|
* @example "28.0"
|
|
3637
3091
|
*/
|
|
3638
3092
|
credits_balance: string;
|
|
@@ -3643,7 +3097,7 @@ export interface WalletObject {
|
|
|
3643
3097
|
balance_cents: number;
|
|
3644
3098
|
/**
|
|
3645
3099
|
* The number of consumed credits.
|
|
3646
|
-
* @
|
|
3100
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3647
3101
|
* @example "2.0"
|
|
3648
3102
|
*/
|
|
3649
3103
|
consumed_credits: string;
|
|
@@ -3692,13 +3146,13 @@ export interface WalletTransactionCreateInput {
|
|
|
3692
3146
|
wallet_id: string;
|
|
3693
3147
|
/**
|
|
3694
3148
|
* The number of paid credits. Required only if there is no granted credits.
|
|
3695
|
-
* @
|
|
3149
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3696
3150
|
* @example "20.0"
|
|
3697
3151
|
*/
|
|
3698
3152
|
paid_credits?: string;
|
|
3699
3153
|
/**
|
|
3700
3154
|
* The number of free granted credits. Required only if there is no paid credits.
|
|
3701
|
-
* @
|
|
3155
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3702
3156
|
* @example "10.0"
|
|
3703
3157
|
*/
|
|
3704
3158
|
granted_credits?: string;
|
|
@@ -3729,13 +3183,13 @@ export interface WalletTransactionObject {
|
|
|
3729
3183
|
transaction_type: "inbound" | "outbound";
|
|
3730
3184
|
/**
|
|
3731
3185
|
* The amount of credits based on the rate and the currency.
|
|
3732
|
-
* @
|
|
3186
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3733
3187
|
* @example "10.0"
|
|
3734
3188
|
*/
|
|
3735
3189
|
amount: string;
|
|
3736
3190
|
/**
|
|
3737
3191
|
* The number of credits used in the wallet transaction.
|
|
3738
|
-
* @
|
|
3192
|
+
* @pattern ^[0-9]+.?[0-9]*$
|
|
3739
3193
|
* @example "100.0"
|
|
3740
3194
|
*/
|
|
3741
3195
|
credit_amount: string;
|
|
@@ -3773,6 +3227,71 @@ export interface WalletUpdateInput {
|
|
|
3773
3227
|
expiration_at?: string | null;
|
|
3774
3228
|
};
|
|
3775
3229
|
}
|
|
3230
|
+
export interface WebhookEndpoint {
|
|
3231
|
+
webhook_endpoint: WebhookEndpointObject;
|
|
3232
|
+
}
|
|
3233
|
+
export interface WebhookEndpointCreateInput {
|
|
3234
|
+
webhook_endpoint?: {
|
|
3235
|
+
/**
|
|
3236
|
+
* The URL of the webhook endpoint.
|
|
3237
|
+
* @example "https://foo.bar"
|
|
3238
|
+
*/
|
|
3239
|
+
webhook_url: string;
|
|
3240
|
+
/**
|
|
3241
|
+
* The signature used for the webhook. If no value is passed,
|
|
3242
|
+
* @example "hmac"
|
|
3243
|
+
*/
|
|
3244
|
+
signature_algo?: "jwt" | "hmac" | null;
|
|
3245
|
+
};
|
|
3246
|
+
}
|
|
3247
|
+
export interface WebhookEndpointObject {
|
|
3248
|
+
/**
|
|
3249
|
+
* Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
|
|
3250
|
+
* @format uuid
|
|
3251
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
3252
|
+
*/
|
|
3253
|
+
lago_id: string;
|
|
3254
|
+
/**
|
|
3255
|
+
* Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization’s record within the Lago system.
|
|
3256
|
+
* @format uuid
|
|
3257
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
3258
|
+
*/
|
|
3259
|
+
lago_organization_id: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* The name of the wallet.
|
|
3262
|
+
* @example "Prepaid"
|
|
3263
|
+
*/
|
|
3264
|
+
webhook_url: string;
|
|
3265
|
+
/**
|
|
3266
|
+
* The signature algo for the webhook.
|
|
3267
|
+
* @example "hmac"
|
|
3268
|
+
*/
|
|
3269
|
+
signature_algo?: "jwt" | "hmac";
|
|
3270
|
+
/**
|
|
3271
|
+
* The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
3272
|
+
* @format date-time
|
|
3273
|
+
* @example "2022-04-29T08:59:51Z"
|
|
3274
|
+
*/
|
|
3275
|
+
created_at: string;
|
|
3276
|
+
}
|
|
3277
|
+
export interface WebhookEndpointsPaginated {
|
|
3278
|
+
webhook_endpoints: WebhookEndpointObject[];
|
|
3279
|
+
meta: PaginationMeta;
|
|
3280
|
+
}
|
|
3281
|
+
export interface WebhookEndpointUpdateInput {
|
|
3282
|
+
webhook_endpoint?: {
|
|
3283
|
+
/**
|
|
3284
|
+
* The URL of the webhook endpoint.
|
|
3285
|
+
* @example "https://foo.bar"
|
|
3286
|
+
*/
|
|
3287
|
+
webhook_url: string;
|
|
3288
|
+
/**
|
|
3289
|
+
* The signature used for the webhook. If no value is passed,
|
|
3290
|
+
* @example "hmac"
|
|
3291
|
+
*/
|
|
3292
|
+
signature_algo?: "jwt" | "hmac" | null;
|
|
3293
|
+
};
|
|
3294
|
+
}
|
|
3776
3295
|
export type QueryParamsType = Record<string | number, any>;
|
|
3777
3296
|
export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
|
|
3778
3297
|
export interface FullRequestParams extends Omit<RequestInit, "body"> {
|
|
@@ -3833,7 +3352,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
3833
3352
|
}
|
|
3834
3353
|
/**
|
|
3835
3354
|
* @title Lago API documentation
|
|
3836
|
-
* @version 0.
|
|
3355
|
+
* @version 0.48.0-beta
|
|
3837
3356
|
* @license AGPLv3
|
|
3838
3357
|
* @baseUrl https://api.getlago.com/api/v1
|
|
3839
3358
|
* @externalDocs https://github.com/getlago
|
|
@@ -3905,19 +3424,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3905
3424
|
*/
|
|
3906
3425
|
destroyAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiErrorUnauthorized | ApiErrorNotFound>>;
|
|
3907
3426
|
};
|
|
3908
|
-
appliedAddOns: {
|
|
3909
|
-
/**
|
|
3910
|
-
* @description Apply an add-on to a customer
|
|
3911
|
-
*
|
|
3912
|
-
* @tags add_ons
|
|
3913
|
-
* @name ApplyAddOn
|
|
3914
|
-
* @summary Apply an add-on to a customer
|
|
3915
|
-
* @request POST:/applied_add_ons
|
|
3916
|
-
* @deprecated
|
|
3917
|
-
* @secure
|
|
3918
|
-
*/
|
|
3919
|
-
applyAddOn: (data: AppliedAddOnInput, params?: RequestParams) => Promise<HttpResponse<AppliedAddOn, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
|
|
3920
|
-
};
|
|
3921
3427
|
appliedCoupons: {
|
|
3922
3428
|
/**
|
|
3923
3429
|
* @description This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
|
|
@@ -4902,51 +4408,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4902
4408
|
* @request POST:/webhook_endpoints
|
|
4903
4409
|
* @secure
|
|
4904
4410
|
*/
|
|
4905
|
-
createWebhookEndpoint: (data:
|
|
4906
|
-
webhook_endpoint?: {
|
|
4907
|
-
/**
|
|
4908
|
-
* The URL of the webhook endpoint.
|
|
4909
|
-
* @example "https://foo.bar"
|
|
4910
|
-
*/
|
|
4911
|
-
webhook_url: string;
|
|
4912
|
-
/**
|
|
4913
|
-
* The signature used for the webhook. If no value is passed,
|
|
4914
|
-
* @example "hmac"
|
|
4915
|
-
*/
|
|
4916
|
-
signature_algo?: "jwt" | "hmac" | null;
|
|
4917
|
-
};
|
|
4918
|
-
}, params?: RequestParams) => Promise<HttpResponse<{
|
|
4919
|
-
webhook_endpoint: {
|
|
4920
|
-
/**
|
|
4921
|
-
* Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
|
|
4922
|
-
* @format uuid
|
|
4923
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
4924
|
-
*/
|
|
4925
|
-
lago_id: string;
|
|
4926
|
-
/**
|
|
4927
|
-
* Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization’s record within the Lago system.
|
|
4928
|
-
* @format uuid
|
|
4929
|
-
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
4930
|
-
*/
|
|
4931
|
-
lago_organization_id: string;
|
|
4932
|
-
/**
|
|
4933
|
-
* The name of the wallet.
|
|
4934
|
-
* @example "Prepaid"
|
|
4935
|
-
*/
|
|
4936
|
-
webhook_url: string;
|
|
4937
|
-
/**
|
|
4938
|
-
* The signature algo for the webhook.
|
|
4939
|
-
* @example "hmac"
|
|
4940
|
-
*/
|
|
4941
|
-
signature_algo?: "jwt" | "hmac";
|
|
4942
|
-
/**
|
|
4943
|
-
* The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
4944
|
-
* @format date-time
|
|
4945
|
-
* @example "2022-04-29T08:59:51Z"
|
|
4946
|
-
*/
|
|
4947
|
-
created_at: string;
|
|
4948
|
-
};
|
|
4949
|
-
}, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
|
|
4411
|
+
createWebhookEndpoint: (data: WebhookEndpointCreateInput, params?: RequestParams) => Promise<HttpResponse<WebhookEndpoint, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
|
|
4950
4412
|
/**
|
|
4951
4413
|
* @description This endpoint is used to list all webhook endpoints.
|
|
4952
4414
|
*
|
|
@@ -4967,10 +4429,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4967
4429
|
* @example 20
|
|
4968
4430
|
*/
|
|
4969
4431
|
per_page?: number;
|
|
4970
|
-
}, params?: RequestParams) => Promise<HttpResponse<
|
|
4971
|
-
webhook_endpoints: any[];
|
|
4972
|
-
meta: PaginationMeta;
|
|
4973
|
-
}, ApiErrorUnauthorized>>;
|
|
4432
|
+
}, params?: RequestParams) => Promise<HttpResponse<WebhookEndpointsPaginated, ApiErrorUnauthorized>>;
|
|
4974
4433
|
/**
|
|
4975
4434
|
* @description This endpoint is used to update an existing webhook endpoint.
|
|
4976
4435
|
*
|
|
@@ -4980,20 +4439,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4980
4439
|
* @request PUT:/webhook_endpoints/{lago_id}
|
|
4981
4440
|
* @secure
|
|
4982
4441
|
*/
|
|
4983
|
-
updateWebhookEndpoint: (lagoId: string, data:
|
|
4984
|
-
webhook_endpoint?: {
|
|
4985
|
-
/**
|
|
4986
|
-
* The URL of the webhook endpoint.
|
|
4987
|
-
* @example "https://foo.bar"
|
|
4988
|
-
*/
|
|
4989
|
-
webhook_url: string;
|
|
4990
|
-
/**
|
|
4991
|
-
* The signature used for the webhook. If no value is passed,
|
|
4992
|
-
* @example "hmac"
|
|
4993
|
-
*/
|
|
4994
|
-
signature_algo?: "jwt" | "hmac" | null;
|
|
4995
|
-
};
|
|
4996
|
-
}, params?: RequestParams) => Promise<HttpResponse<any, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
|
|
4442
|
+
updateWebhookEndpoint: (lagoId: string, data: WebhookEndpointUpdateInput, params?: RequestParams) => Promise<HttpResponse<WebhookEndpoint, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
|
|
4997
4443
|
/**
|
|
4998
4444
|
* @description This endpoint is used to retrieve an existing webhook endpoint.
|
|
4999
4445
|
*
|
|
@@ -5003,7 +4449,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5003
4449
|
* @request GET:/webhook_endpoints/{lago_id}
|
|
5004
4450
|
* @secure
|
|
5005
4451
|
*/
|
|
5006
|
-
findWebhookEndpoint: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<
|
|
4452
|
+
findWebhookEndpoint: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WebhookEndpoint, ApiErrorUnauthorized | ApiErrorNotFound>>;
|
|
5007
4453
|
/**
|
|
5008
4454
|
* @description This endpoint is used to delete an existing webhook endpoint.
|
|
5009
4455
|
*
|
|
@@ -5013,7 +4459,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5013
4459
|
* @request DELETE:/webhook_endpoints/{lago_id}
|
|
5014
4460
|
* @secure
|
|
5015
4461
|
*/
|
|
5016
|
-
destroyWebhookEndpoint: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<
|
|
4462
|
+
destroyWebhookEndpoint: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<WebhookEndpoint, ApiErrorUnauthorized | ApiErrorNotAllowed | ApiErrorNotFound>>;
|
|
5017
4463
|
};
|
|
5018
4464
|
}
|
|
5019
4465
|
export {};
|