@viu/emporix-sdk 4.7.0 → 4.7.2

package/dist/index.d.cts

@@ -2310,6 +2310,12 @@ type AbstractSchemaResponse = {
     metadata?: SchemaMetadata;
 };
 type SchemaResponse = AbstractSchemaResponse & {
+    /**
+     * When `true`, custom instances or products that use this mixin may store per-site overlays under keys in the form `{mixinName}__{siteCode}`.
+     * Historical schemas may omit the field (`null`), which behaves like `false`.
+     *
+     */
+    siteAware?: boolean | null;
     /**
      * List of attributes related to the schema.
      */
@@ -2384,12 +2390,18 @@ type CustomInstanceCreation = {
     };
     owner?: CustomInstanceOwnerRequest;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. For site-aware schemas, include per-site overlays as additional keys in the form `{mixinName}__{siteCode}`.
+     * Overlay values are validated against the base mixin JSON Schema.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     metadata?: {
         /**
-         * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+         * Key-value map where each key is a base mixin name and each value is a link to the mixin schema.
+         * Do not add `{mixinName}__{siteCode}` keys here. Site overlays reuse the base schema URL.
+         *
          */
         mixins?: {
             [key: string]: unknown;
@@ -2405,16 +2417,22 @@ type CustomInstanceUpdate = {
     };
     owner?: CustomInstanceOwnerRequest;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. For site-aware schemas, include per-site overlays as additional keys in the form `{mixinName}__{siteCode}`.
+     * Overlay values are validated against the base mixin JSON Schema.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     metadata?: {
         /**
          * Version of the custom instance.  If provided, it will be validated against the current entity version.
          */
         version?: number;
         /**
-         * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+         * Key-value map where each key is a base mixin name and each value is a link to the mixin schema.
+         * Do not add `{mixinName}__{siteCode}` keys here. Site overlays reuse the base schema URL.
+         *
          */
         mixins?: {
             [key: string]: unknown;
@@ -2472,9 +2490,13 @@ type CustomInstanceResponse = {
     type?: string;
     owner?: CustomInstanceOwner;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. Without `emporix-site`, base keys and `{mixinName}__{siteCode}` overlay keys are returned as stored.
+     * With `emporix-site`, overlays for that site are deep-merged into the base keys and only the merged base keys are returned.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     /**
      * List of media IDs assigned to the custom instance.
      */
@@ -4918,7 +4940,7 @@ type TaxClass = {
      *
      * * If the `Content-Language` header is set to `*`, then the name should be provided as a map of translations, where each key is a language code and the value is the name in its respective language.
      * * If the `Content-Language` header is set to a specific language, the name should be provided as a string.
-     * * If the `Content-Language` header is empty, the endpoint will asume that the name is provided in the default language defined in the Configuration Service.
+     * * If the `Content-Language` header is empty, the endpoint will assume that the name is provided in the default language defined in the Configuration Service.
      *
      * **Note**: You can provide the names only in languages defined in the Configuration Service. In case the name is provided in a language that is not defined in the Configuration Service, the request will be rejected.
      */
@@ -4930,7 +4952,7 @@ type TaxClass = {
      *
      * * If the `Content-Language` header is set to `*`, then the description should be provided as a map of translations, where each key is a language code and the value is the description in its respective language.
      * * If the `Content-Language` header is set to a specific language, the description should be provided as a string.
-     * * If the `Content-Language` header is empty, the endpoint will asume that the description is provided in the default language defined in the Configuration Service.
+     * * If the `Content-Language` header is empty, the endpoint will assume that the description is provided in the default language defined in the Configuration Service.
      *
      * **Note**: You can provide the descriptions only in languages defined in the Configuration Service. In case the description is provided in a language that is not defined in the Configuration Service, the request will be rejected.
      */
@@ -4948,7 +4970,7 @@ type TaxClass = {
      */
     rate: number;
     /**
-     * Indicates that the tax class is a default tax class for the tax configuration. Only one tax class can be marked as a default for a particular tax configuration.
+     * Indicates whether the tax class is the default tax class for the tax configuration. Only one tax class can be marked as default for a particular tax configuration.
      */
     isDefault?: boolean;
 };
@@ -4957,7 +4979,7 @@ type TaxClass = {
  */
 type TaxCreationResponse = {
     /**
-     * Code of country for which the tax configuration has been created.
+     * Code of the country for which the tax configuration has been created.
      */
     locationCode?: string;
 };
@@ -5004,7 +5026,7 @@ type TaxCalculationRequest = {
         /**
          * Original price value.
          *
-         * This field should contain by a number where the cent part is separated by a dot sign - such as `12.99`.
+         * This field must contain a number where the cent part is separated by a dot — for example `12.99`.
          *
          * **Note**: The cent part of the price is not limited to two digits. You can specify the price with any precision.
          */
@@ -5041,8 +5063,8 @@ type TaxCalculationResponse = {
          *
          * | Value | Description |
          * | --- | --- |
-         * | `true` | Prices will be expressed as gross values. |
-         * | `false` | Prices will be expressed as net values. |
+         * | `true` | Prices are expressed as gross values. |
+         * | `false` | Prices are expressed as net values. |
          */
         includesTax?: boolean;
         /**

package/dist/index.d.ts

@@ -2310,6 +2310,12 @@ type AbstractSchemaResponse = {
     metadata?: SchemaMetadata;
 };
 type SchemaResponse = AbstractSchemaResponse & {
+    /**
+     * When `true`, custom instances or products that use this mixin may store per-site overlays under keys in the form `{mixinName}__{siteCode}`.
+     * Historical schemas may omit the field (`null`), which behaves like `false`.
+     *
+     */
+    siteAware?: boolean | null;
     /**
      * List of attributes related to the schema.
      */
@@ -2384,12 +2390,18 @@ type CustomInstanceCreation = {
     };
     owner?: CustomInstanceOwnerRequest;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. For site-aware schemas, include per-site overlays as additional keys in the form `{mixinName}__{siteCode}`.
+     * Overlay values are validated against the base mixin JSON Schema.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     metadata?: {
         /**
-         * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+         * Key-value map where each key is a base mixin name and each value is a link to the mixin schema.
+         * Do not add `{mixinName}__{siteCode}` keys here. Site overlays reuse the base schema URL.
+         *
          */
         mixins?: {
             [key: string]: unknown;
@@ -2405,16 +2417,22 @@ type CustomInstanceUpdate = {
     };
     owner?: CustomInstanceOwnerRequest;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. For site-aware schemas, include per-site overlays as additional keys in the form `{mixinName}__{siteCode}`.
+     * Overlay values are validated against the base mixin JSON Schema.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     metadata?: {
         /**
          * Version of the custom instance.  If provided, it will be validated against the current entity version.
          */
         version?: number;
         /**
-         * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+         * Key-value map where each key is a base mixin name and each value is a link to the mixin schema.
+         * Do not add `{mixinName}__{siteCode}` keys here. Site overlays reuse the base schema URL.
+         *
          */
         mixins?: {
             [key: string]: unknown;
@@ -2472,9 +2490,13 @@ type CustomInstanceResponse = {
     type?: string;
     owner?: CustomInstanceOwner;
     /**
-     * A key-value map of additional attributes.
+     * Key-value map of mixin payloads. Without `emporix-site`, base keys and `{mixinName}__{siteCode}` overlay keys are returned as stored.
+     * With `emporix-site`, overlays for that site are deep-merged into the base keys and only the merged base keys are returned.
+     *
      */
-    mixins?: string;
+    mixins?: {
+        [key: string]: unknown;
+    };
     /**
      * List of media IDs assigned to the custom instance.
      */
@@ -4918,7 +4940,7 @@ type TaxClass = {
      *
      * * If the `Content-Language` header is set to `*`, then the name should be provided as a map of translations, where each key is a language code and the value is the name in its respective language.
      * * If the `Content-Language` header is set to a specific language, the name should be provided as a string.
-     * * If the `Content-Language` header is empty, the endpoint will asume that the name is provided in the default language defined in the Configuration Service.
+     * * If the `Content-Language` header is empty, the endpoint will assume that the name is provided in the default language defined in the Configuration Service.
      *
      * **Note**: You can provide the names only in languages defined in the Configuration Service. In case the name is provided in a language that is not defined in the Configuration Service, the request will be rejected.
      */
@@ -4930,7 +4952,7 @@ type TaxClass = {
      *
      * * If the `Content-Language` header is set to `*`, then the description should be provided as a map of translations, where each key is a language code and the value is the description in its respective language.
      * * If the `Content-Language` header is set to a specific language, the description should be provided as a string.
-     * * If the `Content-Language` header is empty, the endpoint will asume that the description is provided in the default language defined in the Configuration Service.
+     * * If the `Content-Language` header is empty, the endpoint will assume that the description is provided in the default language defined in the Configuration Service.
      *
      * **Note**: You can provide the descriptions only in languages defined in the Configuration Service. In case the description is provided in a language that is not defined in the Configuration Service, the request will be rejected.
      */
@@ -4948,7 +4970,7 @@ type TaxClass = {
      */
     rate: number;
     /**
-     * Indicates that the tax class is a default tax class for the tax configuration. Only one tax class can be marked as a default for a particular tax configuration.
+     * Indicates whether the tax class is the default tax class for the tax configuration. Only one tax class can be marked as default for a particular tax configuration.
      */
     isDefault?: boolean;
 };
@@ -4957,7 +4979,7 @@ type TaxClass = {
  */
 type TaxCreationResponse = {
     /**
-     * Code of country for which the tax configuration has been created.
+     * Code of the country for which the tax configuration has been created.
      */
     locationCode?: string;
 };
@@ -5004,7 +5026,7 @@ type TaxCalculationRequest = {
         /**
          * Original price value.
          *
-         * This field should contain by a number where the cent part is separated by a dot sign - such as `12.99`.
+         * This field must contain a number where the cent part is separated by a dot — for example `12.99`.
          *
          * **Note**: The cent part of the price is not limited to two digits. You can specify the price with any precision.
          */
@@ -5041,8 +5063,8 @@ type TaxCalculationResponse = {
          *
          * | Value | Description |
          * | --- | --- |
-         * | `true` | Prices will be expressed as gross values. |
-         * | `false` | Prices will be expressed as net values. |
+         * | `true` | Prices are expressed as gross values. |
+         * | `false` | Prices are expressed as net values. |
          */
         includesTax?: boolean;
         /**

package/dist/index.js

@@ -948,7 +948,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "4.7.0";
+var version = "4.7.2";
 
 // src/version.ts
 var SDK_VERSION = version;