lago-javascript-client 1.52.0 → 1.53.0

package/esm/openapi/client.js

@@ -156,7 +156,7 @@ export class HttpClient {
 }
 /**
  * @title Lago API documentation
- * @version 1.52.0
+ * @version 1.53.0
  * @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
  * @baseUrl https://api.getlago.com/api/v1
  * @externalDocs https://github.com/getlago
@@ -1255,7 +1255,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to update an existing wallet with prepaid credits.
+         * @description This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.
          *
          * @tags wallets
          * @name UpdateCustomerWallet
@@ -1715,7 +1715,7 @@ export class Api extends HttpClient {
     };
     fees = {
         /**
-         * @description This endpoint is used for retrieving all fees that has been issued.
+         * @description This endpoint is used for retrieving all fees that have been issued.
          *
          * @tags fees
          * @name FindAllFees
@@ -1819,7 +1819,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used for updating an existing invoice.
+         * @description This endpoint is used for updating an existing invoice. A voided invoice cannot be updated and returns a `405` error.
          *
          * @tags invoices
          * @name UpdateInvoice
@@ -2018,7 +2018,145 @@ export class Api extends HttpClient {
             ...params,
         }),
     };
+    orderForms = {
+        /**
+         * @description This endpoint is used to list all existing order forms. This is a premium feature.
+         *
+         * @tags order_forms
+         * @name FindAllOrderForms
+         * @summary List all order forms
+         * @request GET:/order_forms
+         * @secure
+         */
+        findAllOrderForms: (query, params = {}) => this.request({
+            path: `/order_forms`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves a specific order form. This is a premium feature.
+         *
+         * @tags order_forms
+         * @name FindOrderForm
+         * @summary Retrieve an order form
+         * @request GET:/order_forms/{lago_id}
+         * @secure
+         */
+        findOrderForm: (lagoId, params = {}) => this.request({
+            path: `/order_forms/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint records the customer's signature on an order form, and creates the order that carries the quoted deal out. Only a `generated` order form can be signed, so a `422` is returned once the order form has been signed, has expired or has been voided. An `execute_at` landing on or after the day the quoted deal stops being executable is rejected as well, so the order can never be scheduled past the term it bills. A concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight. This is a premium feature.
+         *
+         * @tags order_forms
+         * @name MarkOrderFormAsSigned
+         * @summary Mark an order form as signed
+         * @request POST:/order_forms/{lago_id}/mark_as_signed
+         * @secure
+         */
+        markOrderFormAsSigned: (lagoId, data, params = {}) => this.request({
+            path: `/order_forms/${lagoId}/mark_as_signed`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint voids an order form, with the `manual` reason, and cascades to the quote version it was generated from, which is voided with the `cascade_of_voided` reason. Only a `generated` order form can be voided, so a `422` is returned once the order form has been signed, has expired or has already been voided. A concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight. This is a premium feature.
+         *
+         * @tags order_forms
+         * @name VoidOrderForm
+         * @summary Void an order form
+         * @request POST:/order_forms/{lago_id}/void
+         * @secure
+         */
+        voidOrderForm: (lagoId, params = {}) => this.request({
+            path: `/order_forms/${lagoId}/void`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
+    orders = {
+        /**
+         * @description This endpoint is used to list all existing orders. This is a premium feature.
+         *
+         * @tags orders
+         * @name FindAllOrders
+         * @summary List all orders
+         * @request GET:/orders
+         * @secure
+         */
+        findAllOrders: (query, params = {}) => this.request({
+            path: `/orders`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves a specific order, along with the `billing_snapshot` its execution applies and the `execution_record` of what it produced. This is a premium feature.
+         *
+         * @tags orders
+         * @name FindOrder
+         * @summary Retrieve an order
+         * @request GET:/orders/{lago_id}
+         * @secure
+         */
+        findOrder: (lagoId, params = {}) => this.request({
+            path: `/orders/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint carries out an order on demand, without waiting for its `execute_at` schedule. It runs synchronously, so the response carries the resulting status and, when the execution fails, the reason it failed. An `execute_in_lago` order applies the quoted deal, creating the subscriptions, coupons, wallets or one-off invoice it describes; an `order_only` order is simply marked as executed. What the execution produced is listed in `execution_record`. Executing is idempotent: an order that has already been executed is returned untouched. An order whose previous execution failed is executed again, and a `422` is returned when the order carries no execution mode and none is provided in the body. Restating an `execution_mode` that differs from the one stored on the order updates it first, which only succeeds while the order is still `created`: a `failed` order can be retried, but not switched to another mode. That update also re-validates the order's own `execute_at` against the day the quoted deal stops being executable, so a `422` is possible even though no date was sent. An order carrying no `execute_at` is not bounded that way, and a deal whose term has passed then only fails when the execution runs. A `404` is not limited to an unknown order: when the execution cannot find a catalog record the quote pinned, such as a deleted plan, charge, coupon or the subscription being amended, the missing resource is reported as a `404` and the order is left `failed`. Concurrency is reported two ways. A mode change losing the race on the quote comes back as a `422` validation error, while the execution itself losing it comes back as a `422` carrying a lock code, because a scheduled execution relies on that error to be retried. This is a premium feature.
+         *
+         * @tags orders
+         * @name ExecuteOrder
+         * @summary Execute an order
+         * @request POST:/orders/{lago_id}/execute
+         * @secure
+         */
+        executeOrder: (lagoId, data, params = {}) => this.request({
+            path: `/orders/${lagoId}/execute`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+    };
     organizations = {
+        /**
+         * @description This endpoint retrieves your own organization's settings.
+         *
+         * @tags organizations
+         * @name FindOrganization
+         * @summary Retrieve your organization
+         * @request GET:/organizations
+         * @secure
+         */
+        findOrganization: (params = {}) => this.request({
+            path: `/organizations`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * @description This endpoint is used to update your own organization's settings.
          *
@@ -2695,6 +2833,126 @@ export class Api extends HttpClient {
             ...params,
         }),
     };
+    quotes = {
+        /**
+         * @description This endpoint is used to list all existing quotes. Quotes are ordered by creation date, from the most recent to the oldest. This is a premium feature.
+         *
+         * @tags quotes
+         * @name FindAllQuotes
+         * @summary List all quotes
+         * @request GET:/quotes
+         * @secure
+         */
+        findAllQuotes: (query, params = {}) => this.request({
+            path: `/quotes`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint retrieves a specific quote, along with its owners and its current version. This is a premium feature.
+         *
+         * @tags quotes
+         * @name FindQuote
+         * @summary Retrieve a quote
+         * @request GET:/quotes/{lago_id}
+         * @secure
+         */
+        findQuote: (lagoId, params = {}) => this.request({
+            path: `/quotes/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint is used to list all the versions of a specific quote, from the most recent to the oldest. The `content` and `billing_items` of each version are omitted; retrieve a version to get them. This is a premium feature.
+         *
+         * @tags quotes
+         * @name FindAllQuoteVersions
+         * @summary List all versions of a quote
+         * @request GET:/quotes/{lago_id}/versions
+         * @secure
+         */
+        findAllQuoteVersions: (lagoId, query, params = {}) => this.request({
+            path: `/quotes/${lagoId}/versions`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
+    quoteVersions = {
+        /**
+         * @description This endpoint retrieves a specific quote version, along with its document `content` and its `billing_items`. This is a premium feature.
+         *
+         * @tags quotes
+         * @name FindQuoteVersion
+         * @summary Retrieve a quote version
+         * @request GET:/quote_versions/{lago_id}
+         * @secure
+         */
+        findQuoteVersion: (lagoId, params = {}) => this.request({
+            path: `/quote_versions/${lagoId}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint approves a quote version and generates the order form to send to the customer for signature. Only a `draft` version can be approved, and its `billing_items` must be complete: approval validates them against the catalog and against the customer, and returns a `422` when the deal cannot be executed as quoted. The `expires_at` of the generated order form is bounded by the deal's own term, so a signing window reaching beyond the day the deal stops being executable is rejected. A concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight. This is a premium feature.
+         *
+         * @tags quotes
+         * @name ApproveQuoteVersion
+         * @summary Approve a quote version
+         * @request POST:/quote_versions/{lago_id}/approve
+         * @secure
+         */
+        approveQuoteVersion: (lagoId, data, params = {}) => this.request({
+            path: `/quote_versions/${lagoId}/approve`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint voids a quote version, which makes it definitive: a voided version can neither be edited nor approved again. Only a `draft` version can be voided through this endpoint, and the resulting `void_reason` is `manual`. An `approved` version is voided by Lago itself, through the order form generated from it. A concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight. This is a premium feature.
+         *
+         * @tags quotes
+         * @name VoidQuoteVersion
+         * @summary Void a quote version
+         * @request POST:/quote_versions/{lago_id}/void
+         * @secure
+         */
+        voidQuoteVersion: (lagoId, params = {}) => this.request({
+            path: `/quote_versions/${lagoId}/void`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description This endpoint copies a quote version into a new `draft` version of the same quote, so that the deal can be renegotiated. Any version of the quote can be cloned, but a quote can only carry one active version: the draft the quote currently holds, if any, is voided with the `superseded` reason. Cloning is therefore rejected with a `422` once a version of the quote has been approved. A concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight. This is a premium feature.
+         *
+         * @tags quotes
+         * @name CloneQuoteVersion
+         * @summary Clone a quote version
+         * @request POST:/quote_versions/{lago_id}/clone
+         * @secure
+         */
+        cloneQuoteVersion: (lagoId, params = {}) => this.request({
+            path: `/quote_versions/${lagoId}/clone`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     subscriptions = {
         /**
          * @description This endpoint assigns a plan to a customer, creating or modifying a subscription. Ideal for initial subscriptions or plan changes (upgrades/downgrades).
@@ -3313,7 +3571,7 @@ export class Api extends HttpClient {
             ...params,
         }),
         /**
-         * @description This endpoint is used to update an existing wallet with prepaid credits.
+         * @description This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.
          *
          * @tags wallets
          * @name UpdateWallet