@viu/emporix-sdk 4.2.0 → 4.2.3

package/dist/index.d.cts

@@ -4220,7 +4220,7 @@ type QParamSearchBody = {
     /**
      * A standard query parameter is used to search for specific values.
      *
-     * See: [Standard Practices - Query parameter](https://developer.emporix.io/api-references/standard-practices/q-param)
+     * See: [Standard Practices - Query parameter](https://developer.emporix.io/api-documentation/standard-practices/q-param)
      *
      */
     q?: string;
@@ -10226,9 +10226,18 @@ type ImportSchedule = Schedule;
  * `dryRunSample` carries the previewed records on a dry run and is absent on a
  * normal one. `origin` echoes what asked for the run, and is absent on runs
  * recorded before that field existed.
+ *
+ * `mappingVersions` lists the published mapping version each stream runs with,
+ * fixed when the run starts — version `0` means the stream has no published
+ * mappings. It is absent on a dry run of the draft mappings and on runs recorded
+ * before 2026-09-28. `dryRunPublished` says which mappings a dry run used.
  */
 type ImportRun = ImportRun$1;
-/** Per-stream progress within a run. */
+/**
+ * Per-stream progress within a run. A stream `ABORTED` was not run because of
+ * its configuration — typically mappings that were never published — and its
+ * `message` says why.
+ */
 type ImportRunStream = ImportRunStream$1;
 /** A run together with its per-stream progress — what `getRun` resolves to. */
 type ImportRunDetail = RunDetail;
@@ -10257,7 +10266,7 @@ type ImportDiagnosticKind = TraitDiagnosticsKind;
 /** Filters for `listRunDiagnostics` / `downloadRunDiagnosticsCsv`: `{ streamId?, kind?, limit? }`. */
 type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData["query"]>;
 /**
- * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds? }`.
+ * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds?, mappings? }`.
  *
  * - `mode` defaults to `DELTA` server-side.
  * - `streamIds` runs only those streams — **ids, not names** (`getStreamOrder`
@@ -10268,6 +10277,10 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
  *   idempotency.
  * - `sampleSize` is **dry-run only**: how many mapped records to sample per
  *   stream into the run's `dryRunSample`. Clamped to 1–100, defaults to 25.
+ * - `mappings` is **dry-run only** too: `"published"` (the default) checks what
+ *   a real run would execute, `"draft"` checks saved mapping changes before they
+ *   are published. A real run always uses the published mappings, so the field
+ *   has no effect there.
  * - `origin` is free text naming *what* asked for the run (`"Dashboard"`, an
  *   integration scenario, your own scheduler), as opposed to `trigger`, which
  *   only ever records `MANUAL` or `SCHEDULED`. Omitted or blank, the service
@@ -10276,7 +10289,11 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
  *   audit trail is worse than a refused request.
  */
 type ImportRunInput = NonNullable<PostImporttoolTriggerRunData["body"]>;
-/** Lifecycle status of an {@link ImportRun}. */
+/**
+ * Lifecycle status of an {@link ImportRun}. `ABORTED` means the service refused
+ * to start the run because of its configuration — mappings that were never
+ * published, or a changed target schema — and nothing was read or written.
+ */
 type ImportRunStatus = NonNullable<ImportRun["status"]>;
 /** Run mode — `FULL` re-reads everything, `DELTA` only what changed. */
 type ImportRunMode = NonNullable<ImportRunInput["mode"]>;
@@ -10466,6 +10483,19 @@ declare class ImportService {
      * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
      * and note it takes ids where {@link getStreamOrder} reports names.
      *
+     * A run executes each stream's **published** mappings. Publishing needs
+     * `importtool.import_manage` and is not part of the public API, so it happens
+     * in the Management Dashboard's Import Tool rather than through this SDK; a dry
+     * run with `mappings: "draft"` checks unpublished changes first. A stream whose
+     * mappings were never published is `ABORTED` in the run details, and the run
+     * finishes `PARTIAL`.
+     *
+     * **A refused run still resolves.** When `streamIds` names such a stream, or
+     * every enabled stream is in that state, the service answers `200` with the
+     * run anyway, and the run then finishes `ABORTED` with a `message` naming the
+     * streams. Read it back with {@link getRun}, or follow it with
+     * {@link streamRun}, before treating a resolved call as a started import.
+     *
      * Not retried on a 5xx: a POST that timed out may already have queued a run.
      *
      * @example
@@ -10586,7 +10616,8 @@ declare class ImportService {
      *
      * Returns a **new** run — the retry is its own run with `retry: true`, not a
      * mutation of the original. Poll it with {@link getRun} or follow it with
-     * {@link streamRun} exactly as you would a triggered run.
+     * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
+     * published mappings and can finish `ABORTED`.
      *
      * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
      * that timed out may already have queued the retry.
@@ -10697,7 +10728,7 @@ type GetChangelogRetrieveTenantChangelogsData = {
          * * `related:elemMatch(...)` — ElemMatch syntax, for example `q=related:elemMatch(entity:group entityId:1gr5e52e-6e27-4ac5-9471-2467d3fb7501)`.
          * * `compoundLogicalQuery` — Nested `OR` / `AND` expressions, for example `q=compoundLogicalQuery:((entity:group type:update) OR (related:elemMatch(entity:group)))`.
          *
-         * See also [Query Parameter](https://developer.emporix.io/api-references/standard-practices/q-param).
+         * See also [Query Parameter](https://developer.emporix.io/api-documentation/standard-practices/q-param).
          */
         q?: string;
         /**
@@ -12226,7 +12257,7 @@ type Payment = {
 type PaymentMethod = {
     /**
      * Payment provider, possible values:
-     * * `payment-gateway` - When the Emporix Payment-Gateway service should be used to handle a payment. For details about custom attributes that are required for a particular payment mode, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments.
+     * * `payment-gateway` - When the Emporix Payment-Gateway service is used to handle a payment. For details about custom attributes that are required for a particular payment mode, check https://developer.emporix.io/api-documentation/api-guides/checkout/payment-gateway.
      * * `custom` - When a custom provider is used. In this case the created order has the `IN_CHECKOUT` status.
      * * `none` - For payment by cash or invoice.
      *
@@ -12237,11 +12268,11 @@ type PaymentMethod = {
      */
     customAttributes?: {
         /**
-         * Payment token used for the tokenized credit card flows. The field is used when provider type is `payment-gateway`. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
+         * Payment token used for the tokenized credit card flows. The field is used when provider type is `payment-gateway`. For more details, check https://developer.emporix.io/api-documentation/api-guides/checkout/payment-gateway
          */
         token?: string;
         /**
-         * Identifier of a payment mode. The payment mode has to be configured in the Emporix Payment Gateway service beforehand. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
+         * Identifier of a payment mode. The payment mode has to be configured in the Emporix Payment Gateway service beforehand. For more details, check https://developer.emporix.io/api-documentation/api-guides/checkout/payment-gateway
          */
         modeId?: string;
         /**

package/dist/index.d.ts

@@ -4220,7 +4220,7 @@ type QParamSearchBody = {
     /**
      * A standard query parameter is used to search for specific values.
      *
-     * See: [Standard Practices - Query parameter](https://developer.emporix.io/api-references/standard-practices/q-param)
+     * See: [Standard Practices - Query parameter](https://developer.emporix.io/api-documentation/standard-practices/q-param)
      *
      */
     q?: string;
@@ -10226,9 +10226,18 @@ type ImportSchedule = Schedule;
  * `dryRunSample` carries the previewed records on a dry run and is absent on a
  * normal one. `origin` echoes what asked for the run, and is absent on runs
  * recorded before that field existed.
+ *
+ * `mappingVersions` lists the published mapping version each stream runs with,
+ * fixed when the run starts — version `0` means the stream has no published
+ * mappings. It is absent on a dry run of the draft mappings and on runs recorded
+ * before 2026-09-28. `dryRunPublished` says which mappings a dry run used.
  */
 type ImportRun = ImportRun$1;
-/** Per-stream progress within a run. */
+/**
+ * Per-stream progress within a run. A stream `ABORTED` was not run because of
+ * its configuration — typically mappings that were never published — and its
+ * `message` says why.
+ */
 type ImportRunStream = ImportRunStream$1;
 /** A run together with its per-stream progress — what `getRun` resolves to. */
 type ImportRunDetail = RunDetail;
@@ -10257,7 +10266,7 @@ type ImportDiagnosticKind = TraitDiagnosticsKind;
 /** Filters for `listRunDiagnostics` / `downloadRunDiagnosticsCsv`: `{ streamId?, kind?, limit? }`. */
 type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData["query"]>;
 /**
- * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds? }`.
+ * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds?, mappings? }`.
  *
  * - `mode` defaults to `DELTA` server-side.
  * - `streamIds` runs only those streams — **ids, not names** (`getStreamOrder`
@@ -10268,6 +10277,10 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
  *   idempotency.
  * - `sampleSize` is **dry-run only**: how many mapped records to sample per
  *   stream into the run's `dryRunSample`. Clamped to 1–100, defaults to 25.
+ * - `mappings` is **dry-run only** too: `"published"` (the default) checks what
+ *   a real run would execute, `"draft"` checks saved mapping changes before they
+ *   are published. A real run always uses the published mappings, so the field
+ *   has no effect there.
  * - `origin` is free text naming *what* asked for the run (`"Dashboard"`, an
  *   integration scenario, your own scheduler), as opposed to `trigger`, which
  *   only ever records `MANUAL` or `SCHEDULED`. Omitted or blank, the service
@@ -10276,7 +10289,11 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
  *   audit trail is worse than a refused request.
  */
 type ImportRunInput = NonNullable<PostImporttoolTriggerRunData["body"]>;
-/** Lifecycle status of an {@link ImportRun}. */
+/**
+ * Lifecycle status of an {@link ImportRun}. `ABORTED` means the service refused
+ * to start the run because of its configuration — mappings that were never
+ * published, or a changed target schema — and nothing was read or written.
+ */
 type ImportRunStatus = NonNullable<ImportRun["status"]>;
 /** Run mode — `FULL` re-reads everything, `DELTA` only what changed. */
 type ImportRunMode = NonNullable<ImportRunInput["mode"]>;
@@ -10466,6 +10483,19 @@ declare class ImportService {
      * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
      * and note it takes ids where {@link getStreamOrder} reports names.
      *
+     * A run executes each stream's **published** mappings. Publishing needs
+     * `importtool.import_manage` and is not part of the public API, so it happens
+     * in the Management Dashboard's Import Tool rather than through this SDK; a dry
+     * run with `mappings: "draft"` checks unpublished changes first. A stream whose
+     * mappings were never published is `ABORTED` in the run details, and the run
+     * finishes `PARTIAL`.
+     *
+     * **A refused run still resolves.** When `streamIds` names such a stream, or
+     * every enabled stream is in that state, the service answers `200` with the
+     * run anyway, and the run then finishes `ABORTED` with a `message` naming the
+     * streams. Read it back with {@link getRun}, or follow it with
+     * {@link streamRun}, before treating a resolved call as a started import.
+     *
      * Not retried on a 5xx: a POST that timed out may already have queued a run.
      *
      * @example
@@ -10586,7 +10616,8 @@ declare class ImportService {
      *
      * Returns a **new** run — the retry is its own run with `retry: true`, not a
      * mutation of the original. Poll it with {@link getRun} or follow it with
-     * {@link streamRun} exactly as you would a triggered run.
+     * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
+     * published mappings and can finish `ABORTED`.
      *
      * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
      * that timed out may already have queued the retry.
@@ -10697,7 +10728,7 @@ type GetChangelogRetrieveTenantChangelogsData = {
          * * `related:elemMatch(...)` — ElemMatch syntax, for example `q=related:elemMatch(entity:group entityId:1gr5e52e-6e27-4ac5-9471-2467d3fb7501)`.
          * * `compoundLogicalQuery` — Nested `OR` / `AND` expressions, for example `q=compoundLogicalQuery:((entity:group type:update) OR (related:elemMatch(entity:group)))`.
          *
-         * See also [Query Parameter](https://developer.emporix.io/api-references/standard-practices/q-param).
+         * See also [Query Parameter](https://developer.emporix.io/api-documentation/standard-practices/q-param).
          */
         q?: string;
         /**
@@ -12226,7 +12257,7 @@ type Payment = {
 type PaymentMethod = {
     /**
      * Payment provider, possible values:
-     * * `payment-gateway` - When the Emporix Payment-Gateway service should be used to handle a payment. For details about custom attributes that are required for a particular payment mode, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments.
+     * * `payment-gateway` - When the Emporix Payment-Gateway service is used to handle a payment. For details about custom attributes that are required for a particular payment mode, check https://developer.emporix.io/api-documentation/api-guides/checkout/payment-gateway.
      * * `custom` - When a custom provider is used. In this case the created order has the `IN_CHECKOUT` status.
      * * `none` - For payment by cash or invoice.
      *
@@ -12237,11 +12268,11 @@ type PaymentMethod = {
      */
     customAttributes?: {
         /**
-         * Payment token used for the tokenized credit card flows. The field is used when provider type is `payment-gateway`. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
+         * Payment token used for the tokenized credit card flows. The field is used when provider type is `payment-gateway`. For more details, check https://developer.emporix.io/api-documentation/api-guides/checkout/payment-gateway
          */
         token?: string;
         /**
-         * Identifier of a payment mode. The payment mode has to be configured in the Emporix Payment Gateway service beforehand. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
+         * Identifier of a payment mode. The payment mode has to be configured in the Emporix Payment Gateway service beforehand. For more details, check https://developer.emporix.io/api-documentation/api-guides/checkout/payment-gateway
          */
         modeId?: string;
         /**

package/dist/index.js

@@ -946,7 +946,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "4.2.0";
+var version = "4.2.3";
 
 // src/version.ts
 var SDK_VERSION = version;
@@ -4487,6 +4487,19 @@ var ImportService = class {
    * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
    * and note it takes ids where {@link getStreamOrder} reports names.
    *
+   * A run executes each stream's **published** mappings. Publishing needs
+   * `importtool.import_manage` and is not part of the public API, so it happens
+   * in the Management Dashboard's Import Tool rather than through this SDK; a dry
+   * run with `mappings: "draft"` checks unpublished changes first. A stream whose
+   * mappings were never published is `ABORTED` in the run details, and the run
+   * finishes `PARTIAL`.
+   *
+   * **A refused run still resolves.** When `streamIds` names such a stream, or
+   * every enabled stream is in that state, the service answers `200` with the
+   * run anyway, and the run then finishes `ABORTED` with a `message` naming the
+   * streams. Read it back with {@link getRun}, or follow it with
+   * {@link streamRun}, before treating a resolved call as a started import.
+   *
    * Not retried on a 5xx: a POST that timed out may already have queued a run.
    *
    * @example
@@ -4729,7 +4742,8 @@ var ImportService = class {
    *
    * Returns a **new** run — the retry is its own run with `retry: true`, not a
    * mutation of the original. Poll it with {@link getRun} or follow it with
-   * {@link streamRun} exactly as you would a triggered run.
+   * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
+   * published mappings and can finish `ABORTED`.
    *
    * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
    * that timed out may already have queued the retry.