@viu/emporix-sdk 4.2.0 → 4.2.3

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/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @viu/emporix-sdk
2
2
 
3
+ ## 4.2.3
4
+
5
+ ### Patch Changes
6
+
7
+ - [#374](https://github.com/viuteam/emporix-sdk/pull/374) [`3418d90`](https://github.com/viuteam/emporix-sdk/commit/3418d9066fa2f9f1ec83a0499f1fa365cbee21b0) Thanks [@viu-release-bot](https://github.com/apps/viu-release-bot)! - chore(sdk): sync generated types with upstream Emporix API specs
8
+
9
+ Updated services: ai-rag-indexer,ai-service,approval-service,audit-logs-changelog,availability,cart,category,checkout,customer,customer-segment,customer-service,import-service,indexing-service,label-service,order-v2,price,product,sequential-id,session-context,shopping-list
10
+
11
+ ## 4.2.2
12
+
13
+ ### Patch Changes
14
+
15
+ - [#372](https://github.com/viuteam/emporix-sdk/pull/372) [`b89a81a`](https://github.com/viuteam/emporix-sdk/commit/b89a81a9eed1cdbf781757d5e5f09820f6cb04af) Thanks [@amnael1](https://github.com/amnael1)! - docs(sdk): document published mappings and aborted import runs
16
+
17
+ The import types and `triggerRun` / `retryRun` now describe the Import Service change of 2026-09-28, which the types already carried: a run executes each stream's published mappings, a dry run checks the drafts with `mappings: "draft"`, and runs report `mappingVersions` and `dryRunPublished`. They also name the trap that came with it — a run refused for never-published mappings still resolves with `200` and only then finishes `ABORTED`, so read the run back before treating it as started.
18
+
3
19
  ## 4.2.0
4
20
 
5
21
  ### Minor Changes
package/dist/cart.d.cts CHANGED
@@ -21,7 +21,7 @@ type Search = {
21
21
  /**
22
22
  * A standard query parameter is used to search for specific values.
23
23
  *
24
- * See: [Standard practises - Query parameter](https://developer.emporix.io/api-references/standard-practices/q-param/)
24
+ * See: [Standard Practices - Query parameter](https://developer.emporix.io/api-documentation/standard-practices/q-param)
25
25
  *
26
26
  */
27
27
  q?: string;
@@ -76,7 +76,7 @@ type BaseCart = {
76
76
  * * If the cart has a legal entity, it gets the first location of the legal entity that has both `country` and `zipCode`, and matches the required `type` - then the address has origin=`LEGAL_ENTITY`.
77
77
  * * Otherwise, if the cart has a logged-in customer, it finds the `default` address that has both `country` and `zipCode`, and matches the required `type`. If there is no matching default address with the required information, it uses the first customer address that meets the criteria. The address has origin=`CUSTOMER`.
78
78
  * * Otherwise, the cart uses the site homebase address. Then the address has origin=`SITE`.
79
- * These addresses are used in the tax country code determination [How to determine a tax country at cart level](https://developer.emporix.io/api-references/api-guides/checkout/cart/cart#how-to-determine-a-tax-country-at-cart-level) and shipping cost calculation [How to calculate shipping cost at cart level](https://developer.emporix.io/api-references/api-guides/checkout/cart/cart#how-to-calculate-shipping-cost-at-cart-level).
79
+ * These addresses are used in the tax country code determination [How to determine a tax country at cart level](https://developer.emporix.io/api-documentation/api-guides/checkout/cart/cart#how-to-determine-a-tax-country-at-cart-level) and shipping cost calculation [How to calculate shipping cost at cart level](https://developer.emporix.io/api-documentation/api-guides/checkout/cart/cart#how-to-calculate-shipping-cost-at-cart-level).
80
80
  */
81
81
  addresses?: Array<AddressResponse>;
82
82
  channel?: Channel;
package/dist/cart.d.ts CHANGED
@@ -21,7 +21,7 @@ type Search = {
21
21
  /**
22
22
  * A standard query parameter is used to search for specific values.
23
23
  *
24
- * See: [Standard practises - Query parameter](https://developer.emporix.io/api-references/standard-practices/q-param/)
24
+ * See: [Standard Practices - Query parameter](https://developer.emporix.io/api-documentation/standard-practices/q-param)
25
25
  *
26
26
  */
27
27
  q?: string;
@@ -76,7 +76,7 @@ type BaseCart = {
76
76
  * * If the cart has a legal entity, it gets the first location of the legal entity that has both `country` and `zipCode`, and matches the required `type` - then the address has origin=`LEGAL_ENTITY`.
77
77
  * * Otherwise, if the cart has a logged-in customer, it finds the `default` address that has both `country` and `zipCode`, and matches the required `type`. If there is no matching default address with the required information, it uses the first customer address that meets the criteria. The address has origin=`CUSTOMER`.
78
78
  * * Otherwise, the cart uses the site homebase address. Then the address has origin=`SITE`.
79
- * These addresses are used in the tax country code determination [How to determine a tax country at cart level](https://developer.emporix.io/api-references/api-guides/checkout/cart/cart#how-to-determine-a-tax-country-at-cart-level) and shipping cost calculation [How to calculate shipping cost at cart level](https://developer.emporix.io/api-references/api-guides/checkout/cart/cart#how-to-calculate-shipping-cost-at-cart-level).
79
+ * These addresses are used in the tax country code determination [How to determine a tax country at cart level](https://developer.emporix.io/api-documentation/api-guides/checkout/cart/cart#how-to-determine-a-tax-country-at-cart-level) and shipping cost calculation [How to calculate shipping cost at cart level](https://developer.emporix.io/api-documentation/api-guides/checkout/cart/cart#how-to-calculate-shipping-cost-at-cart-level).
80
80
  */
81
81
  addresses?: Array<AddressResponse>;
82
82
  channel?: Channel;
@@ -156,7 +156,7 @@ type RequestFromQuoteCheckout = {
156
156
  type RequestPaymentMethodJson = {
157
157
  /**
158
158
  * Payment provider, possible values:
159
- * * `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.
159
+ * * `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.
160
160
  * * `custom` - When a custom provider is used. In this case the created order has the `IN_CHECKOUT` status.
161
161
  * * `none` - For payment by cash or invoice.
162
162
  *
@@ -167,11 +167,11 @@ type RequestPaymentMethodJson = {
167
167
  */
168
168
  customAttributes?: {
169
169
  /**
170
- * 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
170
+ * 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
171
171
  */
172
172
  token?: string;
173
173
  /**
174
- * 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
174
+ * 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
175
175
  */
176
176
  modeId?: string;
177
177
  /**
@@ -156,7 +156,7 @@ type RequestFromQuoteCheckout = {
156
156
  type RequestPaymentMethodJson = {
157
157
  /**
158
158
  * Payment provider, possible values:
159
- * * `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.
159
+ * * `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.
160
160
  * * `custom` - When a custom provider is used. In this case the created order has the `IN_CHECKOUT` status.
161
161
  * * `none` - For payment by cash or invoice.
162
162
  *
@@ -167,11 +167,11 @@ type RequestPaymentMethodJson = {
167
167
  */
168
168
  customAttributes?: {
169
169
  /**
170
- * 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
170
+ * 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
171
171
  */
172
172
  token?: string;
173
173
  /**
174
- * 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
174
+ * 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
175
175
  */
176
176
  modeId?: string;
177
177
  /**
package/dist/index.cjs CHANGED
@@ -1242,7 +1242,7 @@ var HttpClient = class {
1242
1242
  };
1243
1243
 
1244
1244
  // package.json
1245
- var version = "4.2.0";
1245
+ var version = "4.2.3";
1246
1246
 
1247
1247
  // src/version.ts
1248
1248
  var SDK_VERSION = version;
@@ -8577,6 +8577,19 @@ var ImportService = class {
8577
8577
  * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
8578
8578
  * and note it takes ids where {@link getStreamOrder} reports names.
8579
8579
  *
8580
+ * A run executes each stream's **published** mappings. Publishing needs
8581
+ * `importtool.import_manage` and is not part of the public API, so it happens
8582
+ * in the Management Dashboard's Import Tool rather than through this SDK; a dry
8583
+ * run with `mappings: "draft"` checks unpublished changes first. A stream whose
8584
+ * mappings were never published is `ABORTED` in the run details, and the run
8585
+ * finishes `PARTIAL`.
8586
+ *
8587
+ * **A refused run still resolves.** When `streamIds` names such a stream, or
8588
+ * every enabled stream is in that state, the service answers `200` with the
8589
+ * run anyway, and the run then finishes `ABORTED` with a `message` naming the
8590
+ * streams. Read it back with {@link getRun}, or follow it with
8591
+ * {@link streamRun}, before treating a resolved call as a started import.
8592
+ *
8580
8593
  * Not retried on a 5xx: a POST that timed out may already have queued a run.
8581
8594
  *
8582
8595
  * @example
@@ -8819,7 +8832,8 @@ var ImportService = class {
8819
8832
  *
8820
8833
  * Returns a **new** run — the retry is its own run with `retry: true`, not a
8821
8834
  * mutation of the original. Poll it with {@link getRun} or follow it with
8822
- * {@link streamRun} exactly as you would a triggered run.
8835
+ * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
8836
+ * published mappings and can finish `ABORTED`.
8823
8837
  *
8824
8838
  * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
8825
8839
  * that timed out may already have queued the retry.