@viu/emporix-sdk 2.33.3 → 2.33.4

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
@@ -1470,7 +1470,15 @@ type SvixConfig = {
1470
1470
  };
1471
1471
  type EventConfiguration = {
1472
1472
  /**
1473
- * Unique identifier of the event.
1473
+ * 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.
1474
+ */
1475
+ id?: string;
1476
+ /**
1477
+ * Optional user-facing label for this entry (for example "ERP integration"). Purely descriptive — it has no impact on delivery. Maximum 255 characters.
1478
+ */
1479
+ name?: string;
1480
+ /**
1481
+ * Unique identifier of the event. Multiple entries may share the same `eventType`.
1474
1482
  */
1475
1483
  eventType?: string;
1476
1484
  /**
@@ -1485,7 +1493,22 @@ type EventConfiguration = {
1485
1493
  * 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.
1486
1494
  */
1487
1495
  headers?: HttpHeadersConfig;
1496
+ /**
1497
+ * 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)]`.
1498
+ */
1499
+ filter?: string;
1500
+ /**
1501
+ * 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.
1502
+ */
1503
+ excludedFields?: Array<string>;
1504
+ /**
1505
+ * 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.
1506
+ */
1507
+ active?: boolean;
1488
1508
  };
1509
+ /**
1510
+ * 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`.
1511
+ */
1489
1512
  type EventsConfiguration = Array<EventConfiguration>;
1490
1513
  type HttpHeaderConfigValue = {
1491
1514
  value?: string;
@@ -1509,7 +1532,7 @@ type HttpConfig = {
1509
1532
  * List of key-value pairs which can decorate outgoing HTTP POST request as headers. The size limit for this list is `10`.
1510
1533
  */
1511
1534
  headers?: HttpHeadersConfig;
1512
- eventsConfiguration?: EventConfiguration;
1535
+ eventsConfiguration?: EventsConfiguration;
1513
1536
  };
1514
1537
  type Configuration = EmptyConfiguration | SvixConfig | HttpConfig;
1515
1538
  type WebhookConfigPartialUpdate = {
@@ -1518,10 +1541,15 @@ type WebhookConfigPartialUpdate = {
1518
1541
  */
1519
1542
  op: 'REMOVE' | 'UPSERT';
1520
1543
  /**
1521
- * Path for identyifing which properties should be updated
1544
+ * Path identifying which properties should be updated.
1545
+ * 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.
1546
+ * Prefer `/configuration/http/eventsConfigurationEntry/{entryId}` paths to address a specific existing entry.
1547
+ * 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.
1548
+ * 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.
1549
+ * Create/update can return `400` for a client-supplied entry id or an invalid JsonPath `filter`.
1522
1550
  */
1523
- 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';
1524
- value?: SvixConfig | HttpConfig | string | boolean | EventsConfiguration | EventConfiguration;
1551
+ 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';
1552
+ value?: SvixConfig | HttpConfig | string | boolean | Array<string> | EventsConfiguration | EventConfiguration;
1525
1553
  };
1526
1554
  type ConfigurationGet = {
1527
1555
  /**
@@ -1538,7 +1566,11 @@ type ConfigurationGet = {
1538
1566
  headers?: HttpHeadersConfig;
1539
1567
  eventsConfiguration?: Array<{
1540
1568
  /**
1541
- * Type of the event.
1569
+ * Stable server-generated identifier of this event configuration entry.
1570
+ */
1571
+ id?: string;
1572
+ /**
1573
+ * Type of the event. Multiple entries may share the same `eventType`.
1542
1574
  */
1543
1575
  eventType?: string;
1544
1576
  /**
@@ -1553,6 +1585,18 @@ type ConfigurationGet = {
1553
1585
  * List of key-value pairs which can decorate outgoing HTTP POST request as headers.
1554
1586
  */
1555
1587
  headers?: HttpHeadersConfig;
1588
+ /**
1589
+ * Optional Jayway JsonPath predicate. When omitted, the entry matches every event of the given `eventType`.
1590
+ */
1591
+ filter?: string;
1592
+ /**
1593
+ * Per-entry field exclusion list. Omitted or `null` means inherit the event-subscription exclusions. An empty array `[]` overrides with no exclusions for this target.
1594
+ */
1595
+ excludedFields?: Array<string>;
1596
+ /**
1597
+ * 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.
1598
+ */
1599
+ active?: boolean;
1556
1600
  }>;
1557
1601
  };
1558
1602
  /**
package/dist/index.d.ts CHANGED
@@ -1470,7 +1470,15 @@ type SvixConfig = {
1470
1470
  };
1471
1471
  type EventConfiguration = {
1472
1472
  /**
1473
- * Unique identifier of the event.
1473
+ * 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.
1474
+ */
1475
+ id?: string;
1476
+ /**
1477
+ * Optional user-facing label for this entry (for example "ERP integration"). Purely descriptive — it has no impact on delivery. Maximum 255 characters.
1478
+ */
1479
+ name?: string;
1480
+ /**
1481
+ * Unique identifier of the event. Multiple entries may share the same `eventType`.
1474
1482
  */
1475
1483
  eventType?: string;
1476
1484
  /**
@@ -1485,7 +1493,22 @@ type EventConfiguration = {
1485
1493
  * 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.
1486
1494
  */
1487
1495
  headers?: HttpHeadersConfig;
1496
+ /**
1497
+ * 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)]`.
1498
+ */
1499
+ filter?: string;
1500
+ /**
1501
+ * 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.
1502
+ */
1503
+ excludedFields?: Array<string>;
1504
+ /**
1505
+ * 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.
1506
+ */
1507
+ active?: boolean;
1488
1508
  };
