@viu/emporix-sdk 4.11.0 → 4.11.1

package/dist/index.d.ts

@@ -526,13 +526,15 @@ type SiteDto = {
      */
     includesTax?: boolean;
     /**
-     * Site's default language, compliant with the IETF BCP-47 standard. Regional variants such as `fr-ca` are supported.
+     * Site's default language: a language code of 2 or 3 letters, optionally followed by hyphen-separated subtags of 2 to 8 letters or digits. Regional variants such as `fr-ca` and custom codes such as `en-NL` are supported.
+     *
+     * **Note**: The default language must be one of the site's `languages`. The values are compared ignoring letter case, so `de-de` matches `de-DE`.
      */
     defaultLanguage: string;
     /**
      * Languages supported by the site.
      *
-     * **Note**: The languages must be compliant with the IETF BCP-47 standard. Regional variants such as `fr-ca` are supported.
+     * **Note**: Each language must be a language code of 2 or 3 letters, optionally followed by hyphen-separated subtags of 2 to 8 letters or digits. The format is checked, not whether the language or region exists. We recommend an ISO 639 language code combined with an ISO 3166 country code, such as `en-NL`. Regional variants such as `fr-ca` and custom codes such as `en-NL` are supported. Letter case is not checked, and the values are stored as sent. For more information, see [Language configuration](https://developer.emporix.io/api-documentation/api-guides/configuration/configuration-service/language).
      */
     languages: Array<string>;
     currency: CurrencyDto;
@@ -9239,6 +9241,12 @@ type IndexConfiguration = IndexPublicConfiguration & {
      * API key used for write purposes. For `BATTERY_INCLUDED`, this key is validated before the configuration is created or updated.
      */
     writeKey?: string;
+    /**
+     * Optional base URL of the Battery Included API that holds the tenant's index, for example `https://api-next.batteryincluded.io`. Applies only to the `BATTERY_INCLUDED` provider.
+     * When set, the Indexing Service sends all of the tenant's Battery Included requests to this host and validates `writeKey` against it, so the write key must be valid on this host. When not set, the default Battery Included host is used.
+     * The value must be an `https` address of an allowed Battery Included host, without a path, query, fragment, user information, or port. A trailing slash is allowed. Other values are rejected with `400`. A change takes effect within 10 minutes. Change `apiUrl` when no product reindex is running. If the index on the new host does not yet hold all products, start a full product reindex after the change takes effect.
+     */
+    apiUrl?: string;
     /**
      * Optional list of root product mixin keys to exclude from indexing. When set, the specified mixin keys are omitted from both the non-localized and localized portions of the indexed document. Applies only to the `BATTERY_INCLUDED` provider.
      */
@@ -10155,9 +10163,9 @@ type FileQueue = {
      */
     pendingTotal?: number;
     /**
-     * The newest file the stream has imported, or `null` when it has imported none. Returned whatever `historyLimit` is, because a run with no file waiting reads this file again (a snapshot stream).
+     * The newest file the stream has imported. Absent when it has imported none. Returned whatever `historyLimit` is, because a run with no file waiting reads this file again (a snapshot stream).
      */
-    lastProcessed?: ImportFile$1 | null;
+    lastProcessed?: ImportFile$1;
 };
 /**
  * Stream
@@ -10182,17 +10190,79 @@ type ImportStream$1 = {
      */
     sourceEntity?: string;
     /**
-     * The target writer code, for example `emporix.customEntity`.
+     * Where the stream writes. Possible values:
+     *
+     * * `emporix.customEntity` – instances of a custom entity type, named by `targetType`.
+     * * `emporix.product` – products. `STANDALONE` streams only.
+     * * `emporix.category` – categories of the tenant's category tree. `STANDALONE` streams only.
+     * * `emporix.price` – prices of products.
+     * * `emporix.availability` – stock of products at a site.
+     * * `emporix.media` – images of products, linked by URL. The images stay where they are hosted.
+     * * `emporix.categoryAssignment` – assignments of products to existing categories.
+     *
+     * The price, availability, media, and category assignment writers are normally used by a `FAN_OUT`
+     * stream whose parent is a product stream. The `FAN_OUT` stream supplies each product's identifier as
+     * `productId`. A `STANDALONE` stream that uses them maps `productId` itself.
+     *
+     * The writers other than `emporix.customEntity` are catalog writers. The Management Dashboard offers them
+     * only to tenants for which Emporix has enabled catalog targets. To have them enabled, contact Emporix
+     * support.
      */
     targetWriter?: string;
     /**
-     * The default target type (custom-entity type identifier).
+     * For `emporix.customEntity`, the custom entity type the stream writes to. For the other writers, a label that groups the stream's imported records, for example in imported data and statistics. Defaults to `PRODUCT` for `emporix.product` and `CATEGORY` for `emporix.category`. For a `FAN_OUT` stream into a catalog writer, the service sets the label.
      */
     targetType?: string;
     /**
-     * How the stream contributes to the target.
+     * The stream's position in the configuration. Streams are listed in this order. When dependencies do not decide the run order, streams run in this order.
+     */
+    seq?: number;
+    /**
+     * How the stream contributes to the target. Possible values:
+     *
+     * * `STANDALONE` – reads its source and writes its own target objects.
+     * * `COMPOSITE_CHILD` – reads its source and writes into the objects of the stream named in
+     * `compositeParent`.
+     * * `COMPOSITE_MERGE` – reads its source and adds fields to the objects of the stream named in
+     * `compositeParent`.
+     * * `FAN_OUT` – has no source of its own. It reads the records the stream named in `compositeParent`
+     * wrote in the same run, and writes further objects for each of them, for example a product's prices.
+     * It runs after that stream. Objects it created earlier for a record that no longer lists them are
+     * removed.
+     */
+    mode?: 'STANDALONE' | 'COMPOSITE_CHILD' | 'COMPOSITE_MERGE' | 'FAN_OUT';
+    /**
+     * `FAN_OUT` only. The array in the parent record whose elements each produce one target object, for example `prices[]`. When omitted, one target object is written per parent record.
      */
-    mode?: 'STANDALONE' | 'COMPOSITE_CHILD' | 'COMPOSITE_MERGE';
+    fanOutPath?: string;
+    /**
+     * `FAN_OUT` only. The element field that identifies an element of `fanOutPath`, for example `currency`, so that a target object keeps its identity when the elements change order. When omitted, a scalar element identifies itself and an object element is identified by its position.
+     */
+    fanOutKey?: string;
+    /**
+     * Whether the stream is a `FAN_OUT` stream with a parent. Derived from `mode` and `compositeParent`.
+     */
+    readonly fanOut?: boolean;
+    /**
+     * Settings for the target writer. Absent when the writer needs none. `emporix.product` reads the
+     * following settings:
+     *
+     * * `matchField` – how existing products are found: `CODE` (the default) or `ID`.
+     * * `createMissing` – whether products that are not found are created. Defaults to `true`.
+     * * `schemas` – a list of the identifiers of the product mixin schemas the stream writes.
+     * * `templateId` – the product template assigned to the products.
+     * * `language` – the language of localized fields. Defaults to `en`.
+     * * `categoryMatchField` – how the categories to assign are found: `CODE` (the default) or `ID`.
+     *
+     * `emporix.category` reads `language`, and `emporix.categoryAssignment` reads `categoryMatchField`.
+     * `emporix.price` reads `currency`, `countryCode`, `siteCode`, and `priceModelId`, and
+     * `emporix.availability` reads `site`. These price and availability settings are fallback values with no
+     * default of their own: a record that does not map the field gets the stream's value. A price needs a
+     * currency and a country, and stock needs a site, from a mapping or from these settings.
+     */
+    targetOptions?: {
+        [key: string]: unknown;
+    };
     /**
      * The source field whose value is tracked as the delta watermark. A delta run extracts only the records whose value is newer than the last run's.
      */
@@ -10202,7 +10272,7 @@ type ImportStream$1 = {
      */
     deltaFieldFormat?: 'DATE' | 'UNIX_SECONDS' | 'UNIX_MILLIS';
     /**
-     * For a composite child stream, the name of the stream it contributes to.
+     * For a `COMPOSITE_CHILD`, `COMPOSITE_MERGE`, or `FAN_OUT` stream, the name of the stream it contributes to or fans out from.
      */
     compositeParent?: string;
     /**
@@ -10218,7 +10288,19 @@ type ImportStream$1 = {
      */
     childStrategy?: 'EMBED' | 'PATCH';
     /**
-     * How an existing target object is updated. `PATCH` changes only the mapped fields and preserves everything else; `REPLACE_PUT` replaces the whole object, so fields this import does not manage are cleared.
+     * How an existing target object is updated. Possible values:
+     *
+     * * `PATCH` – changes only the mapped fields and keeps everything else.
+     * * `MERGE_PUT` – reads the object, merges the mapped fields into it, and writes it back whole.
+     * * `REPLACE_PUT` – replaces the whole object, so fields this import does not manage are cleared.
+     *
+     * The values a stream can use depend on its target writer. The following values are available per
+     * writer, with the default listed first:
+     *
+     * * `emporix.customEntity` – `PATCH`, `MERGE_PUT`, `REPLACE_PUT`.
+     * * `emporix.product` and `emporix.category` – `PATCH`.
+     * * `emporix.media` – `PATCH`, `REPLACE_PUT`.
+     * * `emporix.price`, `emporix.availability`, and `emporix.categoryAssignment` – `REPLACE_PUT`.
      */
     writeStrategy?: 'PATCH' | 'MERGE_PUT' | 'REPLACE_PUT';
     /**
@@ -10306,6 +10388,10 @@ type ImportStream$1 = {
      * For a file-based source, what one file represents. `SNAPSHOT`: each file is the whole picture, so only the most recently arrived one is read, and the per-record content hash decides what is written. A record missing from a newer file is not deleted. `INCREMENTAL`: each file is a change set, so every queued file is read in order and a later file's values win. Defaults to `SNAPSHOT`.
      */
     fileMode?: 'SNAPSHOT' | 'INCREMENTAL';
+    /**
+     * Whether the stream treats each file as a snapshot. `true` unless `fileMode` is `INCREMENTAL`.
+     */
+    readonly snapshotFiles?: boolean;
     /**
      * For an `EMBED` composite child, the source column its parent matches records by. Required for such a stream: without it the parent cannot find its children and writes an empty array.
      */
@@ -10360,11 +10446,11 @@ type Schedule = {
      */
     cron: string;
     /**
-     * The IANA time zone the cron is evaluated in.
+     * The IANA time zone the cron is evaluated in. Defaults to `UTC`.
      */
     timezone?: string;
     /**
-     * Whether the schedule is active.
+     * Whether the schedule is active. Defaults to `true`.
      */
     enabled?: boolean;
     /**
@@ -10391,9 +10477,13 @@ type ImportRun$1 = {
      */
     tenant?: string;
     /**
-     * What triggered the run.
+     * What triggered the run. Possible values:
+     *
+     * * `MANUAL` – triggered with the run operation.
+     * * `SCHEDULED` – started by the configuration's schedule.
+     * * `RETRY` – created by retrying the failed records of an earlier run. `retryOfRunId` names that run.
      */
-    trigger?: 'MANUAL' | 'SCHEDULED';
+    trigger?: 'MANUAL' | 'SCHEDULED' | 'RETRY';
     /**
      * Dry-run only. A sample of the mapped records that would be written, so the mapping can be previewed without a real import. Absent on normal runs. Each stream is sampled separately, up to the `sampleSize` set in the run request. A parent stream's records include the records of its composite child streams that have `childStrategy` set to `EMBED` or `PATCH`. Those child records appear in the parent attribute named by the child stream's `embedAttribute`, as a real import writes them. Only child records inside the child stream's own sample are included, so a sampled parent record can show fewer child records than the source contains for that parent, or none. Child records are also sampled under their own stream.
      */
@@ -10521,6 +10611,10 @@ type ImportRun$1 = {
      * A terminal status message, typically set on failure.
      */
     message?: string;
+    /**
+     * The streams the run was asked to execute, as sent in `streamIds` when it was triggered. Absent when the run executes every stream of the configuration.
+     */
+    streamIds?: Array<string>;
     /**
      * When the run retries another run's failed records, the identifier of that original run.
      */
@@ -10582,9 +10676,9 @@ type ImportRunStream$1 = {
      */
     streamName?: string;
     /**
-     * The stream's status within the run. `ABORTED` means the service refused to run the stream because of its configuration, for example because its mappings have never been published. It indicates a configuration problem to fix. The `message` field gives the reason.
+     * The stream's status within the run. `ABORTED` means the service refused to run the stream because of its configuration, for example because its mappings have never been published. It indicates a configuration problem to fix. The `message` field gives the reason. `CANCELLED` means the run was cancelled while the stream was running.
      */
-    status?: 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'PARTIAL' | 'FAILED' | 'SKIPPED' | 'ABORTED';
+    status?: 'RUNNING' | 'SUCCEEDED' | 'PARTIAL' | 'FAILED' | 'ABORTED' | 'CANCELLED';
     /**
      * Records read for this stream. The counters reconcile: `recordsRead` = created + updated + skipped + unresolvedParents + deleted + failed + collapsed + embedded.
      */
@@ -10685,9 +10779,15 @@ type CancelResult = {
      */
     force?: boolean;
     /**
-     * Whether the cancellation was accepted. `false` when the run is unknown or already finished.
+     * Whether the cancellation was accepted. `false` when the run does not exist, has already finished, or has the `RESUMABLE` status and `force` was not set.
      */
     accepted?: boolean;
+    /**
+     * The same value as `accepted`. Kept for clients written against an earlier response. Use `accepted`.
+     *
+     * @deprecated
+     */
+    cancelRequested?: boolean;
 };
 /**
  * Error record
@@ -10716,9 +10816,14 @@ type ErrorRecord = {
      */
     targetEntity?: string;
     /**
-     * The pipeline stage the error occurred in.
+     * The pipeline stage the error occurred in. Possible values:
+     *
+     * * `EXTRACT` – reading records from the source.
+     * * `MAP` – applying the field mappings.
+     * * `VALIDATE` – validating the mapped record before the write.
+     * * `UPSERT` – writing to the target.
      */
-    stage?: string;
+    stage?: 'EXTRACT' | 'MAP' | 'VALIDATE' | 'UPSERT';
     /**
      * A machine-readable error code:
      *
@@ -10737,6 +10842,8 @@ type ErrorRecord = {
      * delimited-file row whose array has more elements than `sourceDataset.arrays.maxElements`. That
      * record is not imported, but the other records are; `message` names the column, its number of
      * elements, and the limit.
+     * * `FAN_OUT_REMOVE` – a `FAN_OUT` stream could not remove the objects its parent record no longer
+     * lists. The next run that carries those records tries again.
      * * `STREAM_ERROR` – the stream failed as a whole; the record-level detail is in `message`.
      *
      * `CONFIGURATION` and `EXTERNAL_SYSTEM` are reported as a plain sentence naming what to change.
@@ -10747,6 +10854,12 @@ type ErrorRecord = {
      * A human-readable error message.
      */
     message?: string;
+    /**
+     * The source record that failed, as the service read it, when the error concerns one record. Absent for errors that concern the whole stream.
+     */
+    payload?: {
+        [key: string]: unknown;
+    };
     /**
      * When the error was recorded.
      */
@@ -10797,7 +10910,7 @@ type ImportedRecord$1 = {
         [key: string]: unknown;
     };
     /**
-     * The last outcome, one of `UPSERTED`, `DELETED`, `DELETED_TARGET`, `FAILED`, or `DRY_RUN`.
+     * The last outcome, one of `UPSERTED`, `DELETED`, `FAILED`, or `DRY_RUN`.
      */
     outcome?: string;
     /**
@@ -10987,6 +11100,10 @@ type ImportStatsSummary = {
      * The number of runs that were cancelled.
      */
     cancelled?: number;
+    /**
+     * The number of runs the service refused to run because of their configuration (`ABORTED`).
+     */
+    aborted?: number;
     /**
      * The number of source records read.
      */
@@ -11254,7 +11371,7 @@ type GetImporttoolStreamOrderResponse = GetImporttoolStreamOrderResponses[keyof
 type PostImporttoolTriggerRunData = {
     body?: {
         /**
-         * The run mode. When omitted, defaults to `DELTA`.
+         * The run mode, `FULL` or `DELTA`. When omitted, defaults to `DELTA`. The value is not case-sensitive. Send one of the listed values. The service does not reject another value and runs the import as `DELTA`.
          */
         mode?: 'FULL' | 'DELTA';
         /**
@@ -11274,7 +11391,7 @@ type PostImporttoolTriggerRunData = {
          */
         sampleSize?: number;
         /**
-         * What requested this run. Examples: `Dashboard`, an integration scenario name, or a scheduler name. The `trigger` field records only `MANUAL` or `SCHEDULED`. Use `origin` when more than one system calls this endpoint. If you omit `origin` or send a blank value, the service stores the `trigger` value. The service rejects values longer than 40 characters and values that contain control characters. It does not shorten them.
+         * What requested this run. Examples: `Dashboard`, an integration scenario name, or a scheduler name. The `trigger` field records only how the run started, for example `MANUAL`. Use `origin` when more than one system calls this endpoint. If you omit `origin` or send a blank value, the service stores the `trigger` value. The service rejects values longer than 40 characters and values that contain control characters. It does not shorten them.
          */
         origin?: string;
         /**
@@ -11342,19 +11459,25 @@ type GetImporttoolSearchDataRecordsData = {
          */
         type: string;
         /**
-         * Optional free-text filter. This is a case-insensitive substring match on the record's natural key only — it is NOT the Emporix query language, so field selectors and operators (e.g. `field:value`, comparisons, boolean logic) are not supported.
+         * Optional filter. Returns the records whose natural key or Emporix identifier starts with the given text. The natural key can be given with its key name (`ID:SKU-1001`) or as the source value alone (`SKU-1001`). The match is case-sensitive and matches from the start only: text from the middle of a key matches nothing. Emporix identifiers are lower case, so the identifier is also matched with the text converted to lower case: `3FA85F64` finds `3fa85f64-…`. This is not the Emporix query language, so field selectors and operators are not supported.
          */
         search?: string;
         /**
-         * Optional filter by import outcome. Omit to return records of all outcomes. `UPSERTED` (created or updated), `DELETED` (removed at the source), `DELETED_TARGET` (removed in Emporix), `FAILED`, `DRY_RUN` (produced by a dry run).
+         * Optional filter by import outcome. Omit to return records of all outcomes. The value must match
+         * exactly, in upper case. Any other value returns no records. Possible values:
+         *
+         * * `UPSERTED` – created or updated.
+         * * `DELETED` – removed at the source.
+         * * `FAILED` – the record could not be imported.
+         * * `DRY_RUN` – produced by a dry run.
          */
-        outcome?: 'UPSERTED' | 'DELETED' | 'DELETED_TARGET' | 'FAILED' | 'DRY_RUN';
+        outcome?: 'UPSERTED' | 'DELETED' | 'FAILED' | 'DRY_RUN';
         /**
-         * The zero-based page number.
+         * The zero-based page number. A negative value returns HTTP 400.
          */
         page?: number;
         /**
-         * The page size.
+         * The page size. Defaults to 20 for run history, 50 for run errors, and 25 for imported records. A value below 1 returns HTTP 400.
          */
         size?: number;
     };
@@ -11379,7 +11502,7 @@ type GetImporttoolStatsData = {
          */
         configIds?: string;
         /**
-         * Restricts the statistics to a single stream. Takes precedence over the configuration filters.
+         * Restricts the statistics to a single stream. Takes precedence over `configIds`. When `configId` is also given, the stream must belong to that configuration.
          */
         streamId?: string;
         /**
@@ -11395,7 +11518,7 @@ type GetImporttoolStatsData = {
          */
         granularity?: 'DAY' | 'WEEK' | 'MONTH';
         /**
-         * A comma-separated list of the sections to compute: `TOTALS`, `STREAMS`, `ERRORS`, `CHANGES`. When omitted, defaults to all sections. A section not requested through the `sections` parameter is returned as `null`.
+         * A comma-separated list of the sections to compute: `TOTALS`, `STREAMS`, `ERRORS`, `CHANGES`. When omitted, defaults to all sections. A section not requested through the `sections` parameter is returned as `null`. `sourceIssues` belongs to the `STREAMS` section.
          */
         sections?: string;
     };

package/dist/index.js

@@ -1088,7 +1088,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "4.11.0";
+var version = "4.11.1";
 
 // src/version.ts
 var SDK_VERSION = version;