lago-javascript-client 1.31.0 → 1.33.0

package/esm/openapi/client.js

@@ -470,6 +470,23 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Returns usages.
+         *
+         * @tags analytics
+         * @name FindAllUsages
+         * @summary List usage
+         * @request GET:/analytics/usage
+         * @secure
+         */
+        findAllUsages: (query, params = {}) => this.request({
+            path: `/analytics/usage`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     appliedCoupons = {
         /**
@@ -613,6 +630,109 @@ export class Api extends HttpClient {
             ...params,
         }),
     };
+    features = {
+        /**
+         * @description This endpoint creates a new feature representing an entitlement component of your application.
+         *
+         * @tags features
+         * @name CreateFeature
+         * @summary Create a feature
+         * @request POST:/features
+         * @secure
+         */
+        createFeature: (data, params = {}) => this.request({
+            path: `/features`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves all existing features that represent entitlement components of your application.
+         *
+         * @tags features
+         * @name FindAllFeatures
+         * @summary List all features
+         * @request GET:/features
+         * @secure
+         */
+        findAllFeatures: (query, params = {}) => this.request({
+            path: `/features`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint updates an existing feature representing an entitlement component of your application.
+         *
+         * @tags features
+         * @name UpdateFeature
+         * @summary Update a feature
+         * @request PUT:/features/{code}
+         * @secure
+         */
+        updateFeature: (code, data, params = {}) => this.request({
+            path: `/features/${code}`,
+            method: "PUT",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint deletes an existing feature representing an entitlement component of your application. Deleting a feature will remove it from all plans and subscriptions.
+         *
+         * @tags features
+         * @name DestroyFeature
+         * @summary Delete a feature
+         * @request DELETE:/features/{code}
+         * @secure
+         */
+        destroyFeature: (code, params = {}) => this.request({
+            path: `/features/${code}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves an existing feature that represents an entitlement component of your application. The feature is identified by its unique code.
+         *
+         * @tags features
+         * @name FindFeature
+         * @summary Retrieve a feature
+         * @request GET:/features/{code}
+         * @secure
+         */
+        findFeature: (code, params = {}) => this.request({
+            path: `/features/${code}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Delete privilege from 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.
+         * @request DELETE:/features/{code}/privileges/{privilege_code}
+         * @secure
+         */
+        deleteFeaturePrivilege: (code, privilegeCode, params = {}) => this.request({
+            path: `/features/${code}/privileges/${privilegeCode}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     coupons = {
         /**
          * @description This endpoint is used to create a coupon that can be then attached to a customer to create a discount.
@@ -938,6 +1058,23 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint enables the retrieval of the usage-based billing data for a customer within the current period. It also returns the projected usage for the current period based on the current usage.
+         *
+         * @tags customers
+         * @name FindCustomerProjectedUsage
+         * @summary Retrieve customer current and projected usage
+         * @request GET:/customers/{external_customer_id}/projected_usage
+         * @secure
+         */
+        findCustomerProjectedUsage: (externalCustomerId, query, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}/projected_usage`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.
          *
@@ -1023,6 +1160,7 @@ export class Api extends HttpClient {
             body: data,
             secure: true,
             type: ContentType.Json,
+            format: "json",
             ...params,
         }),
         /**
@@ -1043,6 +1181,42 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges
+         *
+         * @tags events
+         * @name EventEstimateInstantFees
+         * @summary Estimate instant fees for a pay in advance charge
+         * @request POST:/events/estimate_instant_fees
+         * @secure
+         */
+        eventEstimateInstantFees: (data, params = {}) => this.request({
+            path: `/events/estimate_instant_fees`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges
+         *
+         * @tags events
+         * @name EventBatchEstimateInstantFees
+         * @summary Batch estimate instant fees for a pay in advance charge
+         * @request POST:/events/batch_estimate_instant_fees
+         * @secure
+         */
+        eventBatchEstimateInstantFees: (data, params = {}) => this.request({
+            path: `/events/batch_estimate_instant_fees`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.
          *
@@ -1438,6 +1612,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint retrieves a specific payment request by its ID.
+         *
+         * @tags payment_requests
+         * @name FindPaymentRequest
+         * @summary Retrieve a payment request
+         * @request GET:/payment_requests/{lago_id}
+         * @secure
+         */
+        findPaymentRequest: (lagoId, params = {}) => this.request({
+            path: `/payment_requests/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     payments = {
         /**
@@ -1578,6 +1768,106 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint creates a new entitlement by adding a feature to a plan. The feature must exist and all privileges must be valid for the feature.
+         *
+         * @tags entitlements
+         * @name CreateEntitlement
+         * @summary Create an entitlement
+         * @request POST:/plans/{code}/entitlements
+         * @secure
+         */
+        createEntitlement: (code, data, params = {}) => this.request({
+            path: `/plans/${code}/entitlements`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves all entitlements for a specific plan.
+         *
+         * @tags entitlements
+         * @name FindAllEntitlements
+         * @summary List all entitlements
+         * @request GET:/plans/{code}/entitlements
+         * @secure
+         */
+        findAllEntitlements: (code, params = {}) => this.request({
+            path: `/plans/${code}/entitlements`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint updates an existing entitlement by modifying privilege values. Notice that the update is partial. All new privileges or features are added. If there is already a value, it's overridden. All feature and privileges not part of the payload are ignored. To remove privileges or feature, use the delete endpoints. All privileges must be valid for the feature.
+         *
+         * @tags entitlements
+         * @name UpdateEntitlement
+         * @summary Partial update of an entitlement
+         * @request PATCH:/plans/{code}/entitlements
+         * @secure
+         */
+        updateEntitlement: (code, data, params = {}) => this.request({
+            path: `/plans/${code}/entitlements`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves a specific entitlement for a plan.
+         *
+         * @tags entitlements
+         * @name FindEntitlement
+         * @summary Retrieve an entitlement
+         * @request GET:/plans/{code}/entitlements/{feature_code}
+         * @secure
+         */
+        findEntitlement: (code, featureCode, params = {}) => this.request({
+            path: `/plans/${code}/entitlements/${featureCode}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint deletes an existing entitlement by removing the feature from the plan.
+         *
+         * @tags entitlements
+         * @name DestroyEntitlement
+         * @summary Delete an entitlement
+         * @request DELETE:/plans/{code}/entitlements/{feature_code}
+         * @secure
+         */
+        destroyEntitlement: (code, featureCode, params = {}) => this.request({
+            path: `/plans/${code}/entitlements/${featureCode}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes a specific privilege and its value from an entitlement. The privilege remains untouched on the original feature.
+         *
+         * @tags entitlements
+         * @name RemoveEntitlementPrivilege
+         * @summary Remove a privilege from an entitlement
+         * @request DELETE:/plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}
+         * @secure
+         */
+        removeEntitlementPrivilege: (code, featureCode, privilegeCode, params = {}) => this.request({
+            path: `/plans/${code}/entitlements/${featureCode}/privileges/${privilegeCode}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     subscriptions = {
         /**
@@ -1785,6 +2075,72 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint retrieves all entitlements for a specific subscription, including both plan entitlements and any subscription-specific overrides.
+         *
+         * @tags entitlements
+         * @name FindAllSubscriptionEntitlements
+         * @summary List all subscription entitlements
+         * @request GET:/subscriptions/{external_id}/entitlements
+         * @secure
+         */
+        findAllSubscriptionEntitlements: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/entitlements`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint allows partial updates to subscription entitlements. New entitlements are added, provided values are overridden, but entitlements not included in the payload are ignored.
+         *
+         * @tags entitlements
+         * @name UpdateSubscriptionEntitlements
+         * @summary Update subscription entitlements
+         * @request PATCH:/subscriptions/{external_id}/entitlements
+         * @secure
+         */
+        updateSubscriptionEntitlements: (externalId, data, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/entitlements`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
+         *
+         * @tags entitlements
+         * @name DestroySubscriptionEntitlement
+         * @summary Remove an entitlement from a subscription
+         * @request DELETE:/subscriptions/{external_id}/entitlements/{feature_code}
+         * @secure
+         */
+        destroySubscriptionEntitlement: (externalId, featureCode, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/entitlements/${featureCode}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
+         *
+         * @tags entitlements
+         * @name DestroySubscriptionEntitlementPrivilege
+         * @summary Remove a privilege from a subscription entitlement override
+         * @request DELETE:/subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}
+         * @secure
+         */
+        destroySubscriptionEntitlementPrivilege: (externalId, featureCode, privilegeCode, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/entitlements/${featureCode}/privileges/${privilegeCode}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     taxes = {
         /**

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "name": "lago-javascript-client",
   "sideEffects": false,
-  "version": "v1.31.0",
+  "version": "v1.33.0",
   "description": "Lago JavaScript API Client",
   "repository": {
     "type": "git",