@attlaz/client 1.95.0 → 1.96.0

package/dist/DataQuality/Model/QualityDataset.d.ts

@@ -1,7 +1,7 @@
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
  * A data-quality dataset: the set of entities being checked, and the problems found on them —
- * the `/data_quality/datasets` resource.
+ * the `/data-quality/datasets` resource.
  *
  * `autoCloseMode` decides what happens to an open problem that a later scan no longer reports.
  */

package/dist/DataQuality/Model/QualityDataset.js

@@ -1,6 +1,6 @@
 /**
  * A data-quality dataset: the set of entities being checked, and the problems found on them —
- * the `/data_quality/datasets` resource.
+ * the `/data-quality/datasets` resource.
  *
  * `autoCloseMode` decides what happens to an open problem that a later scan no longer reports.
  */

package/dist/DataQuality/Model/QualityEntity.d.ts

@@ -1,7 +1,7 @@
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
  * One thing being checked in a dataset (a product, a category, …), with a rollup of the problems
- * currently open on it — the `/data_quality/datasets/:datasetId/entities` resource.
+ * currently open on it — the `/data-quality/datasets/:datasetId/entities` resource.
  *
  * `entityType` + `entityId` identify it in the source system; `id` is the dataset's own row.
  */

package/dist/DataQuality/Model/QualityEntity.js

@@ -1,6 +1,6 @@
 /**
  * One thing being checked in a dataset (a product, a category, …), with a rollup of the problems
- * currently open on it — the `/data_quality/datasets/:datasetId/entities` resource.
+ * currently open on it — the `/data-quality/datasets/:datasetId/entities` resource.
  *
  * `entityType` + `entityId` identify it in the source system; `id` is the dataset's own row.
  */

package/dist/DataQuality/Model/{QualitySuppression.d.ts → QualityEntityProblemSuppression.d.ts}

@@ -1,13 +1,13 @@
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
  * A standing decision to ignore a problem code — the
- * `/data_quality/datasets/:datasetId/suppressions` resource.
+ * `/data-quality/datasets/:datasetId/entity-problem-suppressions` resource.
  *
  * With `entityType` and `entityId` set it covers that one entity; with both null it covers the code
  * across the whole dataset. Suppressed problems are still ingested but parked in `muted`, so they
  * stay out of the needs-attention list and out of every auto-close path without losing history.
  */
