lago-javascript-client 0.26.1-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.
@@ -179,6 +179,23 @@ class Api extends HttpClient {
179
179
  format: "json",
180
180
  ...params,
181
181
  }),
182
+ /**
183
+ * @description Find all billable metrics in certain organisation
184
+ *
185
+ * @tags billable_metrics
186
+ * @name FindAllBillableMetrics
187
+ * @summary Find Billable metrics
188
+ * @request GET:/billable_metrics
189
+ * @secure
190
+ */
191
+ findAllBillableMetrics: (query, params = {}) => this.request({
192
+ path: `/billable_metrics`,
193
+ method: "GET",
194
+ query: query,
195
+ secure: true,
196
+ format: "json",
197
+ ...params,
198
+ }),
182
199
  /**
183
200
  * @description Update an existing billable metric by code
184
201
  *
@@ -229,23 +246,6 @@ class Api extends HttpClient {
229
246
  format: "json",
230
247
  ...params,
231
248
  }),
232
- /**
233
- * @description Find all billable metrics in certain organisation
234
- *
235
- * @tags billable_metrics
236
- * @name FindAllBillableMetrics
237
- * @summary Find Billable metrics
238
- * @request GET:/billable_metrics/
239
- * @secure
240
- */
241
- findAllBillableMetrics: (query, params = {}) => this.request({
242
- path: `/billable_metrics/`,
243
- method: "GET",
244
- query: query,
245
- secure: true,
246
- format: "json",
247
- ...params,
248
- }),
249
249
  /**
250
250
  * @description Find all billable metric groups in certain organisation
251
251
  *
@@ -283,6 +283,23 @@ class Api extends HttpClient {
283
283
  format: "json",
284
284
  ...params,
285
285
  }),
286
+ /**
287
+ * @description Find all add-ons in certain organisation
288
+ *
289
+ * @tags add_ons
290
+ * @name FindAllAddOns
291
+ * @summary Find add-ons
292
+ * @request GET:/add_ons
293
+ * @secure
294
+ */
295
+ findAllAddOns: (query, params = {}) => this.request({
296
+ path: `/add_ons`,
297
+ method: "GET",
298
+ query: query,
299
+ secure: true,
300
+ format: "json",
301
+ ...params,
302
+ }),
286
303
  /**
287
304
  * @description Update an existing add-on by code
288
305
  *
@@ -333,23 +350,6 @@ class Api extends HttpClient {
333
350
  format: "json",
334
351
  ...params,
335
352
  }),
336
- /**
337
- * @description Find all add-ons in certain organisation
338
- *
339
- * @tags add_ons
340
- * @name FindAllAddOns
341
- * @summary Find add-ons
342
- * @request GET:/add_ons/
343
- * @secure
344
- */
345
- findAllAddOns: (query, params = {}) => this.request({
346
- path: `/add_ons/`,
347
- method: "GET",
348
- query: query,
349
- secure: true,
350
- format: "json",
351
- ...params,
352
- }),
353
353
  };
354
354
  appliedAddOns = {
355
355
  /**
@@ -390,6 +390,23 @@ class Api extends HttpClient {
390
390
  format: "json",
391
391
  ...params,
392
392
  }),
393
+ /**
394
+ * @description Find all coupons in certain organisation
395
+ *
396
+ * @tags coupons
397
+ * @name FindAllCoupons
398
+ * @summary Find Coupons
399
+ * @request GET:/coupons
400
+ * @secure
401
+ */
402
+ findAllCoupons: (query, params = {}) => this.request({
403
+ path: `/coupons`,
404
+ method: "GET",
405
+ query: query,
406
+ secure: true,
407
+ format: "json",
408
+ ...params,
409
+ }),
393
410
  /**
394
411
  * @description Update an existing coupon by code
395
412
  *
@@ -440,23 +457,6 @@ class Api extends HttpClient {
440
457
  format: "json",
441
458
  ...params,
442
459
  }),
443
- /**
444
- * @description Find all coupons in certain organisation
445
- *
446
- * @tags coupons
447
- * @name FindAllCoupons
448
- * @summary Find Coupons
449
- * @request GET:/coupons/
450
- * @secure
451
- */
452
- findAllCoupons: (query, params = {}) => this.request({
453
- path: `/coupons/`,
454
- method: "GET",
455
- query: query,
456
- secure: true,
457
- format: "json",
458
- ...params,
459
- }),
460
460
  };
