@viu/emporix-sdk 2.33.3 → 2.33.5

package/dist/index.d.cts

@@ -1023,12 +1023,30 @@ type SequenceSchema$1 = SequenceSchemaCreate$1 & {
     };
 };
 /**
- * The filler text for values based on certain properties or settings in the system.
+ * Placeholder definitions used in `preText` and `postText`. Names must start and end with `__`.
  */
 type Placeholders = {
     [key: string]: {
-        required?: boolean;
+        /**
+         * Flag indicating whether the placeholder must be resolved when generating an ID.
+         */
+        required: boolean;
+        /**
+         * Replacement used when the placeholder is not set in the request. Used only when `required` is `false`.
+         */
         default?: string;
+        /**
+         * Dotted path into the site or site mixins response. Resolved when `siteCode` is provided.
+         */
+        sitePath?: string;
+        /**
+         * Maximum array elements to include. Defaults to `3`. Ignored for scalars.
+         */
+        arrayLimit?: number;
+        /**
+         * Separator for joined array elements. Defaults to `-`. Ignored for scalars.
+         */
+        delimiter?: string;
     };
 };
 type SequenceSchemaCreate$1 = {
@@ -1470,7 +1488,15 @@ type SvixConfig = {
 };
 type EventConfiguration = {
     /**
-     * Unique identifier of the event.
+     * Stable server-generated identifier of this event configuration entry. Omit on create; client-supplied ids are rejected with `400`. On update, known ids must refer to existing entries; unknown ids are rejected with `400`. Ids are immutable once assigned.
+     */
+    id?: string;
+    /**
+     * Optional user-facing label for this entry (for example "ERP integration"). Purely descriptive — it has no impact on delivery. Maximum 255 characters.
+     */
+    name?: string;
+    /**
+     * Unique identifier of the event. Multiple entries may share the same `eventType`.
      */
     eventType?: string;
     /**
@@ -1485,7 +1511,22 @@ type EventConfiguration = {
      * List of key-value pairs which can decorate outgoing HTTP POST request as headers. The size limit for this list is `10`. It has higher priority than `headers` on root level. Each event can have defined a separated headers.
      */
     headers?: HttpHeadersConfig;
+    /**
+     * Optional Jayway JsonPath predicate evaluated against the event payload. When omitted or empty, the entry matches every event of the given `eventType`. Invalid expressions are rejected with `400`. Examples: `$[?(@.status == 'DECLINED')]`, `$[?(@.total.amount > 100)]`.
+     */
+    filter?: string;
+    /**
+     * Optional per-entry field exclusion list. Only non-blank top-level field names are allowed. Omit or set to `null` to inherit the event-subscription `excludedFields`. An empty array `[]` overrides the subscription exclusions with no exclusions for this target.
+     */
+    excludedFields?: Array<string>;
+    /**
+     * Per-endpoint activation switch. When `false`, events for this endpoint are dropped without filter evaluation, delivery, or retries; other endpoints are not affected. Omitted means active.
+     */
+    active?: boolean;
 };
+/**
+ * List of HTTP event-specific configuration entries. Multiple entries for the same `eventType` are allowed. Uniqueness is by entry `id`. Duplicate entry ids are rejected with `400`.
+ */
 type EventsConfiguration = Array<EventConfiguration>;
 type HttpHeaderConfigValue = {
     value?: string;
@@ -1509,7 +1550,7 @@ type HttpConfig = {
      * List of key-value pairs which can decorate outgoing HTTP POST request as headers. The size limit for this list is `10`.
      */
     headers?: HttpHeadersConfig;
-    eventsConfiguration?: EventConfiguration;
+    eventsConfiguration?: EventsConfiguration;
 };
 type Configuration = EmptyConfiguration | SvixConfig | HttpConfig;
 type WebhookConfigPartialUpdate = {
@@ -1518,10 +1559,15 @@ type WebhookConfigPartialUpdate = {
      */
     op: 'REMOVE' | 'UPSERT';
     /**
-     * Path for identyifing which properties should be updated
+     * Path identifying which properties should be updated.
+     * Use `UPSERT` on `/configuration/http/eventsConfigurationEntry` (no id) to create a new entry — body must omit `id` (server-generated); `REMOVE` on this path is rejected.
+     * Prefer `/configuration/http/eventsConfigurationEntry/{entryId}` paths to address a specific existing entry.
+     * Use `UPSERT` on `/configuration/http/eventsConfigurationEntry/{entryId}/active` with a boolean value to deactivate (`false`) or reactivate (`true`) a single endpoint without removing it; the value is required.
+     * Legacy `/configuration/http/eventsConfiguration/{eventType}` paths remain supported when at most one entry exists for that event type; they return `409` when multiple entries exist.
+     * Create/update can return `400` for a client-supplied entry id or an invalid JsonPath `filter`.
      */
-    path: '/active' | '/configuration' | '/configuration/svix/apiKey' | '/configuration/http/headers' | '/configuration/http/destinationUrl' | '/configuration/http/secretKey' | '/configuration/http/eventsConfiguration' | '/configuration/http/eventsConfiguration/{eventType}' | '/configuration/http/eventsConfiguration/{eventType}/destinationUrl' | '/configuration/http/eventsConfiguration/{eventType}/secretKey' | '/configuration/http/eventsConfiguration/{eventType}/headers';
-    value?: SvixConfig | HttpConfig | string | boolean | EventsConfiguration | EventConfiguration;
+    path: '/active' | '/configuration' | '/configuration/svix/apiKey' | '/configuration/http/headers' | '/configuration/http/destinationUrl' | '/configuration/http/secretKey' | '/configuration/http/eventsConfiguration' | '/configuration/http/eventsConfiguration/{eventType}' | '/configuration/http/eventsConfiguration/{eventType}/destinationUrl' | '/configuration/http/eventsConfiguration/{eventType}/secretKey' | '/configuration/http/eventsConfiguration/{eventType}/headers' | '/configuration/http/eventsConfigurationEntry' | '/configuration/http/eventsConfigurationEntry/{entryId}' | '/configuration/http/eventsConfigurationEntry/{entryId}/destinationUrl' | '/configuration/http/eventsConfigurationEntry/{entryId}/secretKey' | '/configuration/http/eventsConfigurationEntry/{entryId}/headers' | '/configuration/http/eventsConfigurationEntry/{entryId}/filter' | '/configuration/http/eventsConfigurationEntry/{entryId}/excludedFields' | '/configuration/http/eventsConfigurationEntry/{entryId}/name' | '/configuration/http/eventsConfigurationEntry/{entryId}/active';
+    value?: SvixConfig | HttpConfig | string | boolean | Array<string> | EventsConfiguration | EventConfiguration;
 };
 type ConfigurationGet = {
     /**
@@ -1538,7 +1584,11 @@ type ConfigurationGet = {
     headers?: HttpHeadersConfig;
     eventsConfiguration?: Array<{
         /**
-         * Type of the event.
+         * Stable server-generated identifier of this event configuration entry.
+         */
+        id?: string;
+        /**
+         * Type of the event. Multiple entries may share the same `eventType`.
          */
         eventType?: string;
         /**
@@ -1553,6 +1603,18 @@ type ConfigurationGet = {
          * List of key-value pairs which can decorate outgoing HTTP POST request as headers.
          */
         headers?: HttpHeadersConfig;
+        /**
+         * Optional Jayway JsonPath predicate. When omitted, the entry matches every event of the given `eventType`.
+         */
+        filter?: string;
+        /**
+         * Per-entry field exclusion list. Omitted or `null` means inherit the event-subscription exclusions. An empty array `[]` overrides with no exclusions for this target.
+         */
+        excludedFields?: Array<string>;
+        /**
+         * Per-endpoint activation switch. Always returned as an explicit boolean; entries created before the flag existed report `true`. When `false`, events for this endpoint are dropped without filter evaluation, delivery, or retries.
+         */
+        active?: boolean;
     }>;
 };
 /**
@@ -1823,7 +1885,7 @@ type IdResponse$1 = {
 /**
  * Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.
  */
-type SchemaType = 'CART' | 'CART_ITEM' | 'CATEGORY' | 'COMPANY' | 'COUPON' | 'CUSTOMER' | 'CUSTOMER_ADDRESS' | 'ORDER' | 'ORDER_ENTRY' | 'PRODUCT' | 'QUOTE' | 'RETURN' | 'PRICE_LIST' | 'SITE' | 'CUSTOM_ENTITY' | 'VENDOR' | 'MEDIA';
+type SchemaType = 'AVAILABILITY' | 'CART' | 'CART_ITEM' | 'CATEGORY' | 'COMPANY' | 'COUPON' | 'CUSTOMER' | 'CUSTOMER_ADDRESS' | 'LOCATION' | 'ORDER' | 'ORDER_ENTRY' | 'PRODUCT' | 'QUOTE' | 'RETURN' | 'PRICE_LIST' | 'SITE' | 'CUSTOM_ENTITY' | 'VENDOR' | 'MEDIA';
 /**
  * Type of the attribute.
  *

package/dist/index.d.ts

@@ -1023,12 +1023,30 @@ type SequenceSchema$1 = SequenceSchemaCreate$1 & {
     };
 };
 /**
- * The filler text for values based on certain properties or settings in the system.
+ * Placeholder definitions used in `preText` and `postText`. Names must start and end with `__`.
  */
 type Placeholders = {
     [key: string]: {
-        required?: boolean;
+        /**
+         * Flag indicating whether the placeholder must be resolved when generating an ID.
+         */
+        required: boolean;
+        /**
+         * Replacement used when the placeholder is not set in the request. Used only when `required` is `false`.
+         */
         default?: string;
+        /**
+         * Dotted path into the site or site mixins response. Resolved when `siteCode` is provided.
+         */
+        sitePath?: string;
+        /**
+         * Maximum array elements to include. Defaults to `3`. Ignored for scalars.
+         */
+        arrayLimit?: number;
+        /**
+         * Separator for joined array elements. Defaults to `-`. Ignored for scalars.
+         */
+        delimiter?: string;
     };
 };
 type SequenceSchemaCreate$1 = {
@@ -1470,7 +1488,15 @@ type SvixConfig = {
 };
 type EventConfiguration = {
     /**
-     * Unique identifier of the event.
+     * Stable server-generated identifier of this event configuration entry. Omit on create; client-supplied ids are rejected with `400`. On update, known ids must refer to existing entries; unknown ids are rejected with `400`. Ids are immutable once assigned.
+     */
+    id?: string;
+    /**
+     * Optional user-facing label for this entry (for example "ERP integration"). Purely descriptive — it has no impact on delivery. Maximum 255 characters.
+     */
+    name?: string;
+    /**
+     * Unique identifier of the event. Multiple entries may share the same `eventType`.
      */
     eventType?: string;
     /**
@@ -1485,7 +1511,22 @@ type EventConfiguration = {
      * List of key-value pairs which can decorate outgoing HTTP POST request as headers. The size limit for this list is `10`. It has higher priority than `headers` on root level. Each event can have defined a separated headers.
      */
     headers?: HttpHeadersConfig;
+    /**
+     * Optional Jayway JsonPath predicate evaluated against the event payload. When omitted or empty, the entry matches every event of the given `eventType`. Invalid expressions are rejected with `400`. Examples: `$[?(@.status == 'DECLINED')]`, `$[?(@.total.amount > 100)]`.
+     */
+    filter?: string;
+    /**
+     * Optional per-entry field exclusion list. Only non-blank top-level field names are allowed. Omit or set to `null` to inherit the event-subscription `excludedFields`. An empty array `[]` overrides the subscription exclusions with no exclusions for this target.
+     */
+    excludedFields?: Array<string>;
+    /**
+     * Per-endpoint activation switch. When `false`, events for this endpoint are dropped without filter evaluation, delivery, or retries; other endpoints are not affected. Omitted means active.
+     */
+    active?: boolean;
 };
+/**
+ * List of HTTP event-specific configuration entries. Multiple entries for the same `eventType` are allowed. Uniqueness is by entry `id`. Duplicate entry ids are rejected with `400`.
+ */
 type EventsConfiguration = Array<EventConfiguration>;
 type HttpHeaderConfigValue = {
     value?: string;
@@ -1509,7 +1550,7 @@ type HttpConfig = {
      * List of key-value pairs which can decorate outgoing HTTP POST request as headers. The size limit for this list is `10`.
      */
     headers?: HttpHeadersConfig;
-    eventsConfiguration?: EventConfiguration;
+    eventsConfiguration?: EventsConfiguration;
 };
 type Configuration = EmptyConfiguration | SvixConfig | HttpConfig;
 type WebhookConfigPartialUpdate = {
@@ -1518,10 +1559,15 @@ type WebhookConfigPartialUpdate = {
      */
     op: 'REMOVE' | 'UPSERT';
     /**
-     * Path for identyifing which properties should be updated
+     * Path identifying which properties should be updated.
+     * Use `UPSERT` on `/configuration/http/eventsConfigurationEntry` (no id) to create a new entry — body must omit `id` (server-generated); `REMOVE` on this path is rejected.
+     * Prefer `/configuration/http/eventsConfigurationEntry/{entryId}` paths to address a specific existing entry.
+     * Use `UPSERT` on `/configuration/http/eventsConfigurationEntry/{entryId}/active` with a boolean value to deactivate (`false`) or reactivate (`true`) a single endpoint without removing it; the value is required.
+     * Legacy `/configuration/http/eventsConfiguration/{eventType}` paths remain supported when at most one entry exists for that event type; they return `409` when multiple entries exist.
+     * Create/update can return `400` for a client-supplied entry id or an invalid JsonPath `filter`.
      */
-    path: '/active' | '/configuration' | '/configuration/svix/apiKey' | '/configuration/http/headers' | '/configuration/http/destinationUrl' | '/configuration/http/secretKey' | '/configuration/http/eventsConfiguration' | '/configuration/http/eventsConfiguration/{eventType}' | '/configuration/http/eventsConfiguration/{eventType}/destinationUrl' | '/configuration/http/eventsConfiguration/{eventType}/secretKey' | '/configuration/http/eventsConfiguration/{eventType}/headers';
-    value?: SvixConfig | HttpConfig | string | boolean | EventsConfiguration | EventConfiguration;
+    path: '/active' | '/configuration' | '/configuration/svix/apiKey' | '/configuration/http/headers' | '/configuration/http/destinationUrl' | '/configuration/http/secretKey' | '/configuration/http/eventsConfiguration' | '/configuration/http/eventsConfiguration/{eventType}' | '/configuration/http/eventsConfiguration/{eventType}/destinationUrl' | '/configuration/http/eventsConfiguration/{eventType}/secretKey' | '/configuration/http/eventsConfiguration/{eventType}/headers' | '/configuration/http/eventsConfigurationEntry' | '/configuration/http/eventsConfigurationEntry/{entryId}' | '/configuration/http/eventsConfigurationEntry/{entryId}/destinationUrl' | '/configuration/http/eventsConfigurationEntry/{entryId}/secretKey' | '/configuration/http/eventsConfigurationEntry/{entryId}/headers' | '/configuration/http/eventsConfigurationEntry/{entryId}/filter' | '/configuration/http/eventsConfigurationEntry/{entryId}/excludedFields' | '/configuration/http/eventsConfigurationEntry/{entryId}/name' | '/configuration/http/eventsConfigurationEntry/{entryId}/active';
+    value?: SvixConfig | HttpConfig | string | boolean | Array<string> | EventsConfiguration | EventConfiguration;
 };
 type ConfigurationGet = {
     /**
@@ -1538,7 +1584,11 @@ type ConfigurationGet = {
     headers?: HttpHeadersConfig;
     eventsConfiguration?: Array<{
         /**
-         * Type of the event.
+         * Stable server-generated identifier of this event configuration entry.
+         */
+        id?: string;
+        /**
+         * Type of the event. Multiple entries may share the same `eventType`.
          */
         eventType?: string;
         /**
@@ -1553,6 +1603,18 @@ type ConfigurationGet = {
          * List of key-value pairs which can decorate outgoing HTTP POST request as headers.
          */
         headers?: HttpHeadersConfig;
+        /**
+         * Optional Jayway JsonPath predicate. When omitted, the entry matches every event of the given `eventType`.
+         */
+        filter?: string;
+        /**
+         * Per-entry field exclusion list. Omitted or `null` means inherit the event-subscription exclusions. An empty array `[]` overrides with no exclusions for this target.
+         */
+        excludedFields?: Array<string>;
+        /**
+         * Per-endpoint activation switch. Always returned as an explicit boolean; entries created before the flag existed report `true`. When `false`, events for this endpoint are dropped without filter evaluation, delivery, or retries.
+         */
+        active?: boolean;
     }>;
 };
 /**
@@ -1823,7 +1885,7 @@ type IdResponse$1 = {
 /**
  * Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.
  */
-type SchemaType = 'CART' | 'CART_ITEM' | 'CATEGORY' | 'COMPANY' | 'COUPON' | 'CUSTOMER' | 'CUSTOMER_ADDRESS' | 'ORDER' | 'ORDER_ENTRY' | 'PRODUCT' | 'QUOTE' | 'RETURN' | 'PRICE_LIST' | 'SITE' | 'CUSTOM_ENTITY' | 'VENDOR' | 'MEDIA';
+type SchemaType = 'AVAILABILITY' | 'CART' | 'CART_ITEM' | 'CATEGORY' | 'COMPANY' | 'COUPON' | 'CUSTOMER' | 'CUSTOMER_ADDRESS' | 'LOCATION' | 'ORDER' | 'ORDER_ENTRY' | 'PRODUCT' | 'QUOTE' | 'RETURN' | 'PRICE_LIST' | 'SITE' | 'CUSTOM_ENTITY' | 'VENDOR' | 'MEDIA';
 /**
  * Type of the attribute.
  *

package/dist/index.js

@@ -686,7 +686,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "2.33.3";
+var version = "2.33.5";
 
 // src/version.ts
 var SDK_VERSION = version;