@naturali/sdk 0.218.1 → 0.219.0
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 +7 -5
- package/dist/index.d.cts +16 -14
- package/dist/index.d.mts +16 -14
- package/dist/index.mjs +7 -5
- package/package.json +2 -2
package/dist/index.cjs
CHANGED
|
@@ -1474,8 +1474,10 @@ var AiProviders = class {
|
|
|
1474
1474
|
*
|
|
1475
1475
|
* Creates a new LLM provider configuration.
|
|
1476
1476
|
*
|
|
1477
|
-
* A
|
|
1478
|
-
*
|
|
1477
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
1478
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
1479
|
+
*
|
|
1480
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
1479
1481
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
1480
1482
|
* chain, Google Application Default Credentials), which is refused with
|
|
1481
1483
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -4545,7 +4547,7 @@ var Playbooks = class {
|
|
|
4545
4547
|
*
|
|
4546
4548
|
* 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`.
|
|
4547
4549
|
*
|
|
4548
|
-
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). 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.
|
|
4550
|
+
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). 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.
|
|
4549
4551
|
*/
|
|
4550
4552
|
static createPlaybook(options) {
|
|
4551
4553
|
return (options.client ?? client).post({
|
|
@@ -4562,7 +4564,7 @@ var Playbooks = class {
|
|
|
4562
4564
|
*
|
|
4563
4565
|
* 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.
|
|
4564
4566
|
*
|
|
4565
|
-
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
4567
|
+
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
4566
4568
|
*/
|
|
4567
4569
|
static validatePlaybook(options) {
|
|
4568
4570
|
return (options.client ?? client).post({
|
|
@@ -4601,7 +4603,7 @@ var Playbooks = class {
|
|
|
4601
4603
|
*
|
|
4602
4604
|
* 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.
|
|
4603
4605
|
*
|
|
4604
|
-
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4606
|
+
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4605
4607
|
*/
|
|
4606
4608
|
static updatePlaybook(options) {
|
|
4607
4609
|
return (options.client ?? client).patch({
|
package/dist/index.d.cts
CHANGED
|
@@ -7353,7 +7353,7 @@ type ValidatePlaybookRequest = {
|
|
|
7353
7353
|
type PlaybookValidationResult = {
|
|
7354
7354
|
valid: boolean;
|
|
7355
7355
|
/**
|
|
7356
|
-
* 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`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED` or `
|
|
7356
|
+
* 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`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`, `EXECUTOR_TOOL_UNSUPPORTED` or `TRANSFORMATION_TOOL_UNSUPPORTED`. The same items a refused write lists under `meta.problems`.
|
|
7357
7357
|
*/
|
|
7358
7358
|
problems: Array<ValidationProblem>;
|
|
7359
7359
|
};
|
|
@@ -12300,7 +12300,7 @@ type ListAiProvidersResponses = {
|
|
|
12300
12300
|
*/
|
|
12301
12301
|
base_url?: string;
|
|
12302
12302
|
/**
|
|
12303
|
-
* Additional provider-specific configuration. Absent when the record sets none.
|
|
12303
|
+
* Additional provider-specific configuration. Absent when the record sets none. Never carries a credential.
|
|
12304
12304
|
*/
|
|
12305
12305
|
config?: {
|
|
12306
12306
|
[key: string]: unknown;
|
|
@@ -12327,7 +12327,7 @@ type CreateAiProviderData = {
|
|
|
12327
12327
|
*/
|
|
12328
12328
|
default_model: string;
|
|
12329
12329
|
/**
|
|
12330
|
-
* Secret ID containing API credentials. Required for `bedrock` and `vertex
|
|
12330
|
+
* Secret ID containing API credentials. Required for `bedrock` and `vertex`.
|
|
12331
12331
|
*/
|
|
12332
12332
|
secret_id?: string;
|
|
12333
12333
|
/**
|
|
@@ -12335,7 +12335,7 @@ type CreateAiProviderData = {
|
|
|
12335
12335
|
*/
|
|
12336
12336
|
base_url?: string;
|
|
12337
12337
|
/**
|
|
12338
|
-
* Additional provider-specific configuration. `
|
|
12338
|
+
* Additional provider-specific configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
12339
12339
|
*/
|
|
12340
12340
|
config?: {
|
|
12341
12341
|
[key: string]: unknown;
|
|
@@ -12511,7 +12511,7 @@ type GetAiProviderResponses = {
|
|
|
12511
12511
|
secret_id?: string | null;
|
|
12512
12512
|
base_url?: string;
|
|
12513
12513
|
/**
|
|
12514
|
-
* Additional provider-specific configuration.
|
|
12514
|
+
* Additional provider-specific configuration. Never carries a credential.
|
|
12515
12515
|
*/
|
|
12516
12516
|
config?: {
|
|
12517
12517
|
[key: string]: unknown;
|
|
@@ -12532,7 +12532,7 @@ type UpdateAiProviderData = {
|
|
|
12532
12532
|
secret_id?: string | null;
|
|
12533
12533
|
base_url?: string;
|
|
12534
12534
|
/**
|
|
12535
|
-
* Replaces the whole configuration
|
|
12535
|
+
* Replaces the whole configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
12536
12536
|
*/
|
|
12537
12537
|
config?: {
|
|
12538
12538
|
[key: string]: unknown;
|
|
@@ -16862,7 +16862,7 @@ type UpdateDocumentErrors = {
|
|
|
16862
16862
|
*/
|
|
16863
16863
|
404: ErrorResponse;
|
|
16864
16864
|
/**
|
|
16865
|
-
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
16865
|
+
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), `path` is held by another file in the project (`NAME_CONFLICT`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
16866
16866
|
*/
|
|
16867
16867
|
409: ErrorResponse;
|
|
16868
16868
|
/**
|
|
@@ -17311,7 +17311,7 @@ type RestoreDocumentVersionErrors = {
|
|
|
17311
17311
|
*/
|
|
17312
17312
|
404: ErrorResponse;
|
|
17313
17313
|
/**
|
|
17314
|
-
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
17314
|
+
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`), the restored `path` is held by another file in the project (`NAME_CONFLICT`), or the restored content would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
17315
17315
|
*/
|
|
17316
17316
|
409: ErrorResponse;
|
|
17317
17317
|
/**
|
|
@@ -22433,7 +22433,7 @@ type UpdateMemoryErrors = {
|
|
|
22433
22433
|
*/
|
|
22434
22434
|
404: ErrorResponse;
|
|
22435
22435
|
/**
|
|
22436
|
-
* The
|
|
22436
|
+
* The memory has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
22437
22437
|
*/
|
|
22438
22438
|
409: ErrorResponse;
|
|
22439
22439
|
/**
|
|
@@ -33048,8 +33048,10 @@ export declare class AiProviders {
|
|
|
33048
33048
|
*
|
|
33049
33049
|
* Creates a new LLM provider configuration.
|
|
33050
33050
|
*
|
|
33051
|
-
* A
|
|
33052
|
-
*
|
|
33051
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
33052
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
33053
|
+
*
|
|
33054
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
33053
33055
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
33054
33056
|
* chain, Google Application Default Credentials), which is refused with
|
|
33055
33057
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -34634,7 +34636,7 @@ export declare class Playbooks {
|
|
|
34634
34636
|
*
|
|
34635
34637
|
* 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`.
|
|
34636
34638
|
*
|
|
34637
|
-
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). 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.
|
|
34639
|
+
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). 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.
|
|
34638
34640
|
*/
|
|
34639
34641
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
34640
34642
|
/**
|
|
@@ -34642,7 +34644,7 @@ export declare class Playbooks {
|
|
|
34642
34644
|
*
|
|
34643
34645
|
* 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.
|
|
34644
34646
|
*
|
|
34645
|
-
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
34647
|
+
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
34646
34648
|
*/
|
|
34647
34649
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
34648
34650
|
/**
|
|
@@ -34662,7 +34664,7 @@ export declare class Playbooks {
|
|
|
34662
34664
|
*
|
|
34663
34665
|
* 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.
|
|
34664
34666
|
*
|
|
34665
|
-
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
34667
|
+
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
34666
34668
|
*/
|
|
34667
34669
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
34668
34670
|
/**
|
package/dist/index.d.mts
CHANGED
|
@@ -7353,7 +7353,7 @@ type ValidatePlaybookRequest = {
|
|
|
7353
7353
|
type PlaybookValidationResult = {
|
|
7354
7354
|
valid: boolean;
|
|
7355
7355
|
/**
|
|
7356
|
-
* 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`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED` or `
|
|
7356
|
+
* 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`, `EXECUTOR_NOT_FOUND`, `EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`, `EXECUTOR_TOOL_UNSUPPORTED` or `TRANSFORMATION_TOOL_UNSUPPORTED`. The same items a refused write lists under `meta.problems`.
|
|
7357
7357
|
*/
|
|
7358
7358
|
problems: Array<ValidationProblem>;
|
|
7359
7359
|
};
|
|
@@ -12300,7 +12300,7 @@ type ListAiProvidersResponses = {
|
|
|
12300
12300
|
*/
|
|
12301
12301
|
base_url?: string;
|
|
12302
12302
|
/**
|
|
12303
|
-
* Additional provider-specific configuration. Absent when the record sets none.
|
|
12303
|
+
* Additional provider-specific configuration. Absent when the record sets none. Never carries a credential.
|
|
12304
12304
|
*/
|
|
12305
12305
|
config?: {
|
|
12306
12306
|
[key: string]: unknown;
|
|
@@ -12327,7 +12327,7 @@ type CreateAiProviderData = {
|
|
|
12327
12327
|
*/
|
|
12328
12328
|
default_model: string;
|
|
12329
12329
|
/**
|
|
12330
|
-
* Secret ID containing API credentials. Required for `bedrock` and `vertex
|
|
12330
|
+
* Secret ID containing API credentials. Required for `bedrock` and `vertex`.
|
|
12331
12331
|
*/
|
|
12332
12332
|
secret_id?: string;
|
|
12333
12333
|
/**
|
|
@@ -12335,7 +12335,7 @@ type CreateAiProviderData = {
|
|
|
12335
12335
|
*/
|
|
12336
12336
|
base_url?: string;
|
|
12337
12337
|
/**
|
|
12338
|
-
* Additional provider-specific configuration. `
|
|
12338
|
+
* Additional provider-specific configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
12339
12339
|
*/
|
|
12340
12340
|
config?: {
|
|
12341
12341
|
[key: string]: unknown;
|
|
@@ -12511,7 +12511,7 @@ type GetAiProviderResponses = {
|
|
|
12511
12511
|
secret_id?: string | null;
|
|
12512
12512
|
base_url?: string;
|
|
12513
12513
|
/**
|
|
12514
|
-
* Additional provider-specific configuration.
|
|
12514
|
+
* Additional provider-specific configuration. Never carries a credential.
|
|
12515
12515
|
*/
|
|
12516
12516
|
config?: {
|
|
12517
12517
|
[key: string]: unknown;
|
|
@@ -12532,7 +12532,7 @@ type UpdateAiProviderData = {
|
|
|
12532
12532
|
secret_id?: string | null;
|
|
12533
12533
|
base_url?: string;
|
|
12534
12534
|
/**
|
|
12535
|
-
* Replaces the whole configuration
|
|
12535
|
+
* Replaces the whole configuration. `apiKey` is refused: the credential goes in the linked secret.
|
|
12536
12536
|
*/
|
|
12537
12537
|
config?: {
|
|
12538
12538
|
[key: string]: unknown;
|
|
@@ -16862,7 +16862,7 @@ type UpdateDocumentErrors = {
|
|
|
16862
16862
|
*/
|
|
16863
16863
|
404: ErrorResponse;
|
|
16864
16864
|
/**
|
|
16865
|
-
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
16865
|
+
* The document has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), `path` is held by another file in the project (`NAME_CONFLICT`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
16866
16866
|
*/
|
|
16867
16867
|
409: ErrorResponse;
|
|
16868
16868
|
/**
|
|
@@ -17311,7 +17311,7 @@ type RestoreDocumentVersionErrors = {
|
|
|
17311
17311
|
*/
|
|
17312
17312
|
404: ErrorResponse;
|
|
17313
17313
|
/**
|
|
17314
|
-
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`),
|
|
17314
|
+
* Another write took the document's version first (`VERSION_CONFLICT`, with `meta.current_version`), the restored `path` is held by another file in the project (`NAME_CONFLICT`), or the restored content would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
17315
17315
|
*/
|
|
17316
17316
|
409: ErrorResponse;
|
|
17317
17317
|
/**
|
|
@@ -22433,7 +22433,7 @@ type UpdateMemoryErrors = {
|
|
|
22433
22433
|
*/
|
|
22434
22434
|
404: ErrorResponse;
|
|
22435
22435
|
/**
|
|
22436
|
-
* The
|
|
22436
|
+
* The memory has moved past the version this write read (`VERSION_CONFLICT`, with `meta.current_version`), or new `content` would exceed the project's `storage_bytes` quota (`QUOTA_STORAGE_EXCEEDED`, no `Retry-After`). Nothing is written.
|
|
22437
22437
|
*/
|
|
22438
22438
|
409: ErrorResponse;
|
|
22439
22439
|
/**
|
|
@@ -33048,8 +33048,10 @@ export declare class AiProviders {
|
|
|
33048
33048
|
*
|
|
33049
33049
|
* Creates a new LLM provider configuration.
|
|
33050
33050
|
*
|
|
33051
|
-
* A
|
|
33052
|
-
*
|
|
33051
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
33052
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
33053
|
+
*
|
|
33054
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
33053
33055
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
33054
33056
|
* chain, Google Application Default Credentials), which is refused with
|
|
33055
33057
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -34634,7 +34636,7 @@ export declare class Playbooks {
|
|
|
34634
34636
|
*
|
|
34635
34637
|
* 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`.
|
|
34636
34638
|
*
|
|
34637
|
-
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). 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.
|
|
34639
|
+
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). 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.
|
|
34638
34640
|
*/
|
|
34639
34641
|
static createPlaybook<ThrowOnError extends boolean = false>(options: Options<CreatePlaybookData, ThrowOnError>): RequestResult<CreatePlaybookResponses, CreatePlaybookErrors, ThrowOnError>;
|
|
34640
34642
|
/**
|
|
@@ -34642,7 +34644,7 @@ export declare class Playbooks {
|
|
|
34642
34644
|
*
|
|
34643
34645
|
* 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.
|
|
34644
34646
|
*
|
|
34645
|
-
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
34647
|
+
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
34646
34648
|
*/
|
|
34647
34649
|
static validatePlaybook<ThrowOnError extends boolean = false>(options: Options<ValidatePlaybookData, ThrowOnError>): RequestResult<ValidatePlaybookResponses, ValidatePlaybookErrors, ThrowOnError>;
|
|
34648
34650
|
/**
|
|
@@ -34662,7 +34664,7 @@ export declare class Playbooks {
|
|
|
34662
34664
|
*
|
|
34663
34665
|
* 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.
|
|
34664
34666
|
*
|
|
34665
|
-
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
34667
|
+
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
34666
34668
|
*/
|
|
34667
34669
|
static updatePlaybook<ThrowOnError extends boolean = false>(options: Options<UpdatePlaybookData, ThrowOnError>): RequestResult<UpdatePlaybookResponses, UpdatePlaybookErrors, ThrowOnError>;
|
|
34668
34670
|
/**
|
package/dist/index.mjs
CHANGED
|
@@ -1473,8 +1473,10 @@ var AiProviders = class {
|
|
|
1473
1473
|
*
|
|
1474
1474
|
* Creates a new LLM provider configuration.
|
|
1475
1475
|
*
|
|
1476
|
-
* A
|
|
1477
|
-
*
|
|
1476
|
+
* A provider's credential is its linked `secret_id`; `config.apiKey` is
|
|
1477
|
+
* refused with `400 VALIDATION_FAILED`.
|
|
1478
|
+
*
|
|
1479
|
+
* A `bedrock` or `vertex` record must link one. Without it the provider
|
|
1478
1480
|
* SDK signs with the server's own credentials (the AWS default credential
|
|
1479
1481
|
* chain, Google Application Default Credentials), which is refused with
|
|
1480
1482
|
* `400 VALIDATION_FAILED` unless the deployment allows it.
|
|
@@ -4544,7 +4546,7 @@ var Playbooks = class {
|
|
|
4544
4546
|
*
|
|
4545
4547
|
* 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`.
|
|
4546
4548
|
*
|
|
4547
|
-
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). 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.
|
|
4549
|
+
* 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 `tool` executor on an `mcp` tool must name in `operation_id` an action the tool's binding allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). An executor cannot be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), nor a transformation's tool a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). 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.
|
|
4548
4550
|
*/
|
|
4549
4551
|
static createPlaybook(options) {
|
|
4550
4552
|
return (options.client ?? client).post({
|
|
@@ -4561,7 +4563,7 @@ var Playbooks = class {
|
|
|
4561
4563
|
*
|
|
4562
4564
|
* 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.
|
|
4563
4565
|
*
|
|
4564
|
-
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
4566
|
+
* 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`) and name an action its `mcp` tool allows (`EXECUTOR_ACTION_REQUIRED`, `EXECUTOR_ACTION_UNAVAILABLE`) and not be a `client` tool (`EXECUTOR_TOOL_UNSUPPORTED`), and each transformation's tool must not be a `client` or `mcp` tool (`TRANSFORMATION_TOOL_UNSUPPORTED`). The caller needs both `playbooks:ValidatePlaybook` and `playbooks:ListPlaybooks` on the project. Without it, only the definition's own graph is checked.
|
|
4565
4567
|
*/
|
|
4566
4568
|
static validatePlaybook(options) {
|
|
4567
4569
|
return (options.client ?? client).post({
|
|
@@ -4600,7 +4602,7 @@ var Playbooks = class {
|
|
|
4600
4602
|
*
|
|
4601
4603
|
* 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.
|
|
4602
4604
|
*
|
|
4603
|
-
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4605
|
+
* 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, `EXECUTOR_ACTION_REQUIRED` or `EXECUTOR_ACTION_UNAVAILABLE` for an `mcp` tool action a run could not call, `EXECUTOR_TOOL_UNSUPPORTED` for a `client` tool executor, `TRANSFORMATION_TOOL_UNSUPPORTED` for a `client` or `mcp` transformation tool, `409 PLAYBOOK_AUTHOR_UNAVAILABLE` for a trigger or OAuth token.
|
|
4604
4606
|
*/
|
|
4605
4607
|
static updatePlaybook(options) {
|
|
4606
4608
|
return (options.client ?? client).patch({
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@naturali/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.219.0",
|
|
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.
|
|
41
|
+
"@naturali/api": "0.219.0",
|
|
42
42
|
"@ttoss/openapi-codegen": "^0.10.0",
|
|
43
43
|
"@types/node": "^26.5.1",
|
|
44
44
|
"tsdown": "^0.23.0",
|