@keboola/api-client 25.0.0 → 29.0.0

package/dist/types-DeApSCzx.d.cts

@@ -0,0 +1,602 @@
+import { s as OpenapiQueryType } from "./index-CLPrlyIz.cjs";
+import { t as Backend } from "./backends-DKBz5OxE.cjs";
+//#region src/clients/omnisearch/__generated__/schema.d.ts
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+type paths = {
+  '': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get Root
+     * @description Gets the API server info.
+     */
+    get: operations['_get_root_get'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/health-check': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get Status
+     * @description Gets the API server status.
+     */
+    get: operations['_get_status_health_check_get'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/v1/lineage/projects': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Shows lineage of all projects within an organization.
+     * @description Gets relationships between all projects in an organization. The nodes are projects and the directed edges show which projects share tables to what other projects that import those tables as table aliases. If `startingPoint` is specified only a partial lineage graph is returned that starts from the starting point and goes in the requested directions.
+     */
+    get: operations['getOrganizationLineage'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/v1/lineage/tables': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Shows lineage of all tables within a project.
+     * @description Gets the relationships between tables, their columns and transformations within a single project. The nodes are tables, columns or transformations and the directed edges show how data are “moved” by transformations from one table to another. If `startingPoint` is specified only a partial lineage graph is returned that starts from the starting point and goes in the requested directions.
+     */
+    get: operations['getProjectLineage'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    /**
+     * Bucket
+     * @description The bucket a table node belongs to.
+     */
+    Bucket: {
+      /** Id */
+      id?: string | null;
+      /** Displayname */
+      displayName?: string | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /**
+     * ConfigurationNode
+     * @description A configuration (transformation) node of a lineage graph.
+     */
+    ConfigurationNode: {
+      /**
+       * Fqid
+       * @description Fully-qualified identifier of this object.
+       */
+      fqid: string;
+      /** Name */
+      name?: string | null;
+      /** Description */
+      description?: string | null;
+      /** Created */
+      created?: string | null;
+      currentVersion?: components['schemas']['ConfigurationVersion'] | null;
+      creatorToken?: components['schemas']['ObjectRef'] | null;
+      /** Metadata */
+      metadata?: components['schemas']['Metadata'][] | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /** ConfigurationVersion */
+    ConfigurationVersion: {
+      /** Created */
+      created?: string | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /** ErrorApiResp */
+    ErrorApiResp: {
+      /** Detail */
+      detail: string;
+    };
+    /** HTTPValidationError */
+    HTTPValidationError: {
+      /** Detail */
+      detail?: components['schemas']['ValidationError'][];
+    };
+    /**
+     * LineageSource
+     * @enum {string}
+     */
+    LineageSource: 'sql_parsing' | 'llm_analysis' | 'extractor_analysis' | 'writer_analysis' | 'alias_analysis' | 'jobs_analysis';
+    /**
+     * Metadata
+     * @description A metadata entry as it comes out of the Storage API.
+     */
+    Metadata: {
+      /** Id */
+      id?: number | string | null;
+      /** Key */
+      key?: string | null;
+      /**
+       * Value
+       * @description Storage API metadata values are strings, but the lineage scores computed by this service are stored as numbers.
+       */
+      value?: string | boolean | number | null;
+      /** Provider */
+      provider?: string | null;
+      /** Timestamp */
+      timestamp?: string | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /**
+     * ObjectRef
+     * @description Reference to another Keboola object by its API id (not an FQID).
+     */
+    ObjectRef: {
+      /** Id */
+      id?: number | string | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /** ProjectLineageApiResp */
+    ProjectLineageApiResp: {
+      graph: components['schemas']['ProjectLineageGraph'];
+    };
+    /** ProjectLineageGraph */
+    ProjectLineageGraph: {
+      /** Projects */
+      projects: {
+        [key: string]: components['schemas']['ProjectNode'];
+      };
+      /** Relations */
+      relations: components['schemas']['ProjectLineageRelation'][];
+    };
+    /** ProjectLineageRelation */
+    ProjectLineageRelation: {
+      /**
+       * Sourcefqid
+       * @description FQID of the "from" project.
+       */
+      sourceFqid: string;
+      /**
+       * Targetfqid
+       * @description FQID of the "to" project.
+       */
+      targetFqid: string;
+      /**
+       * Lineagesource
+       * @description (DEPRECATED, will be removed in the next version) Lineage source, one of: sql_parsing, llm_analysis, extractor_analysis, writer_analysis, alias_analysis, jobs_analysis, combined
+       */
+      lineageSource: components['schemas']['LineageSource'] | 'combined';
+      /**
+       * Lineagesources
+       * @description Lineage sources, each one is one of: sql_parsing, llm_analysis, extractor_analysis, writer_analysis, alias_analysis, jobs_analysis
+       */
+      lineageSources: components['schemas']['LineageSource'][];
+    };
+    /**
+     * ProjectNode
+     * @description A project node of a lineage graph.
+     */
+    ProjectNode: {
+      /**
+       * Fqid
+       * @description Fully-qualified identifier of this object.
+       */
+      fqid: string;
+      /** Id */
+      id?: number | string | null;
+      /** Name */
+      name?: string | null;
+      /** Type */
+      type?: string | null;
+      /** Region */
+      region?: string | null;
+      /** Created */
+      created?: string | null;
+      /** Expires */
+      expires?: string | null;
+      /** Isdisabled */
+      isDisabled?: boolean | null;
+      organization?: components['schemas']['ObjectRef'] | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /** RootApiResp */
+    RootApiResp: {
+      /** Appname */
+      appName: string;
+      /** Appversion */
+      appVersion: string;
+      /** Apidocs */
+      apiDocs: string;
+    };
+    /**
+     * SourceTableRef
+     * @description The table an alias table is created from.
+     */
+    SourceTableRef: {
+      /** Id */
+      id?: string | null;
+      project?: components['schemas']['ObjectRef'] | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /** StatusApiResp */
+    StatusApiResp: {
+      /** Status */
+      status: string;
+    };
+    /** TableLineageApiResp */
+    TableLineageApiResp: {
+      graph: components['schemas']['TableLineageGraph'];
+    };
+    /** TableLineageGraph */
+    TableLineageGraph: {
+      /** Tables */
+      tables: {
+        [key: string]: components['schemas']['TableNode'];
+      };
+      /** Configurations */
+      configurations: {
+        [key: string]: components['schemas']['ConfigurationNode'];
+      };
+      /** Projects */
+      projects: {
+        [key: string]: components['schemas']['ProjectNode'];
+      };
+      /** Relations */
+      relations: components['schemas']['TableLineageRelation'][];
+    };
+    /** TableLineageRelation */
+    TableLineageRelation: {
+      /**
+       * Sourcefqid
+       * @description FQID of the "from" table/column.
+       */
+      sourceFqid: string;
+      /**
+       * Targetfqid
+       * @description FQID of the "to" table/column.
+       */
+      targetFqid: string;
+      /**
+       * Configurationfqid
+       * @description FQID of the configuration where this relation was found.
+       */
+      configurationFqid: string | null;
+      /**
+       * Lineagesource
+       * @description (DEPRECATED, will be removed in the next version) Lineage source, one of: sql_parsing, llm_analysis, extractor_analysis, writer_analysis, alias_analysis, jobs_analysis, combined
+       */
+      lineageSource: components['schemas']['LineageSource'] | 'combined';
+      /**
+       * Lineagesources
+       * @description Lineage sources, each one is one of: sql_parsing, llm_analysis, extractor_analysis, writer_analysis, alias_analysis, jobs_analysis
+       */
+      lineageSources: components['schemas']['LineageSource'][];
+    };
+    /**
+     * TableNode
+     * @description A table node of a lineage graph.
+     *
+     *     Regular Storage tables carry `bucket`, `id`, `name`, `displayName`, the timestamps and the
+     *     metadata; `columns` is only present when the `columns` query parameter is set, and
+     *     `bucket.displayName` only when it is not. External tables carry `name`, `database`, `db_schema`
+     *     and `columns` instead, virtual tables only `id`, `project_id` and `columns`.
+     */
+    TableNode: {
+      /**
+       * Fqid
+       * @description Fully-qualified identifier of this object.
+       */
+      fqid: string;
+      /** Id */
+      id?: string | null;
+      /** Name */
+      name?: string | null;
+      /** Displayname */
+      displayName?: string | null;
+      bucket?: components['schemas']['Bucket'] | null;
+      /** Columns */
+      columns?: string[] | null;
+      /** Primarykey */
+      primaryKey?: string[] | null;
+      /** Created */
+      created?: string | null;
+      /** Lastchangedate */
+      lastChangeDate?: string | null;
+      /** Lastimportdate */
+      lastImportDate?: string | null;
+      /** Metadata */
+      metadata?: components['schemas']['Metadata'][] | null;
+      /** Columnmetadata */
+      columnMetadata?: {
+        [key: string]: components['schemas']['Metadata'][];
+      } | null;
+      /** @description Set when this table is an alias of another table. */
+      sourceTable?: components['schemas']['SourceTableRef'] | null;
+      /**
+       * Database
+       * @description External tables only.
+       */
+      database?: string | null;
+      /**
+       * Db Schema
+       * @description External tables only.
+       */
+      db_schema?: string | null;
+      /**
+       * Project Id
+       * @description Virtual tables only.
+       */
+      project_id?: string | null;
+    } & {
+      [key: string]: unknown;
+    };
+    /** ValidationError */
+    ValidationError: {
+      /** Location */
+      loc: (string | number)[];
+      /** Message */
+      msg: string;
+      /** Error Type */
+      type: string;
+    };
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+type operations = {
+  _get_root_get: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['RootApiResp'];
+        };
+      };
+    };
+  };
+  _get_status_health_check_get: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['StatusApiResp'];
+        };
+      };
+    };
+  };
+  getOrganizationLineage: {
+    parameters: {
+      query?: {
+        /** @description FQID of the project where to start traversing the lineage graph. */
+        startingPoint?: string | null;
+        /** @description Number of projects to traverse through in the downstream direction. If not specified, all projects within the organization are traversed. Ignored if no starting point is specified. */
+        downstream?: number | null;
+        /** @description Number of projects to traverse through in the upstream direction. If not specified, all projects within the organization are traversed. Ignored if no starting point is specified. */
+        upstream?: number | null;
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ProjectLineageApiResp'];
+        };
+      };
+      /** @description The organization has no lineage available. */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ErrorApiResp'];
+        };
+      };
+      /** @description Missing or invalid Storage API token. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ErrorApiResp'];
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['HTTPValidationError'];
+        };
+      };
+    };
+  };
+  getProjectLineage: {
+    parameters: {
+      query: {
+        /** @description FQID of the project which table lineage to get. */
+        project: string;
+        /** @description If true, the relations between columns will be included in the lineage graph. */
+        columns?: boolean | null;
+        /** @description FQID of the table, column or transformation where to start traversing the lineage graph. */
+        startingPoint?: string | null;
+        /** @description Number of tables to traverse through in the downstream direction. If not specified, all tables within the project are traversed. Ignored if no starting point is specified. */
+        downstream?: number | null;
+        /** @description Number of tables to traverse through in the upstream direction. If not specified, all tables within the project are traversed. Ignored if no starting point is specified. */
+        upstream?: number | null;
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Successful Response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['TableLineageApiResp'];
+        };
+      };
+      /** @description The project has no tables and no relations, so there is no graph to return. */
+      204: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description The organization has no lineage available, or the `project`/`startingPoint` FQID is invalid. */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ErrorApiResp'];
+        };
+      };
+      /** @description Missing or invalid Storage API token. */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ErrorApiResp'];
+        };
+      };
+      /** @description The configuration given as the starting point has not been analyzed yet. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ErrorApiResp'];
+        };
+      };
+      /** @description Validation Error */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['HTTPValidationError'];
+        };
+      };
+    };
+  };
+};
+//#endregion
+//#region src/clients/omnisearch/types.d.ts
+type GetProjectsLineageQuery = OpenapiQueryType<paths['/v1/lineage/projects']['get']>;
+type GetTablesLineageQuery = OpenapiQueryType<paths['/v1/lineage/tables']['get']>;
+type ProjectsLineage = components['schemas']['ProjectLineageGraph'];
+type ProjectsLineageResponse = {
+  graph: ProjectsLineage;
+};
+/** Carries {@link LineageTable} nodes, so the fields the spec omits are named rather than `unknown`. */
+type TablesLineage = Omit<components['schemas']['TableLineageGraph'], 'tables'> & {
+  tables: Record<string, LineageTable>;
+};
+type TablesLineageResponse = {
+  graph: TablesLineage;
+};
+/** Which analysis produced an edge. `lineageSource` (singular) may also be the aggregate `'combined'`. */
+type LineageSource = components['schemas']['LineageSource'];
+/** Edge of the project graph — which projects share tables with which. */
+type ProjectLineageRelation = components['schemas']['ProjectLineageRelation'];
+/** Edge of the table graph — how transformations move data between tables and columns. */
+type TableLineageRelation = components['schemas']['TableLineageRelation'];
+type LineageProject = components['schemas']['ProjectNode'];
+type LineageConfiguration = components['schemas']['ConfigurationNode'];
+type LineageMetadata = components['schemas']['Metadata'];
+type LineageBucket = components['schemas']['Bucket'] & {
+  backend?: Backend | null;
+};
+/**
+ * Regular Storage tables carry `bucket`, `id`, `name`, `displayName`, the timestamps and the
+ * metadata; external tables carry `database` / `db_schema` instead, virtual tables only `id` and
+ * `project_id`. `columns` is present only when the `columns` query parameter is set. So `fqid` is the
+ * sole guaranteed field — narrow before reading anything else.
+ */
+type LineageTable = components['schemas']['TableNode'] & {
+  bucket?: LineageBucket | null;
+  rowsCount?: number | null;
+  dataSizeBytes?: number | null;
+};
+//#endregion
+export { LineageMetadata as a, LineageTable as c, ProjectsLineageResponse as d, TableLineageRelation as f, components as h, LineageConfiguration as i, ProjectLineageRelation as l, TablesLineageResponse as m, GetTablesLineageQuery as n, LineageProject as o, TablesLineage as p, LineageBucket as r, LineageSource as s, GetProjectsLineageQuery as t, ProjectsLineage as u };
+//# sourceMappingURL=types-DeApSCzx.d.cts.map