lago-javascript-client 1.36.0 → 1.43.0

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.36.0
+ * @version 1.42.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -944,6 +944,74 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint replaces all existing metadata on a credit note with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
+         *
+         * @tags credit_notes
+         * @name ReplaceCreditNoteMetadata
+         * @summary Replace credit note metadata
+         * @request POST:/credit_notes/{lago_id}/metadata
+         * @secure
+         */
+        replaceCreditNoteMetadata: (lagoId, data, params = {}) => this.request({
+            path: `/credit_notes/${lagoId}/metadata`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint merges the provided metadata with existing metadata on the credit note. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
+         *
+         * @tags credit_notes
+         * @name MergeCreditNoteMetadata
+         * @summary Merge credit note metadata
+         * @request PATCH:/credit_notes/{lago_id}/metadata
+         * @secure
+         */
+        mergeCreditNoteMetadata: (lagoId, data, params = {}) => this.request({
+            path: `/credit_notes/${lagoId}/metadata`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes all metadata from a credit note.
+         *
+         * @tags credit_notes
+         * @name DeleteAllCreditNoteMetadata
+         * @summary Delete all credit note metadata
+         * @request DELETE:/credit_notes/{lago_id}/metadata
+         * @secure
+         */
+        deleteAllCreditNoteMetadata: (lagoId, params = {}) => this.request({
+            path: `/credit_notes/${lagoId}/metadata`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes a single metadata key from a credit note.
+         *
+         * @tags credit_notes
+         * @name DeleteCreditNoteMetadataKey
+         * @summary Delete a metadata key
+         * @request DELETE:/credit_notes/{lago_id}/metadata/{key}
+         * @secure
+         */
+        deleteCreditNoteMetadataKey: (lagoId, key, params = {}) => this.request({
+            path: `/credit_notes/${lagoId}/metadata/${key}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     customers = {
         /**
@@ -1231,6 +1299,55 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint retrieves all payment methods of a Customer.
+         *
+         * @tags payment_methods
+         * @name FindAllCustomersPaymentMethods
+         * @summary List all customer payment methods
+         * @request GET:/customers/{external_customer_id}/payment_methods
+         * @secure
+         */
+        findAllCustomersPaymentMethods: (externalCustomerId, query, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}/payment_methods`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Use the payment method as default when not selected a payment method
+         *
+         * @tags payment_methods
+         * @name PaymentMethodSetAsDefault
+         * @summary Set the payment method as default
+         * @request PUT:/customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default
+         * @secure
+         */
+        paymentMethodSetAsDefault: (lagoId, externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}/payment_methods/${lagoId}/set_as_default`,
+            method: "PUT",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint deletes a specific payment method for a customer.
+         *
+         * @tags payment_methods
+         * @name DestroyPaymentMethod
+         * @summary Delete a payment method
+         * @request DELETE:/customers/{external_customer_id}/payment_methods/{lago_id}
+         * @secure
+         */
+        destroyPaymentMethod: (lagoId, externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}/payment_methods/${lagoId}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     events = {
         /**
@@ -1341,7 +1458,7 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.
+         * @description This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription. Note that transaction_id is unique per external_subscription_id so multiple subscriptions can share the same transaction_id. This endpoint will only return the first event found with the given transaction_id. WARNING: If your Lago organization is configured to use the Clickhouse-based event pipeline, multiple events can share the same `transaction_id` (with different timestamps). This endpoint will only return the first event found.
          *
          * @tags events
          * @name FindEvent
@@ -1619,10 +1736,12 @@ class Api extends HttpClient {
          * @request POST:/invoices/{lago_id}/retry_payment
          * @secure
          */
-        retryPayment: (lagoId, params = {}) => this.request({
+        retryPayment: (lagoId, data, params = {}) => this.request({
             path: `/invoices/${lagoId}/retry_payment`,
             method: "POST",
+            body: data,
             secure: true,
+            type: ContentType.Json,
             ...params,
         }),
         /**
@@ -1991,6 +2110,74 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint replaces all existing metadata on a plan with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
+         *
+         * @tags plans
+         * @name ReplacePlanMetadata
+         * @summary Replace plan metadata
+         * @request POST:/plans/{code}/metadata
+         * @secure
+         */
+        replacePlanMetadata: (code, data, params = {}) => this.request({
+            path: `/plans/${code}/metadata`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint merges the provided metadata with existing metadata on the plan. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
+         *
+         * @tags plans
+         * @name MergePlanMetadata
+         * @summary Merge plan metadata
+         * @request PATCH:/plans/{code}/metadata
+         * @secure
+         */
+        mergePlanMetadata: (code, data, params = {}) => this.request({
+            path: `/plans/${code}/metadata`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes all metadata from a plan.
+         *
+         * @tags plans
+         * @name DeleteAllPlanMetadata
+         * @summary Delete all plan metadata
+         * @request DELETE:/plans/{code}/metadata
+         * @secure
+         */
+        deleteAllPlanMetadata: (code, params = {}) => this.request({
+            path: `/plans/${code}/metadata`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes a single metadata key from a plan.
+         *
+         * @tags plans
+         * @name DeletePlanMetadataKey
+         * @summary Delete a metadata key
+         * @request DELETE:/plans/{code}/metadata/{key}
+         * @secure
+         */
+        deletePlanMetadataKey: (code, key, params = {}) => this.request({
+            path: `/plans/${code}/metadata/${key}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     subscriptions = {
         /**
@@ -2132,11 +2319,11 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint allows you to create a new alert for a subscription.
+         * @description This endpoint allows you to create alerts for a subscription. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
          *
          * @tags subscriptions
          * @name CreateSubscriptionAlert
-         * @summary Create a subscription alert
+         * @summary Create subscription alert(s)
          * @request POST:/subscriptions/{external_id}/alerts
          * @secure
          */
@@ -2149,6 +2336,21 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint allows you to delete all alerts for a subscription.
+         *
+         * @tags subscriptions
+         * @name DeleteAllSubscriptionAlerts
+         * @summary Delete all subscription alerts
+         * @request DELETE:/subscriptions/{external_id}/alerts
+         * @secure
+         */
+        deleteAllSubscriptionAlerts: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/alerts`,
+            method: "DELETE",
+            secure: true,
+            ...params,
+        }),
         /**
          * @description This endpoint enables the retrieval of a specific alert for a subscription.
          *
@@ -2265,6 +2467,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint retrieves all fixed charges for a specific subscription.
+         *
+         * @tags subscriptions
+         * @name FindAllSubscriptionFixedCharges
+         * @summary List subscription fixed charges
+         * @request GET:/subscriptions/{external_id}/fixed_charges
+         * @secure
+         */
+        findAllSubscriptionFixedCharges: (externalId, params = {}) => this.request({
+            path: `/subscriptions/${externalId}/fixed_charges`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     taxes = {
         /**
@@ -2439,6 +2657,74 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint replaces all existing metadata on a wallet with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
+         *
+         * @tags wallets
+         * @name ReplaceWalletMetadata
+         * @summary Replace wallet metadata
+         * @request POST:/wallets/{lago_id}/metadata
+         * @secure
+         */
+        replaceWalletMetadata: (lagoId, data, params = {}) => this.request({
+            path: `/wallets/${lagoId}/metadata`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint merges the provided metadata with existing metadata on the wallet. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
+         *
+         * @tags wallets
+         * @name MergeWalletMetadata
+         * @summary Merge wallet metadata
+         * @request PATCH:/wallets/{lago_id}/metadata
+         * @secure
+         */
+        mergeWalletMetadata: (lagoId, data, params = {}) => this.request({
+            path: `/wallets/${lagoId}/metadata`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes all metadata from a wallet.
+         *
+         * @tags wallets
+         * @name DeleteAllWalletMetadata
+         * @summary Delete all wallet metadata
+         * @request DELETE:/wallets/{lago_id}/metadata
+         * @secure
+         */
+        deleteAllWalletMetadata: (lagoId, params = {}) => this.request({
+            path: `/wallets/${lagoId}/metadata`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint removes a single metadata key from a wallet.
+         *
+         * @tags wallets
+         * @name DeleteWalletMetadataKey
+         * @summary Delete a metadata key
+         * @request DELETE:/wallets/{lago_id}/metadata/{key}
+         * @secure
+         */
+        deleteWalletMetadataKey: (lagoId, key, params = {}) => this.request({
+            path: `/wallets/${lagoId}/metadata/${key}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint is used to list all wallet transactions.
          *