lago-javascript-client 1.20.0 → 1.26.0

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 1.20.0
+ * @version 1.26.0
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -161,6 +161,40 @@ exports.HttpClient = HttpClient;
  * Lago API allows your application to push customer information and metrics (events) from your application to the billing application.
  */
 class Api extends HttpClient {
+    billingEntities = {
+        /**
+         * @description This endpoint returns a list of all billing entities in the organization
+         *
+         * @tags billing_entities
+         * @name ListBillingEntities
+         * @summary List all billing entities
+         * @request GET:/billing_entities
+         * @secure
+         */
+        listBillingEntities: (params = {}) => this.request({
+            path: `/billing_entities`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint returns a specific billing entity by its code
+         *
+         * @tags billing_entities
+         * @name GetBillingEntity
+         * @summary Retrieve a billing entity
+         * @request GET:/billing_entities/{code}
+         * @secure
+         */
+        getBillingEntity: (code, params = {}) => this.request({
+            path: `/billing_entities/${code}`,
+            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.
@@ -727,11 +761,11 @@ class Api extends HttpClient {
          * @tags customers
          * @name FindCustomer
          * @summary Retrieve a customer
-         * @request GET:/customers/{external_id}
+         * @request GET:/customers/{external_customer_id}
          * @secure
          */
-        findCustomer: (externalId, params = {}) => this.request({
-            path: `/customers/${externalId}`,
+        findCustomer: (externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}`,
             method: "GET",
             secure: true,
             format: "json",
@@ -743,11 +777,11 @@ class Api extends HttpClient {
          * @tags customers
          * @name DestroyCustomer
          * @summary Delete a customer
-         * @request DELETE:/customers/{external_id}
+         * @request DELETE:/customers/{external_customer_id}
          * @secure
          */
-        destroyCustomer: (externalId, params = {}) => this.request({
-            path: `/customers/${externalId}`,
+        destroyCustomer: (externalCustomerId, params = {}) => this.request({
+            path: `/customers/${externalCustomerId}`,
             method: "DELETE",
             secure: true,
             format: "json",
@@ -1159,6 +1193,24 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used for generating invoice preview.
+         *
+         * @tags invoices
+         * @name InvoicePreview
+         * @summary Create an invoice preview
+         * @request POST:/invoices/preview
+         * @secure
+         */
+        invoicePreview: (data, params = {}) => this.request({
+            path: `/invoices/preview`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *
@@ -1211,6 +1263,41 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    paymentReceipts = {
+        /**
+         * @description This endpoint is used to list all existing payment receipts.
+         *
+         * @tags payment_receipts
+         * @name FindAllPaymentReceipts
+         * @summary List all payment receipts
+         * @request GET:/payment_receipts
+         * @secure
+         */
+        findAllPaymentReceipts: (query, params = {}) => this.request({
+            path: `/payment_receipts`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves a specific payment receipt.
+         *
+         * @tags payment_receipts
+         * @name FindPaymentReceipt
+         * @summary Retrieve a payment receipt
+         * @request GET:/payment_receipts/{lago_id}
+         * @secure
+         */
+        findPaymentReceipt: (lagoId, params = {}) => this.request({
+            path: `/payment_receipts/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     paymentRequests = {
         /**
          * @description This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer
@@ -1248,6 +1335,59 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    payments = {
+        /**
+         * @description This endpoint is used to create a manual payment
+         *
+         * @tags payments
+         * @name CreatePayment
+         * @summary Create a payment
+         * @request POST:/payments
+         * @secure
+         */
+        createPayment: (data, params = {}) => this.request({
+            path: `/payments`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all payments
+         *
+         * @tags payments
+         * @name FindAllPayments
+         * @summary List all payments
+         * @request GET:/payments
+         * @secure
+         */
+        findAllPayments: (query, params = {}) => this.request({
+            path: `/payments`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves a specific payment by its ID.
+         *
+         * @tags payments
+         * @name FindPayment
+         * @summary Retrieve a payment
+         * @request GET:/payments/{lago_id}
+         * @secure
+         */
+        findPayment: (lagoId, params = {}) => this.request({
+            path: `/payments/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     plans = {
         /**
          * @description This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.
@@ -1667,6 +1807,38 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint is used to retrieve a specific wallet transactions.
+         *
+         * @tags wallets
+         * @name FindWalletTransaction
+         * @summary Retrieve a wallet transaction
+         * @request GET:/wallet_transactions/{lago_id}
+         * @secure
+         */
+        findWalletTransaction: (lagoId, params = {}) => this.request({
+            path: `/wallet_transactions/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint generates a checkout link for a specific wallet transaction.
+         *
+         * @tags wallets
+         * @name WalletTransactionPaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/wallet_transactions/{lago_id}/payment_url
+         * @secure
+         */
+        walletTransactionPaymentUrl: (lagoId, params = {}) => this.request({
+            path: `/wallet_transactions/${lagoId}/payment_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     webhooks = {
         /**