@revenexx/node 0.1.0 → 0.1.1

package/dist/services/forms.d.mts

@@ -8,6 +8,15 @@ import '../query.mjs';
 import '../enums/address-type-row-tone.mjs';
 import '../enums/address-type-row-create-request-tone.mjs';
 import '../enums/address-type-row-update-request-tone.mjs';
+import '../enums/approval-rule-approver-type.mjs';
+import '../enums/approval-rule-condition.mjs';
+import '../enums/approval-rule-effect.mjs';
+import '../enums/approval-rule-create-request-approver-type.mjs';
+import '../enums/approval-rule-create-request-condition.mjs';
+import '../enums/approval-rule-create-request-effect.mjs';
+import '../enums/approval-rule-update-request-approver-type.mjs';
+import '../enums/approval-rule-update-request-condition.mjs';
+import '../enums/approval-rule-update-request-effect.mjs';
 import '../enums/assets-source.mjs';
 import '../enums/attribute-value-bucket.mjs';
 import '../enums/auth-mail-source.mjs';
@@ -119,6 +128,8 @@ import '../enums/payment-term-tone.mjs';
 import '../enums/payment-term-create-request-tone.mjs';
 import '../enums/payment-term-update-request-tone.mjs';
 import '../enums/payment-vocabulary-tone.mjs';
+import '../enums/pending-approval-approver-type.mjs';
+import '../enums/pending-approval-status.mjs';
 import '../enums/price-ending-rule.mjs';
 import '../enums/price-entries-adjust-response-rounding.mjs';
 import '../enums/price-entries-adjust-response-rounding-mode.mjs';
@@ -141,6 +152,11 @@ import '../enums/product-grid-column-source.mjs';
 import '../enums/product-label-source.mjs';
 import '../enums/product-label-attribute-source.mjs';
 import '../enums/products-kind.mjs';
+import '../enums/purchase-request-status.mjs';
+import '../enums/purchase-request-event-name.mjs';
+import '../enums/purchase-request-item-type.mjs';
+import '../enums/purchase-request-item-create-request-type.mjs';
+import '../enums/purchase-request-item-update-request-type.mjs';
 import '../enums/reorder-point-source.mjs';
 import '../enums/reservation-status.mjs';
 import '../enums/price-on-request-reason.mjs';
@@ -178,6 +194,8 @@ import '../enums/shipping-weight-unit-row-tone.mjs';
 import '../enums/shipping-weight-unit-update-request-tone.mjs';
 import '../enums/stock-movement-type.mjs';
 import '../enums/store-asset-request-visibility.mjs';
+import '../enums/submit-item-type.mjs';
+import '../enums/submit-result-outcome.mjs';
 import '../enums/validation-failed-response-status.mjs';
 import '../enums/vocabulary-default-tone.mjs';
 import '../enums/vocabulary-source.mjs';
