@naturali/sdk 0.208.8 → 0.208.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +3 -3
- package/dist/index.d.cts +8 -4
- package/dist/index.d.mts +8 -4
- package/dist/index.mjs +3 -3
- package/package.json +2 -2
package/dist/index.cjs
CHANGED
|
@@ -4526,7 +4526,7 @@ var Playbooks = class {
|
|
|
4526
4526
|
*
|
|
4527
4527
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
4528
4528
|
*
|
|
4529
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
4529
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
4530
4530
|
*/
|
|
4531
4531
|
static createPlaybook(options) {
|
|
4532
4532
|
return (options.client ?? client).post({
|
|
@@ -4543,7 +4543,7 @@ var Playbooks = class {
|
|
|
4543
4543
|
*
|
|
4544
4544
|
* 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.
|
|
4545
4545
|
*
|
|
4546
|
-
* With `project_id`, the
|
|
4546
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
4547
4547
|
*/
|
|
4548
4548
|
static validatePlaybook(options) {
|
|
4549
4549
|
return (options.client ?? client).post({
|
|
@@ -4582,7 +4582,7 @@ var Playbooks = class {
|
|
|
4582
4582
|
*
|
|
4583
4583
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
4584
4584
|
*
|
|
4585
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4585
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4586
4586
|
*/
|
|
4587
4587
|
static updatePlaybook(options) {
|
|
4588
4588
|
return (options.client ?? client).patch({
|
package/dist/index.d.cts
CHANGED
|
@@ -2476,6 +2476,10 @@ type OnBehalfOf = {
|
|
|
2476
2476
|
* The generation that called the tool
|
|
2477
2477
|
*/
|
|
2478
2478
|
generation_id?: string | null;
|
|
2479
|
+
/**
|
|
2480
|
+
* The run-as work that called the tool: a playbook case or execution, a task, or an orchestration run
|
|
2481
|
+
*/
|
|
2482
|
+
work_id?: string | null;
|
|
2479
2483
|
session_id?: string | null;
|
|
2480
2484
|
actor_id?: string | null;
|
|
2481
2485
|
} | null;
|
|
@@ -7386,7 +7390,7 @@ type ValidatePlaybookRequest = {
|
|
|
7386
7390
|
type PlaybookValidationResult = {
|
|
7387
7391
|
valid: boolean;
|
|
7388
7392
|
/**
|
|
7389
|
-
* 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 `
|
|
7393
|
+
* 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`, `UPSTREAM_CYCLE` or `EXECUTOR_NOT_FOUND`. The same items a refused write lists under `meta.problems`.
|
|
7390
7394
|
*/
|
|
7391
7395
|
problems: Array<ValidationProblem>;
|
|
7392
7396
|
};
|
|
@@ -30605,7 +30609,7 @@ export declare class Playbooks {
|
|
|
30605
30609
|
*
|
|
30606
30610
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
30607
30611
|
*
|
|
30608
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30612
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30609
30613
|
*/
|
|
30610
30614
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
30611
30615
|
/**
|
|
@@ -30613,7 +30617,7 @@ export declare class Playbooks {
|
|
|
30613
30617
|
*
|
|
30614
30618
|
* 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.
|
|
30615
30619
|
*
|
|
30616
|
-
* With `project_id`, the
|
|
30620
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
30617
30621
|
*/
|
|
30618
30622
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
30619
30623
|
/**
|
|
@@ -30633,7 +30637,7 @@ export declare class Playbooks {
|
|
|
30633
30637
|
*
|
|
30634
30638
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
30635
30639
|
*
|
|
30636
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30640
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30637
30641
|
*/
|
|
30638
30642
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
30639
30643
|
/**
|
package/dist/index.d.mts
CHANGED
|
@@ -2476,6 +2476,10 @@ type OnBehalfOf = {
|
|
|
2476
2476
|
* The generation that called the tool
|
|
2477
2477
|
*/
|
|
2478
2478
|
generation_id?: string | null;
|
|
2479
|
+
/**
|
|
2480
|
+
* The run-as work that called the tool: a playbook case or execution, a task, or an orchestration run
|
|
2481
|
+
*/
|
|
2482
|
+
work_id?: string | null;
|
|
2479
2483
|
session_id?: string | null;
|
|
2480
2484
|
actor_id?: string | null;
|
|
2481
2485
|
} | null;
|
|
@@ -7386,7 +7390,7 @@ type ValidatePlaybookRequest = {
|
|
|
7386
7390
|
type PlaybookValidationResult = {
|
|
7387
7391
|
valid: boolean;
|
|
7388
7392
|
/**
|
|
7389
|
-
* 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 `
|
|
7393
|
+
* 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`, `UPSTREAM_CYCLE` or `EXECUTOR_NOT_FOUND`. The same items a refused write lists under `meta.problems`.
|
|
7390
7394
|
*/
|
|
7391
7395
|
problems: Array<ValidationProblem>;
|
|
7392
7396
|
};
|
|
@@ -30605,7 +30609,7 @@ export declare class Playbooks {
|
|
|
30605
30609
|
*
|
|
30606
30610
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
30607
30611
|
*
|
|
30608
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30612
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
30609
30613
|
*/
|
|
30610
30614
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
30611
30615
|
/**
|
|
@@ -30613,7 +30617,7 @@ export declare class Playbooks {
|
|
|
30613
30617
|
*
|
|
30614
30618
|
* 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.
|
|
30615
30619
|
*
|
|
30616
|
-
* With `project_id`, the
|
|
30620
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
30617
30621
|
*/
|
|
30618
30622
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
30619
30623
|
/**
|
|
@@ -30633,7 +30637,7 @@ export declare class Playbooks {
|
|
|
30633
30637
|
*
|
|
30634
30638
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
30635
30639
|
*
|
|
30636
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30640
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
30637
30641
|
*/
|
|
30638
30642
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
30639
30643
|
/**
|
package/dist/index.mjs
CHANGED
|
@@ -4525,7 +4525,7 @@ var Playbooks = class {
|
|
|
4525
4525
|
*
|
|
4526
4526
|
* Creates a playbook at version 1. The definition is refused with `400 PLAYBOOK_VALIDATION_FAILED` when it holds a duplicate node or input, an input reading a missing node or field, an `execute` node without an executor or another kind with one, transformations on a non-final node, or a cycle; `meta.problems` lists every one. A duplicate `name` in the project is `409 NAME_CONFLICT`.
|
|
4527
4527
|
*
|
|
4528
|
-
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
4528
|
+
* The caller becomes the version's author, whom its executors run as, so it must be allowed to start every executor the definition names (`403 PLAYBOOK_EXECUTOR_FORBIDDEN`), and each must exist in the project, or be an agent or tool shared with it (`400 PLAYBOOK_VALIDATION_FAILED`, an `EXECUTOR_NOT_FOUND` problem). A definition with executors written with a trigger or OAuth token is `409 PLAYBOOK_AUTHOR_UNAVAILABLE`: those carry their boundary in the token, so no run can act as them.
|
|
4529
4529
|
*/
|
|
4530
4530
|
static createPlaybook(options) {
|
|
4531
4531
|
return (options.client ?? client).post({
|
|
@@ -4542,7 +4542,7 @@ var Playbooks = class {
|
|
|
4542
4542
|
*
|
|
4543
4543
|
* 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.
|
|
4544
4544
|
*
|
|
4545
|
-
* With `project_id`, the
|
|
4545
|
+
* With `project_id`, the references are checked too, as a write there would check them: the upstreams against that project's playbooks, and each executor the caller may start must exist (`EXECUTOR_NOT_FOUND`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
4546
4546
|
*/
|
|
4547
4547
|
static validatePlaybook(options) {
|
|
4548
4548
|
return (options.client ?? client).post({
|
|
@@ -4581,7 +4581,7 @@ var Playbooks = class {
|
|
|
4581
4581
|
*
|
|
4582
4582
|
* Updates any of `name`, `description` and `definition`. Only a change to `definition` archives a new version; a rename or a rewrite of the definition the playbook already holds leaves `version` where it is. A case keeps the version it was created on.
|
|
4583
4583
|
*
|
|
4584
|
-
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4584
|
+
* A new version is authored by the caller, checked as on create: `403 PLAYBOOK_EXECUTOR_FORBIDDEN` for an executor it may not start, an `EXECUTOR_NOT_FOUND` problem for one that does not exist, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4585
4585
|
*/
|
|
4586
4586
|
static updatePlaybook(options) {
|
|
4587
4587
|
return (options.client ?? client).patch({
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@naturali/sdk",
|
|
3
|
-
"version": "0.208.
|
|
3
|
+
"version": "0.208.10",
|
|
4
4
|
"description": "TypeScript SDK for the naturali.ai API, generated from its OpenAPI specs",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"naturali",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@hey-api/openapi-ts": "^0.99.0",
|
|
41
|
-
"@naturali/api": "0.208.
|
|
41
|
+
"@naturali/api": "0.208.10",
|
|
42
42
|
"@ttoss/openapi-codegen": "^0.5.0",
|
|
43
43
|
"@types/node": "^26.5.1",
|
|
44
44
|
"tsdown": "^0.23.0",
|