lago-javascript-client 0.56.0-beta → 1.0.0

package/esm/openapi/client.d.ts

@@ -1816,6 +1816,8 @@ export interface EventEstimateFeesInput {
         code: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1837,6 +1839,8 @@ export interface EventInput {
         transaction_id: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1884,6 +1888,8 @@ export interface EventObject {
     lago_customer_id: string | null;
     /**
      * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+     * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+     * @deprecated
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
     external_customer_id: string | null;
@@ -4076,7 +4082,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4487,11 +4493,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         estimateCreditNote: (data: CreditNoteEstimateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteEstimated, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -4675,7 +4681,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -4926,6 +4932,44 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<{
+            invoice_payment_details?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system
+                 * @example "1e501a90-1a90-1a90-1a90-1a901a901a80"
+                 */
+                lago_invoice_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The generated Payment URL for the Invoice.
+                 * @example "https://foo.bar"
+                 */
+                payment_url?: string | undefined;
+            } | undefined;
+        }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *

package/esm/openapi/client.js

@@ -148,7 +148,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -647,11 +647,11 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -834,7 +834,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -1056,6 +1056,22 @@ export class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/payment_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *

package/package.json

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

package/script/openapi/client.d.ts

@@ -1816,6 +1816,8 @@ export interface EventEstimateFeesInput {
         code: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1837,6 +1839,8 @@ export interface EventInput {
         transaction_id: string;
         /**
          * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+         * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+         * @deprecated
          * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
          */
         external_customer_id?: string;
@@ -1884,6 +1888,8 @@ export interface EventObject {
     lago_customer_id: string | null;
     /**
      * The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription.
+     * This field is deprecated and is no longer supported or maintained. Please use the `external_subscription_id` instead.
+     * @deprecated
      * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      */
     external_customer_id: string | null;
@@ -4076,7 +4082,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -4487,11 +4493,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         estimateCreditNote: (data: CreditNoteEstimateInput, params?: RequestParams) => Promise<HttpResponse<CreditNoteEstimated, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -4675,7 +4681,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         createEvent: (data: EventInput, params?: RequestParams) => Promise<HttpResponse<Event, ApiErrorBadRequest | ApiErrorUnauthorized | ApiErrorUnprocessableEntity>>;
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -4926,6 +4932,44 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         refreshInvoice: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<Invoice, ApiErrorUnauthorized | ApiErrorNotFound>>;
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId: string, params?: RequestParams) => Promise<HttpResponse<{
+            invoice_payment_details?: {
+                /**
+                 * Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
+                 * @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
+                 */
+                lago_customer_id?: string | undefined;
+                /**
+                 * Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice's record within the Lago system
+                 * @example "1e501a90-1a90-1a90-1a90-1a901a901a80"
+                 */
+                lago_invoice_id?: string | undefined;
+                /**
+                 * The customer external unique identifier (provided by your own application)
+                 * @example "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
+                 */
+                external_customer_id?: string | undefined;
+                /**
+                 * The Payment Provider name linked to the Customer.
+                 * @example "stripe"
+                 */
+                payment_provider?: string | undefined;
+                /**
+                 * The generated Payment URL for the Invoice.
+                 * @example "https://foo.bar"
+                 */
+                payment_url?: string | undefined;
+            } | undefined;
+        }, ApiErrorUnauthorized | ApiErrorUnprocessableEntity | ApiErrorNotFound>>;
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *

package/script/openapi/client.js

@@ -152,7 +152,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Lago API documentation
- * @version 0.56.0-beta
+ * @version 0.57.0-beta
  * @license AGPLv3
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -651,11 +651,11 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint voids an existing credit note.
+         * @description This endpoint voids the available credit linked to a specific credit note.
          *
          * @tags credit_notes
          * @name VoidCreditNote
-         * @summary Void a credit note
+         * @summary Void available credit
          * @request PUT:/credit_notes/{lago_id}/void
          * @secure
          */
@@ -838,7 +838,7 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to send a batch of usage records.
+         * @description This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
          *
          * @tags events
          * @name CreateBatchEvents
@@ -1060,6 +1060,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description This endpoint generates a checkout link for a specific invoice.
+         *
+         * @tags invoices
+         * @name InvoicePaymentUrl
+         * @summary Generate a payment URL
+         * @request POST:/invoices/{lago_id}/payment_url
+         * @secure
+         */
+        invoicePaymentUrl: (lagoId, params = {}) => this.request({
+            path: `/invoices/${lagoId}/payment_url`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint resends an invoice for collection and retry a payment.
          *