lago-javascript-client 1.53.0 → 1.55.0

package/esm/openapi/client.js

@@ -156,7 +156,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.53.0
+ * @version 1.55.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -445,7 +445,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to list MRR.
+         * @description Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle: - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued. - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing). - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
          *
          * @tags analytics
          * @name FindAllMrrs
@@ -725,11 +725,11 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.
+         * @description This endpoint deletes a privilege from a feature. Deleting a privilege removes it from all plans and subscriptions.
          *
          * @tags features
          * @name DeleteFeaturePrivilege
-         * @summary Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.
+         * @summary Delete a privilege
          * @request DELETE:/features/{code}/privileges/{privilege_code}
          * @secure
          */
@@ -1381,9 +1381,10 @@ export class Api extends HttpClient {
          * @request GET:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
          * @secure
          */
-        getCustomerWalletAlerts: (externalCustomerId, walletCode, params = {}) => this.request({
+        getCustomerWalletAlerts: (externalCustomerId, walletCode, query, params = {}) => this.request({
             path: `/customers/${externalCustomerId}/wallets/${walletCode}/alerts`,
             method: "GET",
+            query: query,
             secure: true,
             format: "json",
             ...params,
@@ -1556,7 +1557,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description Use the payment method as default when not selected a payment method
+         * @description This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset.
          *
          * @tags payment_methods
          * @name PaymentMethodSetAsDefault
@@ -2438,7 +2439,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateEntitlement
@@ -3199,7 +3200,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
+         * @description This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
          *
          * @tags entitlements
          * @name UpdateSubscriptionEntitlements
@@ -3218,7 +3219,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
+         * @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
          *
          * @tags entitlements
          * @name DestroySubscriptionEntitlement
@@ -3235,7 +3236,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
+         * @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
          *
          * @tags entitlements
          * @name DestroySubscriptionEntitlementPrivilege