lago-javascript-client 0.49.0-beta → 0.53.0-beta

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 0.49.0-beta
+ * @version 0.53.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -248,6 +248,76 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    analytics = {
+        /**
+         * @description Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.
+         *
+         * @tags analytics
+         * @name FindAllGrossRevenues
+         * @summary List gross revenue
+         * @request GET:/analytics/gross_revenue
+         * @secure
+         */
+        findAllGrossRevenues: (query, params = {}) => this.request({
+            path: `/analytics/gross_revenue`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
+         *
+         * @tags analytics
+         * @name FindAllInvoiceCollections
+         * @summary List of finalized invoices
+         * @request GET:/analytics/invoice_collection
+         * @secure
+         */
+        findAllInvoiceCollections: (query, params = {}) => this.request({
+            path: `/analytics/invoice_collection`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
+         *
+         * @tags analytics
+         * @name FindAllInvoicedUsages
+         * @summary List usage revenue
+         * @request GET:/analytics/invoiced_usage
+         * @secure
+         */
+        findAllInvoicedUsages: (query, params = {}) => this.request({
+            path: `/analytics/invoiced_usage`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list MRR.
+         *
+         * @tags analytics
+         * @name FindAllMrrs
+         * @summary List MRR
+         * @request GET:/analytics/mrr
+         * @secure
+         */
+        findAllMrrs: (query, params = {}) => this.request({
+            path: `/analytics/mrr`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     appliedCoupons = {
         /**
          * @description This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
@@ -562,6 +632,24 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint allows you to retrieve amounts for a new credit note creation.
+         *
+         * @tags credit_notes
+         * @name EstimateCreditNote
+         * @summary Estimate amounts for a new credit note
+         * @request POST:/credit_notes/estimate
+         * @secure
+         */
+        estimateCreditNote: (data, params = {}) => this.request({
+            path: `/credit_notes/estimate`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint voids an existing credit note.
          *
@@ -713,6 +801,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint regenerates the Payment Provider Checkout URL of a Customer.
+         *
+         * @tags customers
+         * @name GenerateCustomerCheckoutUrl
+         * @summary Generate a Customer Payment Provider Checkout URL
+         * @request POST:/customers/{external_customer_id}/checkout_url
+         * @secure
+         */
+        generateCustomerCheckoutUrl: (externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}/checkout_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     events = {
         /**
@@ -730,6 +834,7 @@ class Api extends HttpClient {
             body: data,
             secure: true,
             type: ContentType.Json,
+            format: "json",
             ...params,
         }),
         /**
@@ -971,6 +1076,22 @@ class Api extends HttpClient {
             secure: true,
             ...params,
         }),
+        /**
+         * @description This endpoint is used for voiding an invoice. You can void an invoice only when it's in a `finalized` status, and the payment status is not `succeeded`.
+         *
+         * @tags invoices
+         * @name VoidInvoice
+         * @summary Void an invoice
+         * @request POST:/invoices/{lago_id}/void
+         * @secure
+         */
+        voidInvoice: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/void`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     organizations = {
         /**