@viu/emporix-sdk 4.1.0 → 4.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -8,7 +8,7 @@ export { Media, Product, ProductBulkCreateInput, ProductBulkResult, ProductBulkU
8
8
  import { CategoryService } from './category.cjs';
9
9
  export { Category, CategoryAssignment, CategoryAssignmentBulkInput, CategoryAssignmentBulkResult, CategoryAssignmentCreated, CategoryAssignmentInput, CategoryAssignmentRefBulkInput, CategoryCreateInput, CategoryCreated, CategoryNode, CategoryPatchInput, CategoryTreeSearchInput, CategoryUpdateInput } from './category.cjs';
10
10
  import { CartService } from './cart.cjs';
11
- export { Cart, CartAddress, CartCreated, CartDeliveryRestrictions, CartDiscount, CartItem, CartItemInput, CartItemUpdate, CartItemsBatchUpdateInput, CartItemsBatchUpdateResult, CartSearchInput, CartSummary, CartUpdateInput, CartValidationResult, CreateCartInput } from './cart.cjs';
11
+ export { Cart, CartAddress, CartCommand, CartCommandBodies, CartCommandResult, CartCreated, CartDeliveryRestrictions, CartDiscount, CartDiscountInput, CartExecuteOptions, CartExecuteResult, CartItem, CartItemInput, CartItemUpdate, CartItemsBatchUpdateInput, CartItemsBatchUpdateResult, CartSearchInput, CartSummary, CartUpdateInput, CartValidationResult, CreateCartInput } from './cart.cjs';
12
12
  import { CheckoutService } from './checkout.cjs';
13
13
  export { CheckoutInput, CheckoutOptions, CheckoutResult, QuoteCheckoutInput } from './checkout.cjs';
14
14
  import { PaymentGatewayService } from './payment.cjs';
@@ -483,13 +483,13 @@ type SiteDto = {
483
483
  */
484
484
  includesTax?: boolean;
485
485
  /**
486
- * Site's default language, compliant with the ISO 639-1 standard.
486
+ * Site's default language, compliant with the IETF BCP-47 standard. Regional variants such as `fr-ca` are supported.
487
487
  */
488
488
  defaultLanguage: string;
489
489
  /**
490
490
  * Languages supported by the site.
491
491
  *
492
- * **Note**: The languages must be compliant with the ISO 639-1 standard.
492
+ * **Note**: The languages must be compliant with the IETF BCP-47 standard. Regional variants such as `fr-ca` are supported.
493
493
  */
494
494
  languages: Array<string>;
495
495
  currency: CurrencyDto;
@@ -3881,7 +3881,12 @@ type AgentRequest = BaseForAgentRequestAndResponse & {
3881
3881
  nativeTools?: Array<NativeToolReferenceRequest>;
3882
3882
  llmConfig: EmporixLlm | ApiKeyLlmRequest | SelfHostedLlmRequest;
3883
3883
  mcpServers: AgentMcpServersRequest;
3884
- metadata?: MetadataRequest;
3884
+ metadata?: MetadataRequest & {
3885
+ /**
3886
+ * Optional note stored on this version. A blank value clears the live note. The next successful update archives the note with this version.
3887
+ */
3888
+ changeNote?: string;
3889
+ };
3885
3890
  };
3886
3891
  type AgentResponse = BaseForAgentRequestAndResponse & {
3887
3892
  /**
@@ -3900,7 +3905,58 @@ type AgentResponse = BaseForAgentRequestAndResponse & {
3900
3905
  * Prompt which is inherited from the template (if agent is created based on the template). The prompt provided by the user is then concatenated with this prompt.
3901
3906
  */
3902
3907
  templatePrompt?: string;
3903
- metadata?: MetadataResponse$1;
3908
+ metadata?: AgentMetadataResponse;
3909
+ /**
3910
+ * Stored history of previous agent configurations. Present only when the request sets `allVersions=true`. Omitted otherwise.
3911
+ */
3912
+ versions?: Array<AgentVersion>;
3913
+ };
3914
+ type AgentVersion = BaseForAgentRequestAndResponse & {
3915
+ /**
3916
+ * Prompt inherited from the template at the time of this version.
3917
+ */
3918
+ templatePrompt?: string;
3919
+ nativeTools?: NativeToolsResponse;
3920
+ llmConfig?: EmporixLlm | ApiKeyLlmResponse | SelfHostedLlmResponse;
3921
+ mcpServers?: AgentMcpServersResponse;
3922
+ metadata: AgentVersionMetadata;
3923
+ };
3924
+ type AgentVersionMetadata = {
3925
+ /**
3926
+ * Version number of this archived snapshot.
3927
+ */
3928
+ version: number;
3929
+ /**
3930
+ * Date and time when this version was stored. The value is an ISO-8601 instant. For example: `2022-04-30T13:18:02.379Z`
3931
+ */
3932
+ modifiedAt?: string;
3933
+ modifiedBy?: ModifiedBy;
3934
+ /**
3935
+ * Note stored with this snapshot.
3936
+ */
3937
+ changeNote?: string;
3938
+ };
3939
+ /**
3940
+ * Who last changed the agent.
3941
+ */
3942
+ type ModifiedBy = {
3943
+ /**
3944
+ * Identity recorded for the change. `EXTERNAL` is assigned when the request authenticates with an API token. `SYSTEM` is used for automatic updates.
3945
+ *
3946
+ */
3947
+ type: 'CUSTOMER' | 'EMPLOYEE' | 'EXTERNAL' | 'SYSTEM';
3948
+ /**
3949
+ * Identifier of the customer or employee. Omitted for `EXTERNAL` and `SYSTEM`. `id` is the `Hybris-User-Id` header value when `CUSTOMER` or `EMPLOYEE`.
3950
+ */
3951
+ id?: string;
3952
+ /**
3953
+ * First name of the customer or employee.
3954
+ */
3955
+ firstName?: string;
3956
+ /**
3957
+ * Last name of the customer or employee.
3958
+ */
3959
+ lastName?: string;
3904
3960
  };
3905
3961
  type MetadataRequest = {
3906
3962
  /**
@@ -3910,14 +3966,21 @@ type MetadataRequest = {
3910
3966
  };
3911
3967
  type MetadataResponse$1 = MetadataRequest & {
3912
3968
  /**
3913
- * Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
3969
+ * Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`
3914
3970
  */
3915
3971
  createdAt: string;
3916
3972
  /**
3917
- * Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
3973
+ * Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`
3918
3974
  */
3919
3975
  modifiedAt: string;
3920
3976
  };
3977
+ type AgentMetadataResponse = MetadataResponse$1 & {
3978
+ modifiedBy?: ModifiedBy;
3979
+ /**
3980
+ * Note stored for this live version.
3981
+ */
3982
+ changeNote?: string;
3983
+ };
3921
3984
  /**
3922
3985
  * Status of the job.
3923
3986
  */
@@ -4045,6 +4108,10 @@ type AgentLogMessageResponse = {
4045
4108
  * Unique identifier of the agent that generated the log.
4046
4109
  */
4047
4110
  agentId?: string;
4111
+ /**
4112
+ * Version of the agent that wrote this log message.
4113
+ */
4114
+ agentVersion?: number;
4048
4115
  /**
4049
4116
  * Unique identifier of the request associated with the log.
4050
4117
  */
@@ -4092,6 +4159,10 @@ type AgentRequestResponse = {
4092
4159
  * Cumulative LLM completion token count for this request.
4093
4160
  */
4094
4161
  completionTokens?: number;
4162
+ /**
4163
+ * Version of the agent which triggered the request.
4164
+ */
4165
+ agentVersion?: number;
4095
4166
  metadata?: MetadataResponse$1;
4096
4167
  };
4097
4168
  type AgentSessionResponse = {
@@ -10155,9 +10226,18 @@ type ImportSchedule = Schedule;
10155
10226
  * `dryRunSample` carries the previewed records on a dry run and is absent on a
10156
10227
  * normal one. `origin` echoes what asked for the run, and is absent on runs
10157
10228
  * recorded before that field existed.
10229
+ *
10230
+ * `mappingVersions` lists the published mapping version each stream runs with,
10231
+ * fixed when the run starts — version `0` means the stream has no published
10232
+ * mappings. It is absent on a dry run of the draft mappings and on runs recorded
10233
+ * before 2026-09-28. `dryRunPublished` says which mappings a dry run used.
10158
10234
  */
10159
10235
  type ImportRun = ImportRun$1;
10160
- /** Per-stream progress within a run. */
10236
+ /**
10237
+ * Per-stream progress within a run. A stream `ABORTED` was not run because of
10238
+ * its configuration — typically mappings that were never published — and its
10239
+ * `message` says why.
10240
+ */
10161
10241
  type ImportRunStream = ImportRunStream$1;
10162
10242
  /** A run together with its per-stream progress — what `getRun` resolves to. */
10163
10243
  type ImportRunDetail = RunDetail;
@@ -10186,7 +10266,7 @@ type ImportDiagnosticKind = TraitDiagnosticsKind;
10186
10266
  /** Filters for `listRunDiagnostics` / `downloadRunDiagnosticsCsv`: `{ streamId?, kind?, limit? }`. */
10187
10267
  type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData["query"]>;
10188
10268
  /**
10189
- * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds? }`.
10269
+ * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds?, mappings? }`.
10190
10270
  *
10191
10271
  * - `mode` defaults to `DELTA` server-side.
10192
10272
  * - `streamIds` runs only those streams — **ids, not names** (`getStreamOrder`
@@ -10197,6 +10277,10 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
10197
10277
  * idempotency.
10198
10278
  * - `sampleSize` is **dry-run only**: how many mapped records to sample per
10199
10279
  * stream into the run's `dryRunSample`. Clamped to 1–100, defaults to 25.
10280
+ * - `mappings` is **dry-run only** too: `"published"` (the default) checks what
10281
+ * a real run would execute, `"draft"` checks saved mapping changes before they
10282
+ * are published. A real run always uses the published mappings, so the field
10283
+ * has no effect there.
10200
10284
  * - `origin` is free text naming *what* asked for the run (`"Dashboard"`, an
10201
10285
  * integration scenario, your own scheduler), as opposed to `trigger`, which
10202
10286
  * only ever records `MANUAL` or `SCHEDULED`. Omitted or blank, the service
@@ -10205,7 +10289,11 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
10205
10289
  * audit trail is worse than a refused request.
10206
10290
  */
10207
10291
  type ImportRunInput = NonNullable<PostImporttoolTriggerRunData["body"]>;
10208
- /** Lifecycle status of an {@link ImportRun}. */
10292
+ /**
10293
+ * Lifecycle status of an {@link ImportRun}. `ABORTED` means the service refused
10294
+ * to start the run because of its configuration — mappings that were never
10295
+ * published, or a changed target schema — and nothing was read or written.
10296
+ */
10209
10297
  type ImportRunStatus = NonNullable<ImportRun["status"]>;
10210
10298
  /** Run mode — `FULL` re-reads everything, `DELTA` only what changed. */
10211
10299
  type ImportRunMode = NonNullable<ImportRunInput["mode"]>;
@@ -10395,6 +10483,19 @@ declare class ImportService {
10395
10483
  * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
10396
10484
  * and note it takes ids where {@link getStreamOrder} reports names.
10397
10485
  *
10486
+ * A run executes each stream's **published** mappings. Publishing needs
10487
+ * `importtool.import_manage` and is not part of the public API, so it happens
10488
+ * in the Management Dashboard's Import Tool rather than through this SDK; a dry
10489
+ * run with `mappings: "draft"` checks unpublished changes first. A stream whose
10490
+ * mappings were never published is `ABORTED` in the run details, and the run
10491
+ * finishes `PARTIAL`.
10492
+ *
10493
+ * **A refused run still resolves.** When `streamIds` names such a stream, or
10494
+ * every enabled stream is in that state, the service answers `200` with the
10495
+ * run anyway, and the run then finishes `ABORTED` with a `message` naming the
10496
+ * streams. Read it back with {@link getRun}, or follow it with
10497
+ * {@link streamRun}, before treating a resolved call as a started import.
10498
+ *
10398
10499
  * Not retried on a 5xx: a POST that timed out may already have queued a run.
10399
10500
  *
10400
10501
  * @example
@@ -10515,7 +10616,8 @@ declare class ImportService {
10515
10616
  *
10516
10617
  * Returns a **new** run — the retry is its own run with `retry: true`, not a
10517
10618
  * mutation of the original. Poll it with {@link getRun} or follow it with
10518
- * {@link streamRun} exactly as you would a triggered run.
10619
+ * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
10620
+ * published mappings and can finish `ABORTED`.
10519
10621
  *
10520
10622
  * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
10521
10623
  * that timed out may already have queued the retry.
package/dist/index.d.ts CHANGED
@@ -8,7 +8,7 @@ export { Media, Product, ProductBulkCreateInput, ProductBulkResult, ProductBulkU
8
8
  import { CategoryService } from './category.js';
9
9
  export { Category, CategoryAssignment, CategoryAssignmentBulkInput, CategoryAssignmentBulkResult, CategoryAssignmentCreated, CategoryAssignmentInput, CategoryAssignmentRefBulkInput, CategoryCreateInput, CategoryCreated, CategoryNode, CategoryPatchInput, CategoryTreeSearchInput, CategoryUpdateInput } from './category.js';
10
10
  import { CartService } from './cart.js';
11
- export { Cart, CartAddress, CartCreated, CartDeliveryRestrictions, CartDiscount, CartItem, CartItemInput, CartItemUpdate, CartItemsBatchUpdateInput, CartItemsBatchUpdateResult, CartSearchInput, CartSummary, CartUpdateInput, CartValidationResult, CreateCartInput } from './cart.js';
11
+ export { Cart, CartAddress, CartCommand, CartCommandBodies, CartCommandResult, CartCreated, CartDeliveryRestrictions, CartDiscount, CartDiscountInput, CartExecuteOptions, CartExecuteResult, CartItem, CartItemInput, CartItemUpdate, CartItemsBatchUpdateInput, CartItemsBatchUpdateResult, CartSearchInput, CartSummary, CartUpdateInput, CartValidationResult, CreateCartInput } from './cart.js';
12
12
  import { CheckoutService } from './checkout.js';
13
13
  export { CheckoutInput, CheckoutOptions, CheckoutResult, QuoteCheckoutInput } from './checkout.js';
14
14
  import { PaymentGatewayService } from './payment.js';
@@ -483,13 +483,13 @@ type SiteDto = {
483
483
  */
484
484
  includesTax?: boolean;
485
485
  /**
486
- * Site's default language, compliant with the ISO 639-1 standard.
486
+ * Site's default language, compliant with the IETF BCP-47 standard. Regional variants such as `fr-ca` are supported.
487
487
  */
488
488
  defaultLanguage: string;
489
489
  /**
490
490
  * Languages supported by the site.
491
491
  *
492
- * **Note**: The languages must be compliant with the ISO 639-1 standard.
492
+ * **Note**: The languages must be compliant with the IETF BCP-47 standard. Regional variants such as `fr-ca` are supported.
493
493
  */
494
494
  languages: Array<string>;
495
495
  currency: CurrencyDto;
@@ -3881,7 +3881,12 @@ type AgentRequest = BaseForAgentRequestAndResponse & {
3881
3881
  nativeTools?: Array<NativeToolReferenceRequest>;
3882
3882
  llmConfig: EmporixLlm | ApiKeyLlmRequest | SelfHostedLlmRequest;
3883
3883
  mcpServers: AgentMcpServersRequest;
3884
- metadata?: MetadataRequest;
3884
+ metadata?: MetadataRequest & {
3885
+ /**
3886
+ * Optional note stored on this version. A blank value clears the live note. The next successful update archives the note with this version.
3887
+ */
3888
+ changeNote?: string;
3889
+ };
3885
3890
  };
3886
3891
  type AgentResponse = BaseForAgentRequestAndResponse & {
3887
3892
  /**
@@ -3900,7 +3905,58 @@ type AgentResponse = BaseForAgentRequestAndResponse & {
3900
3905
  * Prompt which is inherited from the template (if agent is created based on the template). The prompt provided by the user is then concatenated with this prompt.
3901
3906
  */
3902
3907
  templatePrompt?: string;
3903
- metadata?: MetadataResponse$1;
3908
+ metadata?: AgentMetadataResponse;
3909
+ /**
3910
+ * Stored history of previous agent configurations. Present only when the request sets `allVersions=true`. Omitted otherwise.
3911
+ */
3912
+ versions?: Array<AgentVersion>;
3913
+ };
3914
+ type AgentVersion = BaseForAgentRequestAndResponse & {
3915
+ /**
3916
+ * Prompt inherited from the template at the time of this version.
3917
+ */
3918
+ templatePrompt?: string;
3919
+ nativeTools?: NativeToolsResponse;
3920
+ llmConfig?: EmporixLlm | ApiKeyLlmResponse | SelfHostedLlmResponse;
3921
+ mcpServers?: AgentMcpServersResponse;
3922
+ metadata: AgentVersionMetadata;
3923
+ };
3924
+ type AgentVersionMetadata = {
3925
+ /**
3926
+ * Version number of this archived snapshot.
3927
+ */
3928
+ version: number;
3929
+ /**
3930
+ * Date and time when this version was stored. The value is an ISO-8601 instant. For example: `2022-04-30T13:18:02.379Z`
3931
+ */
3932
+ modifiedAt?: string;
3933
+ modifiedBy?: ModifiedBy;
3934
+ /**
3935
+ * Note stored with this snapshot.
3936
+ */
3937
+ changeNote?: string;
3938
+ };
3939
+ /**
3940
+ * Who last changed the agent.
3941
+ */
3942
+ type ModifiedBy = {
3943
+ /**
3944
+ * Identity recorded for the change. `EXTERNAL` is assigned when the request authenticates with an API token. `SYSTEM` is used for automatic updates.
3945
+ *
3946
+ */
3947
+ type: 'CUSTOMER' | 'EMPLOYEE' | 'EXTERNAL' | 'SYSTEM';
3948
+ /**
3949
+ * Identifier of the customer or employee. Omitted for `EXTERNAL` and `SYSTEM`. `id` is the `Hybris-User-Id` header value when `CUSTOMER` or `EMPLOYEE`.
3950
+ */
3951
+ id?: string;
3952
+ /**
3953
+ * First name of the customer or employee.
3954
+ */
3955
+ firstName?: string;
3956
+ /**
3957
+ * Last name of the customer or employee.
3958
+ */
3959
+ lastName?: string;
3904
3960
  };
3905
3961
  type MetadataRequest = {
3906
3962
  /**
@@ -3910,14 +3966,21 @@ type MetadataRequest = {
3910
3966
  };
3911
3967
  type MetadataResponse$1 = MetadataRequest & {
3912
3968
  /**
3913
- * Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
3969
+ * Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`
3914
3970
  */
3915
3971
  createdAt: string;
3916
3972
  /**
3917
- * Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
3973
+ * Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`
3918
3974
  */
3919
3975
  modifiedAt: string;
3920
3976
  };
3977
+ type AgentMetadataResponse = MetadataResponse$1 & {
3978
+ modifiedBy?: ModifiedBy;
3979
+ /**
3980
+ * Note stored for this live version.
3981
+ */
3982
+ changeNote?: string;
3983
+ };
3921
3984
  /**
3922
3985
  * Status of the job.
3923
3986
  */
@@ -4045,6 +4108,10 @@ type AgentLogMessageResponse = {
4045
4108
  * Unique identifier of the agent that generated the log.
4046
4109
  */
4047
4110
  agentId?: string;
4111
+ /**
4112
+ * Version of the agent that wrote this log message.
4113
+ */
4114
+ agentVersion?: number;
4048
4115
  /**
4049
4116
  * Unique identifier of the request associated with the log.
4050
4117
  */
@@ -4092,6 +4159,10 @@ type AgentRequestResponse = {
4092
4159
  * Cumulative LLM completion token count for this request.
4093
4160
  */
4094
4161
  completionTokens?: number;
4162
+ /**
4163
+ * Version of the agent which triggered the request.
4164
+ */
4165
+ agentVersion?: number;
4095
4166
  metadata?: MetadataResponse$1;
4096
4167
  };
4097
4168
  type AgentSessionResponse = {
@@ -10155,9 +10226,18 @@ type ImportSchedule = Schedule;
10155
10226
  * `dryRunSample` carries the previewed records on a dry run and is absent on a
10156
10227
  * normal one. `origin` echoes what asked for the run, and is absent on runs
10157
10228
  * recorded before that field existed.
10229
+ *
10230
+ * `mappingVersions` lists the published mapping version each stream runs with,
10231
+ * fixed when the run starts — version `0` means the stream has no published
10232
+ * mappings. It is absent on a dry run of the draft mappings and on runs recorded
10233
+ * before 2026-09-28. `dryRunPublished` says which mappings a dry run used.
10158
10234
  */
10159
10235
  type ImportRun = ImportRun$1;
10160
- /** Per-stream progress within a run. */
10236
+ /**
10237
+ * Per-stream progress within a run. A stream `ABORTED` was not run because of
10238
+ * its configuration — typically mappings that were never published — and its
10239
+ * `message` says why.
10240
+ */
10161
10241
  type ImportRunStream = ImportRunStream$1;
10162
10242
  /** A run together with its per-stream progress — what `getRun` resolves to. */
10163
10243
  type ImportRunDetail = RunDetail;
@@ -10186,7 +10266,7 @@ type ImportDiagnosticKind = TraitDiagnosticsKind;
10186
10266
  /** Filters for `listRunDiagnostics` / `downloadRunDiagnosticsCsv`: `{ streamId?, kind?, limit? }`. */
10187
10267
  type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData["query"]>;
10188
10268
  /**
10189
- * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds? }`.
10269
+ * Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds?, mappings? }`.
10190
10270
  *
10191
10271
  * - `mode` defaults to `DELTA` server-side.
10192
10272
  * - `streamIds` runs only those streams — **ids, not names** (`getStreamOrder`
@@ -10197,6 +10277,10 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
10197
10277
  * idempotency.
10198
10278
  * - `sampleSize` is **dry-run only**: how many mapped records to sample per
10199
10279
  * stream into the run's `dryRunSample`. Clamped to 1–100, defaults to 25.
10280
+ * - `mappings` is **dry-run only** too: `"published"` (the default) checks what
10281
+ * a real run would execute, `"draft"` checks saved mapping changes before they
10282
+ * are published. A real run always uses the published mappings, so the field
10283
+ * has no effect there.
10200
10284
  * - `origin` is free text naming *what* asked for the run (`"Dashboard"`, an
10201
10285
  * integration scenario, your own scheduler), as opposed to `trigger`, which
10202
10286
  * only ever records `MANUAL` or `SCHEDULED`. Omitted or blank, the service
@@ -10205,7 +10289,11 @@ type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData
10205
10289
  * audit trail is worse than a refused request.
10206
10290
  */
10207
10291
  type ImportRunInput = NonNullable<PostImporttoolTriggerRunData["body"]>;
10208
- /** Lifecycle status of an {@link ImportRun}. */
10292
+ /**
10293
+ * Lifecycle status of an {@link ImportRun}. `ABORTED` means the service refused
10294
+ * to start the run because of its configuration — mappings that were never
10295
+ * published, or a changed target schema — and nothing was read or written.
10296
+ */
10209
10297
  type ImportRunStatus = NonNullable<ImportRun["status"]>;
10210
10298
  /** Run mode — `FULL` re-reads everything, `DELTA` only what changed. */
10211
10299
  type ImportRunMode = NonNullable<ImportRunInput["mode"]>;
@@ -10395,6 +10483,19 @@ declare class ImportService {
10395
10483
  * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
10396
10484
  * and note it takes ids where {@link getStreamOrder} reports names.
10397
10485
  *
10486
+ * A run executes each stream's **published** mappings. Publishing needs
10487
+ * `importtool.import_manage` and is not part of the public API, so it happens
10488
+ * in the Management Dashboard's Import Tool rather than through this SDK; a dry
10489
+ * run with `mappings: "draft"` checks unpublished changes first. A stream whose
10490
+ * mappings were never published is `ABORTED` in the run details, and the run
10491
+ * finishes `PARTIAL`.
10492
+ *
10493
+ * **A refused run still resolves.** When `streamIds` names such a stream, or
10494
+ * every enabled stream is in that state, the service answers `200` with the
10495
+ * run anyway, and the run then finishes `ABORTED` with a `message` naming the
10496
+ * streams. Read it back with {@link getRun}, or follow it with
10497
+ * {@link streamRun}, before treating a resolved call as a started import.
10498
+ *
10398
10499
  * Not retried on a 5xx: a POST that timed out may already have queued a run.
10399
10500
  *
10400
10501
  * @example
@@ -10515,7 +10616,8 @@ declare class ImportService {
10515
10616
  *
10516
10617
  * Returns a **new** run — the retry is its own run with `retry: true`, not a
10517
10618
  * mutation of the original. Poll it with {@link getRun} or follow it with
10518
- * {@link streamRun} exactly as you would a triggered run.
10619
+ * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
10620
+ * published mappings and can finish `ABORTED`.
10519
10621
  *
10520
10622
  * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
10521
10623
  * that timed out may already have queued the retry.
package/dist/index.js CHANGED
@@ -14,8 +14,8 @@ import { SegmentService } from './chunk-N2CE3J4M.js';
14
14
  export { SegmentService } from './chunk-N2CE3J4M.js';
15
15
  import { AvailabilityService } from './chunk-XQAOHHXL.js';
16
16
  export { AvailabilityService } from './chunk-XQAOHHXL.js';
17
- import { CartService } from './chunk-YVZ6GOLE.js';
18
- export { CartService } from './chunk-YVZ6GOLE.js';
17
+ import { CartService } from './chunk-S2ERKGYL.js';
18
+ export { CartService } from './chunk-S2ERKGYL.js';
19
19
  import { CategoryService } from './chunk-MSQ3GEIW.js';
20
20
  export { CategoryService } from './chunk-MSQ3GEIW.js';
21
21
  export { iterateAll } from './chunk-W6SLZNRX.js';
@@ -946,7 +946,7 @@ var HttpClient = class {
946
946
  };
947
947
 
948
948
  // package.json
949
- var version = "4.1.0";
949
+ var version = "4.2.2";
950
950
 
951
951
  // src/version.ts
952
952
  var SDK_VERSION = version;
@@ -4487,6 +4487,19 @@ var ImportService = class {
4487
4487
  * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
4488
4488
  * and note it takes ids where {@link getStreamOrder} reports names.
4489
4489
  *
4490
+ * A run executes each stream's **published** mappings. Publishing needs
4491
+ * `importtool.import_manage` and is not part of the public API, so it happens
4492
+ * in the Management Dashboard's Import Tool rather than through this SDK; a dry
4493
+ * run with `mappings: "draft"` checks unpublished changes first. A stream whose
4494
+ * mappings were never published is `ABORTED` in the run details, and the run
4495
+ * finishes `PARTIAL`.
4496
+ *
4497
+ * **A refused run still resolves.** When `streamIds` names such a stream, or
4498
+ * every enabled stream is in that state, the service answers `200` with the
4499
+ * run anyway, and the run then finishes `ABORTED` with a `message` naming the
4500
+ * streams. Read it back with {@link getRun}, or follow it with
4501
+ * {@link streamRun}, before treating a resolved call as a started import.
4502
+ *
4490
4503
  * Not retried on a 5xx: a POST that timed out may already have queued a run.
4491
4504
  *
4492
4505
  * @example
@@ -4729,7 +4742,8 @@ var ImportService = class {
4729
4742
  *
4730
4743
  * Returns a **new** run — the retry is its own run with `retry: true`, not a
4731
4744
  * mutation of the original. Poll it with {@link getRun} or follow it with
4732
- * {@link streamRun} exactly as you would a triggered run.
4745
+ * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
4746
+ * published mappings and can finish `ABORTED`.
4733
4747
  *
4734
4748
  * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
4735
4749
  * that timed out may already have queued the retry.