@soat/sdk 0.93.0 → 0.93.2
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 +9 -5
- package/dist/index.d.mts +9 -5
- package/dist/index.mjs +3 -3
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -3703,7 +3703,7 @@ var Playbooks = class {
|
|
|
3703
3703
|
*
|
|
3704
3704
|
* 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`.
|
|
3705
3705
|
*
|
|
3706
|
-
* 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.
|
|
3706
|
+
* 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.
|
|
3707
3707
|
*/
|
|
3708
3708
|
static createPlaybook(options) {
|
|
3709
3709
|
return (options.client ?? client).post({
|
|
@@ -3720,7 +3720,7 @@ var Playbooks = class {
|
|
|
3720
3720
|
*
|
|
3721
3721
|
* 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.
|
|
3722
3722
|
*
|
|
3723
|
-
* With `project_id`, the
|
|
3723
|
+
* 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.
|
|
3724
3724
|
*/
|
|
3725
3725
|
static validatePlaybook(options) {
|
|
3726
3726
|
return (options.client ?? client).post({
|
|
@@ -3759,7 +3759,7 @@ var Playbooks = class {
|
|
|
3759
3759
|
*
|
|
3760
3760
|
* 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.
|
|
3761
3761
|
*
|
|
3762
|
-
* 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.
|
|
3762
|
+
* 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.
|
|
3763
3763
|
*/
|
|
3764
3764
|
static updatePlaybook(options) {
|
|
3765
3765
|
return (options.client ?? client).patch({
|
package/dist/index.d.cts
CHANGED
|
@@ -5459,6 +5459,10 @@ type OnBehalfOf = {
|
|
|
5459
5459
|
* The generation that called the tool
|
|
5460
5460
|
*/
|
|
5461
5461
|
generation_id?: string | null;
|
|
5462
|
+
/**
|
|
5463
|
+
* The run-as work that called the tool: a playbook case or execution, a task, or an orchestration run
|
|
5464
|
+
*/
|
|
5465
|
+
work_id?: string | null;
|
|
5462
5466
|
session_id?: string | null;
|
|
5463
5467
|
actor_id?: string | null;
|
|
5464
5468
|
} | null;
|
|
@@ -6305,7 +6309,7 @@ type UpdatePlaybookRequest = {
|
|
|
6305
6309
|
};
|
|
6306
6310
|
type ValidatePlaybookRequest = {
|
|
6307
6311
|
/**
|
|
6308
|
-
* Also check the
|
|
6312
|
+
* Also check the references against this project: the upstreams (`UNKNOWN_UPSTREAM`, and the `MISSING_NODE` and `UNKNOWN_FIELD` of what an upstream node pulls) and the executors (`EXECUTOR_NOT_FOUND`).
|
|
6309
6313
|
*/
|
|
6310
6314
|
project_id?: string;
|
|
6311
6315
|
/**
|
|
@@ -6320,7 +6324,7 @@ type ValidatePlaybookRequest = {
|
|
|
6320
6324
|
type PlaybookValidationResult = {
|
|
6321
6325
|
valid: boolean;
|
|
6322
6326
|
/**
|
|
6323
|
-
* 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 `
|
|
6327
|
+
* 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`.
|
|
6324
6328
|
*/
|
|
6325
6329
|
problems: Array<ValidationProblem>;
|
|
6326
6330
|
};
|
|
@@ -25882,7 +25886,7 @@ export declare class Playbooks {
|
|
|
25882
25886
|
*
|
|
25883
25887
|
* 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`.
|
|
25884
25888
|
*
|
|
25885
|
-
* 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.
|
|
25889
|
+
* 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.
|
|
25886
25890
|
*/
|
|
25887
25891
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
25888
25892
|
/**
|
|
@@ -25890,7 +25894,7 @@ export declare class Playbooks {
|
|
|
25890
25894
|
*
|
|
25891
25895
|
* 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.
|
|
25892
25896
|
*
|
|
25893
|
-
* With `project_id`, the
|
|
25897
|
+
* 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.
|
|
25894
25898
|
*/
|
|
25895
25899
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
25896
25900
|
/**
|
|
@@ -25910,7 +25914,7 @@ export declare class Playbooks {
|
|
|
25910
25914
|
*
|
|
25911
25915
|
* 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.
|
|
25912
25916
|
*
|
|
25913
|
-
* 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.
|
|
25917
|
+
* 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.
|
|
25914
25918
|
*/
|
|
25915
25919
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
25916
25920
|
/**
|
package/dist/index.d.mts
CHANGED
|
@@ -5459,6 +5459,10 @@ type OnBehalfOf = {
|
|
|
5459
5459
|
* The generation that called the tool
|
|
5460
5460
|
*/
|
|
5461
5461
|
generation_id?: string | null;
|
|
5462
|
+
/**
|
|
5463
|
+
* The run-as work that called the tool: a playbook case or execution, a task, or an orchestration run
|
|
5464
|
+
*/
|
|
5465
|
+
work_id?: string | null;
|
|
5462
5466
|
session_id?: string | null;
|
|
5463
5467
|
actor_id?: string | null;
|
|
5464
5468
|
} | null;
|
|
@@ -6305,7 +6309,7 @@ type UpdatePlaybookRequest = {
|
|
|
6305
6309
|
};
|
|
6306
6310
|
type ValidatePlaybookRequest = {
|
|
6307
6311
|
/**
|
|
6308
|
-
* Also check the
|
|
6312
|
+
* Also check the references against this project: the upstreams (`UNKNOWN_UPSTREAM`, and the `MISSING_NODE` and `UNKNOWN_FIELD` of what an upstream node pulls) and the executors (`EXECUTOR_NOT_FOUND`).
|
|
6309
6313
|
*/
|
|
6310
6314
|
project_id?: string;
|
|
6311
6315
|
/**
|
|
@@ -6320,7 +6324,7 @@ type ValidatePlaybookRequest = {
|
|
|
6320
6324
|
type PlaybookValidationResult = {
|
|
6321
6325
|
valid: boolean;
|
|
6322
6326
|
/**
|
|
6323
|
-
* 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 `
|
|
6327
|
+
* 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`.
|
|
6324
6328
|
*/
|
|
6325
6329
|
problems: Array<ValidationProblem>;
|
|
6326
6330
|
};
|
|
@@ -25882,7 +25886,7 @@ export declare class Playbooks {
|
|
|
25882
25886
|
*
|
|
25883
25887
|
* 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`.
|
|
25884
25888
|
*
|
|
25885
|
-
* 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.
|
|
25889
|
+
* 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.
|
|
25886
25890
|
*/
|
|
25887
25891
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
25888
25892
|
/**
|
|
@@ -25890,7 +25894,7 @@ export declare class Playbooks {
|
|
|
25890
25894
|
*
|
|
25891
25895
|
* 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.
|
|
25892
25896
|
*
|
|
25893
|
-
* With `project_id`, the
|
|
25897
|
+
* 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.
|
|
25894
25898
|
*/
|
|
25895
25899
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
25896
25900
|
/**
|
|
@@ -25910,7 +25914,7 @@ export declare class Playbooks {
|
|
|
25910
25914
|
*
|
|
25911
25915
|
* 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.
|
|
25912
25916
|
*
|
|
25913
|
-
* 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.
|
|
25917
|
+
* 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.
|
|
25914
25918
|
*/
|
|
25915
25919
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
25916
25920
|
/**
|
package/dist/index.mjs
CHANGED
|
@@ -3702,7 +3702,7 @@ var Playbooks = class {
|
|
|
3702
3702
|
*
|
|
3703
3703
|
* 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`.
|
|
3704
3704
|
*
|
|
3705
|
-
* 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.
|
|
3705
|
+
* 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.
|
|
3706
3706
|
*/
|
|
3707
3707
|
static createPlaybook(options) {
|
|
3708
3708
|
return (options.client ?? client).post({
|
|
@@ -3719,7 +3719,7 @@ var Playbooks = class {
|
|
|
3719
3719
|
*
|
|
3720
3720
|
* 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.
|
|
3721
3721
|
*
|
|
3722
|
-
* With `project_id`, the
|
|
3722
|
+
* 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.
|
|
3723
3723
|
*/
|
|
3724
3724
|
static validatePlaybook(options) {
|
|
3725
3725
|
return (options.client ?? client).post({
|
|
@@ -3758,7 +3758,7 @@ var Playbooks = class {
|
|
|
3758
3758
|
*
|
|
3759
3759
|
* 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.
|
|
3760
3760
|
*
|
|
3761
|
-
* 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.
|
|
3761
|
+
* 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.
|
|
3762
3762
|
*/
|
|
3763
3763
|
static updatePlaybook(options) {
|
|
3764
3764
|
return (options.client ?? client).patch({
|