@naturali/sdk 0.208.6 → 0.208.7

package/dist/index.cjs

@@ -4542,6 +4542,8 @@ var Playbooks = class {
 	* Validate a playbook definition
 	*
 	* Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
+	*
+	* With `project_id`, the upstreams are also read against that project's playbooks, as a write there would read them, and the caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
 	*/
 	static validatePlaybook(options) {
 		return (options.client ?? client).post({
@@ -4803,6 +4805,8 @@ var Playbooks = class {
 	*
 	* Moves a case to another version of its playbook: the playbook's current version, or the `version` named, an earlier one included. Values carry over by node ID, and every node's state is read against the new version: a node added is open, a node removed leaves the structure while its entries stay, a node whose input reads another field is `stale`, and a value its input's new schema refuses is missing again. The cascade then runs what became runnable. With `wait: true` it answers once every execution queued, and every one those queue, has settled or parked. Each upgrade is recorded with what moved; the version the case is already on records nothing.
 	*
+	* The case's upstream bindings follow the target version: a name it declares on the same playbook keeps its case, any other binding is dropped, and each name it declares that the case does not bind is bound from `upstreams`, by the rules of create. A declared name left unbound is `400 PLAYBOOK_CASE_UPSTREAM_INVALID` and moves nothing.
+	*
 	* An execution running is `409 PLAYBOOK_CASE_BUSY`; one queued but not started settles `superseded`. An upgrade made with a credential the case's own work, or that of a case reading it as an upstream, runs as is `403 PLAYBOOK_SELF_WRITE`.
 	*/
 	static upgradePlaybookCase(options) {

package/dist/index.d.cts

@@ -7374,6 +7374,10 @@ type UpdatePlaybookRequest = {
   expected_version?: ExpectedVersion;
 };
 type ValidatePlaybookRequest = {
+  /**
+   * The playbook the definition would update, so an upstream reading it back is `UPSTREAM_CYCLE`. Requires `project_id`.
+   */
+  playbook_id?: string;
   /**
    * The definition to check
    */
@@ -7382,7 +7386,7 @@ type ValidatePlaybookRequest = {
 type PlaybookValidationResult = {
   valid: boolean;
   /**
-   * Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION` or `CYCLE`. The same items a refused write lists under `meta.problems`.
+   * Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION`, `CYCLE`, and, with `project_id`, `UNKNOWN_UPSTREAM` or `UPSTREAM_CYCLE`. The same items a refused write lists under `meta.problems`.
    */
   problems: Array<ValidationProblem>;
 };
@@ -7512,7 +7516,7 @@ type PlaybookCaseSummary = {
   updated_at?: Date;
 };
 /**
- * The case bound to each of the playbook's declared `upstreams`, by name: every declared name and no other, each a case of the declared playbook. Fixed at create; empty when the playbook declares none.
+ * The case bound to each of the playbook's declared `upstreams`, by name: every declared name and no other, each a case of the declared playbook. Bound at create and fitted to the version at each upgrade; empty when the version declares none.
  */
 type PlaybookCaseUpstreams = {
   [key: string]: string;
@@ -7739,6 +7743,10 @@ type UpgradePlaybookCaseRequest = {
    * The version to move the case to; the playbook's current one when omitted
    */
   version?: number;
+  /**
+   * A case for each upstream the target version declares and the case does not bind yet, by name, checked as at create. A binding the target version declares on the same playbook is kept and never named here; every other binding is dropped.
+   */
+  upstreams?: PlaybookCaseUpstreams;
   /**
    * Answer once every execution the write queued, and every one those queue in turn, has settled or parked, instead of right away
    */
@@ -22861,13 +22869,21 @@ type ValidatePlaybookData = {
 };
 type ValidatePlaybookErrors = {
   /**
-   * Bad request — the definition's shape cannot be read
+   * Bad request — the definition's shape cannot be read, or `playbook_id` is given without `project_id`
    */
   400: unknown;
   /**
    * Unauthorized
    */
   401: unknown;
+  /**
+   * Forbidden
+   */
+  403: unknown;
+  /**
+   * `playbook_id` names no playbook of the project
+   */
+  404: unknown;
 };
 type ValidatePlaybookResponses = {
   /**
@@ -23786,7 +23802,7 @@ type UpgradePlaybookCaseData = {
 };
 type UpgradePlaybookCaseErrors = {
   /**
-   * Bad request — a version the playbook does not have
+   * Bad request — a version the playbook does not have, or `PLAYBOOK_CASE_UPSTREAM_INVALID`: an upstream the target version declares left unbound, a name it does not declare or the case already binds, or a case that cannot be bound
    */
   400: unknown;
   /**
@@ -30596,6 +30612,8 @@ export declare class Playbooks {
    * Validate a playbook definition
    *
    * Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
+   *
+   * With `project_id`, the upstreams are also read against that project's playbooks, as a write there would read them, and the caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
    */
   static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
   /**
@@ -30729,6 +30747,8 @@ export declare class Playbooks {
    *
    * Moves a case to another version of its playbook: the playbook's current version, or the `version` named, an earlier one included. Values carry over by node ID, and every node's state is read against the new version: a node added is open, a node removed leaves the structure while its entries stay, a node whose input reads another field is `stale`, and a value its input's new schema refuses is missing again. The cascade then runs what became runnable. With `wait: true` it answers once every execution queued, and every one those queue, has settled or parked. Each upgrade is recorded with what moved; the version the case is already on records nothing.
    *
+   * The case's upstream bindings follow the target version: a name it declares on the same playbook keeps its case, any other binding is dropped, and each name it declares that the case does not bind is bound from `upstreams`, by the rules of create. A declared name left unbound is `400 PLAYBOOK_CASE_UPSTREAM_INVALID` and moves nothing.
+   *
    * An execution running is `409 PLAYBOOK_CASE_BUSY`; one queued but not started settles `superseded`. An upgrade made with a credential the case's own work, or that of a case reading it as an upstream, runs as is `403 PLAYBOOK_SELF_WRITE`.
    */
   static upgradePlaybookCase<ThrowOnError extends boolean = false>(options: Options<UpgradePlaybookCaseData, ThrowOnError>): RequestResult<UpgradePlaybookCaseResponses, UpgradePlaybookCaseErrors, ThrowOnError>;

package/dist/index.d.mts

@@ -7374,6 +7374,10 @@ type UpdatePlaybookRequest = {
   expected_version?: ExpectedVersion;
 };
 type ValidatePlaybookRequest = {
+  /**
+   * The playbook the definition would update, so an upstream reading it back is `UPSTREAM_CYCLE`. Requires `project_id`.
+   */
+  playbook_id?: string;
   /**
    * The definition to check
    */
@@ -7382,7 +7386,7 @@ type ValidatePlaybookRequest = {
 type PlaybookValidationResult = {
   valid: boolean;
   /**
-   * Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION` or `CYCLE`. The same items a refused write lists under `meta.problems`.
+   * Every reason the definition cannot be stored: `DUPLICATE_NODE`, `DUPLICATE_INPUT`, `MISSING_NODE`, `UNKNOWN_FIELD`, `EXECUTOR_REQUIRED`, `EXECUTOR_FORBIDDEN`, `TRANSFORMATIONS_NOT_FINAL`, `DUPLICATE_TRANSFORMATION`, `CYCLE`, and, with `project_id`, `UNKNOWN_UPSTREAM` or `UPSTREAM_CYCLE`. The same items a refused write lists under `meta.problems`.
    */
   problems: Array<ValidationProblem>;
 };
@@ -7512,7 +7516,7 @@ type PlaybookCaseSummary = {
   updated_at?: Date;
 };
 /**
- * The case bound to each of the playbook's declared `upstreams`, by name: every declared name and no other, each a case of the declared playbook. Fixed at create; empty when the playbook declares none.
+ * The case bound to each of the playbook's declared `upstreams`, by name: every declared name and no other, each a case of the declared playbook. Bound at create and fitted to the version at each upgrade; empty when the version declares none.
  */
 type PlaybookCaseUpstreams = {
   [key: string]: string;
@@ -7739,6 +7743,10 @@ type UpgradePlaybookCaseRequest = {
    * The version to move the case to; the playbook's current one when omitted
    */
   version?: number;
+  /**
+   * A case for each upstream the target version declares and the case does not bind yet, by name, checked as at create. A binding the target version declares on the same playbook is kept and never named here; every other binding is dropped.
+   */
+  upstreams?: PlaybookCaseUpstreams;
   /**
    * Answer once every execution the write queued, and every one those queue in turn, has settled or parked, instead of right away
    */
@@ -22861,13 +22869,21 @@ type ValidatePlaybookData = {
 };
 type ValidatePlaybookErrors = {
   /**
-   * Bad request — the definition's shape cannot be read
+   * Bad request — the definition's shape cannot be read, or `playbook_id` is given without `project_id`
    */
   400: unknown;
   /**
    * Unauthorized
    */
   401: unknown;
+  /**
+   * Forbidden
+   */
+  403: unknown;
+  /**
+   * `playbook_id` names no playbook of the project
+   */
+  404: unknown;
 };
 type ValidatePlaybookResponses = {
   /**
@@ -23786,7 +23802,7 @@ type UpgradePlaybookCaseData = {
 };
 type UpgradePlaybookCaseErrors = {
   /**
-   * Bad request — a version the playbook does not have
+   * Bad request — a version the playbook does not have, or `PLAYBOOK_CASE_UPSTREAM_INVALID`: an upstream the target version declares left unbound, a name it does not declare or the case already binds, or a case that cannot be bound
    */
   400: unknown;
   /**
@@ -30596,6 +30612,8 @@ export declare class Playbooks {
    * Validate a playbook definition
    *
    * Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
+   *
+   * With `project_id`, the upstreams are also read against that project's playbooks, as a write there would read them, and the caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
    */
   static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
   /**
@@ -30729,6 +30747,8 @@ export declare class Playbooks {
    *
    * Moves a case to another version of its playbook: the playbook's current version, or the `version` named, an earlier one included. Values carry over by node ID, and every node's state is read against the new version: a node added is open, a node removed leaves the structure while its entries stay, a node whose input reads another field is `stale`, and a value its input's new schema refuses is missing again. The cascade then runs what became runnable. With `wait: true` it answers once every execution queued, and every one those queue, has settled or parked. Each upgrade is recorded with what moved; the version the case is already on records nothing.
    *
+   * The case's upstream bindings follow the target version: a name it declares on the same playbook keeps its case, any other binding is dropped, and each name it declares that the case does not bind is bound from `upstreams`, by the rules of create. A declared name left unbound is `400 PLAYBOOK_CASE_UPSTREAM_INVALID` and moves nothing.
+   *
    * An execution running is `409 PLAYBOOK_CASE_BUSY`; one queued but not started settles `superseded`. An upgrade made with a credential the case's own work, or that of a case reading it as an upstream, runs as is `403 PLAYBOOK_SELF_WRITE`.
    */
   static upgradePlaybookCase<ThrowOnError extends boolean = false>(options: Options<UpgradePlaybookCaseData, ThrowOnError>): RequestResult<UpgradePlaybookCaseResponses, UpgradePlaybookCaseErrors, ThrowOnError>;

package/dist/index.mjs

@@ -4541,6 +4541,8 @@ var Playbooks = class {
 	* Validate a playbook definition
 	*
 	* Answers what a create or update would be told about a definition, without writing: `valid`, and every graph problem it holds. A definition whose shape cannot be read is `400 VALIDATION_FAILED`, as on a write.
+	*
+	* With `project_id`, the upstreams are also read against that project's playbooks, as a write there would read them, and the caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
 	*/
 	static validatePlaybook(options) {
 		return (options.client ?? client).post({
@@ -4802,6 +4804,8 @@ var Playbooks = class {
 	*
 	* Moves a case to another version of its playbook: the playbook's current version, or the `version` named, an earlier one included. Values carry over by node ID, and every node's state is read against the new version: a node added is open, a node removed leaves the structure while its entries stay, a node whose input reads another field is `stale`, and a value its input's new schema refuses is missing again. The cascade then runs what became runnable. With `wait: true` it answers once every execution queued, and every one those queue, has settled or parked. Each upgrade is recorded with what moved; the version the case is already on records nothing.
 	*
+	* The case's upstream bindings follow the target version: a name it declares on the same playbook keeps its case, any other binding is dropped, and each name it declares that the case does not bind is bound from `upstreams`, by the rules of create. A declared name left unbound is `400 PLAYBOOK_CASE_UPSTREAM_INVALID` and moves nothing.
+	*
 	* An execution running is `409 PLAYBOOK_CASE_BUSY`; one queued but not started settles `superseded`. An upgrade made with a credential the case's own work, or that of a case reading it as an upstream, runs as is `403 PLAYBOOK_SELF_WRITE`.
 	*/
 	static upgradePlaybookCase(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturali/sdk",
-  "version": "0.208.6",
+  "version": "0.208.7",
   "description": "TypeScript SDK for the naturali.ai API, generated from its OpenAPI specs",
   "keywords": [
     "naturali",
@@ -38,7 +38,7 @@
   },
   "devDependencies": {
     "@hey-api/openapi-ts": "^0.99.0",
-    "@naturali/api": "0.208.6",
+    "@naturali/api": "0.208.7",
     "@ttoss/openapi-codegen": "^0.5.0",
     "@types/node": "^26.5.1",
     "tsdown": "^0.23.0",