lago-javascript-client 0.27.0-beta → 0.27.1-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/esm/swagger/client.js +206 -155
- package/package.json +1 -1
- package/script/swagger/client.js +206 -155
- package/types/swagger/client.d.ts +456 -254
|
@@ -6,7 +6,7 @@ export interface BillableMetricGroup {
|
|
|
6
6
|
export interface BillableMetricObject {
|
|
7
7
|
/**
|
|
8
8
|
* @format uuid
|
|
9
|
-
* @example "
|
|
9
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
10
10
|
*/
|
|
11
11
|
lago_id: string;
|
|
12
12
|
/** @example "bm1" */
|
|
@@ -56,7 +56,7 @@ export interface BillableMetricInput {
|
|
|
56
56
|
export interface GroupObject {
|
|
57
57
|
/**
|
|
58
58
|
* @format uuid
|
|
59
|
-
* @example "
|
|
59
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
60
60
|
*/
|
|
61
61
|
lago_id: string;
|
|
62
62
|
/** @example "region" */
|
|
@@ -70,7 +70,7 @@ export interface Groups {
|
|
|
70
70
|
export interface AddOnObject {
|
|
71
71
|
/**
|
|
72
72
|
* @format uuid
|
|
73
|
-
* @example "
|
|
73
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
74
74
|
*/
|
|
75
75
|
lago_id: string;
|
|
76
76
|
/** @example "example name" */
|
|
@@ -112,19 +112,19 @@ export interface AddOnInput {
|
|
|
112
112
|
export interface AppliedAddOnObject {
|
|
113
113
|
/**
|
|
114
114
|
* @format uuid
|
|
115
|
-
* @example "
|
|
115
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
116
116
|
*/
|
|
117
117
|
lago_id: string;
|
|
118
118
|
/**
|
|
119
119
|
* @format uuid
|
|
120
|
-
* @example "
|
|
120
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
121
121
|
*/
|
|
122
122
|
lago_add_on_id: string;
|
|
123
123
|
/** @example "code" */
|
|
124
124
|
add_on_code: string;
|
|
125
125
|
/**
|
|
126
126
|
* @format uuid
|
|
127
|
-
* @example "
|
|
127
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
128
128
|
*/
|
|
129
129
|
lago_customer_id: string;
|
|
130
130
|
/** @example "1234567" */
|
|
@@ -157,7 +157,7 @@ export interface AppliedAddOnInput {
|
|
|
157
157
|
export interface CouponObject {
|
|
158
158
|
/**
|
|
159
159
|
* @format uuid
|
|
160
|
-
* @example "
|
|
160
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
161
161
|
*/
|
|
162
162
|
lago_id: string;
|
|
163
163
|
/** @example "coupon1" */
|
|
@@ -235,19 +235,19 @@ export interface CouponInput {
|
|
|
235
235
|
export interface AppliedCouponObject {
|
|
236
236
|
/**
|
|
237
237
|
* @format uuid
|
|
238
|
-
* @example "
|
|
238
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
239
239
|
*/
|
|
240
240
|
lago_id: string;
|
|
241
241
|
/**
|
|
242
242
|
* @format uuid
|
|
243
|
-
* @example "
|
|
243
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
244
244
|
*/
|
|
245
245
|
lago_coupon_id: string;
|
|
246
246
|
/** @example "example_code" */
|
|
247
247
|
coupon_code: string;
|
|
248
248
|
/**
|
|
249
249
|
* @format uuid
|
|
250
|
-
* @example "
|
|
250
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
251
251
|
*/
|
|
252
252
|
lago_customer_id: string;
|
|
253
253
|
/** @example "123456" */
|
|
@@ -322,7 +322,7 @@ export interface BillingConfigurationOrganization {
|
|
|
322
322
|
export interface OrganizationObject {
|
|
323
323
|
/**
|
|
324
324
|
* @format uuid
|
|
325
|
-
* @example "
|
|
325
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
326
326
|
*/
|
|
327
327
|
lago_id?: string;
|
|
328
328
|
/** @example "example name" */
|
|
@@ -411,7 +411,7 @@ export interface BillingConfigurationCustomer {
|
|
|
411
411
|
export interface CustomerMetadataObject {
|
|
412
412
|
/**
|
|
413
413
|
* @format uuid
|
|
414
|
-
* @example "
|
|
414
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
415
415
|
*/
|
|
416
416
|
lago_id?: string;
|
|
417
417
|
/** @example "name" */
|
|
@@ -429,7 +429,7 @@ export interface CustomerMetadataObject {
|
|
|
429
429
|
export interface CustomerObject {
|
|
430
430
|
/**
|
|
431
431
|
* @format uuid
|
|
432
|
-
* @example "
|
|
432
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
433
433
|
*/
|
|
434
434
|
lago_id: string;
|
|
435
435
|
/** @example "12345" */
|
|
@@ -528,7 +528,7 @@ export interface CustomerInput {
|
|
|
528
528
|
metadata?: {
|
|
529
529
|
/**
|
|
530
530
|
* @format uuid
|
|
531
|
-
* @example "
|
|
531
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
532
532
|
*/
|
|
533
533
|
id?: string;
|
|
534
534
|
/** @example "name" */
|
|
@@ -550,16 +550,17 @@ export interface ChargeUsageObject {
|
|
|
550
550
|
charge: {
|
|
551
551
|
/**
|
|
552
552
|
* @format uuid
|
|
553
|
-
* @example "
|
|
553
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
554
554
|
*/
|
|
555
555
|
lago_id?: string;
|
|
556
556
|
/** Charge model type */
|
|
557
557
|
charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
|
|
558
|
+
instant?: boolean;
|
|
558
559
|
};
|
|
559
560
|
billable_metric: {
|
|
560
561
|
/**
|
|
561
562
|
* @format uuid
|
|
562
|
-
* @example "
|
|
563
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
563
564
|
*/
|
|
564
565
|
lago_id?: string;
|
|
565
566
|
/** @example "Example name" */
|
|
@@ -572,7 +573,7 @@ export interface ChargeUsageObject {
|
|
|
572
573
|
groups: {
|
|
573
574
|
/**
|
|
574
575
|
* @format uuid
|
|
575
|
-
* @example "
|
|
576
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
576
577
|
*/
|
|
577
578
|
lago_id?: string;
|
|
578
579
|
/** @example "key" */
|
|
@@ -621,14 +622,14 @@ export interface CustomerUsage {
|
|
|
621
622
|
export interface EventObject {
|
|
622
623
|
/**
|
|
623
624
|
* @format uuid
|
|
624
|
-
* @example "
|
|
625
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
625
626
|
*/
|
|
626
627
|
lago_id: string;
|
|
627
628
|
/** @example "987654321" */
|
|
628
629
|
transaction_id: string;
|
|
629
630
|
/**
|
|
630
631
|
* @format uuid
|
|
631
|
-
* @example "
|
|
632
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
632
633
|
*/
|
|
633
634
|
lago_customer_id: string;
|
|
634
635
|
/** @example "123456" */
|
|
@@ -643,7 +644,7 @@ export interface EventObject {
|
|
|
643
644
|
properties?: object;
|
|
644
645
|
/**
|
|
645
646
|
* @format uuid
|
|
646
|
-
* @example "
|
|
647
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
647
648
|
*/
|
|
648
649
|
lago_subscription_id: string;
|
|
649
650
|
/** @example "123456" */
|
|
@@ -700,6 +701,16 @@ export interface BatchEventInput {
|
|
|
700
701
|
export interface Fees {
|
|
701
702
|
fees: FeeObject[];
|
|
702
703
|
}
|
|
704
|
+
export interface FeesPaginated {
|
|
705
|
+
fees: FeeObject[];
|
|
706
|
+
meta: PaginationMeta;
|
|
707
|
+
}
|
|
708
|
+
export interface FeeUpdateInput {
|
|
709
|
+
invoice: {
|
|
710
|
+
/** Status */
|
|
711
|
+
payment_status: "pending" | "succeeded" | "failed" | "refunded";
|
|
712
|
+
};
|
|
713
|
+
}
|
|
703
714
|
export interface GroupPropertiesObject {
|
|
704
715
|
/** @example "123456" */
|
|
705
716
|
group_id: string;
|
|
@@ -708,12 +719,12 @@ export interface GroupPropertiesObject {
|
|
|
708
719
|
export interface ChargeObject {
|
|
709
720
|
/**
|
|
710
721
|
* @format uuid
|
|
711
|
-
* @example "
|
|
722
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
712
723
|
*/
|
|
713
724
|
lago_id: string;
|
|
714
725
|
/**
|
|
715
726
|
* @format uuid
|
|
716
|
-
* @example "
|
|
727
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
717
728
|
*/
|
|
718
729
|
lago_billable_metric_id: string;
|
|
719
730
|
/** @example "bm_code" */
|
|
@@ -725,13 +736,15 @@ export interface ChargeObject {
|
|
|
725
736
|
created_at: string;
|
|
726
737
|
/** Charge model type */
|
|
727
738
|
charge_model: "standard" | "graduated" | "package" | "percentage" | "volume";
|
|
739
|
+
/** @example true */
|
|
740
|
+
instant?: boolean;
|
|
728
741
|
properties?: object;
|
|
729
742
|
group_properties?: GroupPropertiesObject[];
|
|
730
743
|
}
|
|
731
744
|
export interface PlanObject {
|
|
732
745
|
/**
|
|
733
746
|
* @format uuid
|
|
734
|
-
* @example "
|
|
747
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
735
748
|
*/
|
|
736
749
|
lago_id: string;
|
|
737
750
|
/** @example "example name" */
|
|
@@ -792,16 +805,17 @@ export interface PlanInput {
|
|
|
792
805
|
charges?: {
|
|
793
806
|
/**
|
|
794
807
|
* @format uuid
|
|
795
|
-
* @example "
|
|
808
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
796
809
|
*/
|
|
797
810
|
id?: string;
|
|
798
811
|
/**
|
|
799
812
|
* @format uuid
|
|
800
|
-
* @example "
|
|
813
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
801
814
|
*/
|
|
802
815
|
billable_metric_id?: string;
|
|
803
816
|
/** Charge model type */
|
|
804
817
|
charge_model?: "standard" | "graduated" | "package" | "percentage" | "volume";
|
|
818
|
+
instant?: boolean;
|
|
805
819
|
properties?: object;
|
|
806
820
|
group_properties?: {
|
|
807
821
|
/** @example "123456" */
|
|
@@ -814,14 +828,14 @@ export interface PlanInput {
|
|
|
814
828
|
export interface SubscriptionObject {
|
|
815
829
|
/**
|
|
816
830
|
* @format uuid
|
|
817
|
-
* @example "
|
|
831
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
818
832
|
*/
|
|
819
833
|
lago_id: string;
|
|
820
834
|
/** @example "12345" */
|
|
821
835
|
external_id: string;
|
|
822
836
|
/**
|
|
823
837
|
* @format uuid
|
|
824
|
-
* @example "
|
|
838
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
825
839
|
*/
|
|
826
840
|
lago_customer_id: string;
|
|
827
841
|
/** @example "54321" */
|
|
@@ -908,7 +922,7 @@ export interface SubscriptionUpdateInput {
|
|
|
908
922
|
export interface CreditObject {
|
|
909
923
|
/**
|
|
910
924
|
* @format uuid
|
|
911
|
-
* @example "
|
|
925
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
912
926
|
*/
|
|
913
927
|
lago_id: string;
|
|
914
928
|
/** @example 1200 */
|
|
@@ -918,7 +932,7 @@ export interface CreditObject {
|
|
|
918
932
|
item: {
|
|
919
933
|
/**
|
|
920
934
|
* @format uuid
|
|
921
|
-
* @example "
|
|
935
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
922
936
|
*/
|
|
923
937
|
lago_id: string;
|
|
924
938
|
/** @example "coupon" */
|
|
@@ -931,7 +945,7 @@ export interface CreditObject {
|
|
|
931
945
|
invoice: {
|
|
932
946
|
/**
|
|
933
947
|
* @format uuid
|
|
934
|
-
* @example "
|
|
948
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
935
949
|
*/
|
|
936
950
|
lago_id: string;
|
|
937
951
|
payment_status: "pending" | "succeeded" | "failed";
|
|
@@ -940,14 +954,21 @@ export interface CreditObject {
|
|
|
940
954
|
export interface FeeObject {
|
|
941
955
|
/**
|
|
942
956
|
* @format uuid
|
|
943
|
-
* @example "
|
|
957
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
944
958
|
*/
|
|
945
959
|
lago_id: string;
|
|
946
960
|
/**
|
|
947
961
|
* @format uuid
|
|
948
|
-
* @example "
|
|
962
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
949
963
|
*/
|
|
950
964
|
lago_group_id?: string;
|
|
965
|
+
/**
|
|
966
|
+
* @format uuid
|
|
967
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
968
|
+
*/
|
|
969
|
+
lago_invoice_id?: string;
|
|
970
|
+
/** @example "54321" */
|
|
971
|
+
external_subscription_id?: string;
|
|
951
972
|
/** @example 1000 */
|
|
952
973
|
amount_cents: number;
|
|
953
974
|
/** @example "EUR" */
|
|
@@ -964,6 +985,37 @@ export interface FeeObject {
|
|
|
964
985
|
total_amount_currency?: string;
|
|
965
986
|
/** @example 5 */
|
|
966
987
|
events_count?: number;
|
|
988
|
+
/**
|
|
989
|
+
* @format date-time
|
|
990
|
+
* @example "2022-08-08T00:00:00Z"
|
|
991
|
+
*/
|
|
992
|
+
from_date?: string;
|
|
993
|
+
/**
|
|
994
|
+
* @format date-time
|
|
995
|
+
* @example "2022-08-08T00:00:00Z"
|
|
996
|
+
*/
|
|
997
|
+
to_date?: string;
|
|
998
|
+
payment_status: "pending" | "succeeded" | "failed" | "refunded";
|
|
999
|
+
/**
|
|
1000
|
+
* @format date-time
|
|
1001
|
+
* @example "2022-09-14T16:35:31Z"
|
|
1002
|
+
*/
|
|
1003
|
+
created_at: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* @format date-time
|
|
1006
|
+
* @example "2022-09-14T16:35:31Z"
|
|
1007
|
+
*/
|
|
1008
|
+
succeeded_at?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* @format date-time
|
|
1011
|
+
* @example "2022-09-14T16:35:31Z"
|
|
1012
|
+
*/
|
|
1013
|
+
failed_at?: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* @format date-time
|
|
1016
|
+
* @example "2022-09-14T16:35:31Z"
|
|
1017
|
+
*/
|
|
1018
|
+
refunded_at?: string;
|
|
967
1019
|
item: {
|
|
968
1020
|
/** Billing time */
|
|
969
1021
|
type: "charge" | "add_on" | "subscription" | "credit";
|
|
@@ -971,12 +1023,18 @@ export interface FeeObject {
|
|
|
971
1023
|
code: string;
|
|
972
1024
|
/** @example "name" */
|
|
973
1025
|
name: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* @format uuid
|
|
1028
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1029
|
+
*/
|
|
1030
|
+
lago_item_id: string;
|
|
1031
|
+
item_type: "AddOn" | "BillableMetric" | "Subscription" | "WalletTransaction";
|
|
974
1032
|
};
|
|
975
1033
|
}
|
|
976
1034
|
export interface InvoiceMetadataObject {
|
|
977
1035
|
/**
|
|
978
1036
|
* @format uuid
|
|
979
|
-
* @example "
|
|
1037
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
980
1038
|
*/
|
|
981
1039
|
lago_id?: string;
|
|
982
1040
|
/** @example "name" */
|
|
@@ -992,7 +1050,7 @@ export interface InvoiceMetadataObject {
|
|
|
992
1050
|
export interface InvoiceObject {
|
|
993
1051
|
/**
|
|
994
1052
|
* @format uuid
|
|
995
|
-
* @example "
|
|
1053
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
996
1054
|
*/
|
|
997
1055
|
lago_id: string;
|
|
998
1056
|
/** @example 12345 */
|
|
@@ -1051,7 +1109,7 @@ export interface InvoiceInput {
|
|
|
1051
1109
|
metadata?: {
|
|
1052
1110
|
/**
|
|
1053
1111
|
* @format uuid
|
|
1054
|
-
* @example "
|
|
1112
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1055
1113
|
*/
|
|
1056
1114
|
id?: string;
|
|
1057
1115
|
/** @example "name" */
|
|
@@ -1064,12 +1122,12 @@ export interface InvoiceInput {
|
|
|
1064
1122
|
export interface WalletObject {
|
|
1065
1123
|
/**
|
|
1066
1124
|
* @format uuid
|
|
1067
|
-
* @example "
|
|
1125
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1068
1126
|
*/
|
|
1069
1127
|
lago_id: string;
|
|
1070
1128
|
/**
|
|
1071
1129
|
* @format uuid
|
|
1072
|
-
* @example "
|
|
1130
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1073
1131
|
*/
|
|
1074
1132
|
lago_customer_id: string;
|
|
1075
1133
|
/** @example "12345" */
|
|
@@ -1155,12 +1213,12 @@ export interface WalletUpdateInput {
|
|
|
1155
1213
|
export interface WalletTransactionObject {
|
|
1156
1214
|
/**
|
|
1157
1215
|
* @format uuid
|
|
1158
|
-
* @example "
|
|
1216
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1159
1217
|
*/
|
|
1160
1218
|
lago_id: string;
|
|
1161
1219
|
/**
|
|
1162
1220
|
* @format uuid
|
|
1163
|
-
* @example "
|
|
1221
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1164
1222
|
*/
|
|
1165
1223
|
lago_wallet_id: string;
|
|
1166
1224
|
/** Status */
|
|
@@ -1192,7 +1250,7 @@ export interface WalletTransactionInput {
|
|
|
1192
1250
|
wallet_transaction: {
|
|
1193
1251
|
/**
|
|
1194
1252
|
* @format uuid
|
|
1195
|
-
* @example "
|
|
1253
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1196
1254
|
*/
|
|
1197
1255
|
wallet_id: string;
|
|
1198
1256
|
/** @example 100 */
|
|
@@ -1204,7 +1262,7 @@ export interface WalletTransactionInput {
|
|
|
1204
1262
|
export interface CreditNoteItemObject {
|
|
1205
1263
|
/**
|
|
1206
1264
|
* @format uuid
|
|
1207
|
-
* @example "
|
|
1265
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1208
1266
|
*/
|
|
1209
1267
|
lago_id: string;
|
|
1210
1268
|
/** @example 1220 */
|
|
@@ -1216,7 +1274,7 @@ export interface CreditNoteItemObject {
|
|
|
1216
1274
|
export interface CreditNoteObject {
|
|
1217
1275
|
/**
|
|
1218
1276
|
* @format uuid
|
|
1219
|
-
* @example "
|
|
1277
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1220
1278
|
*/
|
|
1221
1279
|
lago_id: string;
|
|
1222
1280
|
/** @example 1234 */
|
|
@@ -1225,7 +1283,7 @@ export interface CreditNoteObject {
|
|
|
1225
1283
|
number: string;
|
|
1226
1284
|
/**
|
|
1227
1285
|
* @format uuid
|
|
1228
|
-
* @example "
|
|
1286
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1229
1287
|
*/
|
|
1230
1288
|
lago_invoice_id: string;
|
|
1231
1289
|
/** @example "123456789" */
|
|
@@ -1292,7 +1350,7 @@ export interface CreditNoteInput {
|
|
|
1292
1350
|
credit_note: {
|
|
1293
1351
|
/**
|
|
1294
1352
|
* @format uuid
|
|
1295
|
-
* @example "
|
|
1353
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1296
1354
|
*/
|
|
1297
1355
|
invoice_id: string;
|
|
1298
1356
|
/** Reason */
|
|
@@ -1306,7 +1364,7 @@ export interface CreditNoteInput {
|
|
|
1306
1364
|
items: {
|
|
1307
1365
|
/**
|
|
1308
1366
|
* @format uuid
|
|
1309
|
-
* @example "
|
|
1367
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
1310
1368
|
*/
|
|
1311
1369
|
fee_id: string;
|
|
1312
1370
|
/** @example 20 */
|
|
@@ -1320,6 +1378,18 @@ export interface CreditNoteUpdateInput {
|
|
|
1320
1378
|
refund_status: "pending" | "succeeded" | "failed";
|
|
1321
1379
|
};
|
|
1322
1380
|
}
|
|
1381
|
+
export interface PaginationMeta {
|
|
1382
|
+
/** Current page */
|
|
1383
|
+
current_page: number;
|
|
1384
|
+
/** Next page */
|
|
1385
|
+
next_page?: number;
|
|
1386
|
+
/** Previous page */
|
|
1387
|
+
prev_page?: number;
|
|
1388
|
+
/** Total number of pages */
|
|
1389
|
+
total_pages: number;
|
|
1390
|
+
/** Total number of records */
|
|
1391
|
+
total_count: number;
|
|
1392
|
+
}
|
|
1323
1393
|
export interface ApiResponseBadRequest {
|
|
1324
1394
|
/**
|
|
1325
1395
|
* @format int32
|
|
@@ -1361,6 +1431,17 @@ export interface ApiResponseNotFound {
|
|
|
1361
1431
|
/** @example "object_not_found" */
|
|
1362
1432
|
code: string;
|
|
1363
1433
|
}
|
|
1434
|
+
export interface ApiResponseForbidden {
|
|
1435
|
+
/**
|
|
1436
|
+
* @format int32
|
|
1437
|
+
* @example 403
|
|
1438
|
+
*/
|
|
1439
|
+
status: number;
|
|
1440
|
+
/** @example "Forbidden" */
|
|
1441
|
+
error: string;
|
|
1442
|
+
/** @example "feature_unavailable" */
|
|
1443
|
+
code: string;
|
|
1444
|
+
}
|
|
1364
1445
|
export interface ApiResponseNotAllowed {
|
|
1365
1446
|
/**
|
|
1366
1447
|
* @format int32
|
|
@@ -1451,6 +1532,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1451
1532
|
* @secure
|
|
1452
1533
|
*/
|
|
1453
1534
|
createBillableMetric: (data: BillableMetricInput, params?: RequestParams) => Promise<HttpResponse<BillableMetric, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
1535
|
+
/**
|
|
1536
|
+
* @description Find all billable metrics in certain organisation
|
|
1537
|
+
*
|
|
1538
|
+
* @tags billable_metrics
|
|
1539
|
+
* @name FindAllBillableMetrics
|
|
1540
|
+
* @summary Find Billable metrics
|
|
1541
|
+
* @request GET:/billable_metrics
|
|
1542
|
+
* @secure
|
|
1543
|
+
*/
|
|
1544
|
+
findAllBillableMetrics: (query?: {
|
|
1545
|
+
/**
|
|
1546
|
+
* Number of page
|
|
1547
|
+
* @example 2
|
|
1548
|
+
*/
|
|
1549
|
+
page?: number;
|
|
1550
|
+
/**
|
|
1551
|
+
* Number of records per page
|
|
1552
|
+
* @example 20
|
|
1553
|
+
*/
|
|
1554
|
+
per_page?: number;
|
|
1555
|
+
}, params?: RequestParams) => Promise<HttpResponse<BillableMetrics, ApiResponseUnauthorized>>;
|
|
1454
1556
|
/**
|
|
1455
1557
|
* @description Update an existing billable metric by code
|
|
1456
1558
|
*
|
|
@@ -1481,27 +1583,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1481
1583
|
* @secure
|
|
1482
1584
|
*/
|
|
1483
1585
|
destroyBillableMetric: (code: string, params?: RequestParams) => Promise<HttpResponse<BillableMetric, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
1484
|
-
/**
|
|
1485
|
-
* @description Find all billable metrics in certain organisation
|
|
1486
|
-
*
|
|
1487
|
-
* @tags billable_metrics
|
|
1488
|
-
* @name FindAllBillableMetrics
|
|
1489
|
-
* @summary Find Billable metrics
|
|
1490
|
-
* @request GET:/billable_metrics/
|
|
1491
|
-
* @secure
|
|
1492
|
-
*/
|
|
1493
|
-
findAllBillableMetrics: (query?: {
|
|
1494
|
-
/**
|
|
1495
|
-
* Number of page
|
|
1496
|
-
* @example 2
|
|
1497
|
-
*/
|
|
1498
|
-
page?: number;
|
|
1499
|
-
/**
|
|
1500
|
-
* Number of records per page
|
|
1501
|
-
* @example 20
|
|
1502
|
-
*/
|
|
1503
|
-
per_page?: number;
|
|
1504
|
-
}, params?: RequestParams) => Promise<HttpResponse<BillableMetrics, ApiResponseUnauthorized>>;
|
|
1505
1586
|
/**
|
|
1506
1587
|
* @description Find all billable metric groups in certain organisation
|
|
1507
1588
|
*
|
|
@@ -1535,6 +1616,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1535
1616
|
* @secure
|
|
1536
1617
|
*/
|
|
1537
1618
|
createAddOn: (data: AddOnInput, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
1619
|
+
/**
|
|
1620
|
+
* @description Find all add-ons in certain organisation
|
|
1621
|
+
*
|
|
1622
|
+
* @tags add_ons
|
|
1623
|
+
* @name FindAllAddOns
|
|
1624
|
+
* @summary Find add-ons
|
|
1625
|
+
* @request GET:/add_ons
|
|
1626
|
+
* @secure
|
|
1627
|
+
*/
|
|
1628
|
+
findAllAddOns: (query?: {
|
|
1629
|
+
/**
|
|
1630
|
+
* Number of page
|
|
1631
|
+
* @example 2
|
|
1632
|
+
*/
|
|
1633
|
+
page?: number;
|
|
1634
|
+
/**
|
|
1635
|
+
* Number of records per page
|
|
1636
|
+
* @example 20
|
|
1637
|
+
*/
|
|
1638
|
+
per_page?: number;
|
|
1639
|
+
}, params?: RequestParams) => Promise<HttpResponse<AddOns, ApiResponseUnauthorized>>;
|
|
1538
1640
|
/**
|
|
1539
1641
|
* @description Update an existing add-on by code
|
|
1540
1642
|
*
|
|
@@ -1565,27 +1667,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1565
1667
|
* @secure
|
|
1566
1668
|
*/
|
|
1567
1669
|
destroyAddOn: (code: string, params?: RequestParams) => Promise<HttpResponse<AddOn, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
1568
|
-
/**
|
|
1569
|
-
* @description Find all add-ons in certain organisation
|
|
1570
|
-
*
|
|
1571
|
-
* @tags add_ons
|
|
1572
|
-
* @name FindAllAddOns
|
|
1573
|
-
* @summary Find add-ons
|
|
1574
|
-
* @request GET:/add_ons/
|
|
1575
|
-
* @secure
|
|
1576
|
-
*/
|
|
1577
|
-
findAllAddOns: (query?: {
|
|
1578
|
-
/**
|
|
1579
|
-
* Number of page
|
|
1580
|
-
* @example 2
|
|
1581
|
-
*/
|
|
1582
|
-
page?: number;
|
|
1583
|
-
/**
|
|
1584
|
-
* Number of records per page
|
|
1585
|
-
* @example 20
|
|
1586
|
-
*/
|
|
1587
|
-
per_page?: number;
|
|
1588
|
-
}, params?: RequestParams) => Promise<HttpResponse<AddOns, ApiResponseUnauthorized>>;
|
|
1589
1670
|
};
|
|
1590
1671
|
appliedAddOns: {
|
|
1591
1672
|
/**
|
|
@@ -1610,6 +1691,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1610
1691
|
* @secure
|
|
1611
1692
|
*/
|
|
1612
1693
|
createCoupon: (data: CouponInput, params?: RequestParams) => Promise<HttpResponse<Coupon, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
1694
|
+
/**
|
|
1695
|
+
* @description Find all coupons in certain organisation
|
|
1696
|
+
*
|
|
1697
|
+
* @tags coupons
|
|
1698
|
+
* @name FindAllCoupons
|
|
1699
|
+
* @summary Find Coupons
|
|
1700
|
+
* @request GET:/coupons
|
|
1701
|
+
* @secure
|
|
1702
|
+
*/
|
|
1703
|
+
findAllCoupons: (query?: {
|
|
1704
|
+
/**
|
|
1705
|
+
* Number of page
|
|
1706
|
+
* @example 2
|
|
1707
|
+
*/
|
|
1708
|
+
page?: number;
|
|
1709
|
+
/**
|
|
1710
|
+
* Number of records per page
|
|
1711
|
+
* @example 20
|
|
1712
|
+
*/
|
|
1713
|
+
per_page?: number;
|
|
1714
|
+
}, params?: RequestParams) => Promise<HttpResponse<Coupons, ApiResponseUnauthorized>>;
|
|
1613
1715
|
/**
|
|
1614
1716
|
* @description Update an existing coupon by code
|
|
1615
1717
|
*
|
|
@@ -1640,27 +1742,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1640
1742
|
* @secure
|
|
1641
1743
|
*/
|
|
1642
1744
|
destroyCoupon: (code: string, params?: RequestParams) => Promise<HttpResponse<Coupon, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
1643
|
-
/**
|
|
1644
|
-
* @description Find all coupons in certain organisation
|
|
1645
|
-
*
|
|
1646
|
-
* @tags coupons
|
|
1647
|
-
* @name FindAllCoupons
|
|
1648
|
-
* @summary Find Coupons
|
|
1649
|
-
* @request GET:/coupons/
|
|
1650
|
-
* @secure
|
|
1651
|
-
*/
|
|
1652
|
-
findAllCoupons: (query?: {
|
|
1653
|
-
/**
|
|
1654
|
-
* Number of page
|
|
1655
|
-
* @example 2
|
|
1656
|
-
*/
|
|
1657
|
-
page?: number;
|
|
1658
|
-
/**
|
|
1659
|
-
* Number of records per page
|
|
1660
|
-
* @example 20
|
|
1661
|
-
*/
|
|
1662
|
-
per_page?: number;
|
|
1663
|
-
}, params?: RequestParams) => Promise<HttpResponse<Coupons, ApiResponseUnauthorized>>;
|
|
1664
1745
|
};
|
|
1665
1746
|
appliedCoupons: {
|
|
1666
1747
|
/**
|
|
@@ -1679,7 +1760,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1679
1760
|
* @tags coupons
|
|
1680
1761
|
* @name FindAllAppliedCoupons
|
|
1681
1762
|
* @summary Find Applied Coupons
|
|
1682
|
-
* @request GET:/applied_coupons
|
|
1763
|
+
* @request GET:/applied_coupons
|
|
1683
1764
|
* @secure
|
|
1684
1765
|
*/
|
|
1685
1766
|
findAllAppliedCoupons: (query?: {
|
|
@@ -1709,7 +1790,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1709
1790
|
* @tags organizations
|
|
1710
1791
|
* @name UpdateOrganization
|
|
1711
1792
|
* @summary Update an existing Organization
|
|
1712
|
-
* @request PUT:/organizations
|
|
1793
|
+
* @request PUT:/organizations
|
|
1713
1794
|
* @secure
|
|
1714
1795
|
*/
|
|
1715
1796
|
updateOrganization: (data: OrganizationInput, params?: RequestParams) => Promise<HttpResponse<Organization, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
@@ -1725,6 +1806,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1725
1806
|
* @secure
|
|
1726
1807
|
*/
|
|
1727
1808
|
createCustomer: (data: CustomerInput, params?: RequestParams) => Promise<HttpResponse<Customer, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
1809
|
+
/**
|
|
1810
|
+
* @description Find all customers in certain organisation
|
|
1811
|
+
*
|
|
1812
|
+
* @tags customers
|
|
1813
|
+
* @name FindAllCustomers
|
|
1814
|
+
* @summary Find customers
|
|
1815
|
+
* @request GET:/customers
|
|
1816
|
+
* @secure
|
|
1817
|
+
*/
|
|
1818
|
+
findAllCustomers: (query?: {
|
|
1819
|
+
/**
|
|
1820
|
+
* Number of page
|
|
1821
|
+
* @example 2
|
|
1822
|
+
*/
|
|
1823
|
+
page?: number;
|
|
1824
|
+
/**
|
|
1825
|
+
* Number of records per page
|
|
1826
|
+
* @example 20
|
|
1827
|
+
*/
|
|
1828
|
+
per_page?: number;
|
|
1829
|
+
}, params?: RequestParams) => Promise<HttpResponse<Customers, ApiResponseUnauthorized>>;
|
|
1728
1830
|
/**
|
|
1729
1831
|
* @description Return a single customer
|
|
1730
1832
|
*
|
|
@@ -1762,36 +1864,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1762
1864
|
external_subscription_id: string;
|
|
1763
1865
|
}, params?: RequestParams) => Promise<HttpResponse<CustomerUsage, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
1764
1866
|
/**
|
|
1765
|
-
* @description
|
|
1867
|
+
* @description Get customer portal URL
|
|
1766
1868
|
*
|
|
1767
1869
|
* @tags customers
|
|
1768
|
-
* @name
|
|
1769
|
-
* @summary
|
|
1770
|
-
* @request
|
|
1870
|
+
* @name GetCustomerPortalUrl
|
|
1871
|
+
* @summary Get customer portal URL
|
|
1872
|
+
* @request GET:/customers/{customer_external_id}/portal_url
|
|
1771
1873
|
* @secure
|
|
1772
1874
|
*/
|
|
1773
|
-
|
|
1875
|
+
getCustomerPortalUrl: (customerExternalId: string, params?: RequestParams) => Promise<HttpResponse<{
|
|
1876
|
+
customer: {
|
|
1877
|
+
/** @example "https://app.lago.com/customer-portal/abc/" */
|
|
1878
|
+
portal_url: string;
|
|
1879
|
+
};
|
|
1880
|
+
}, ApiResponseUnauthorized | ApiResponseNotFound | ApiResponseForbidden>>;
|
|
1774
1881
|
/**
|
|
1775
|
-
* @description
|
|
1882
|
+
* @description Delete customer's appplied coupon
|
|
1776
1883
|
*
|
|
1777
1884
|
* @tags customers
|
|
1778
|
-
* @name
|
|
1779
|
-
* @summary
|
|
1780
|
-
* @request
|
|
1885
|
+
* @name DeleteAppliedCoupon
|
|
1886
|
+
* @summary Delete customer's appplied coupon
|
|
1887
|
+
* @request DELETE:/customers/{customer_external_id}/applied_coupons/{applied_coupon_id}
|
|
1781
1888
|
* @secure
|
|
1782
1889
|
*/
|
|
1783
|
-
|
|
1784
|
-
/**
|
|
1785
|
-
* Number of page
|
|
1786
|
-
* @example 2
|
|
1787
|
-
*/
|
|
1788
|
-
page?: number;
|
|
1789
|
-
/**
|
|
1790
|
-
* Number of records per page
|
|
1791
|
-
* @example 20
|
|
1792
|
-
*/
|
|
1793
|
-
per_page?: number;
|
|
1794
|
-
}, params?: RequestParams) => Promise<HttpResponse<Customers, ApiResponseUnauthorized>>;
|
|
1890
|
+
deleteAppliedCoupon: (customerExternalId: string, appliedCouponId: string, params?: RequestParams) => Promise<HttpResponse<AppliedCoupon, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
1795
1891
|
};
|
|
1796
1892
|
events: {
|
|
1797
1893
|
/**
|
|
@@ -1846,6 +1942,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1846
1942
|
* @secure
|
|
1847
1943
|
*/
|
|
1848
1944
|
createPlan: (data: PlanInput, params?: RequestParams) => Promise<HttpResponse<Plan, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity | ApiResponseNotFound>>;
|
|
1945
|
+
/**
|
|
1946
|
+
* @description Find all plans in certain organisation
|
|
1947
|
+
*
|
|
1948
|
+
* @tags plans
|
|
1949
|
+
* @name FindAllPlans
|
|
1950
|
+
* @summary Find plans
|
|
1951
|
+
* @request GET:/plans
|
|
1952
|
+
* @secure
|
|
1953
|
+
*/
|
|
1954
|
+
findAllPlans: (query?: {
|
|
1955
|
+
/**
|
|
1956
|
+
* Number of page
|
|
1957
|
+
* @example 2
|
|
1958
|
+
*/
|
|
1959
|
+
page?: number;
|
|
1960
|
+
/**
|
|
1961
|
+
* Number of records per page
|
|
1962
|
+
* @example 20
|
|
1963
|
+
*/
|
|
1964
|
+
per_page?: number;
|
|
1965
|
+
}, params?: RequestParams) => Promise<HttpResponse<Plans, ApiResponseUnauthorized>>;
|
|
1849
1966
|
/**
|
|
1850
1967
|
* @description Update an existing plan by code
|
|
1851
1968
|
*
|
|
@@ -1876,16 +1993,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1876
1993
|
* @secure
|
|
1877
1994
|
*/
|
|
1878
1995
|
destroyPlan: (code: string, params?: RequestParams) => Promise<HttpResponse<Plan, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
1996
|
+
};
|
|
1997
|
+
subscriptions: {
|
|
1879
1998
|
/**
|
|
1880
|
-
* @description
|
|
1999
|
+
* @description Assign a plan to a customer
|
|
1881
2000
|
*
|
|
1882
|
-
* @tags
|
|
1883
|
-
* @name
|
|
1884
|
-
* @summary
|
|
1885
|
-
* @request
|
|
2001
|
+
* @tags subscriptions
|
|
2002
|
+
* @name CreateSubscription
|
|
2003
|
+
* @summary Assign a plan to a customer
|
|
2004
|
+
* @request POST:/subscriptions
|
|
1886
2005
|
* @secure
|
|
1887
2006
|
*/
|
|
1888
|
-
|
|
2007
|
+
createSubscription: (data: SubscriptionCreateInput, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity | ApiResponseNotFound>>;
|
|
2008
|
+
/**
|
|
2009
|
+
* @description Find all suscriptions for certain customer
|
|
2010
|
+
*
|
|
2011
|
+
* @tags subscriptions
|
|
2012
|
+
* @name FindAllSubscriptions
|
|
2013
|
+
* @summary Find subscriptions
|
|
2014
|
+
* @request GET:/subscriptions
|
|
2015
|
+
* @secure
|
|
2016
|
+
*/
|
|
2017
|
+
findAllSubscriptions: (query: {
|
|
1889
2018
|
/**
|
|
1890
2019
|
* Number of page
|
|
1891
2020
|
* @example 2
|
|
@@ -1896,19 +2025,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1896
2025
|
* @example 20
|
|
1897
2026
|
*/
|
|
1898
2027
|
per_page?: number;
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
* @tags subscriptions
|
|
1906
|
-
* @name CreateSubscription
|
|
1907
|
-
* @summary Assign a plan to a customer
|
|
1908
|
-
* @request POST:/subscriptions
|
|
1909
|
-
* @secure
|
|
1910
|
-
*/
|
|
1911
|
-
createSubscription: (data: SubscriptionCreateInput, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity | ApiResponseNotFound>>;
|
|
2028
|
+
/**
|
|
2029
|
+
* External customer ID
|
|
2030
|
+
* @example "12345"
|
|
2031
|
+
*/
|
|
2032
|
+
external_customer_id: string;
|
|
2033
|
+
}, params?: RequestParams) => Promise<HttpResponse<Subscriptions, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
1912
2034
|
/**
|
|
1913
2035
|
* @description Update an existing subscription by external ID
|
|
1914
2036
|
*
|
|
@@ -1929,16 +2051,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1929
2051
|
* @secure
|
|
1930
2052
|
*/
|
|
1931
2053
|
destroySubscription: (externalId: string, params?: RequestParams) => Promise<HttpResponse<Subscription, ApiResponseUnauthorized | ApiResponseNotFound | ApiResponseNotAllowed>>;
|
|
2054
|
+
};
|
|
2055
|
+
webhooks: {
|
|
1932
2056
|
/**
|
|
1933
|
-
* @description
|
|
2057
|
+
* @description Webhook public key
|
|
1934
2058
|
*
|
|
1935
|
-
* @tags
|
|
1936
|
-
* @name
|
|
1937
|
-
* @summary
|
|
1938
|
-
* @request GET:/
|
|
2059
|
+
* @tags webhooks
|
|
2060
|
+
* @name FetchPublicKey
|
|
2061
|
+
* @summary Fetch webhook public key
|
|
2062
|
+
* @request GET:/webhooks/public_key
|
|
1939
2063
|
* @secure
|
|
1940
2064
|
*/
|
|
1941
|
-
|
|
2065
|
+
fetchPublicKey: (params?: RequestParams) => Promise<HttpResponse<string, ApiResponseUnauthorized>>;
|
|
2066
|
+
};
|
|
2067
|
+
invoices: {
|
|
2068
|
+
/**
|
|
2069
|
+
* @description Find all invoices in certain organisation
|
|
2070
|
+
*
|
|
2071
|
+
* @tags invoices
|
|
2072
|
+
* @name FindAllInvoices
|
|
2073
|
+
* @summary Find all invoices
|
|
2074
|
+
* @request GET:/invoices
|
|
2075
|
+
* @secure
|
|
2076
|
+
*/
|
|
2077
|
+
findAllInvoices: (query?: {
|
|
1942
2078
|
/**
|
|
1943
2079
|
* Number of page
|
|
1944
2080
|
* @example 2
|
|
@@ -1953,22 +2089,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1953
2089
|
* External customer ID
|
|
1954
2090
|
* @example "12345"
|
|
1955
2091
|
*/
|
|
1956
|
-
external_customer_id
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
2092
|
+
external_customer_id?: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* Date from
|
|
2095
|
+
* @format date
|
|
2096
|
+
* @example "2022-07-08"
|
|
2097
|
+
*/
|
|
2098
|
+
issuing_date_from?: string;
|
|
2099
|
+
/**
|
|
2100
|
+
* Date to
|
|
2101
|
+
* @format date
|
|
2102
|
+
* @example "2022-08-09"
|
|
2103
|
+
*/
|
|
2104
|
+
issuing_date_to?: string;
|
|
2105
|
+
/** Status */
|
|
2106
|
+
status?: "draft" | "finalized";
|
|
2107
|
+
}, params?: RequestParams) => Promise<HttpResponse<Invoices, ApiResponseUnauthorized>>;
|
|
1972
2108
|
/**
|
|
1973
2109
|
* @description Update an existing invoice
|
|
1974
2110
|
*
|
|
@@ -2029,16 +2165,38 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2029
2165
|
* @secure
|
|
2030
2166
|
*/
|
|
2031
2167
|
finalizeInvoice: (id: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
2168
|
+
};
|
|
2169
|
+
fees: {
|
|
2032
2170
|
/**
|
|
2033
|
-
* @description
|
|
2171
|
+
* @description Return a single fee
|
|
2034
2172
|
*
|
|
2035
|
-
* @tags
|
|
2036
|
-
* @name
|
|
2037
|
-
* @summary Find
|
|
2038
|
-
* @request GET:/
|
|
2173
|
+
* @tags fees
|
|
2174
|
+
* @name FindFee
|
|
2175
|
+
* @summary Find fee by ID
|
|
2176
|
+
* @request GET:/fees/{id}
|
|
2039
2177
|
* @secure
|
|
2040
2178
|
*/
|
|
2041
|
-
|
|
2179
|
+
findFee: (id: string, params?: RequestParams) => Promise<HttpResponse<FeeObject, ApiResponseUnauthorized | ApiResponseNotFound>>;
|
|
2180
|
+
/**
|
|
2181
|
+
* @description Update an existing fee
|
|
2182
|
+
*
|
|
2183
|
+
* @tags fees
|
|
2184
|
+
* @name UpdateFee
|
|
2185
|
+
* @summary Update an existing fee
|
|
2186
|
+
* @request PUT:/fees/{id}
|
|
2187
|
+
* @secure
|
|
2188
|
+
*/
|
|
2189
|
+
updateFee: (id: string, data: FeeUpdateInput, params?: RequestParams) => Promise<HttpResponse<FeeObject, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity | ApiResponseNotFound>>;
|
|
2190
|
+
/**
|
|
2191
|
+
* @description Find all fees of an organization and filter them
|
|
2192
|
+
*
|
|
2193
|
+
* @tags fees
|
|
2194
|
+
* @name FindAllFees
|
|
2195
|
+
* @summary Find all fees
|
|
2196
|
+
* @request GET:/fees
|
|
2197
|
+
* @secure
|
|
2198
|
+
*/
|
|
2199
|
+
findAllFees: (query?: {
|
|
2042
2200
|
/**
|
|
2043
2201
|
* Number of page
|
|
2044
2202
|
* @example 2
|
|
@@ -2055,35 +2213,79 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2055
2213
|
*/
|
|
2056
2214
|
external_customer_id?: string;
|
|
2057
2215
|
/**
|
|
2058
|
-
*
|
|
2059
|
-
* @
|
|
2060
|
-
* @example "2022-07-08"
|
|
2216
|
+
* External subscription ID
|
|
2217
|
+
* @example "12345"
|
|
2061
2218
|
*/
|
|
2062
|
-
|
|
2219
|
+
external_subscription_id?: string;
|
|
2063
2220
|
/**
|
|
2064
|
-
*
|
|
2065
|
-
* @
|
|
2066
|
-
* @example "2022-08-09"
|
|
2221
|
+
* Amount currency
|
|
2222
|
+
* @example "EUR"
|
|
2067
2223
|
*/
|
|
2068
|
-
|
|
2224
|
+
currency?: string;
|
|
2069
2225
|
/**
|
|
2070
|
-
*
|
|
2071
|
-
* @example "
|
|
2226
|
+
* Fee type
|
|
2227
|
+
* @example "charge"
|
|
2072
2228
|
*/
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
|
|
2076
|
-
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2229
|
+
fee_type?: "charge" | "add_on" | "subscription" | "credit" | "instant_charge";
|
|
2230
|
+
/**
|
|
2231
|
+
* Code of the source billable metric
|
|
2232
|
+
* @example "bm_code"
|
|
2233
|
+
*/
|
|
2234
|
+
billable_metric_code?: string;
|
|
2235
|
+
/**
|
|
2236
|
+
* Payment status
|
|
2237
|
+
* @example "succeeded"
|
|
2238
|
+
*/
|
|
2239
|
+
payment_status?: "pending" | "succeeded" | "failed" | "refunded";
|
|
2240
|
+
/**
|
|
2241
|
+
* Creation datetime from
|
|
2242
|
+
* @format date-time
|
|
2243
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2244
|
+
*/
|
|
2245
|
+
created_at_from?: string;
|
|
2246
|
+
/**
|
|
2247
|
+
* Creation date to
|
|
2248
|
+
* @format date-time
|
|
2249
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2250
|
+
*/
|
|
2251
|
+
created_at_to?: string;
|
|
2252
|
+
/**
|
|
2253
|
+
* Payment succees date from
|
|
2254
|
+
* @format date-time
|
|
2255
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2256
|
+
*/
|
|
2257
|
+
succeeded_at_from?: string;
|
|
2258
|
+
/**
|
|
2259
|
+
* Payment succees date to
|
|
2260
|
+
* @format date-time
|
|
2261
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2262
|
+
*/
|
|
2263
|
+
succeeded_at_to?: string;
|
|
2264
|
+
/**
|
|
2265
|
+
* Payment failed date from
|
|
2266
|
+
* @format date-time
|
|
2267
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2268
|
+
*/
|
|
2269
|
+
failed_at_from?: string;
|
|
2270
|
+
/**
|
|
2271
|
+
* Payment failed date to
|
|
2272
|
+
* @format date-time
|
|
2273
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2274
|
+
*/
|
|
2275
|
+
failed_at_to?: string;
|
|
2276
|
+
/**
|
|
2277
|
+
* Payment refund date from
|
|
2278
|
+
* @format date-time
|
|
2279
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2280
|
+
*/
|
|
2281
|
+
refunded_at_from?: string;
|
|
2282
|
+
/**
|
|
2283
|
+
* Payment refund date to
|
|
2284
|
+
* @format date-time
|
|
2285
|
+
* @example "2023-03-28T12:21:51Z"
|
|
2286
|
+
*/
|
|
2287
|
+
refunded_at_to?: string;
|
|
2288
|
+
}, params?: RequestParams) => Promise<HttpResponse<FeesPaginated, ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
2087
2289
|
};
|
|
2088
2290
|
wallets: {
|
|
2089
2291
|
/**
|
|
@@ -2096,6 +2298,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2096
2298
|
* @secure
|
|
2097
2299
|
*/
|
|
2098
2300
|
createWallet: (data: WalletInput, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
2301
|
+
/**
|
|
2302
|
+
* @description Find all wallets for certain customer
|
|
2303
|
+
*
|
|
2304
|
+
* @tags wallets
|
|
2305
|
+
* @name FindAllWallets
|
|
2306
|
+
* @summary Find wallets
|
|
2307
|
+
* @request GET:/wallets
|
|
2308
|
+
* @secure
|
|
2309
|
+
*/
|
|
2310
|
+
findAllWallets: (query: {
|
|
2311
|
+
/**
|
|
2312
|
+
* Number of page
|
|
2313
|
+
* @example 2
|
|
2314
|
+
*/
|
|
2315
|
+
page?: number;
|
|
2316
|
+
/**
|
|
2317
|
+
* Number of records per page
|
|
2318
|
+
* @example 20
|
|
2319
|
+
*/
|
|
2320
|
+
per_page?: number;
|
|
2321
|
+
/**
|
|
2322
|
+
* External customer ID
|
|
2323
|
+
* @example "12345"
|
|
2324
|
+
*/
|
|
2325
|
+
external_customer_id: string;
|
|
2326
|
+
}, params?: RequestParams) => Promise<HttpResponse<Wallets, ApiResponseUnauthorized>>;
|
|
2099
2327
|
/**
|
|
2100
2328
|
* @description Update an existing wallet
|
|
2101
2329
|
*
|
|
@@ -2126,32 +2354,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2126
2354
|
* @secure
|
|
2127
2355
|
*/
|
|
2128
2356
|
destroyWallet: (id: string, params?: RequestParams) => Promise<HttpResponse<Wallet, ApiResponseUnauthorized | ApiResponseNotFound | ApiResponseNotAllowed>>;
|
|
2129
|
-
/**
|
|
2130
|
-
* @description Find all wallets for certain customer
|
|
2131
|
-
*
|
|
2132
|
-
* @tags wallets
|
|
2133
|
-
* @name FindAllWallets
|
|
2134
|
-
* @summary Find wallets
|
|
2135
|
-
* @request GET:/wallets/
|
|
2136
|
-
* @secure
|
|
2137
|
-
*/
|
|
2138
|
-
findAllWallets: (query: {
|
|
2139
|
-
/**
|
|
2140
|
-
* Number of page
|
|
2141
|
-
* @example 2
|
|
2142
|
-
*/
|
|
2143
|
-
page?: number;
|
|
2144
|
-
/**
|
|
2145
|
-
* Number of records per page
|
|
2146
|
-
* @example 20
|
|
2147
|
-
*/
|
|
2148
|
-
per_page?: number;
|
|
2149
|
-
/**
|
|
2150
|
-
* External customer ID
|
|
2151
|
-
* @example "12345"
|
|
2152
|
-
*/
|
|
2153
|
-
external_customer_id: string;
|
|
2154
|
-
}, params?: RequestParams) => Promise<HttpResponse<Wallets, ApiResponseUnauthorized>>;
|
|
2155
2357
|
/**
|
|
2156
2358
|
* @description Find all wallet transactions for certain wallet
|
|
2157
2359
|
*
|
|
@@ -2207,6 +2409,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2207
2409
|
* @secure
|
|
2208
2410
|
*/
|
|
2209
2411
|
createCreditNote: (data: CreditNoteInput, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiResponseBadRequest | ApiResponseUnauthorized | ApiResponseUnprocessableEntity>>;
|
|
2412
|
+
/**
|
|
2413
|
+
* @description Find all credit notes in certain organisation
|
|
2414
|
+
*
|
|
2415
|
+
* @tags credit_notes
|
|
2416
|
+
* @name FindAllCreditNotes
|
|
2417
|
+
* @summary Find Credit notes
|
|
2418
|
+
* @request GET:/credit_notes
|
|
2419
|
+
* @secure
|
|
2420
|
+
*/
|
|
2421
|
+
findAllCreditNotes: (query?: {
|
|
2422
|
+
/**
|
|
2423
|
+
* Number of page
|
|
2424
|
+
* @example 2
|
|
2425
|
+
*/
|
|
2426
|
+
page?: number;
|
|
2427
|
+
/**
|
|
2428
|
+
* Number of records per page
|
|
2429
|
+
* @example 20
|
|
2430
|
+
*/
|
|
2431
|
+
per_page?: number;
|
|
2432
|
+
/**
|
|
2433
|
+
* External customer ID
|
|
2434
|
+
* @example "12345"
|
|
2435
|
+
*/
|
|
2436
|
+
external_customer_id?: string;
|
|
2437
|
+
}, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiResponseUnauthorized>>;
|
|
2210
2438
|
/**
|
|
2211
2439
|
* @description Update an existing credit note
|
|
2212
2440
|
*
|
|
@@ -2247,32 +2475,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2247
2475
|
* @secure
|
|
2248
2476
|
*/
|
|
2249
2477
|
voidCreditNote: (id: string, params?: RequestParams) => Promise<HttpResponse<CreditNote, ApiResponseUnauthorized | ApiResponseNotFound | ApiResponseNotAllowed>>;
|
|
2250
|
-
/**
|
|
2251
|
-
* @description Find all credit notes in certain organisation
|
|
2252
|
-
*
|
|
2253
|
-
* @tags credit_notes
|
|
2254
|
-
* @name FindAllCreditNotes
|
|
2255
|
-
* @summary Find Credit notes
|
|
2256
|
-
* @request GET:/credit_notes/
|
|
2257
|
-
* @secure
|
|
2258
|
-
*/
|
|
2259
|
-
findAllCreditNotes: (query?: {
|
|
2260
|
-
/**
|
|
2261
|
-
* Number of page
|
|
2262
|
-
* @example 2
|
|
2263
|
-
*/
|
|
2264
|
-
page?: number;
|
|
2265
|
-
/**
|
|
2266
|
-
* Number of records per page
|
|
2267
|
-
* @example 20
|
|
2268
|
-
*/
|
|
2269
|
-
per_page?: number;
|
|
2270
|
-
/**
|
|
2271
|
-
* External customer ID
|
|
2272
|
-
* @example "12345"
|
|
2273
|
-
*/
|
|
2274
|
-
external_customer_id?: string;
|
|
2275
|
-
}, params?: RequestParams) => Promise<HttpResponse<CreditNotes, ApiResponseUnauthorized>>;
|
|
2276
2478
|
};
|
|
2277
2479
|
}
|
|
2278
2480
|
export {};
|