dataiku-sdk 3.6.1 → 3.8.0

package/dist/src/generated/action-output-schemas.json

@@ -124,21 +124,26 @@
         "code-env.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "envName",
-                    "envLang"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "envName": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "envLang": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "deploymentMode": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -361,41 +366,32 @@
         "dataset.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "name"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "type": {
-                        "type": "string"
-                    },
-                    "shortDesc": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "managed": {
-                        "type": "boolean"
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
                     },
-                    "params": {
-                        "additionalProperties": true,
-                        "type": "object",
-                        "properties": {
-                            "connection": {
-                                "type": "string"
-                            },
-                            "uploadConnection": {
-                                "type": "string"
-                            },
-                            "schema": {
-                                "type": "string"
-                            },
-                            "catalog": {
-                                "type": "string"
-                            }
-                        }
+                    "connection": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -730,44 +726,146 @@
                 }
             }
         },
+        "folder.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "name": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "connection": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
+        "future.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "jobId": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "owner": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "alive": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    },
+                    "hasResult": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    },
+                    "runningTime": {
+                        "type": [
+                            "number",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
+        "group.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "name": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "description": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "admin": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
         "job.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
+                "additionalProperties": false,
                 "properties": {
-                    "def": {
-                        "additionalProperties": true,
-                        "type": "object",
-                        "properties": {
-                            "id": {
-                                "type": "string"
-                            },
-                            "type": {
-                                "type": "string"
-                            }
-                        }
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
-                    "baseStatus": {
-                        "additionalProperties": true,
-                        "type": "object",
-                        "properties": {
-                            "def": {
-                                "additionalProperties": true,
-                                "type": "object",
-                                "properties": {
-                                    "id": {
-                                        "type": "string"
-                                    },
-                                    "type": {
-                                        "type": "string"
-                                    }
-                                }
-                            },
-                            "state": {
-                                "type": "string"
-                            }
-                        }
+                    "name": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "state": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "startTime": {
+                        "type": [
+                            "number",
+                            "null"
+                        ]
+                    },
+                    "endTime": {
+                        "type": [
+                            "number",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -908,6 +1006,60 @@
                 }
             }
         },
+        "macro.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "runnableType": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "ownerPluginId": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "label": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
+        "meaning.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "label": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
         "notebook.get-jupyter": {
             "additionalProperties": true,
             "type": "object",
@@ -1186,6 +1338,33 @@
                 }
             }
         },
+        "plugin.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "version": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "label": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
         "project-library.diff": {
             "type": "object",
             "additionalProperties": false,
@@ -1407,21 +1586,26 @@
         "project.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "projectKey",
-                    "name"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "projectKey": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
-                    "shortDesc": {
-                        "type": "string"
+                    "ownerLogin": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -1492,17 +1676,32 @@
         "recipe.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "name"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "type": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "inputs": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "outputs": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
                     }
                 }
             }
@@ -1573,20 +1772,38 @@
         "scenario.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "id"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "id": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "active": {
-                        "type": "boolean"
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    },
+                    "running": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -1730,6 +1947,45 @@
                     }
                 }
             ]
+        },
+        "user.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "login": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "displayName": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "userProfile": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "groups": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "enabled": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    }
+                }
+            }
         }
     }
 }

package/dist/src/index.d.ts

