dataiku-sdk 0.3.1 → 0.5.0

package/dist/packages/types/src/index.js

@@ -196,6 +196,7 @@ export const RecipeCreateOptionsSchema = Type.Object({
     joinOn: Type.Optional(Type.Union([Type.String(), Type.Array(Type.String()),])),
     joinType: Type.Optional(Type.String()),
     projectKey: Type.Optional(Type.String()),
+    outputFolder: Type.Optional(Type.String()),
 });
 export const RecipeCreateResultSchema = Type.Object({
     recipeName: Type.String(),
@@ -203,6 +204,9 @@ export const RecipeCreateResultSchema = Type.Object({
     createdDatasets: Type.Array(Type.String()),
     joinConfigured: Type.Boolean(),
     outputProvisioningFallbackUsed: Type.Boolean(),
+    outputFolder: Type.Optional(Type.String()),
+    temporaryOutputDataset: Type.Optional(Type.String()),
+    temporaryOutputDatasetDeleted: Type.Optional(Type.Boolean()),
 });
 // ---------------------------------------------------------------------------
 // Jobs
@@ -236,6 +240,31 @@ export const JobWaitResultSchema = Type.Object({
     }),
     log: Type.Optional(Type.String()),
 });
+export const FutureStateSchema = Type.Object({
+    jobId: Type.Optional(Type.String()),
+    hasResult: Type.Optional(Type.Boolean()),
+    aborted: Type.Optional(Type.Boolean()),
+    abortable: Type.Optional(Type.Boolean()),
+    alive: Type.Optional(Type.Boolean()),
+    unknown: Type.Optional(Type.Boolean()),
+    startTime: Type.Optional(Type.Number()),
+    runningTime: Type.Optional(Type.Number()),
+    result: Type.Optional(Type.Unknown()),
+}, { additionalProperties: true, });
+export const FutureWaitResultSchema = Type.Object({
+    futureId: Type.String(),
+    jobId: Type.Optional(Type.String()),
+    state: Type.String(),
+    elapsedMs: Type.Number(),
+    pollCount: Type.Number(),
+    success: Type.Boolean(),
+    timedOut: Type.Optional(Type.Boolean()),
+    hasResult: Type.Boolean(),
+    alive: Type.Optional(Type.Boolean()),
+    aborted: Type.Optional(Type.Boolean()),
+    unknown: Type.Optional(Type.Boolean()),
+    result: Type.Optional(Type.Unknown()),
+}, { additionalProperties: true, });
 export const BuildModeSchema = Type.Union([
     Type.Literal("RECURSIVE_BUILD"),
     Type.Literal("NON_RECURSIVE_FORCED_BUILD"),
@@ -284,9 +313,63 @@ export const ScenarioStatusSchema = Type.Object({
         }, { additionalProperties: true, })),
     }, { additionalProperties: true, })),
 }, { additionalProperties: true, });
+export const ScenarioWaitResultSchema = Type.Object({
+    scenarioId: Type.String(),
+    runId: Type.String(),
+    outcome: Type.String(),
+    success: Type.Boolean(),
+    elapsedMs: Type.Number(),
+    pollCount: Type.Number(),
+    timedOut: Type.Optional(Type.Boolean()),
+});
+// ---------------------------------------------------------------------------
+// Flow zones
+// ---------------------------------------------------------------------------
+export const FlowZoneObjectTypeSchema = Type.Union([
+    Type.Literal("DATASET"),
+    Type.Literal("MANAGED_FOLDER"),
+    Type.Literal("SAVED_MODEL"),
+    Type.Literal("RECIPE"),
+    Type.Literal("MODEL_EVALUATION_STORE"),
+    Type.Literal("STREAMING_ENDPOINT"),
+    Type.Literal("LABELING_TASK"),
+    Type.Literal("RETRIEVABLE_KNOWLEDGE"),
+]);
+export const FlowZoneItemSchema = Type.Object({
+    objectId: Type.String(),
+    objectType: FlowZoneObjectTypeSchema,
+    projectKey: Type.Optional(Type.String()),
+}, { additionalProperties: true, });
+export const FlowZoneSchema = Type.Object({
+    id: Type.String(),
+    name: Type.String(),
+    color: Type.Optional(Type.String()),
+    projectKey: Type.Optional(Type.String()),
+    items: Type.Optional(Type.Array(FlowZoneItemSchema)),
+    shared: Type.Optional(Type.Array(FlowZoneItemSchema)),
+}, { additionalProperties: true, });
+export const FlowZoneArraySchema = Type.Array(FlowZoneSchema);
+export const FlowZoneCreateOptionsSchema = Type.Object({
+    name: Type.String(),
+    color: Type.Optional(Type.String()),
+    projectKey: Type.Optional(Type.String()),
+}, { additionalProperties: false, });
+export const FlowZoneUpdateOptionsSchema = Type.Object({
+    name: Type.Optional(Type.String()),
+    color: Type.Optional(Type.String()),
+    projectKey: Type.Optional(Type.String()),
+}, { additionalProperties: false, });
 // ---------------------------------------------------------------------------
 // Folders
 // ---------------------------------------------------------------------------
