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.
@@ -175,6 +175,23 @@ export class Api extends HttpClient {
175
175
  format: "json",
176
176
  ...params,
177
177
  }),
178
+ /**
179
+ * @description Find all billable metrics in certain organisation
180
+ *
181
+ * @tags billable_metrics
182
+ * @name FindAllBillableMetrics
183
+ * @summary Find Billable metrics
184
+ * @request GET:/billable_metrics
185
+ * @secure
186
+ */
187
+ findAllBillableMetrics: (query, params = {}) => this.request({
188
+ path: `/billable_metrics`,
189
+ method: "GET",
190
+ query: query,
191
+ secure: true,
192
+ format: "json",
193
+ ...params,
194
+ }),
178
195
  /**
179
196
  * @description Update an existing billable metric by code
180
197
  *
@@ -225,23 +242,6 @@ export class Api extends HttpClient {
225
242
  format: "json",
226
243
  ...params,
227
244
  }),
228
- /**
229
- * @description Find all billable metrics in certain organisation
230
- *
231
- * @tags billable_metrics
232
- * @name FindAllBillableMetrics
233
- * @summary Find Billable metrics
234
- * @request GET:/billable_metrics/
235
- * @secure
236
- */
237
- findAllBillableMetrics: (query, params = {}) => this.request({
238
- path: `/billable_metrics/`,
239
- method: "GET",
240
- query: query,
241
- secure: true,
242
- format: "json",
243
- ...params,
244
- }),
245
245
  /**
246
246
  * @description Find all billable metric groups in certain organisation
247
247
  *
@@ -279,6 +279,23 @@ export class Api extends HttpClient {
279
279
  format: "json",
280
280
  ...params,
281
281
  }),
282
+ /**
283
+ * @description Find all add-ons in certain organisation
284
+ *
285
+ * @tags add_ons
286
+ * @name FindAllAddOns
287
+ * @summary Find add-ons
288
+ * @request GET:/add_ons
289
+ * @secure
290
+ */
291
+ findAllAddOns: (query, params = {}) => this.request({
292
+ path: `/add_ons`,
293
+ method: "GET",
294
+ query: query,
295
+ secure: true,
296
+ format: "json",
297
+ ...params,
298
+ }),
282
299
  /**
283
300
  * @description Update an existing add-on by code
284
301
  *
@@ -329,23 +346,6 @@ export class Api extends HttpClient {
329
346
  format: "json",
330
347
  ...params,
331
348
  }),
332
- /**
333
- * @description Find all add-ons in certain organisation
334
- *
335
- * @tags add_ons
336
- * @name FindAllAddOns
337
- * @summary Find add-ons
338
- * @request GET:/add_ons/
339
- * @secure
340
- */
341
- findAllAddOns: (query, params = {}) => this.request({
342
- path: `/add_ons/`,
343
- method: "GET",
344
- query: query,
345
- secure: true,
346
- format: "json",
347
- ...params,
348
- }),
349
349
  };
350
350
  appliedAddOns = {
351
351
  /**
@@ -386,6 +386,23 @@ export class Api extends HttpClient {
386
386
  format: "json",
387
387
  ...params,
388
388
  }),
389
+ /**
390
+ * @description Find all coupons in certain organisation
391
+ *
392
+ * @tags coupons
393
+ * @name FindAllCoupons
394
+ * @summary Find Coupons
395
+ * @request GET:/coupons
396
+ * @secure
397
+ */
398
+ findAllCoupons: (query, params = {}) => this.request({
399
+ path: `/coupons`,
400
+ method: "GET",
401
+ query: query,
402
+ secure: true,
403
+ format: "json",
404
+ ...params,
405
+ }),
389
406
  /**
390
407
  * @description Update an existing coupon by code
391
408
  *
@@ -436,23 +453,6 @@ export class Api extends HttpClient {
436
453
  format: "json",
437
454
  ...params,
438
455
  }),
439
- /**
440
- * @description Find all coupons in certain organisation
441
- *
442
- * @tags coupons
443
- * @name FindAllCoupons
444
- * @summary Find Coupons
445
- * @request GET:/coupons/
446
- * @secure
447
- */
448
- findAllCoupons: (query, params = {}) => this.request({
449
- path: `/coupons/`,
450
- method: "GET",
451
- query: query,
452
- secure: true,
453
- format: "json",
454
- ...params,
455
- }),
456
456
  };