@@ -15,9 +15,11 @@ export { type DataCollectionCreateRequest, type DataCollectionObject, type DataC
 export { DataQualityResource, } from "./resources/data-quality.js";
 export { type DatasetBuildValidationResult, type DatasetCloneOptions, type DatasetCloneResult, type DatasetManagedCreateOptions, type DatasetManagedCreateResult, type DatasetSchemaColumnInput, DatasetsResource, type UploadDatasetFileOptions, type UploadDatasetFileResult, type UploadedFileMetadata, } from "./resources/datasets.js";
 export { DiscussionsResource, } from "./resources/discussions.js";
+export { type DocumentationTemplate, } from "./resources/documentation.js";
 export { type FlowZoneItemInput, FlowZonesResource, } from "./resources/flow-zones.js";
+export { FlowResource, type SchemaPropagationOptions, } from "./resources/flow.js";
 export { FoldersResource, } from "./resources/folders.js";
-export { FuturesResource, } from "./resources/futures.js";
+export { type DssTask, FuturesResource, type FutureWaitOptions, } from "./resources/futures.js";
 export { type DssGroup, type GroupCreateRequest, GroupsResource, } from "./resources/groups.js";
 export { InsightsResource, } from "./resources/insights.js";
 export { type JobBuildAndWaitOptions, type JobBuildOptions, type JobBuildTarget, type JobBuildTargetType, type JobLogFilter, type JobLogProgress, type JobLogSummary, type JobLogUnavailableReason, JobsResource, type JobWaitOutcome, parseJobLogProgress, } from "./resources/jobs.js";
@@ -27,6 +29,7 @@ export { type MacroResultOptions, type MacroRunFailure, type MacroRunHandle, typ
 export { MeaningsResource, } from "./resources/meanings.js";
 export { MetricsResource, } from "./resources/metrics.js";
 export * from "./resources/ml-tasks.js";
+export { type MlflowDeployRunOptions, type MlflowExperimentsDatasetOptions, MlflowExtensionResource, type MlflowInferenceInfo, type MlflowPredictionType, } from "./resources/mlflow-extension.js";
 export * from "./resources/model-evaluation-stores.js";
 export { NotebooksResource, } from "./resources/notebooks.js";
 export { type PluginCodeEnvCreateOptions, type PluginContentItem, type PluginCreateDevOptions, type PluginFileDetails, type PluginGitInstallOptions, type PluginGitRemote, type PluginMissingType, type PluginProjectScopeOptions, type PluginSettings, PluginsResource, type PluginSummary, type PluginUsage, type PluginUsageReport, } from "./resources/plugins.js";
@@ -40,6 +43,7 @@ export { normalizeScenarioUpdateData, SCENARIO_CANONICAL_EDITABLE_FIELDS, type S
 export { SqlResource, } from "./resources/sql.js";
 export { StatisticsResource, } from "./resources/statistics.js";
 export { StreamingEndpointsResource, } from "./resources/streaming-endpoints.js";
+export * from "./resources/trained-model.js";
 export { type DssUser, type ExternalUserEntry, type ProvisionRequest, type UserActivity, type UserCreateRequest, UsersResource, } from "./resources/users.js";
 export { VariablesResource, } from "./resources/variables.js";
 export { WebappsResource, } from "./resources/webapps.js";

package/dist/src/index.js

@@ -20,6 +20,7 @@ export { DataQualityResource, } from "./resources/data-quality.js";
 export { DatasetsResource, } from "./resources/datasets.js";
 export { DiscussionsResource, } from "./resources/discussions.js";
 export { FlowZonesResource, } from "./resources/flow-zones.js";
+export { FlowResource, } from "./resources/flow.js";
 export { FoldersResource, } from "./resources/folders.js";
 export { FuturesResource, } from "./resources/futures.js";
 export { GroupsResource, } from "./resources/groups.js";
@@ -31,6 +32,7 @@ export { MacrosResource, } from "./resources/macros.js";
 export { MeaningsResource, } from "./resources/meanings.js";
 export { MetricsResource, } from "./resources/metrics.js";
 export * from "./resources/ml-tasks.js";
+export { MlflowExtensionResource, } from "./resources/mlflow-extension.js";
 export * from "./resources/model-evaluation-stores.js";
 export { NotebooksResource, } from "./resources/notebooks.js";
 export { PluginsResource, } from "./resources/plugins.js";
@@ -44,6 +46,7 @@ export { normalizeScenarioUpdateData, SCENARIO_CANONICAL_EDITABLE_FIELDS, Scenar
 export { SqlResource, } from "./resources/sql.js";
 export { StatisticsResource, } from "./resources/statistics.js";
 export { StreamingEndpointsResource, } from "./resources/streaming-endpoints.js";
+export * from "./resources/trained-model.js";
 export { UsersResource, } from "./resources/users.js";
 export { VariablesResource, } from "./resources/variables.js";
 export { WebappsResource, } from "./resources/webapps.js";

package/dist/src/resources/analyses.d.ts

@@ -1,4 +1,5 @@
 import { BaseResource } from "./base.js";
+import type { MlTaskListItem } from "./ml-tasks.js";
 export interface AnalysisListItem extends Record<string, unknown> {
     id?: string;
     analysisId?: string;
@@ -30,5 +31,12 @@ export declare class AnalysesResource extends BaseResource {
     create(opts: AnalysisCreateOptions): Promise<AnalysisCreateResult>;
     /** Delete a visual analysis. */
     delete(analysisId: string, projectKey?: string): Promise<void>;
+    /**
+     * Replace a visual analysis definition (script, charts, name, tags): the
+     * object from {@link get}, edited (PUT /lab/{analysisId}/).
+     */
+    update(analysisId: string, definition: AnalysisDefinition, projectKey?: string): Promise<Record<string, unknown>>;
+    /** The ML tasks of one visual analysis (GET /lab/{analysisId}/models/). */
+    listMlTasks(analysisId: string, projectKey?: string): Promise<MlTaskListItem[]>;
     private analysisPath;
 }

package/dist/src/resources/analyses.js

@@ -1,4 +1,4 @@
-import { BaseResource, requireNonEmpty, } from "./base.js";
+import { BaseResource, requireArrayResponse, requireNonEmpty, requireObject, } from "./base.js";
 export class AnalysesResource extends BaseResource {
     /** List visual analyses in a project. */
     async list(projectKey) {
@@ -17,6 +17,18 @@ export class AnalysesResource extends BaseResource {
     async delete(analysisId, projectKey) {
         await this.client.del(`${this.analysisPath(analysisId, projectKey)}/`);
     }
+    /**
+     * Replace a visual analysis definition (script, charts, name, tags): the
+     * object from {@link get}, edited (PUT /lab/{analysisId}/).
+     */
+    async update(analysisId, definition, projectKey) {
+        return this.client.put(`${this.analysisPath(analysisId, projectKey)}/`, requireObject(definition, "definition"));
+    }
+    /** The ML tasks of one visual analysis (GET /lab/{analysisId}/models/). */
+    async listMlTasks(analysisId, projectKey) {
+        const res = await this.client.get(`${this.analysisPath(analysisId, projectKey)}/models/`);
+        return requireArrayResponse(res.mlTasks, "analyses.listMlTasks");
+    }
     analysisPath(analysisId, projectKey) {
         const id = encodeURIComponent(requireNonEmpty(analysisId, "analysisId"));
         return `/public/api/projects/${this.enc(projectKey)}/lab/${id}`;