1509
+ /**
1510
+ * 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`.
1511
+ */
1489
1512
  type EventsConfiguration = Array<EventConfiguration>;
1490
1513
  type HttpHeaderConfigValue = {
1491
1514
  value?: string;
@@ -1509,7 +1532,7 @@ type HttpConfig = {
1509
1532
  * List of key-value pairs which can decorate outgoing HTTP POST request as headers. The size limit for this list is `10`.
1510
1533
  */
1511
1534
  headers?: HttpHeadersConfig;
1512
- eventsConfiguration?: EventConfiguration;
1535
+ eventsConfiguration?: EventsConfiguration;
1513
1536
  };
1514
1537
  type Configuration = EmptyConfiguration | SvixConfig | HttpConfig;
1515
1538
  type WebhookConfigPartialUpdate = {
@@ -1518,10 +1541,15 @@ type WebhookConfigPartialUpdate = {
1518
1541
  */
1519
1542
  op: 'REMOVE' | 'UPSERT';
1520
1543
  /**
1521
- * Path for identyifing which properties should be updated
1544
+ * Path identifying which properties should be updated.
1545
+ * 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.
1546
+ * Prefer `/configuration/http/eventsConfigurationEntry/{entryId}` paths to address a specific existing entry.
1547
+ * 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.
1548
+ * 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.
1549
+ * Create/update can return `400` for a client-supplied entry id or an invalid JsonPath `filter`.
1522
1550
  */
1523
- 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';
1524
- value?: SvixConfig | HttpConfig | string | boolean | EventsConfiguration | EventConfiguration;
1551
+ 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';
1552
+ value?: SvixConfig | HttpConfig | string | boolean | Array<string> | EventsConfiguration | EventConfiguration;
1525
1553
  };
1526
1554
  type ConfigurationGet = {
1527
1555
  /**
@@ -1538,7 +1566,11 @@ type ConfigurationGet = {
1538
1566
  headers?: HttpHeadersConfig;
1539
1567
  eventsConfiguration?: Array<{
1540
1568
  /**
1541
- * Type of the event.
1569
+ * Stable server-generated identifier of this event configuration entry.
1570
+ */
1571
+ id?: string;
1572
+ /**
1573
+ * Type of the event. Multiple entries may share the same `eventType`.
1542
1574
  */
1543
1575
  eventType?: string;
1544
1576
  /**
@@ -1553,6 +1585,18 @@ type ConfigurationGet = {
1553
1585
  * List of key-value pairs which can decorate outgoing HTTP POST request as headers.
1554
1586
  */
1555
1587
  headers?: HttpHeadersConfig;
1588
+ /**
1589
+ * Optional Jayway JsonPath predicate. When omitted, the entry matches every event of the given `eventType`.
1590
+ */
1591
+ filter?: string;
1592
+ /**
1593
+ * Per-entry field exclusion list. Omitted or `null` means inherit the event-subscription exclusions. An empty array `[]` overrides with no exclusions for this target.
1594
+ */
1595
+ excludedFields?: Array<string>;
1596
+ /**
1597
+ * 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.
1598
+ */
1599
+ active?: boolean;
1556
1600
  }>;
1557
1601
  };
1558
1602
  /**
package/dist/index.js CHANGED
@@ -686,7 +686,7 @@ var HttpClient = class {
686
686
  };
687
687
 
688
688
  // package.json
689
- var version = "2.33.3";
689
+ var version = "2.33.4";
690
690
 
691
691
  // src/version.ts
692
692
  var SDK_VERSION = version;