457
457
  appliedCoupons = {
458
458
  /**
@@ -479,11 +479,11 @@ export class Api extends HttpClient {
479
479
  * @tags coupons
480
480
  * @name FindAllAppliedCoupons
481
481
  * @summary Find Applied Coupons
482
- * @request GET:/applied_coupons/
482
+ * @request GET:/applied_coupons
483
483
  * @secure
484
484
  */
485
485
  findAllAppliedCoupons: (query, params = {}) => this.request({
486
- path: `/applied_coupons/`,
486
+ path: `/applied_coupons`,
487
487
  method: "GET",
488
488
  query: query,
489
489
  secure: true,
@@ -498,11 +498,11 @@ export class Api extends HttpClient {
498
498
  * @tags organizations
499
499
  * @name UpdateOrganization
500
500
  * @summary Update an existing Organization
501
- * @request PUT:/organizations/
501
+ * @request PUT:/organizations
502
502
  * @secure
503
503
  */
504
504
  updateOrganization: (data, params = {}) => this.request({
505
- path: `/organizations/`,
505
+ path: `/organizations`,
506
506
  method: "PUT",
507
507
  body: data,
508
508
  secure: true,
@@ -530,6 +530,23 @@ export class Api extends HttpClient {
530
530
  format: "json",
531
531
  ...params,
532
532
  }),
533
+ /**
534
+ * @description Find all customers in certain organisation
535
+ *
536
+ * @tags customers
537
+ * @name FindAllCustomers
538
+ * @summary Find customers
539
+ * @request GET:/customers
540
+ * @secure
541
+ */
542
+ findAllCustomers: (query, params = {}) => this.request({
543
+ path: `/customers`,
544
+ method: "GET",
545
+ query: query,
546
+ secure: true,
547
+ format: "json",
548
+ ...params,
549
+ }),
533
550
  /**
534
551
  * @description Return a single customer
535
552
  *
@@ -580,34 +597,33 @@ export class Api extends HttpClient {
580
597
  ...params,
581
598
  }),
582
599
  /**
583
- * @description Delete customer's appplied coupon
600
+ * @description Get customer portal URL
584
601
  *
585
602
  * @tags customers
586
- * @name DeleteAppliedCoupon
587
- * @summary Delete customer's appplied coupon
588
- * @request DELETE:/customers/{customer_external_id}/applied_coupons/{applied_coupon_id}
603
+ * @name GetCustomerPortalUrl
604
+ * @summary Get customer portal URL
605
+ * @request GET:/customers/{customer_external_id}/portal_url
589
606
  * @secure
590
607
  */
591
- deleteAppliedCoupon: (customerExternalId, appliedCouponId, params = {}) => this.request({
592
- path: `/customers/${customerExternalId}/applied_coupons/${appliedCouponId}`,
593
- method: "DELETE",
608
+ getCustomerPortalUrl: (customerExternalId, params = {}) => this.request({
609
+ path: `/customers/${customerExternalId}/portal_url`,
610
+ method: "GET",
594
611
  secure: true,
595
612
  format: "json",
596
613
  ...params,
597
614
  }),
598
615
  /**
599
- * @description Find all customers in certain organisation
616
+ * @description Delete customer's appplied coupon
600
617
  *
601
618
  * @tags customers
602
- * @name FindAllCustomers
603
- * @summary Find customers
604
- * @request GET:/customers/
619
+ * @name DeleteAppliedCoupon
620
+ * @summary Delete customer's appplied coupon
621
+ * @request DELETE:/customers/{customer_external_id}/applied_coupons/{applied_coupon_id}
605
622
  * @secure
606
623
  */
607
- findAllCustomers: (query, params = {}) => this.request({
608
- path: `/customers/`,
609
- method: "GET",
610
- query: query,
624
+ deleteAppliedCoupon: (customerExternalId, appliedCouponId, params = {}) => this.request({
625
+ path: `/customers/${customerExternalId}/applied_coupons/${appliedCouponId}`,
626
+ method: "DELETE",
611
627
  secure: true,
612
628
  format: "json",
613
629
  ...params,
@@ -664,6 +680,24 @@ export class Api extends HttpClient {
664
680
  format: "json",
665
681
  ...params,
666
682
  }),
683
+ /**
684
+ * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple instant charges
685
+ *
686
+ * @tags events
687
+ * @name EventEstimateFees
688
+ * @summary Estimate fees for an instant charge
689
+ * @request POST:/events/estimate_fees
690
+ * @secure
691
+ */
692
+ eventEstimateFees: (data, params = {}) => this.request({
693
+ path: `/events/estimate_fees`,
694
+ method: "POST",
695
+ body: data,
696
+ secure: true,
697
+ type: ContentType.Json,
698
+ format: "json",
699
+ ...params,
700
+ }),
667
701
  };
668
702
  plans = {
669
703
  /**
@@ -684,6 +718,23 @@ export class Api extends HttpClient {
684
718
  format: "json",
685
719
  ...params,
686
720
  }),
721
+ /**
722
+ * @description Find all plans in certain organisation
723
+ *
724
+ * @tags plans
725
+ * @name FindAllPlans
726
+ * @summary Find plans
727
+ * @request GET:/plans
728
+ * @secure
729
+ */
730
+ findAllPlans: (query, params = {}) => this.request({
731
+ path: `/plans`,
732
+ method: "GET",
733
+ query: query,
734
+ secure: true,
735
+ format: "json",
736
+ ...params,
737
+ }),
687
738
  /**
688
739
  * @description Update an existing plan by code
689
740
  *
@@ -734,23 +785,6 @@ export class Api extends HttpClient {
734
785
  format: "json",
735
786
  ...params,
736
787
  }),
737
- /**
738
- * @description Find all plans in certain organisation
739
- *
740
- * @tags plans
741
- * @name FindAllPlans
742
- * @summary Find plans
743
- * @request GET:/plans/
744
- * @secure
745
- */
746
- findAllPlans: (query, params = {}) => this.request({
747
- path: `/plans/`,
748
- method: "GET",
749
- query: query,
750
- secure: true,
751
- format: "json",
752
- ...params,
753
- }),
754
788
  };
755
789
  subscriptions = {
756
790
  /**
@@ -771,6 +805,23 @@ export class Api extends HttpClient {
771
805
  format: "json",
772
806
  ...params,
773
807
  }),
808
+ /**
809
+ * @description Find all suscriptions for certain customer
810
+ *
811
+ * @tags subscriptions
812
+ * @name FindAllSubscriptions
813
+ * @summary Find subscriptions
814
+ * @request GET:/subscriptions
815
+ * @secure
816
+ */
817
+ findAllSubscriptions: (query, params = {}) => this.request({
818
+ path: `/subscriptions`,
819
+ method: "GET",
820
+ query: query,
821
+ secure: true,
822
+ format: "json",
823
+ ...params,
824
+ }),
774
825
  /**
775
826
  * @description Update an existing subscription by external ID
776
827
  *
@@ -805,23 +856,6 @@ export class Api extends HttpClient {
805
856
  format: "json",
806
857
  ...params,
807
858
  }),
808
- /**
809
- * @description Find all suscriptions for certain customer
810
- *
811
- * @tags subscriptions
812
- * @name FindAllSubscriptions
813
- * @summary Find subscriptions
814
- * @request GET:/subscriptions/
815
- * @secure
816
- */
817
- findAllSubscriptions: (query, params = {}) => this.request({
818
- path: `/subscriptions/`,
819
- method: "GET",
820
- query: query,
821
- secure: true,
822
- format: "json",
823
- ...params,
824
- }),
825
859
  };
826
860
  webhooks = {
827
861
  /**
@@ -830,17 +864,34 @@ export class Api extends HttpClient {
830
864
  * @tags webhooks
831
865
  * @name FetchPublicKey
832
866
  * @summary Fetch webhook public key
833
- * @request GET:/webhooks/public_key/
867
+ * @request GET:/webhooks/public_key
834
868
  * @secure
835
869
  */
836
870
  fetchPublicKey: (params = {}) => this.request({
837
- path: `/webhooks/public_key/`,
871
+ path: `/webhooks/public_key`,
838
872
  method: "GET",
839
873
  secure: true,
840
874
  ...params,
841
875
  }),
842
876
  };
843
877
  invoices = {
878
+ /**
879
+ * @description Find all invoices in certain organisation
880
+ *
881
+ * @tags invoices
882
+ * @name FindAllInvoices
883
+ * @summary Find all invoices
884
+ * @request GET:/invoices
885
+ * @secure
886
+ */
887
+ findAllInvoices: (query, params = {}) => this.request({
888
+ path: `/invoices`,
889
+ method: "GET",
890
+ query: query,
891
+ secure: true,
892
+ format: "json",
893
+ ...params,
894
+ }),
844
895
  /**
845
896
  * @description Update an existing invoice
846
897
  *
@@ -938,37 +989,55 @@ export class Api extends HttpClient {
938
989
  format: "json",
939
990
  ...params,
940
991
  }),
992
+ };
993
+ fees = {
941
994
  /**
942
- * @description Find all invoices in certain organisation
995
+ * @description Return a single fee
943
996
  *
944
- * @tags invoices
945
- * @name FindAllInvoices
946
- * @summary Find all invoices
947
- * @request GET:/invoices/
997
+ * @tags fees
998
+ * @name FindFee
999
+ * @summary Find fee by ID
1000
+ * @request GET:/fees/{id}
948
1001
  * @secure
949
1002
  */
950
- findAllInvoices: (query, params = {}) => this.request({
951
- path: `/invoices/`,
1003
+ findFee: (id, params = {}) => this.request({
1004
+ path: `/fees/${id}`,
952
1005
  method: "GET",
953
- query: query,
954
1006
  secure: true,
955
1007
  format: "json",
956
1008
  ...params,
957
1009
  }),
958
- };
959
- fees = {
960
1010
  /**
961
- * @description Return a single fee
1011
+ * @description Update an existing fee
962
1012
  *
963
1013
  * @tags fees
964
- * @name FindFee
965
- * @summary Find fee by ID
966
- * @request GET:/fees/{id}
1014
+ * @name UpdateFee
1015
+ * @summary Update an existing fee
1016
+ * @request PUT:/fees/{id}
967
1017
  * @secure
968
1018
  */
969
- findFee: (id, params = {}) => this.request({
1019
+ updateFee: (id, data, params = {}) => this.request({
970
1020
  path: `/fees/${id}`,
1021
+ method: "PUT",
1022
+ body: data,
1023
+ secure: true,
1024
+ type: ContentType.Json,
1025
+ format: "json",
1026
+ ...params,
1027
+ }),
1028
+ /**
1029
+ * @description Find all fees of an organization and filter them
1030
+ *
1031
+ * @tags fees
1032
+ * @name FindAllFees
1033
+ * @summary Find all fees
1034
+ * @request GET:/fees
1035
+ * @secure
1036
+ */
1037
+ findAllFees: (query, params = {}) => this.request({
1038
+ path: `/fees`,
971
1039
  method: "GET",
1040
+ query: query,
972
1041
  secure: true,
973
1042
  format: "json",
974
1043
  ...params,
@@ -993,6 +1062,23 @@ export class Api extends HttpClient {
993
1062
  format: "json",
994
1063
  ...params,
995
1064
  }),
1065
+ /**
1066
+ * @description Find all wallets for certain customer
1067
+ *
1068
+ * @tags wallets
1069
+ * @name FindAllWallets
1070
+ * @summary Find wallets
1071
+ * @request GET:/wallets
1072
+ * @secure
1073
+ */
1074
+ findAllWallets: (query, params = {}) => this.request({
1075
+ path: `/wallets`,
1076
+ method: "GET",
1077
+ query: query,
1078
+ secure: true,
1079
+ format: "json",
1080
+ ...params,
1081
+ }),
996
1082
  /**
997
1083
  * @description Update an existing wallet
998
1084
  *
@@ -1043,23 +1129,6 @@ export class Api extends HttpClient {
1043
1129
  format: "json",
1044
1130
  ...params,
1045
1131
  }),
1046
- /**
1047
- * @description Find all wallets for certain customer
1048
- *
1049
- * @tags wallets
1050
- * @name FindAllWallets
1051
- * @summary Find wallets
1052
- * @request GET:/wallets/
1053
- * @secure
1054
- */
1055
- findAllWallets: (query, params = {}) => this.request({
1056
- path: `/wallets/`,
1057
- method: "GET",
1058
- query: query,
1059
- secure: true,
1060
- format: "json",
1061
- ...params,
1062
- }),
1063
1132
  /**
1064
1133
  * @description Find all wallet transactions for certain wallet
1065
1134
  *
@@ -1117,6 +1186,23 @@ export class Api extends HttpClient {
1117
1186
  format: "json",
1118
1187
  ...params,
1119
1188
  }),
1189
+ /**
1190
+ * @description Find all credit notes in certain organisation
1191
+ *
1192
+ * @tags credit_notes
1193
+ * @name FindAllCreditNotes
1194
+ * @summary Find Credit notes
1195
+ * @request GET:/credit_notes
1196
+ * @secure
1197
+ */
1198
+ findAllCreditNotes: (query, params = {}) => this.request({
1199
+ path: `/credit_notes`,
1200
+ method: "GET",
1201
+ query: query,
1202
+ secure: true,
1203
+ format: "json",
1204
+ ...params,
1205
+ }),
1120
1206
  /**
1121
1207
  * @description Update an existing credit note
1122
1208
  *
@@ -1183,22 +1269,5 @@ export class Api extends HttpClient {
1183
1269
  format: "json",
1184
1270
  ...params,
1185
1271
  }),
1186
- /**
1187
- * @description Find all credit notes in certain organisation
1188
- *
1189
- * @tags credit_notes
1190
- * @name FindAllCreditNotes
1191
- * @summary Find Credit notes
1192
- * @request GET:/credit_notes/
1193
- * @secure
1194
- */
1195
- findAllCreditNotes: (query, params = {}) => this.request({
1196
- path: `/credit_notes/`,
1197
- method: "GET",
1198
- query: query,
1199
- secure: true,
1200
- format: "json",
1201
- ...params,
1202
- }),
1203
1272
  };
1204
1273
  }
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "types": "./types/mod.d.ts",
5
5
  "name": "lago-javascript-client",
6
6
  "sideEffects": false,
7
- "version": "v0.26.1-beta",
7
+ "version": "v0.27.1-beta",
8
8
  "description": "Lago JavaScript API Client",
9
9
  "repository": {
10
10
  "type": "git",