+export const FolderCreateOptionsSchema = Type.Object({
+    name: Type.String(),
+    type: Type.String(),
+    connection: Type.String(),
+    path: Type.Optional(Type.String()),
+    params: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
+    projectKey: Type.Optional(Type.String()),
+}, { additionalProperties: false, });
 export const FolderSummarySchema = Type.Object({
     id: Type.String(),
     name: Type.Optional(Type.String()),
@@ -340,6 +423,116 @@ export const CodeEnvDetailsSchema = Type.Object({
     requestedPackages: Type.Array(Type.String()),
     installedPackages: Type.Array(Type.String()),
 });
+export const CodeEnvActionResultSchema = Type.Record(Type.String(), Type.Unknown());
+export const CodeEnvCreateOptionsSchema = Type.Object({
+    envLang: Type.String(),
+    envName: Type.String(),
+    deploymentMode: Type.String(),
+    params: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
+    wait: Type.Optional(Type.Boolean()),
+}, { additionalProperties: false, });
+export const CodeEnvPackageListSchema = Type.Union([
+    Type.String(),
+    Type.Array(Type.String()),
+]);
+export const CodeEnvSetPackagesOptionsSchema = Type.Object({
+    packages: CodeEnvPackageListSchema,
+    installCorePackages: Type.Optional(Type.Boolean()),
+}, { additionalProperties: false, });
+export const CodeEnvUpdatePackagesOptionsSchema = Type.Object({
+    forceRebuildEnv: Type.Optional(Type.Boolean()),
+    versionToUpdate: Type.Optional(Type.String()),
+    wait: Type.Optional(Type.Boolean()),
+}, { additionalProperties: false, });
+export const CodeEnvWaitOptionsSchema = Type.Object({
+    wait: Type.Optional(Type.Boolean()),
+}, { additionalProperties: false, });
+export const CodeEnvUsageArraySchema = Type.Array(CodeEnvActionResultSchema);
+// ---------------------------------------------------------------------------
+// Wiki, Dashboards, Insights
+// ---------------------------------------------------------------------------
+export const WikiTaxonomyNodeSchema = Type.Object({
+    id: Type.String(),
+    children: Type.Array(Type.Unknown()),
+}, { additionalProperties: true, });
+export const WikiSettingsSchema = Type.Object({
+    projectKey: Type.Optional(Type.String()),
+    taxonomy: Type.Optional(Type.Array(WikiTaxonomyNodeSchema)),
+    homeArticleId: Type.Optional(Type.String()),
+}, { additionalProperties: true, });
+export const WikiArticleMetadataSchema = Type.Object({
+    id: Type.String(),
+    name: Type.Optional(Type.String()),
+    projectKey: Type.Optional(Type.String()),
+}, { additionalProperties: true, });
+export const WikiArticleDataSchema = Type.Object({
+    article: WikiArticleMetadataSchema,
+    payload: Type.Optional(Type.String()),
+}, { additionalProperties: true, });
+export const DashboardSummarySchema = Type.Object({
+    id: Type.String(),
+    name: Type.String(),
+    projectKey: Type.Optional(Type.String()),
+    owner: Type.Optional(Type.String()),
+    listed: Type.Optional(Type.Boolean()),
+    numPages: Type.Optional(Type.Number()),
+    numTiles: Type.Optional(Type.Number()),
+}, { additionalProperties: true, });
+export const DashboardDetailsSchema = Type.Object({
+    id: Type.String(),
+    name: Type.String(),
+    projectKey: Type.Optional(Type.String()),
+    owner: Type.Optional(Type.String()),
+    listed: Type.Optional(Type.Boolean()),
+    pages: Type.Optional(Type.Array(Type.Unknown())),
+}, { additionalProperties: true, });
+export const InsightSummarySchema = Type.Object({
+    id: Type.String(),
+    name: Type.String(),
+    type: Type.Optional(Type.String()),
+    projectKey: Type.Optional(Type.String()),
+    owner: Type.Optional(Type.String()),
+    listed: Type.Optional(Type.Boolean()),
+}, { additionalProperties: true, });
+export const InsightDetailsSchema = Type.Object({
+    id: Type.String(),
+    name: Type.String(),
+    type: Type.Optional(Type.String()),
+    projectKey: Type.Optional(Type.String()),
+    owner: Type.Optional(Type.String()),
+    listed: Type.Optional(Type.Boolean()),
+}, { additionalProperties: true, });
+export const DataQualityRuleSchema = Type.Object({
+    id: Type.String(),
+    displayName: Type.Optional(Type.String()),
+    name: Type.Optional(Type.String()),
+    type: Type.Optional(Type.String()),
+    enabled: Type.Optional(Type.Boolean()),
+    autoRun: Type.Optional(Type.Boolean()),
+    computeOnBuildMode: Type.Optional(Type.String()),
+}, { additionalProperties: true, });
+export const DataQualityRulesSchema = Type.Object({
+    checks: Type.Array(DataQualityRuleSchema),
+    monitor: Type.Optional(Type.Unknown()),
+    displayedState: Type.Optional(Type.Unknown()),
+}, { additionalProperties: true, });
+export const DataQualityRuleResultSchema = Type.Object({
+    id: Type.Optional(Type.String()),
+    name: Type.Optional(Type.String()),
+    ruleId: Type.Optional(Type.String()),
+    outcome: Type.Optional(Type.String()),
+    status: Type.Optional(Type.String()),
+}, { additionalProperties: true, });
+export const DataQualityStatusByPartitionSchema = Type.Record(Type.String(), Type.Unknown());
+export const DataQualityStatusSchema = Type.Union([
+    Type.String(),
+    Type.Record(Type.String(), Type.Unknown()),
+]);
+export const DataQualityProjectStatusSchema = Type.Record(Type.String(), Type.Unknown());
+export const DataQualityTimelineEntrySchema = Type.Record(Type.String(), Type.Unknown());
+export const DataQualityComputeResultSchema = Type.Object({
+    jobId: Type.Optional(Type.String()),
+}, { additionalProperties: true, });
 // ---------------------------------------------------------------------------
 // Jupyter Notebooks
 // ---------------------------------------------------------------------------
@@ -429,6 +622,12 @@ export const ScenarioSummaryArraySchema = Type.Array(ScenarioSummarySchema);
 export const FolderSummaryArraySchema = Type.Array(FolderSummarySchema);
 export const FolderItemArraySchema = Type.Array(FolderItemSchema);
 export const CodeEnvSummaryArraySchema = Type.Array(CodeEnvSummarySchema);
+export const WikiArticleDataArraySchema = Type.Array(WikiArticleDataSchema);
+export const DashboardSummaryArraySchema = Type.Array(DashboardSummarySchema);
+export const InsightSummaryArraySchema = Type.Array(InsightSummarySchema);
+export const DataQualityRuleArraySchema = Type.Array(DataQualityRuleSchema);
+export const DataQualityRuleResultArraySchema = Type.Array(DataQualityRuleResultSchema);
+export const DataQualityTimelineSchema = Type.Array(DataQualityTimelineEntrySchema);
 export const JupyterNotebookSummaryArraySchema = Type.Array(JupyterNotebookSummarySchema);
 export const SqlNotebookSummaryArraySchema = Type.Array(SqlNotebookSummarySchema);
 export const NotebookSessionArraySchema = Type.Array(NotebookSessionSchema);