@qlik/api 2.2.0 → 2.3.0

package/chunks/data-qualities-DBrot957.d.ts

@@ -1,176 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/data-qualities.d.ts
-
-/**
- * The ID of the computation
- */
-type ComputationResponse = {
-  computationId: string;
-};
-type ComputationStatusResponse = {
-  status: ExecutionStatus;
-};
-/**
- * The ID of the connection
- */
-type ConnectionIdType = string;
-/**
- * Represents a data quality computation request. The `connectionId` attribute is optional for file-based datasets. If no sampling parameters (`executionMode`, `sampleMode`, `sampleSize`) are provided, the following default configuration is used: - `executionMode: PULLUP` - `sampleMode: ABSOLUTE` - `sampleSize: 1000`
- * @example
- * {
- *   connectionId: "2b855c3d-426c-4aac-90cf-0edf9fc294d3",
- *   datasetId: "669144f5aa2d642638ef1dd0"
- * }
- */
-type DataQualityComputationRequest = {
-  /** The ID of the connection */
-  connectionId?: ConnectionIdType;
-  /** The ID of the dataset */
-  datasetId?: DatasetIdType;
-} & SamplingConfiguration;
-/**
- * The ID of the dataset
- */
-type DatasetIdType = string;
-type DatasetQualityGlobalResultsResponse = {
-  /** The ID of the dataset */
-  datasetId: string;
-  qualities: QualitiesGlobalResultsResponse[];
-};
-type Error = {
-  code?: string;
-  detail?: string;
-  status?: string;
-  title?: string;
-};
-type ErrorResponse = {
-  errors?: Error[];
-  traceId?: string;
-};
-type ExecutionStatus = "PROFILE_REQUESTED" | "PROFILE_FAILED" | "REQUESTED" | "SUBMITTED" | "SUCCEEDED" | "FAILED";
-type QualitiesGlobalResultsResponse = {
-  /** The ID of the connection */
-  connectionId: string;
-  quality: QualityGlobalResultsResponse;
-};
-type QualityGlobalResultsResponse = {
-  /** Number of empty sample cells */
-  empty: number;
-  /** Number of invalid sample cells */
-  invalid: number;
-  /** Total number of cells in the sample */
-  total: number;
-  updatedAt: string;
-  /** Number of valid sample cells */
-  valid: number;
-};
-type SamplingConfiguration = {
-  /** Specifies where the data quality computation takes place. In PUSHDOWN mode, it runs within the Cloud Data Warehouse (e.g., Snowflake, Databricks), whereas in PULLUP mode, it runs in Qlik Cloud. */
-  executionMode?: "PUSHDOWN" | "PULLUP";
-  /** Specifies how the dataset is sampled. ABSOLUTE represents a fixed number of rows, while RELATIVE refers to a percentage of the total dataset rows. */
-  sampleMode?: "ABSOLUTE" | "RELATIVE";
-  /** The actual value of the selected sampling method size (either a fixed number for ABSOLUTE mode or a percentage for RELATIVE mode). */
-  sampleSize?: number;
-};
-/**
- * Triggers the computation of data quality.
- *
- * @param body an object with the body content
- * @throws TriggerDataQualitiesComputationHttpError
- */
-declare function triggerDataQualitiesComputation(body: DataQualityComputationRequest, options?: ApiCallOptions): Promise<TriggerDataQualitiesComputationHttpResponse>;
-type TriggerDataQualitiesComputationHttpResponse = {
-  data: ComputationResponse;
-  headers: Headers;
-  status: 202;
-};
-type TriggerDataQualitiesComputationHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 500 | 503;
-};
-/**
- * Returns the execution status of a data quality computation.
- * @example
- * getDataQualitiesComputation(
- *   "4db06daa-3117-412e-8fb4-b29c937f9a0e"
- * )
- *
- * @param computationId The ID of the computation
- * @throws GetDataQualitiesComputationHttpError
- */
-declare function getDataQualitiesComputation(computationId: string, options?: ApiCallOptions): Promise<GetDataQualitiesComputationHttpResponse>;
-type GetDataQualitiesComputationHttpResponse = {
-  data: ComputationStatusResponse;
-  headers: Headers;
-  status: 200;
-};
-type GetDataQualitiesComputationHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 500 | 503;
-};
-/**
- * Returns the global data results for a dataset, including counts of total, valid, invalid, and empty sample cells.
- *
- * @param query an object with query parameters
- * @throws GetDataQualitiesGlobalResultsHttpError
- */
-declare function getDataQualitiesGlobalResults(query: {
-  /** The connection ID */
-  connectionId?: ConnectionIdType;
-  /** The ID of the dataset */
-  datasetId: DatasetIdType;
-}, options?: ApiCallOptions): Promise<GetDataQualitiesGlobalResultsHttpResponse>;
-type GetDataQualitiesGlobalResultsHttpResponse = {
-  data: DatasetQualityGlobalResultsResponse;
-  headers: Headers;
-  status: 200;
-};
-type GetDataQualitiesGlobalResultsHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 500 | 503;
-};
-/**
- * Clears the cache for data-qualities api requests.
- */
-declare function clearCache(): void;
-type DataQualitiesAPI = {
-  /**
-   * Triggers the computation of data quality.
-   *
-   * @param body an object with the body content
-   * @throws TriggerDataQualitiesComputationHttpError
-   */
-  triggerDataQualitiesComputation: typeof triggerDataQualitiesComputation;
-  /**
-   * Returns the execution status of a data quality computation.
-   * @example
-   * getDataQualitiesComputation(
-   *   "4db06daa-3117-412e-8fb4-b29c937f9a0e"
-   * )
-   *
-   * @param computationId The ID of the computation
-   * @throws GetDataQualitiesComputationHttpError
-   */
-  getDataQualitiesComputation: typeof getDataQualitiesComputation;
-  /**
-   * Returns the global data results for a dataset, including counts of total, valid, invalid, and empty sample cells.
-   *
-   * @param query an object with query parameters
-   * @throws GetDataQualitiesGlobalResultsHttpError
-   */
-  getDataQualitiesGlobalResults: typeof getDataQualitiesGlobalResults;
-  /**
-   * Clears the cache for data-qualities api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the data-qualities api
- */
-declare const dataQualitiesExport: DataQualitiesAPI;
-//#endregion
-export { getDataQualitiesGlobalResults as C, getDataQualitiesComputation as S, SamplingConfiguration as _, DataQualityComputationRequest as a, clearCache as b, Error as c, GetDataQualitiesComputationHttpError as d, GetDataQualitiesComputationHttpResponse as f, QualityGlobalResultsResponse as g, QualitiesGlobalResultsResponse as h, DataQualitiesAPI as i, ErrorResponse as l, GetDataQualitiesGlobalResultsHttpResponse as m, ComputationStatusResponse as n, DatasetIdType as o, GetDataQualitiesGlobalResultsHttpError as p, ConnectionIdType as r, DatasetQualityGlobalResultsResponse as s, ComputationResponse as t, ExecutionStatus as u, TriggerDataQualitiesComputationHttpError as v, triggerDataQualitiesComputation as w, dataQualitiesExport as x, TriggerDataQualitiesComputationHttpResponse as y };

package/chunks/data-sets-CFzxgWnO.d.ts

@@ -1,424 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/data-sets.d.ts
-type BatchIdDto = {
-  ids?: string[];
-};
-type BinnedFrequency = {
-  binEdge?: number;
-  frequency?: number;
-};
-type Classification = {
-  obfuscation?: string;
-  pii?: boolean;
-  sensitive?: boolean;
-  tags?: Tag[];
-};
-type DataAssetInfo = {
-  dataStoreInfo?: DataStoreInfo;
-  id: string;
-  readonly name?: string;
-};
-type DataField = {
-  alias?: string;
-  dataType: FieldDataType;
-  description?: string;
-  encrypted?: boolean;
-  readonly index?: number;
-  name: string;
-  nullable?: boolean;
-  ordinalPositionInKey?: number;
-  orphan?: boolean;
-  primaryKey?: boolean;
-  properties?: Record<string, unknown>;
-  sensitive?: boolean;
-  /** An array of system tags */
-  tags?: string[];
-  /** An array of user-supplied tags */
-  userTags?: UserTag[];
-};
-type DataSet = {
-  /** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */
-  additionalSchemas?: Schema[];
-  /** Optional override of DataAsset appType. */
-  appTypeOverride?: string;
-  /** The value is automatically set by the application. User defined value is ignored. */
-  readonly createdBy?: string;
-  /** The connectionId that created the Dataset. Optional. */
-  createdByConnectionId?: string;
-  /** The value is automatically set by the application. User defined value is ignored. */
-  readonly createdTime?: string;
-  dataAssetInfo: DataAssetInfo;
-  description?: string;
-  /** Only required when updating the resource. Must be null for new resources. */
-  id?: string;
-  /** The value is automatically set by the application. User defined value is ignored. */
-  readonly lastModifiedBy?: string;
-  /** The value is automatically set by the application. User defined value is ignored. */
-  readonly lastModifiedTime?: string;
-  name?: string;
-  operational?: Operational;
-  /** The value is automatically set by the application. */
-  ownerId?: string;
-  /** A Map of name-value pairs. */
-  properties?: Record<string, unknown>;
-  /** NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. */
-  qri: string;
-  /** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */
-  schema?: Schema;
-  secureQri: string;
-  spaceId?: string;
-  tags?: string[];
-  technicalDescription?: string;
-  technicalName: string;
-  /** The value is automatically set by the application. User defined value is ignored. */
-  readonly tenantId?: string;
-  type?: string;
-  /** Only required when updating the resource. Must be null for new resources. */
-  version?: number;
-};
-type DataSetProfile = {
-  meta?: ProfileMetadata;
-  readonly profiles?: TableProfile[];
-  readonly samples?: TableSample[];
-};
-type DataStoreInfo = {
-  id: string;
-  readonly name?: string;
-  readonly type?: string;
-};
-type Error = {
-  code?: string;
-  detail?: string;
-  status?: string;
-  title?: string;
-};
-type ErrorResponse = {
-  errors?: Error[];
-  traceId?: string;
-};
-type FieldDataType = {
-  originalType?: string;
-  /** The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value.  All other datatypes does not require any manadatory properties to be defined. */
-  properties?: Record<string, unknown>;
-  /** Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties. */
-  type: "DATE" | "TIME" | "DATETIME" | "TIMESTAMP" | "STRING" | "DOUBLE" | "DECIMAL" | "INTEGER" | "BOOLEAN" | "BINARY" | "CUSTOM";
-};
-type FieldProfile = {
-  average?: number;
-  averageStringLength?: number;
-  classification?: Classification;
-  dataType?: "DATE" | "TIME" | "DATETIME" | "TIMESTAMP" | "STRING" | "DOUBLE" | "DECIMAL" | "INTEGER" | "BOOLEAN" | "BINARY" | "CUSTOM";
-  distinctValueCount?: number;
-  emptyStringCount?: number;
-  evenness?: number;
-  firstSortedStringValue?: string;
-  fractiles?: number[];
-  frequencyDistribution?: BinnedFrequency[];
-  index?: number;
-  kurtosis?: number;
-  lastSortedStringValue?: string;
-  maxNumericValue?: number;
-  maxStringLength?: number;
-  median?: number;
-  minNumericValue?: number;
-  minStringLength?: number;
-  mostFrequentValues?: Frequency[];
-  name?: string;
-  negativeValueCount?: number;
-  nullValueCount?: number;
-  numericValueCount?: number;
-  positiveValueCount?: number;
-  sampleValues?: string[];
-  skewness?: number;
-  standardDeviation?: number;
-  sumNumericValues?: number;
-  sumSquaredNumericValues?: number;
-  sumStringLength?: number;
-  tags?: string[];
-  technicalName?: string;
-  textValueCount?: number;
-  zeroValueCount?: number;
-};
-type Frequency = {
-  frequency?: number;
-  value?: string;
-};
-type JsonPatch = {
-  /** A JSON Pointer path pointing to the location to move/copy from. */
-  from?: string;
-  /** The operation to be performed. */
-  op: "add" | "remove" | "replace" | "move" | "copy" | "test";
-  /** A JSON pointer to the property being affected. */
-  path: string;
-  /** The value to add, replace or test. */
-  value?: unknown;
-};
-type Link = {
-  href?: string;
-};
-type Links = {
-  first?: Link;
-  last?: Link;
-  next?: Link;
-  prev?: Link;
-  self?: Link;
-};
-type Operational = {
-  contentUpdated?: boolean;
-  endDate?: string;
-  lastLoadTime?: string;
-  lastUpdateTime?: string;
-  location?: string;
-  logMessage?: string;
-  rowCount?: number;
-  size?: number;
-  startDate?: string;
-  status?: string;
-  tableConnectionInfo?: TableConnectionInfo;
-  tableOwner?: string;
-};
-type PageDataSetProfile = {
-  data?: DataSetProfile[];
-  limit?: number;
-  links?: Links;
-  page?: number;
-  pages?: number;
-  total?: number;
-};
-type ProfileMetadata = {
-  computationEndTime?: string;
-  computationStartTime?: string;
-  connectionId?: string;
-  dataSetId?: string;
-  lastLoadTime?: string;
-  messages?: string[];
-  resultType?: "NORMAL" | "BASIC";
-  status?: "QUEUED" | "RUNNING" | "FINISHED" | "FAILED" | "INCOMPLETE" | "CANCELLED" | "STALE" | "PARTIAL" | "DEFERRED";
-};
-/**
- * Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema
- */
-type Schema = {
-  /** Anomalies associated with this schema. Example: $warning-unknown-headers */
-  anomalies?: string[];
-  dataFields: DataField[];
-  readonly effectiveDate?: string;
-  /** Options for loading files. Example: "qLabel": "embedded labels" */
-  loadOptions?: Record<string, unknown>;
-  overrideSchemaAnomalies?: boolean;
-  schemaName?: string;
-};
-type TableConnectionInfo = {
-  additionalProperties?: Record<string, string>;
-  selectionScript?: string;
-  tableName?: string;
-};
-type TableProfile = {
-  readonly fieldProfiles?: FieldProfile[];
-  readonly name?: string;
-  readonly numberOfRows?: number;
-  readonly sizeInBytes?: number;
-};
-type TableRecord = {
-  values?: string[];
-};
-type TableSample = {
-  readonly fieldNames?: string[];
-  readonly name?: string;
-  readonly records?: TableRecord[];
-};
-type Tag = {
-  score?: number;
-  tag?: string;
-};
-/**
- * An array of user-supplied tags
- */
-type UserTag = {
-  /** The id of the tag in Collections */
-  id?: string;
-  name?: string;
-};
-/**
- * Batch delete data sets.
- *
- * @param body an object with the body content
- * @throws DeleteDataSetsHttpError
- */
-declare function deleteDataSets(body: BatchIdDto, options?: ApiCallOptions): Promise<DeleteDataSetsHttpResponse>;
-type DeleteDataSetsHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type DeleteDataSetsHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
-};
-/**
- * Save new data set
- *
- * @param body an object with the body content
- * @throws CreateDataSetHttpError
- */
-declare function createDataSet(body: DataSet, options?: ApiCallOptions): Promise<CreateDataSetHttpResponse>;
-type CreateDataSetHttpResponse = {
-  data: DataSet;
-  headers: Headers;
-  status: 201;
-};
-type CreateDataSetHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
-};
-/**
- * Get data set by ID.
- *
- * @param dataSetId
- * @param query an object with query parameters
- * @throws GetDataSetHttpError
- */
-declare function getDataSet(dataSetId: string, query: {
-  /** Comma-separated fields to return in the response. */
-  projections?: string[];
-}, options?: ApiCallOptions): Promise<GetDataSetHttpResponse>;
-type GetDataSetHttpResponse = {
-  data: DataSet;
-  headers: Headers;
-  status: 200;
-};
-type GetDataSetHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
-};
-/**
- * Patch data set.
- *
- * @param dataSetId
- * @param body an object with the body content
- * @throws PatchDataSetHttpError
- */
-declare function patchDataSet(dataSetId: string, body: JsonPatch[], options?: ApiCallOptions): Promise<PatchDataSetHttpResponse>;
-type PatchDataSetHttpResponse = {
-  data: DataSet;
-  headers: Headers;
-  status: 200 | 204;
-};
-type PatchDataSetHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
-};
-/**
- * Update data set.
- *
- * @param dataSetId
- * @param body an object with the body content
- * @throws UpdateDataSetHttpError
- */
-declare function updateDataSet(dataSetId: string, body: DataSet, options?: ApiCallOptions): Promise<UpdateDataSetHttpResponse>;
-type UpdateDataSetHttpResponse = {
-  data: DataSet;
-  headers: Headers;
-  status: 200;
-};
-type UpdateDataSetHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
-};
-/**
- * Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.
- *
- * @param dataSetId
- * @param query an object with query parameters
- * @throws GetDataSetProfilesHttpError
- */
-declare function getDataSetProfiles(dataSetId: string, query: {
-  /** Comma-separated data connection IDs. */
-  dataConnectionIds?: string[];
-  /** Page size limit. */
-  limit?: number;
-  page?: number;
-  /** Comma-separated fields to return in the response. */
-  projections?: string[];
-  sort?: string[];
-}, options?: ApiCallOptions): Promise<GetDataSetProfilesHttpResponse>;
-type GetDataSetProfilesHttpResponse = {
-  data: PageDataSetProfile;
-  headers: Headers;
-  status: 200 | 202;
-  prev?: (options?: ApiCallOptions) => Promise<GetDataSetProfilesHttpResponse>;
-  next?: (options?: ApiCallOptions) => Promise<GetDataSetProfilesHttpResponse>;
-};
-type GetDataSetProfilesHttpError = {
-  data: ErrorResponse;
-  headers: Headers;
-  status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
-};
-/**
- * Clears the cache for data-sets api requests.
- */
-declare function clearCache(): void;
-type DataSetsAPI = {
-  /**
-   * Batch delete data sets.
-   *
-   * @param body an object with the body content
-   * @throws DeleteDataSetsHttpError
-   */
-  deleteDataSets: typeof deleteDataSets;
-  /**
-   * Save new data set
-   *
-   * @param body an object with the body content
-   * @throws CreateDataSetHttpError
-   */
-  createDataSet: typeof createDataSet;
-  /**
-   * Get data set by ID.
-   *
-   * @param dataSetId
-   * @param query an object with query parameters
-   * @throws GetDataSetHttpError
-   */
-  getDataSet: typeof getDataSet;
-  /**
-   * Patch data set.
-   *
-   * @param dataSetId
-   * @param body an object with the body content
-   * @throws PatchDataSetHttpError
-   */
-  patchDataSet: typeof patchDataSet;
-  /**
-   * Update data set.
-   *
-   * @param dataSetId
-   * @param body an object with the body content
-   * @throws UpdateDataSetHttpError
-   */
-  updateDataSet: typeof updateDataSet;
-  /**
-   * Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.
-   *
-   * @param dataSetId
-   * @param query an object with query parameters
-   * @throws GetDataSetProfilesHttpError
-   */
-  getDataSetProfiles: typeof getDataSetProfiles;
-  /**
-   * Clears the cache for data-sets api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the data-sets api
- */
-declare const dataSetsExport: DataSetsAPI;
-//#endregion
-export { ProfileMetadata as A, clearCache as B, JsonPatch as C, PageDataSetProfile as D, Operational as E, TableSample as F, getDataSetProfiles as G, dataSetsExport as H, Tag as I, patchDataSet as K, UpdateDataSetHttpError as L, TableConnectionInfo as M, TableProfile as N, PatchDataSetHttpError as O, TableRecord as P, UpdateDataSetHttpResponse as R, GetDataSetProfilesHttpResponse as S, Links as T, deleteDataSets as U, createDataSet as V, getDataSet as W, FieldProfile as _, CreateDataSetHttpResponse as a, GetDataSetHttpResponse as b, DataSet as c, DataStoreInfo as d, DeleteDataSetsHttpError as f, FieldDataType as g, ErrorResponse as h, CreateDataSetHttpError as i, Schema as j, PatchDataSetHttpResponse as k, DataSetProfile as l, Error as m, BinnedFrequency as n, DataAssetInfo as o, DeleteDataSetsHttpResponse as p, updateDataSet as q, Classification as r, DataField as s, BatchIdDto as t, DataSetsAPI as u, Frequency as v, Link as w, GetDataSetProfilesHttpError as x, GetDataSetHttpError as y, UserTag as z };