461
461
  appliedCoupons = {
462
462
  /**
@@ -483,11 +483,11 @@ class Api extends HttpClient {
483
483
  * @tags coupons
484
484
  * @name FindAllAppliedCoupons
485
485
  * @summary Find Applied Coupons
486
- * @request GET:/applied_coupons/
486
+ * @request GET:/applied_coupons
487
487
  * @secure
488
488
  */
489
489
  findAllAppliedCoupons: (query, params = {}) => this.request({
490
- path: `/applied_coupons/`,
490
+ path: `/applied_coupons`,
491
491
  method: "GET",
492
492
  query: query,
493
493
  secure: true,
@@ -502,11 +502,11 @@ class Api extends HttpClient {
502
502
  * @tags organizations
503
503
  * @name UpdateOrganization
504
504
  * @summary Update an existing Organization
505
- * @request PUT:/organizations/
505
+ * @request PUT:/organizations
506
506
  * @secure
507
507
  */
508
508
  updateOrganization: (data, params = {}) => this.request({
509
- path: `/organizations/`,
509
+ path: `/organizations`,
510
510
  method: "PUT",
511
511
  body: data,
512
512
  secure: true,
@@ -534,6 +534,23 @@ class Api extends HttpClient {
534
534
  format: "json",
535
535
  ...params,
536
536
  }),
537
+ /**
538
+ * @description Find all customers in certain organisation
539
+ *
540
+ * @tags customers
541
+ * @name FindAllCustomers
542
+ * @summary Find customers
543
+ * @request GET:/customers
544
+ * @secure
545
+ */
546
+ findAllCustomers: (query, params = {}) => this.request({
547
+ path: `/customers`,
548
+ method: "GET",
549
+ query: query,
550
+ secure: true,
551
+ format: "json",
552
+ ...params,
553
+ }),
537
554
  /**
538
555
  * @description Return a single customer
539
556
  *
@@ -584,34 +601,33 @@ class Api extends HttpClient {
584
601
  ...params,
585
602
  }),
586
603
  /**
587
- * @description Delete customer's appplied coupon
604
+ * @description Get customer portal URL
588
605
  *
589
606
  * @tags customers
590
- * @name DeleteAppliedCoupon
591
- * @summary Delete customer's appplied coupon
592
- * @request DELETE:/customers/{customer_external_id}/applied_coupons/{applied_coupon_id}
607
+ * @name GetCustomerPortalUrl
608
+ * @summary Get customer portal URL
609
+ * @request GET:/customers/{customer_external_id}/portal_url
593
610
  * @secure
594
611
  */
595
- deleteAppliedCoupon: (customerExternalId, appliedCouponId, params = {}) => this.request({
596
- path: `/customers/${customerExternalId}/applied_coupons/${appliedCouponId}`,
597
- method: "DELETE",
612
+ getCustomerPortalUrl: (customerExternalId, params = {}) => this.request({
613
+ path: `/customers/${customerExternalId}/portal_url`,
614
+ method: "GET",
598
615
  secure: true,
599
616
  format: "json",
600
617
  ...params,
601
618
  }),
602
619
  /**
603
- * @description Find all customers in certain organisation
620
+ * @description Delete customer's appplied coupon
604
621
  *
605
622
  * @tags customers
606
- * @name FindAllCustomers
607
- * @summary Find customers
608
- * @request GET:/customers/
623
+ * @name DeleteAppliedCoupon
624
+ * @summary Delete customer's appplied coupon
625
+ * @request DELETE:/customers/{customer_external_id}/applied_coupons/{applied_coupon_id}
609
626
  * @secure
610
627
  */
611
- findAllCustomers: (query, params = {}) => this.request({
612
- path: `/customers/`,
613
- method: "GET",
614
- query: query,
628
+ deleteAppliedCoupon: (customerExternalId, appliedCouponId, params = {}) => this.request({
629
+ path: `/customers/${customerExternalId}/applied_coupons/${appliedCouponId}`,
630
+ method: "DELETE",
615
631
  secure: true,
616
632
  format: "json",
617
633
  ...params,
@@ -668,6 +684,24 @@ class Api extends HttpClient {
668
684
  format: "json",
669
685
  ...params,
670
686
  }),
687
+ /**
688
+ * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple instant charges
689
+ *
690
+ * @tags events
691
+ * @name EventEstimateFees
692
+ * @summary Estimate fees for an instant charge
693
+ * @request POST:/events/estimate_fees
694
+ * @secure
695
+ */
696
+ eventEstimateFees: (data, params = {}) => this.request({
697
+ path: `/events/estimate_fees`,
698
+ method: "POST",
699
+ body: data,
700
+ secure: true,
701
+ type: ContentType.Json,
702
+ format: "json",
703
+ ...params,
704
+ }),
671
705
  };
672
706
  plans = {
673
707
  /**
@@ -688,6 +722,23 @@ class Api extends HttpClient {
688
722
  format: "json",
689
723
  ...params,
690
724
  }),
725
+ /**
726
+ * @description Find all plans in certain organisation
727
+ *
728
+ * @tags plans
729
+ * @name FindAllPlans
730
+ * @summary Find plans
731
+ * @request GET:/plans
732
+ * @secure
733
+ */
734
+ findAllPlans: (query, params = {}) => this.request({
735
+ path: `/plans`,
736
+ method: "GET",
737
+ query: query,
738
+ secure: true,
739
+ format: "json",
740
+ ...params,
741
+ }),
691
742
  /**
692
743
  * @description Update an existing plan by code
693
744
  *
@@ -738,23 +789,6 @@ class Api extends HttpClient {
738
789
  format: "json",
739
790
  ...params,
740
791
  }),
741
- /**
742
- * @description Find all plans in certain organisation
743
- *
744
- * @tags plans
745
- * @name FindAllPlans
746
- * @summary Find plans
747
- * @request GET:/plans/
748
- * @secure
749
- */
750
- findAllPlans: (query, params = {}) => this.request({
751
- path: `/plans/`,
752
- method: "GET",
753
- query: query,
754
- secure: true,
755
- format: "json",
756
- ...params,
757
- }),
758
792
  };
759
793
  subscriptions = {
760
794
  /**
@@ -775,6 +809,23 @@ class Api extends HttpClient {
775
809
  format: "json",
776
810
  ...params,
777
811
  }),
812
+ /**
813
+ * @description Find all suscriptions for certain customer
814
+ *
815
+ * @tags subscriptions
816
+ * @name FindAllSubscriptions
817
+ * @summary Find subscriptions
818
+ * @request GET:/subscriptions
819
+ * @secure
820
+ */
821
+ findAllSubscriptions: (query, params = {}) => this.request({
822
+ path: `/subscriptions`,
823
+ method: "GET",
824
+ query: query,
825
+ secure: true,
826
+ format: "json",
827
+ ...params,
828
+ }),
778
829
  /**
779
830
  * @description Update an existing subscription by external ID
780
831
  *
@@ -809,23 +860,6 @@ class Api extends HttpClient {
809
860
  format: "json",
810
861
  ...params,
811
862
  }),
812
- /**
813
- * @description Find all suscriptions for certain customer
814
- *
815
- * @tags subscriptions
816
- * @name FindAllSubscriptions
817
- * @summary Find subscriptions
818
- * @request GET:/subscriptions/
819
- * @secure
820
- */
821
- findAllSubscriptions: (query, params = {}) => this.request({
822
- path: `/subscriptions/`,
823
- method: "GET",
824
- query: query,
825
- secure: true,
826
- format: "json",
827
- ...params,
828
- }),
829
863
  };
830
864
  webhooks = {
831
865
  /**
@@ -834,17 +868,34 @@ class Api extends HttpClient {
834
868
  * @tags webhooks
835
869
  * @name FetchPublicKey
836
870
  * @summary Fetch webhook public key
837
- * @request GET:/webhooks/public_key/
871
+ * @request GET:/webhooks/public_key
838
872
  * @secure
839
873
  */
840
874
  fetchPublicKey: (params = {}) => this.request({
841
- path: `/webhooks/public_key/`,
875
+ path: `/webhooks/public_key`,
842
876
  method: "GET",
843
877
  secure: true,
844
878
  ...params,
845
879
  }),
846
880
  };
847
881
  invoices = {
882
+ /**
883
+ * @description Find all invoices in certain organisation
884
+ *
885
+ * @tags invoices
886
+ * @name FindAllInvoices
887
+ * @summary Find all invoices
888
+ * @request GET:/invoices
889
+ * @secure
890
+ */
891
+ findAllInvoices: (query, params = {}) => this.request({
892
+ path: `/invoices`,
893
+ method: "GET",
894
+ query: query,
895
+ secure: true,
896
+ format: "json",
897
+ ...params,
898
+ }),
848
899
  /**
849
900
  * @description Update an existing invoice
850
901
  *
@@ -942,37 +993,55 @@ class Api extends HttpClient {
942
993
  format: "json",
943
994
  ...params,
944
995
  }),
996
+ };
997
+ fees = {
945
998
  /**
946
- * @description Find all invoices in certain organisation
999
+ * @description Return a single fee
947
1000
  *
948
- * @tags invoices
949
- * @name FindAllInvoices
950
- * @summary Find all invoices
951
- * @request GET:/invoices/
1001
+ * @tags fees
1002
+ * @name FindFee
1003
+ * @summary Find fee by ID
1004
+ * @request GET:/fees/{id}
952
1005
  * @secure
953
1006
  */
954
- findAllInvoices: (query, params = {}) => this.request({
955
- path: `/invoices/`,
1007
+ findFee: (id, params = {}) => this.request({
1008
+ path: `/fees/${id}`,
956
1009
  method: "GET",
957
- query: query,
958
1010
  secure: true,
959
1011
  format: "json",
960
1012
  ...params,
961
1013
  }),
962
- };
963
- fees = {
964
1014
  /**
965
- * @description Return a single fee
1015
+ * @description Update an existing fee
966
1016
  *
967
1017
  * @tags fees
968
- * @name FindFee
969
- * @summary Find fee by ID
970
- * @request GET:/fees/{id}
1018
+ * @name UpdateFee
1019
+ * @summary Update an existing fee
1020
+ * @request PUT:/fees/{id}
971
1021
  * @secure
972
1022
  */
973
- findFee: (id, params = {}) => this.request({
1023
+ updateFee: (id, data, params = {}) => this.request({
974
1024
  path: `/fees/${id}`,
1025
+ method: "PUT",
1026
+ body: data,
1027
+ secure: true,
1028
+ type: ContentType.Json,
1029
+ format: "json",
1030
+ ...params,
1031
+ }),
1032
+ /**
1033
+ * @description Find all fees of an organization and filter them
1034
+ *
1035
+ * @tags fees
1036
+ * @name FindAllFees
1037
+ * @summary Find all fees
1038
+ * @request GET:/fees
1039
+ * @secure
1040
+ */
1041
+ findAllFees: (query, params = {}) => this.request({
1042
+ path: `/fees`,
975
1043
  method: "GET",
1044
+ query: query,
976
1045
  secure: true,
977
1046
  format: "json",
978
1047
  ...params,
@@ -997,6 +1066,23 @@ class Api extends HttpClient {
997
1066
  format: "json",
998
1067
  ...params,
999
1068
  }),
1069
+ /**
1070
+ * @description Find all wallets for certain customer
1071
+ *
1072
+ * @tags wallets
1073
+ * @name FindAllWallets
1074
+ * @summary Find wallets
1075
+ * @request GET:/wallets
1076
+ * @secure
1077
+ */
1078
+ findAllWallets: (query, params = {}) => this.request({
1079
+ path: `/wallets`,
1080
+ method: "GET",
1081
+ query: query,
1082
+ secure: true,
1083
+ format: "json",
1084
+ ...params,
1085
+ }),
1000
1086
  /**
1001
1087
  * @description Update an existing wallet
1002
1088
  *
@@ -1047,23 +1133,6 @@ class Api extends HttpClient {
1047
1133
  format: "json",
1048
1134
  ...params,
1049
1135
  }),
1050
- /**
1051
- * @description Find all wallets for certain customer
1052
- *
1053
- * @tags wallets
1054
- * @name FindAllWallets
1055
- * @summary Find wallets
1056
- * @request GET:/wallets/
1057
- * @secure
1058
- */
1059
- findAllWallets: (query, params = {}) => this.request({
1060
- path: `/wallets/`,
1061
- method: "GET",
1062
- query: query,
1063
- secure: true,
1064
- format: "json",
1065
- ...params,
1066
- }),
1067
1136
  /**
1068
1137
  * @description Find all wallet transactions for certain wallet
1069
1138
  *
@@ -1121,6 +1190,23 @@ class Api extends HttpClient {
1121
1190
  format: "json",
1122
1191
  ...params,
1123
1192
  }),
1193
+ /**
1194
+ * @description Find all credit notes in certain organisation
1195
+ *
1196
+ * @tags credit_notes
1197
+ * @name FindAllCreditNotes
1198
+ * @summary Find Credit notes
1199
+ * @request GET:/credit_notes
1200
+ * @secure
1201
+ */
1202
+ findAllCreditNotes: (query, params = {}) => this.request({
1203
+ path: `/credit_notes`,
1204
+ method: "GET",
1205
+ query: query,
1206
+ secure: true,
1207
+ format: "json",
1208
+ ...params,
1209
+ }),
1124
1210
  /**
1125
1211
  * @description Update an existing credit note
1126
1212
  *
@@ -1187,23 +1273,6 @@ class Api extends HttpClient {
1187
1273
  format: "json",
1188
1274
  ...params,
1189
1275
  }),
1190
- /**
1191
- * @description Find all credit notes in certain organisation
1192
- *
1193
- * @tags credit_notes
1194
- * @name FindAllCreditNotes
1195
- * @summary Find Credit notes
1196
- * @request GET:/credit_notes/
1197
- * @secure
1198
- */
1199
- findAllCreditNotes: (query, params = {}) => this.request({
1200
- path: `/credit_notes/`,
1201
- method: "GET",
1202
- query: query,
1203
- secure: true,
1204
- format: "json",
1205
- ...params,
1206
- }),
1207
1276
  };
1208
1277
  }
1209
1278
  exports.Api = Api;