@@ -245,7 +263,7 @@ declare class Forms {
      * @param {number} params.offset - How many matching rows to skip. Page N is `offset = (N - 1) * limit`; `page.hasMore` says whether there is a next one.
      * @param {string} params.order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      */
     formsList(params?: {
         id?: string;
@@ -257,7 +275,7 @@ declare class Forms {
         limit?: number;
         offset?: number;
         order?: string;
-    }): Promise<Models.Error>;
+    }): Promise<{}>;
     /**
      * The catalogue of forms this tenant has authored, a page at a time. A row is the whole form — `definition`, `settings`, `status`, `slug` — so a list read is not a summary view that has to be followed by a read per row.
      *
@@ -275,10 +293,10 @@ declare class Forms {
      * @param {number} offset - How many matching rows to skip. Page N is `offset = (N - 1) * limit`; `page.hasMore` says whether there is a next one.
      * @param {string} order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsList(id?: string, name?: string, slug?: string, status?: FormStatus, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.Error>;
+    formsList(id?: string, name?: string, slug?: string, status?: FormStatus, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      * A form is born a `draft` and stays off the storefront until somebody moves it to `live`, so creating one is safe: the cover BFF resolves live forms only, and nothing renders until the status says it may. `definition` may be omitted entirely — the row is then the empty shell the Form Builder fills in.
      *
@@ -299,7 +317,7 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
      * @param {object} params.settings - Submit label, success message, per-form notify email, post-submit actions, translations — see the `FormSettings` schema for every key that is read. Unconstrained jsonb on the way in: nothing here is required and no key is refused.
      * @param {FormStatus} params.status - Lifecycle. `draft` while it is being built; `live` once the storefront may render it — the cover BFF resolves live forms only, so a draft is a 404 on the storefront and never a broken page; `archived` for a form that is kept for its submissions but no longer offered. Default 'draft'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Form>}
      */
     formsCreate(params: {
         name: string;
@@ -308,7 +326,7 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
         metadata?: object;
         settings?: object;
         status?: FormStatus;
-    }): Promise<Models.Error>;
+    }): Promise<Models.Form>;
     /**
      * A form is born a `draft` and stays off the storefront until somebody moves it to `live`, so creating one is safe: the cover BFF resolves live forms only, and nothing renders until the status says it may. `definition` may be omitted entirely — the row is then the empty shell the Form Builder fills in.
      *
@@ -329,10 +347,10 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
      * @param {object} settings - Submit label, success message, per-form notify email, post-submit actions, translations — see the `FormSettings` schema for every key that is read. Unconstrained jsonb on the way in: nothing here is required and no key is refused.
      * @param {FormStatus} status - Lifecycle. `draft` while it is being built; `live` once the storefront may render it — the cover BFF resolves live forms only, so a draft is a 404 on the storefront and never a broken page; `archived` for a form that is kept for its submissions but no longer offered. Default 'draft'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Form>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsCreate(name: string, slug: string, definition?: object[], metadata?: object, settings?: object, status?: FormStatus): Promise<Models.Error>;
+    formsCreate(name: string, slug: string, definition?: object[], metadata?: object, settings?: object, status?: FormStatus): Promise<Models.Form>;
     /**
      * Every tenant starts with one sample form so the Form Builder is never empty and there is a live render and submit target from the first minute — the `contact` slug the read examples throughout this document resolve against.
      *
@@ -362,7 +380,7 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
      * @param {number} params.offset - How many matching rows to skip. Page N is `offset = (N - 1) * limit`; `page.hasMore` says whether there is a next one.
      * @param {string} params.order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      */
     formsSubmissionsList(params?: {
         id?: string;
@@ -375,7 +393,7 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
         limit?: number;
         offset?: number;
         order?: string;
-    }): Promise<Models.Error>;
+    }): Promise<{}>;
     /**
      * The inbox: every submission this tenant has received, a page at a time. A row is the whole submission, `data` included, so the list is the inbox and the detail view at once — nothing has to be fetched per row to show what somebody wrote. Treat all of it as END-USER data.
      *
@@ -394,10 +412,10 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
      * @param {number} offset - How many matching rows to skip. Page N is `offset = (N - 1) * limit`; `page.hasMore` says whether there is a next one.
      * @param {string} order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsSubmissionsList(id?: string, formId?: string, formSlug?: string, source?: string, status?: FormSubmissionStatus, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.Error>;
+    formsSubmissionsList(id?: string, formId?: string, formSlug?: string, source?: string, status?: FormSubmissionStatus, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      * The storefront's path, and the moment a lead enters the platform. A stored submission emits `form.submitted` onto the tenant event bus with the row itself as the payload — that is the event an Integration Studio workflow or a notification email listens to, and it is the only event this app raises about a submission. A call that is refused therefore leaves no trace anywhere: no row, and no automation that ever hears about it.
      *
@@ -418,7 +436,7 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      * @param {string} params.source - Where the submission came from. The storefront sends the `window.location.pathname` of the page that carried the form, so this is normally a path rather than an absolute URL; any other surface (an app, an import) puts its own name here. Null when the caller sent none.
      * @param {FormSubmissionStatus} params.status - Inbox triage. `new` until somebody opens it, then `read`, and `archived` once it is dealt with. `spam` is set by code in exactly one place — the honeypot, and only while the tenant's spam_handling is 'flag'; under 'reject' the submission is never stored at all. Default 'new'. A create may set it — an inbox importer records a submission that is already read — but nothing needs to: omit it and the row is 'new'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmission>}
      */
     formsSubmissionsCreate(params: {
         data: object;
@@ -427,7 +445,7 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
         metadata?: object;
         source?: string;
         status?: FormSubmissionStatus;
-    }): Promise<Models.Error>;
+    }): Promise<Models.FormSubmission>;
     /**
      * The storefront's path, and the moment a lead enters the platform. A stored submission emits `form.submitted` onto the tenant event bus with the row itself as the payload — that is the event an Integration Studio workflow or a notification email listens to, and it is the only event this app raises about a submission. A call that is refused therefore leaves no trace anywhere: no row, and no automation that ever hears about it.
      *
@@ -448,10 +466,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      * @param {string} source - Where the submission came from. The storefront sends the `window.location.pathname` of the page that carried the form, so this is normally a path rather than an absolute URL; any other surface (an app, an import) puts its own name here. Null when the caller sent none.
      * @param {FormSubmissionStatus} status - Inbox triage. `new` until somebody opens it, then `read`, and `archived` once it is dealt with. `spam` is set by code in exactly one place — the honeypot, and only while the tenant's spam_handling is 'flag'; under 'reject' the submission is never stored at all. Default 'new'. A create may set it — an inbox importer records a submission that is already read — but nothing needs to: omit it and the row is 'new'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmission>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsSubmissionsCreate(data: object, formId: string, formSlug?: string, metadata?: object, source?: string, status?: FormSubmissionStatus): Promise<Models.Error>;
+    formsSubmissionsCreate(data: object, formId: string, formSlug?: string, metadata?: object, source?: string, status?: FormSubmissionStatus): Promise<Models.FormSubmission>;
     /**
      * The retention sweep. It deletes submissions the tenant has stopped promising to keep — everything older than `submission_retention_days` — and it is the one route in this app that reads that promise at all.
      *
@@ -468,14 +486,14 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      * @param {number} params.olderThanDays - Age threshold. Omit to use the retention floor. A value BELOW the floor is raised to it — the setting is the floor, not a default, and the floor is the LONGEST submission_retention_days configured anywhere in the tenant (see the operation description).
      * @param {FormsSubmissionsPruneStatus} params.status - Narrow the sweep to one inbox status, e.g. 'spam'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmissionPruneResult>}
      */
     formsSubmissionsPrune(params?: {
         dryRun?: boolean;
         formSlug?: string;
         olderThanDays?: number;
         status?: FormsSubmissionsPruneStatus;
-    }): Promise<Models.Error>;
+    }): Promise<Models.FormSubmissionPruneResult>;
     /**
      * The retention sweep. It deletes submissions the tenant has stopped promising to keep — everything older than `submission_retention_days` — and it is the one route in this app that reads that promise at all.
      *
@@ -492,10 +510,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      * @param {number} olderThanDays - Age threshold. Omit to use the retention floor. A value BELOW the floor is raised to it — the setting is the floor, not a default, and the floor is the LONGEST submission_retention_days configured anywhere in the tenant (see the operation description).
      * @param {FormsSubmissionsPruneStatus} status - Narrow the sweep to one inbox status, e.g. 'spam'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmissionPruneResult>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsSubmissionsPrune(dryRun?: boolean, formSlug?: string, olderThanDays?: number, status?: FormsSubmissionsPruneStatus): Promise<Models.Error>;
+    formsSubmissionsPrune(dryRun?: boolean, formSlug?: string, olderThanDays?: number, status?: FormsSubmissionsPruneStatus): Promise<Models.FormSubmissionPruneResult>;
     /**
      * Removes one submission permanently. There is no soft delete anywhere in this app — no `deleted_at`, no trash, no undo — so the row and the end-user data in it are gone when this answers.
      *
@@ -505,11 +523,11 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} params.id - The submission, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmissionDeleteResult>}
      */
     formsSubmissionsDelete(params: {
         id: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.FormSubmissionDeleteResult>;
     /**
      * Removes one submission permanently. There is no soft delete anywhere in this app — no `deleted_at`, no trash, no undo — so the row and the end-user data in it are gone when this answers.
      *
@@ -519,10 +537,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} id - The submission, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmissionDeleteResult>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsSubmissionsDelete(id: string): Promise<Models.Error>;
+    formsSubmissionsDelete(id: string): Promise<Models.FormSubmissionDeleteResult>;
     /**
      * One received submission, whole — the detail view behind a row of `GET /v1/forms/submissions`.
      *
@@ -534,11 +552,11 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} params.id - The submission, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmission>}
      */
     formsSubmissionsGet(params: {
         id: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.FormSubmission>;
     /**
      * One received submission, whole — the detail view behind a row of `GET /v1/forms/submissions`.
      *
@@ -550,10 +568,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} id - The submission, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmission>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsSubmissionsGet(id: string): Promise<Models.Error>;
+    formsSubmissionsGet(id: string): Promise<Models.FormSubmission>;
     /**
      * Triage, not correction. What this route is FOR is moving the inbox `status` — 'new' to 'read' as somebody opens the lead, 'archived' once it is dealt with, 'spam' for what the honeypot did not catch — and stamping whatever an integration keeps in `metadata`.
      *
@@ -575,7 +593,7 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      * @param {string} params.source - Where the submission came from. The storefront sends the `window.location.pathname` of the page that carried the form, so this is normally a path rather than an absolute URL; any other surface (an app, an import) puts its own name here. Null when the caller sent none.
      * @param {FormSubmissionStatus} params.status - Inbox triage. `new` until somebody opens it, then `read`, and `archived` once it is dealt with. `spam` is set by code in exactly one place — the honeypot, and only while the tenant's spam_handling is 'flag'; under 'reject' the submission is never stored at all. Default 'new'. A create may set it — an inbox importer records a submission that is already read — but nothing needs to: omit it and the row is 'new'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmission>}
      */
     formsSubmissionsUpdate(params: {
         id: string;
@@ -585,7 +603,7 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
         metadata?: object;
         source?: string;
         status?: FormSubmissionStatus;
-    }): Promise<Models.Error>;
+    }): Promise<Models.FormSubmission>;
     /**
      * Triage, not correction. What this route is FOR is moving the inbox `status` — 'new' to 'read' as somebody opens the lead, 'archived' once it is dealt with, 'spam' for what the honeypot did not catch — and stamping whatever an integration keeps in `metadata`.
      *
@@ -607,10 +625,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      * @param {string} source - Where the submission came from. The storefront sends the `window.location.pathname` of the page that carried the form, so this is normally a path rather than an absolute URL; any other surface (an app, an import) puts its own name here. Null when the caller sent none.
      * @param {FormSubmissionStatus} status - Inbox triage. `new` until somebody opens it, then `read`, and `archived` once it is dealt with. `spam` is set by code in exactly one place — the honeypot, and only while the tenant's spam_handling is 'flag'; under 'reject' the submission is never stored at all. Default 'new'. A create may set it — an inbox importer records a submission that is already read — but nothing needs to: omit it and the row is 'new'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormSubmission>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsSubmissionsUpdate(id: string, data?: object, formId?: string, formSlug?: string, metadata?: object, source?: string, status?: FormSubmissionStatus): Promise<Models.Error>;
+    formsSubmissionsUpdate(id: string, data?: object, formId?: string, formSlug?: string, metadata?: object, source?: string, status?: FormSubmissionStatus): Promise<Models.FormSubmission>;
     /**
      * The enums this app publishes, so a client can discover them instead of holding a copy. Names: form-statuses, submission-statuses.
      *
@@ -631,11 +649,11 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {FormsVocabulariesGetName} params.name - The vocabulary name — the part after the dot in the qualified id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormsVocabulary>}
      */
     formsVocabulariesGet(params: {
         name: FormsVocabulariesGetName;
-    }): Promise<Models.Error>;
+    }): Promise<Models.FormsVocabulary>;
     /**
      * One vocabulary WITH its values: every value the column permits, each carrying the `key` the database stores, the `title` and `description` a human reads, a semantic badge `tone`, and a `final` flag for the values that end the lifecycle. This is the call that fills a select or renders a status badge. Names: form-statuses, submission-statuses.
      *
@@ -645,10 +663,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {FormsVocabulariesGetName} name - The vocabulary name — the part after the dot in the qualified id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormsVocabulary>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsVocabulariesGet(name: FormsVocabulariesGetName): Promise<Models.Error>;
+    formsVocabulariesGet(name: FormsVocabulariesGetName): Promise<Models.FormsVocabulary>;
     /**
      * Deleting a form deletes every submission it ever received.
      *
@@ -664,11 +682,11 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} params.id - The form, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormDeleteResult>}
      */
     formsDelete(params: {
         id: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.FormDeleteResult>;
     /**
      * Deleting a form deletes every submission it ever received.
      *
@@ -684,10 +702,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} id - The form, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.FormDeleteResult>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsDelete(id: string): Promise<Models.Error>;
+    formsDelete(id: string): Promise<Models.FormDeleteResult>;
     /**
      * The whole form: `definition` — the flat FormKit node array the storefront renders verbatim — plus `settings`, `status` and `slug`.
      *
@@ -697,11 +715,11 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} params.id - The form, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Form>}
      */
     formsGet(params: {
         id: string;
-    }): Promise<Models.Error>;
+    }): Promise<Models.Form>;
     /**
      * The whole form: `definition` — the flat FormKit node array the storefront renders verbatim — plus `settings`, `status` and `slug`.
      *
@@ -711,10 +729,10 @@ Two values are NOT here: the honeypot field, if the tenant configured one, is st
      *
      * @param {string} id - The form, by id.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Form>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsGet(id: string): Promise<Models.Error>;
+    formsGet(id: string): Promise<Models.Form>;
     /**
      * A partial update over everything a create may set — `definition`, `settings`, `status`, `name`, `slug`, `metadata` — where an omitted field keeps the value it has. It is the write behind the Form Builder's save, and equally behind the one-field change that publishes a form by moving `status` from `draft` to `live`. `updated_at` is stamped on every call, so it is the column an editor sorts by.
      *
@@ -736,7 +754,7 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
      * @param {string} params.slug - URL-safe identifier, unique per tenant. This is the name a storefront resolves a form by (`GET /v1/forms?slug=contact&status=live&limit=1`), so it is part of the page's contract: changing it changes which form a page renders. Lower-case letters, digits and inner hyphens. Taken already? That is the 409 — one slug answers for one form.
      * @param {FormStatus} params.status - Lifecycle. `draft` while it is being built; `live` once the storefront may render it — the cover BFF resolves live forms only, so a draft is a 404 on the storefront and never a broken page; `archived` for a form that is kept for its submissions but no longer offered. Default 'draft'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Form>}
      */
     formsUpdate(params: {
         id: string;
@@ -746,7 +764,7 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
         settings?: object;
         slug?: string;
         status?: FormStatus;
-    }): Promise<Models.Error>;
+    }): Promise<Models.Form>;
     /**
      * A partial update over everything a create may set — `definition`, `settings`, `status`, `name`, `slug`, `metadata` — where an omitted field keeps the value it has. It is the write behind the Form Builder's save, and equally behind the one-field change that publishes a form by moving `status` from `draft` to `live`. `updated_at` is stamped on every call, so it is the column an editor sorts by.
      *
@@ -768,10 +786,10 @@ On the way IN a node is any object: this is unconstrained jsonb, FormKit owns th
      * @param {string} slug - URL-safe identifier, unique per tenant. This is the name a storefront resolves a form by (`GET /v1/forms?slug=contact&status=live&limit=1`), so it is part of the page's contract: changing it changes which form a page renders. Lower-case letters, digits and inner hyphens. Taken already? That is the 409 — one slug answers for one form.
      * @param {FormStatus} status - Lifecycle. `draft` while it is being built; `live` once the storefront may render it — the cover BFF resolves live forms only, so a draft is a 404 on the storefront and never a broken page; `archived` for a form that is kept for its submissions but no longer offered. Default 'draft'.
      * @throws {RevenexxException}
-     * @returns {Promise<Models.Error>}
+     * @returns {Promise<Models.Form>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    formsUpdate(id: string, definition?: object[], metadata?: object, name?: string, settings?: object, slug?: string, status?: FormStatus): Promise<Models.Error>;
+    formsUpdate(id: string, definition?: object[], metadata?: object, name?: string, settings?: object, slug?: string, status?: FormStatus): Promise<Models.Form>;
 }
 
 export { Forms };