-export declare class QualitySuppression {
+export declare class QualityEntityProblemSuppression {
     id: string;
     code: string;
     /** Both null = the suppression applies to this code across the whole dataset. */
@@ -18,5 +18,5 @@ export declare class QualitySuppression {
     createdAt: Date | null;
     constructor(id: string, code: string);
     get isDatasetWide(): boolean;
-    static parse(raw: ApiRecord): QualitySuppression;
+    static parse(raw: ApiRecord): QualityEntityProblemSuppression;
 }

package/dist/DataQuality/Model/{QualitySuppression.js → QualityEntityProblemSuppression.js}

@@ -1,12 +1,12 @@
 /**
  * A standing decision to ignore a problem code — the
- * `/data_quality/datasets/:datasetId/suppressions` resource.
+ * `/data-quality/datasets/:datasetId/entity-problem-suppressions` resource.
  *
  * With `entityType` and `entityId` set it covers that one entity; with both null it covers the code
  * across the whole dataset. Suppressed problems are still ingested but parked in `muted`, so they
  * stay out of the needs-attention list and out of every auto-close path without losing history.
  */
-export class QualitySuppression {
+export class QualityEntityProblemSuppression {
     id;
     code;
     /** Both null = the suppression applies to this code across the whole dataset. */
@@ -23,7 +23,7 @@ export class QualitySuppression {
         return this.entityId === null;
     }
     static parse(raw) {
-        const suppression = new QualitySuppression(raw.id, raw.code);
+        const suppression = new QualityEntityProblemSuppression(raw.id, raw.code);
         suppression.entityType = raw.entity_type ?? null;
         // The API strips the `_id` suffix, so `entity_id` arrives as `entity`.
         suppression.entityId = raw.entity ?? null;

package/dist/DataQuality/Model/QualityEntityProblemSuppressionResult.d.ts

@@ -0,0 +1,6 @@
+import { QualityEntityProblemSuppression } from './QualityEntityProblemSuppression.js';
+/** What a new suppression did: the record itself, plus how many open problems it muted. */
+export type QualityEntityProblemSuppressionResult = {
+    suppression: QualityEntityProblemSuppression | null;
+    muted: number;
+};

package/dist/DataQuality/Model/QualityProblem.d.ts

@@ -1,7 +1,7 @@
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
  * One quality issue found on an entity — the
- * `/data_quality/datasets/:datasetId/entities/:entityType/:entityId/problems` resource.
+ * `/data-quality/datasets/:datasetId/entities/:entityType/:entityId/problems` resource.
  *
  * `code` says what is wrong (the rule that fired) and `property` where; `channel` and `locale`
  * narrow it to one sales channel or language when the rule is scoped that way.

package/dist/DataQuality/Model/QualityProblem.js

@@ -1,6 +1,6 @@
 /**
  * One quality issue found on an entity — the
- * `/data_quality/datasets/:datasetId/entities/:entityType/:entityId/problems` resource.
+ * `/data-quality/datasets/:datasetId/entities/:entityType/:entityId/problems` resource.
  *
  * `code` says what is wrong (the rule that fired) and `property` where; `channel` and `locale`
  * narrow it to one sales channel or language when the rule is scoped that way.

package/dist/DataQuality/Model/QualityProblemDefinition.d.ts

@@ -1,6 +1,6 @@
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
- * The catalogue entry behind a problem code — the `/data_quality/definitions` resource.
+ * The catalogue entry behind a problem code — the `/data-quality/definitions` resource.
  *
  * A code is a machine key (`verlichting.ean_invalid_checkdigit`); the definition is what makes it
  * readable, so anything showing a code to a user should resolve it here. Definitions are either

package/dist/DataQuality/Model/QualityProblemDefinition.js

@@ -1,5 +1,5 @@
 /**
- * The catalogue entry behind a problem code — the `/data_quality/definitions` resource.
+ * The catalogue entry behind a problem code — the `/data-quality/definitions` resource.
  *
  * A code is a machine key (`verlichting.ean_invalid_checkdigit`); the definition is what makes it
  * readable, so anything showing a code to a user should resolve it here. Definitions are either

package/dist/DataQuality/Model/QualityProblemEvent.d.ts

@@ -1,7 +1,7 @@
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
  * One transition of a single problem — the
- * `/data_quality/datasets/:datasetId/entities/:entityType/:entityId/problems/:code/events` resource.
+ * `/data-quality/datasets/:datasetId/entities/:entityType/:entityId/problems/:code/events` resource.
  *
  * A problem is reported once and then re-reported by every later scan; only the transitions are
  * recorded, so the timeline stays short: `reported` when it first appears, `resolved` when a scan

package/dist/DataQuality/Model/QualityProblemEvent.js

@@ -1,6 +1,6 @@
 /**
  * One transition of a single problem — the
- * `/data_quality/datasets/:datasetId/entities/:entityType/:entityId/problems/:code/events` resource.
+ * `/data-quality/datasets/:datasetId/entities/:entityType/:entityId/problems/:code/events` resource.
  *
  * A problem is reported once and then re-reported by every later scan; only the transitions are
  * recorded, so the timeline stays short: `reported` when it first appears, `resolved` when a scan

package/dist/DataQuality/Service/QualityEndpoint.d.ts

@@ -6,13 +6,13 @@ import { QualityProblem } from '../Model/QualityProblem.js';
 import { QualityProblemDefinition } from '../Model/QualityProblemDefinition.js';
 import { QualityProblemEvent } from '../Model/QualityProblemEvent.js';
 import { QualitySummary } from '../Model/QualitySummary.js';
-import { QualitySuppression } from '../Model/QualitySuppression.js';
-import { QualitySuppressionResult } from '../Model/QualitySuppressionResult.js';
+import { QualityEntityProblemSuppression } from '../Model/QualityEntityProblemSuppression.js';
+import { QualityEntityProblemSuppressionResult } from '../Model/QualityEntityProblemSuppressionResult.js';
 import { CursorPagination } from '../../Model/Pagination/CursorPagination.js';
 import { CollectionResult } from '../../Model/Result/CollectionResult.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 /**
- * Data Quality — `/data_quality/datasets`. A dataset holds the entities being checked and the
+ * Data Quality — `/data-quality/datasets`. A dataset holds the entities being checked and the
  * problems open on them.
  */
 export declare class QualityEndpoint extends Endpoint {
@@ -40,18 +40,18 @@ export declare class QualityEndpoint extends Endpoint {
      * have open problems, so a fully suppressed or resolved code has no label there.
      */
     getDefinitions(projectId: string, pack?: string | null): Promise<CollectionResult<QualityProblemDefinition>>;
-    getSuppressions(datasetId: string): Promise<CollectionResult<QualitySuppression>>;
+    getEntityProblemSuppressions(datasetId: string): Promise<CollectionResult<QualityEntityProblemSuppression>>;
     /**
      * Suppress a code, either on one entity or — with both entity fields omitted — across the whole
      * dataset. Also mutes the matching problems that are already open, so suppressing acts on what
      * is there rather than only on future scans.
      */
-    createSuppression(datasetId: string, suppression: {
+    createEntityProblemSuppression(datasetId: string, suppression: {
         code: string;
         entityType?: string | null;
         entityId?: string | null;
         reason?: string | null;
-    }): Promise<QualitySuppressionResult>;
+    }): Promise<QualityEntityProblemSuppressionResult>;
     /** Lift a suppression; returns how many muted problems were returned to the open list. */
-    deleteSuppression(datasetId: string, suppressionId: string): Promise<number>;
+    deleteEntityProblemSuppression(datasetId: string, entityProblemSuppressionId: string): Promise<number>;
 }

package/dist/DataQuality/Service/QualityEndpoint.js

@@ -4,21 +4,21 @@ import { QualityEntity } from '../Model/QualityEntity.js';
 import { QualityProblem } from '../Model/QualityProblem.js';
 import { QualityProblemDefinition } from '../Model/QualityProblemDefinition.js';
 import { QualityProblemEvent } from '../Model/QualityProblemEvent.js';
-import { QualitySuppression } from '../Model/QualitySuppression.js';
+import { QualityEntityProblemSuppression } from '../Model/QualityEntityProblemSuppression.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 /**
- * Data Quality — `/data_quality/datasets`. A dataset holds the entities being checked and the
+ * Data Quality — `/data-quality/datasets`. A dataset holds the entities being checked and the
  * problems open on them.
  */
 export class QualityEndpoint extends Endpoint {
     async getDatasets(projectId, pagination = null) {
-        const queryString = new QueryString('/data_quality/datasets');
+        const queryString = new QueryString('/data-quality/datasets');
         queryString.set('project', projectId);
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, QualityDataset.parse);
     }
     async getDataset(datasetId) {
-        const result = await this.requestObject('/data_quality/datasets/' + datasetId, null, QualityDataset.parse, 'GET');
+        const result = await this.requestObject('/data-quality/datasets/' + datasetId, null, QualityDataset.parse, 'GET');
         return result.getData();
     }
     async createDataset(projectId, name, autoCloseMode = null) {
@@ -26,19 +26,19 @@ export class QualityEndpoint extends Endpoint {
         if (autoCloseMode !== null) {
             body['auto_close_mode'] = autoCloseMode;
         }
-        const result = await this.requestObject('/data_quality/datasets', body, QualityDataset.parse, 'POST');
+        const result = await this.requestObject('/data-quality/datasets', body, QualityDataset.parse, 'POST');
         return result.getData();
     }
     async updateDataset(datasetId, changes) {
         // camelCase keys are snake_cased by the base Endpoint (autoCloseMode -> auto_close_mode).
-        const result = await this.requestObject('/data_quality/datasets/' + datasetId, changes, QualityDataset.parse, 'PATCH');
+        const result = await this.requestObject('/data-quality/datasets/' + datasetId, changes, QualityDataset.parse, 'PATCH');
         return result.getData();
     }
     async deleteDataset(datasetId) {
-        await this.requestObject('/data_quality/datasets/' + datasetId, null, (raw) => raw, 'DELETE');
+        await this.requestObject('/data-quality/datasets/' + datasetId, null, (raw) => raw, 'DELETE');
     }
     async getEntities(datasetId, pagination = null, filters = {}) {
-        const queryString = new QueryString('/data_quality/datasets/' + datasetId + '/entities');
+        const queryString = new QueryString('/data-quality/datasets/' + datasetId + '/entities');
         if (filters.entityType) {
             queryString.set('entity_type', filters.entityType);
         }
@@ -62,7 +62,7 @@ export class QualityEndpoint extends Endpoint {
     }
     /** Suppressed problems are hidden unless `includeSuppressed` is set. */
     async getEntityProblems(datasetId, entityType, entityId, includeSuppressed = false) {
-        const queryString = new QueryString('/data_quality/datasets/' + datasetId
+        const queryString = new QueryString('/data-quality/datasets/' + datasetId
             + '/entities/' + encodeURIComponent(entityType)
             + '/' + encodeURIComponent(entityId) + '/problems');
         if (includeSuppressed) {
@@ -72,7 +72,7 @@ export class QualityEndpoint extends Endpoint {
     }
     /** The transition timeline for one problem, oldest first. */
     async getProblemEvents(datasetId, entityType, entityId, code) {
-        const path = '/data_quality/datasets/' + datasetId
+        const path = '/data-quality/datasets/' + datasetId
             + '/entities/' + encodeURIComponent(entityType)
             + '/' + encodeURIComponent(entityId)
             + '/problems/' + encodeURIComponent(code) + '/events';
@@ -80,14 +80,14 @@ export class QualityEndpoint extends Endpoint {
     }
     /** Clear an entity's problems so the next scan starts from scratch; returns how many were removed. */
     async resetEntity(datasetId, entityType, entityId) {
-        const path = '/data_quality/datasets/' + datasetId
+        const path = '/data-quality/datasets/' + datasetId
             + '/entities/' + encodeURIComponent(entityType)
             + '/' + encodeURIComponent(entityId) + '/reset';
         const result = await this.requestObject(path, {}, (raw) => ({ deleted: raw.deleted ?? 0 }), 'POST');
         return result.getData()?.deleted ?? 0;
     }
     async getFilterOptions(datasetId) {
-        const result = await this.requestObject('/data_quality/datasets/' + datasetId + '/filter-options', null, (raw) => ({
+        const result = await this.requestObject('/data-quality/datasets/' + datasetId + '/filter-options', null, (raw) => ({
             entityTypes: raw.entity_types ?? [],
             properties: raw.properties ?? [],
             codes: (raw.codes ?? []).map((row) => ({
@@ -100,7 +100,7 @@ export class QualityEndpoint extends Endpoint {
     }
     /** Both groupings in one call: `counts` by (property, severity) and `codes` for the fix cards. */
     async getSummary(datasetId) {
-        const result = await this.requestObject('/data_quality/datasets/' + datasetId + '/summary', null, (raw) => ({
+        const result = await this.requestObject('/data-quality/datasets/' + datasetId + '/summary', null, (raw) => ({
             counts: (raw.counts ?? []).map((row) => ({
                 property: row.property,
                 severity: row.severity,
@@ -125,7 +125,7 @@ export class QualityEndpoint extends Endpoint {
      * have open problems, so a fully suppressed or resolved code has no label there.
      */
     async getDefinitions(projectId, pack = null) {
-        const queryString = new QueryString('/data_quality/definitions');
+        const queryString = new QueryString('/data-quality/definitions');
         queryString.set('project', projectId);
         if (pack !== null) {
             queryString.set('pack', pack);
@@ -133,15 +133,15 @@ export class QualityEndpoint extends Endpoint {
         return await this.requestCollection(queryString, QualityProblemDefinition.parse);
     }
     // ---- Suppressions ----
-    async getSuppressions(datasetId) {
-        return await this.requestCollection('/data_quality/datasets/' + datasetId + '/suppressions', QualitySuppression.parse);
+    async getEntityProblemSuppressions(datasetId) {
+        return await this.requestCollection('/data-quality/datasets/' + datasetId + '/entity-problem-suppressions', QualityEntityProblemSuppression.parse);
     }
     /**
      * Suppress a code, either on one entity or — with both entity fields omitted — across the whole
      * dataset. Also mutes the matching problems that are already open, so suppressing acts on what
      * is there rather than only on future scans.
      */
-    async createSuppression(datasetId, suppression) {
+    async createEntityProblemSuppression(datasetId, suppression) {
         // Both entity keys are always sent, explicitly null for a dataset-wide suppression: the
         // endpoint requires them to be present so that a dropped or renamed key is an error rather
         // than a silent widening to the whole dataset.
@@ -154,15 +154,15 @@ export class QualityEndpoint extends Endpoint {
             entity: suppression.entityId ?? null,
             reason: suppression.reason ?? null,
         };
-        const result = await this.requestObject('/data_quality/datasets/' + datasetId + '/suppressions', body, (raw) => ({
-            suppression: raw.id ? QualitySuppression.parse(raw) : null,
+        const result = await this.requestObject('/data-quality/datasets/' + datasetId + '/entity-problem-suppressions', body, (raw) => ({
+            suppression: raw.id ? QualityEntityProblemSuppression.parse(raw) : null,
             muted: Number(raw.muted ?? 0),
         }), 'POST');
         return result.getData() ?? { suppression: null, muted: 0 };
     }
     /** Lift a suppression; returns how many muted problems were returned to the open list. */
-    async deleteSuppression(datasetId, suppressionId) {
-        const result = await this.requestObject('/data_quality/datasets/' + datasetId + '/suppressions/' + suppressionId, null, (raw) => ({ reopened: Number(raw.reopened ?? 0) }), 'DELETE');
+    async deleteEntityProblemSuppression(datasetId, entityProblemSuppressionId) {
+        const result = await this.requestObject('/data-quality/datasets/' + datasetId + '/entity-problem-suppressions/' + entityProblemSuppressionId, null, (raw) => ({ reopened: Number(raw.reopened ?? 0) }), 'DELETE');
         return result.getData()?.reopened ?? 0;
     }
 }

package/dist/index.d.ts

@@ -137,14 +137,14 @@ export { QualityEntity } from './DataQuality/Model/QualityEntity.js';
 export { QualityProblem } from './DataQuality/Model/QualityProblem.js';
 export { QualityProblemDefinition } from './DataQuality/Model/QualityProblemDefinition.js';
 export { QualityProblemEvent } from './DataQuality/Model/QualityProblemEvent.js';
-export { QualitySuppression } from './DataQuality/Model/QualitySuppression.js';
+export { QualityEntityProblemSuppression } from './DataQuality/Model/QualityEntityProblemSuppression.js';
 export { QualityCodeOption } from './DataQuality/Model/QualityCodeOption.js';
 export { QualityCodeSummaryRow } from './DataQuality/Model/QualityCodeSummaryRow.js';
 export { QualityEntityFilters } from './DataQuality/Model/QualityEntityFilters.js';
 export { QualityFilterOptions } from './DataQuality/Model/QualityFilterOptions.js';
 export { QualitySummary } from './DataQuality/Model/QualitySummary.js';
 export { QualitySummaryRow } from './DataQuality/Model/QualitySummaryRow.js';
-export { QualitySuppressionResult } from './DataQuality/Model/QualitySuppressionResult.js';
+export { QualityEntityProblemSuppressionResult } from './DataQuality/Model/QualityEntityProblemSuppressionResult.js';
 export { QualityEndpoint } from './DataQuality/Service/QualityEndpoint.js';
 export { CatalogFeed } from './FeedManagement/Model/CatalogFeed.js';
 export { CatalogFeedEndpoint } from './FeedManagement/Service/CatalogFeedEndpoint.js';

package/dist/index.js

@@ -110,7 +110,7 @@ export { QualityEntity } from './DataQuality/Model/QualityEntity.js';
 export { QualityProblem } from './DataQuality/Model/QualityProblem.js';
 export { QualityProblemDefinition } from './DataQuality/Model/QualityProblemDefinition.js';
 export { QualityProblemEvent } from './DataQuality/Model/QualityProblemEvent.js';
-export { QualitySuppression } from './DataQuality/Model/QualitySuppression.js';
+export { QualityEntityProblemSuppression } from './DataQuality/Model/QualityEntityProblemSuppression.js';
 export { QualityEndpoint } from './DataQuality/Service/QualityEndpoint.js';
 export { CatalogFeed } from './FeedManagement/Model/CatalogFeed.js';
 export { CatalogFeedEndpoint } from './FeedManagement/Service/CatalogFeedEndpoint.js';

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.94.0";
+export declare const VERSION = "1.96.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "1.94.0";
+export const VERSION = "1.96.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@attlaz/client",
-  "version": "1.95.0",
+  "version": "1.96.0",
   "description": "Javascript Client to access Attlaz API",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",

package/dist/DataQuality/Model/QualitySuppressionResult.d.ts

@@ -1,6 +0,0 @@
-import { QualitySuppression } from './QualitySuppression.js';
-/** What a new suppression did: the record itself, plus how many open problems it muted. */
-export type QualitySuppressionResult = {
-    suppression: QualitySuppression | null;
-    muted: number;
-};