lago-javascript-client 1.28.1 → 1.31.0

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.28.1
+ * @version 1.31.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -231,6 +231,41 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    activityLogs = {
+        /**
+         * @description This endpoint retrieves all existing activity logs that represent actions performed on application resources.
+         *
+         * @tags activity_logs
+         * @name FindAllActivityLogs
+         * @summary List all activity logs
+         * @request GET:/activity_logs
+         * @secure
+         */
+        findAllActivityLogs: (query, params = {}) => this.request({
+            path: `/activity_logs`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves an existing activity log that represents an action performed on some resource. The activity log is identified by its unique activity_id.
+         *
+         * @tags activity_logs
+         * @name FindActivityLog
+         * @summary Retrieve an activity log
+         * @request GET:/activity_logs/{activity_id}
+         * @secure
+         */
+        findActivityLog: (activityId, params = {}) => this.request({
+            path: `/activity_logs/${activityId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     addOns = {
         /**
          * @description This endpoint is used to create an add-on that can be then attached to a one-off invoice.
@@ -318,6 +353,41 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    apiLogs = {
+        /**
+         * @description This endpoint retrieves all existing api logs that represent requests performed to Lago's API.
+         *
+         * @tags api_logs
+         * @name FindAllApiLogs
+         * @summary List all api logs
+         * @request GET:/api_logs
+         * @secure
+         */
+        findAllApiLogs: (query, params = {}) => this.request({
+            path: `/api_logs`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves an existing api log that represents a request made to the API. The api log is identified by its unique request_id.
+         *
+         * @tags api_logs
+         * @name FindApiLog
+         * @summary Retrieve an api log
+         * @request GET:/api_logs/{request_id}
+         * @secure
+         */
+        findApiLog: (requestId, params = {}) => this.request({
+            path: `/api_logs/${requestId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...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.
@@ -1263,7 +1333,7 @@ class Api extends HttpClient {
             ...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`.
+         * @description This endpoint is used for voiding an invoice. • When no body parameters are provided, the invoice can be voided only if it is in a `finalized` status and its payment status is NOT `succeeded`. • When `generate_credit_note` is provided (optionally with `refund_amount` and/or `credit_amount`), this validation is bypassed: the invoice is forcibly voided and a credit note is generated. If the specified refund/credit amounts do not cover the full invoice total, the remainder is issued on a second credit note that is created and immediately voided.
          *
          * @tags invoices
          * @name VoidInvoice
@@ -1271,10 +1341,12 @@ class Api extends HttpClient {
          * @request POST:/invoices/{lago_id}/void
          * @secure
          */
-        voidInvoice: (lagoId, params = {}) => this.request({
+        voidInvoice: (lagoId, data, params = {}) => this.request({
             path: `/invoices/${lagoId}/void`,
             method: "POST",
+            body: data,
             secure: true,
+            type: ContentType.Json,
             format: "json",
             ...params,
         }),
@@ -1556,9 +1628,10 @@ class Api extends HttpClient {
          * @request GET:/subscriptions/{external_id}
          * @secure
          */
-        findSubscription: (externalId, params = {}) => this.request({
+        findSubscription: (externalId, query, params = {}) => this.request({
             path: `/subscriptions/${externalId}`,
             method: "GET",
+            query: query,
             secure: true,
             format: "json",
             ...params,
@@ -1603,7 +1676,7 @@ class Api extends HttpClient {
          *
          * @tags subscriptions
          * @name GetSubscriptionLifetimeUsage
-         * @summary Retrive subscription lifetime usage
+         * @summary Retrieve subscription lifetime usage
          * @request GET:/subscriptions/{external_id}/lifetime_usage
          * @secure
          */
@@ -1632,6 +1705,90 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint enables the retrieval of all alerts for a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionAlerts
+         * @summary List subscription alerts
+         * @request GET:/subscriptions/{external_id}/alerts
+         * @secure
+         */
+        getSubscriptionAlerts: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/alerts`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint allows you to create a new alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name CreateSubscriptionAlert
+         * @summary Create a subscription alert
+         * @request POST:/subscriptions/{external_id}/alerts
+         * @secure
+         */
+        createSubscriptionAlert: (externalId, data, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/alerts`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint enables the retrieval of a specific alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name GetSubscriptionAlert
+         * @summary Retrieve a subscription alert
+         * @request GET:/subscriptions/{external_id}/alerts/{code}
+         * @secure
+         */
+        getSubscriptionAlert: (externalId, code, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/alerts/${code}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint allows you to update an existing alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name UpdateSubscriptionAlert
+         * @summary Update a subscription alert
+         * @request PUT:/subscriptions/{external_id}/alerts/{code}
+         * @secure
+         */
+        updateSubscriptionAlert: (externalId, code, data, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/alerts/${code}`,
+            method: "PUT",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint allows you to delete an existing alert for a subscription.
+         *
+         * @tags subscriptions
+         * @name DeleteSubscriptionAlert
+         * @summary Delete a subscription alert
+         * @request DELETE:/subscriptions/{external_id}/alerts/{code}
+         * @secure
+         */
+        deleteSubscriptionAlert: (externalId, code, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/alerts/${code}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     taxes = {
         /**