@epilot/sdk 2.4.4 → 2.6.0

package/definitions/entity.json

@@ -5640,14 +5640,12 @@
             "type": "boolean"
           },
           "edit_mode": {
-            "type": "string",
-            "description": "Controls how updates to this attribute are handled.\n- `direct` (default): update is applied immediately. No changeset created.\n- `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).\n- `approval`: update creates a changeset, requires explicit human approval.\n",
-            "enum": [
-              "direct",
-              "external",
-              "approval"
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/EditMode"
+              }
             ],
-            "default": "direct"
+            "description": "Controls how updates to this attribute are handled. See the `EditMode`\nschema for the per-mode semantics. Defaults to `direct`.\n"
           },
           "edit_mode_config": {
             "description": "Configuration for auto-clear matching on `edit_mode: external` attributes.\n`match_strategy` and `fuzzy_config` are only consulted for `external` mode —\nthey are ignored for `approval` mode, which resolves via explicit\n`:apply` / `:dismiss` endpoints and never auto-clears.\n",
@@ -7581,7 +7579,7 @@
             "readOnly": true,
             "type": "object",
             "nullable": true,
-            "description": "Pending attribute changesets for attributes configured with external or approval edit mode.\nRead-only via normal entity PATCH/PUT operations — cannot be set directly.\nUse the changeset management endpoints to apply or dismiss changesets.\n",
+            "description": "Pending attribute changesets for attributes configured with external or approval edit mode.\n\nThe value shape is `Changeset` (`proposed_value`, `created_at`, `edit_mode`, ...)\nand is what `:apply` / `:dismiss` operate on.\n\nRead-only via normal entity PATCH/PUT operations — those handlers strip `_changesets`\nfrom request bodies. Use the changeset management endpoints to mutate this field.\n",
             "additionalProperties": {
               "$ref": "#/components/schemas/Changeset"
             }
@@ -9771,6 +9769,185 @@
           "$ref": "#/components/schemas/Changeset"
         }
       },
+      "MeterReadingChangesetEntry": {
+        "type": "object",
+        "description": "A meter readings changeset entry — service-managed by metering-api.\nStored on `Meter._meter_readings_changeset` array attribute. Each entry mirrors a\nClickHouse meter reading row plus a changeset metadata overlay.\n\nNote: `org_id` is NOT stored on the entry. The entries live on the Meter entity,\nwhich is already org-scoped (`_org`). Round-tripping it would only invite drift;\ndownstream consumers receive the org from the meter / handler context.\n",
+        "required": [
+          "changeset_id",
+          "meter_id",
+          "counter_id",
+          "value",
+          "edit_mode",
+          "created_at"
+        ],
+        "properties": {
+          "value": {
+            "type": "number"
+          },
+          "direction": {
+            "type": "string",
+            "enum": [
+              "feed-in",
+              "feed-out"
+            ]
+          },
+          "timestamp": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "meter_id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "counter_id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "source": {
+            "type": "string"
+          },
+          "reason": {
+            "type": "string"
+          },
+          "read_by": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "valid",
+              "in-validation",
+              "implausible"
+            ]
+          },
+          "external_id": {
+            "type": "string"
+          },
+          "remark": {
+            "type": "string"
+          },
+          "metadata": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "changeset_id": {
+            "type": "string",
+            "description": "Unique changeset identifier (UUID v4)."
+          },
+          "edit_mode": {
+            "type": "string",
+            "enum": [
+              "external",
+              "approval"
+            ]
+          },
+          "match_strategy": {
+            "type": "string",
+            "enum": [
+              "exact",
+              "fuzzy"
+            ]
+          },
+          "timestamp_tolerance": {
+            "description": "Slack on `reading.timestamp` when metering-api auto-clear matches an\nincoming reading against this pending changeset.\n\nVariants:\n- `'exact'`: strict millisecond equality.\n- `{ type: 'same-day', timezone? }`: strip the time component and\n  compare year-month-day. Optional `timezone` is an IANA name\n  (e.g. `'Europe/Berlin'`); the day is bucketed in that zone.\n  Defaults to UTC when omitted.\n- `{ type: 'within-seconds', seconds }`: symmetric ±N-second window.\n",
+            "oneOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "exact"
+                ]
+              },
+              {
+                "type": "object",
+                "required": [
+                  "type"
+                ],
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "same-day"
+                    ]
+                  },
+                  "timezone": {
+                    "type": "string",
+                    "description": "IANA timezone identifier (e.g. `'Europe/Berlin'`, `'UTC'`).\nWhen omitted, the day is bucketed in UTC.\n"
+                  }
+                }
+              },
+              {
+                "type": "object",
+                "required": [
+                  "type",
+                  "seconds"
+                ],
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "within-seconds"
+                    ]
+                  },
+                  "seconds": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Tolerance in seconds. e.g. 60 = ±1 minute, 3600 = ±1 hour."
+                  }
+                }
+              }
+            ]
+          },
+          "fuzzy_config": {
+            "type": "object",
+            "properties": {
+              "percentage_threshold": {
+                "type": "number"
+              },
+              "absolute_threshold": {
+                "type": "number"
+              }
+            }
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "created_by": {
+            "$ref": "#/components/schemas/ChangesetCreator"
+          },
+          "previous": {
+            "type": "object",
+            "properties": {
+              "value": {
+                "type": "number"
+              },
+              "direction": {
+                "type": "string",
+                "enum": [
+                  "feed-in",
+                  "feed-out"
+                ]
+              },
+              "timestamp": {
+                "type": "string",
+                "format": "date-time"
+              }
+            }
+          }
+        }
+      },
+      "EditMode": {
+        "type": "string",
+        "description": "Controls whether a write goes through immediately or is held as a pending entry\non the parent entity's `_changesets` map.\n\n- `direct`: write applied immediately. No changeset created.\n- `external`: write held as a pending changeset; auto-cleared on a matching direct/ERP write.\n- `approval`: write held as a pending changeset; requires explicit human apply/dismiss.\n\nUsed at two levels: per-attribute (entity-attribute changesets) and per-capability\n(currently the `meter_readings` capability on the Meter schema, gating reading submissions).\n",
+        "enum": [
+          "direct",
+          "external",
+          "approval"
+        ],
+        "default": "direct"
+      },
       "EditModeConfig": {
         "type": "object",
         "description": "Configuration for `edit_mode: external` auto-clear matching.\nFields here (`match_strategy`, `fuzzy_config`) only take effect when\n`edit_mode` is `external`. They are ignored for `edit_mode: approval`,\nwhich never auto-clears and is resolved exclusively via the\n`:apply` / `:dismiss` changeset endpoints.\n",

package/definitions/integration-toolkit-runtime.json

@@ -1 +1 @@
-{"s":"https://integration-toolkit.sls.epilot.io","o":[["acknowledgeTracking","post","/v1/erp/tracking/acknowledgement",null,1],["triggerErp","post","/v1/erp/trigger",null,1],["processErpUpdatesEvents","post","/v1/erp/updates/events",null,1],["processErpUpdatesEventsV2","post","/v2/erp/updates/events",null,1],["processErpUpdatesEventsV3","post","/v3/erp/updates/events",null,1],["simulateMappingV2","post","/v2/erp/updates/mapping_simulation",null,1],["simulateMapping","post","/v1/erp/updates/mapping_simulation",null,1],["listIntegrations","get","/v1/integrations"],["createIntegration","post","/v1/integrations",null,1],["getIntegration","get","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegration","put","/v1/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegration","delete","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["queryEvents","post","/v1/integrations/{integrationId}/events",[["integrationId","p",true]],1],["replayEvents","post","/v1/integrations/{integrationId}/events/replay",[["integrationId","p",true]],1],["listUseCases","get","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]]],["createUseCase","post","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]],1],["getUseCase","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["updateUseCase","put","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]],1],["deleteUseCase","delete","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["listUseCaseHistory","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}/history",[["integrationId","p",true],["useCaseId","p",true],["cursor","q"]]],["listIntegrationsV2","get","/v2/integrations"],["createIntegrationV2","post","/v2/integrations",null,1],["getIntegrationV2","get","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegrationV2","put","/v2/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegrationV2","delete","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["setIntegrationAppMapping","put","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["deleteIntegrationAppMapping","delete","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["queryInboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/inbound-events",[["integrationId","p",true]],1],["getMonitoringStats","post","/v1/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeries","post","/v1/integrations/{integrationId}/monitoring/timeseries",[["integrationId","p",true]],1],["getOutboundStatus","get","/v1/integrations/{integrationId}/outbound-status",[["integrationId","p",true]]],["queryAccessLogs","post","/v1/integrations/{integrationId}/monitoring/access-logs",[["integrationId","p",true]],1],["queryOutboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/outbound-events",[["integrationId","p",true]],1],["queryMonitoringEventsV2","post","/v2/integrations/{integrationId}/monitoring/events",[["integrationId","p",true]],1],["getMonitoringStatsV2","post","/v2/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeriesV2","post","/v2/integrations/{integrationId}/monitoring/time-series",[["integrationId","p",true]],1],["getAssociatedMonitoringEvents","get","/v2/integrations/{integrationId}/monitoring/events/{eventId}/associated",[["integrationId","p",true],["eventId","p",true]]],["listSecureProxies","get","/v1/integrations/secure-proxies"],["secureProxy","post","/v1/secure-proxy",null,1],["managedCallExecute","post","/v1/managed-call/{slug}/execute",[["slug","p",true]],1],["generateTypesPreview","post","/v1/integrations/{integrationId}/generate-types-preview",[["integrationId","p",true]]],["generateTypes","post","/v1/integrations/{integrationId}/generate-types",[["integrationId","p",true]],1],["commitTypes","post","/v1/integrations/{integrationId}/commit-types",[["integrationId","p",true]],1]],"v":"3.0.3"}
+{"s":"https://integration-toolkit.sls.epilot.io","o":[["acknowledgeTracking","post","/v1/erp/tracking/acknowledgement",null,1],["triggerErp","post","/v1/erp/trigger",null,1],["processErpUpdatesEvents","post","/v1/erp/updates/events",null,1],["processErpUpdatesEventsV2","post","/v2/erp/updates/events",null,1],["processErpUpdatesEventsV3","post","/v3/erp/updates/events",null,1],["simulateMappingV2","post","/v2/erp/updates/mapping_simulation",null,1],["simulateMapping","post","/v1/erp/updates/mapping_simulation",null,1],["listIntegrations","get","/v1/integrations"],["createIntegration","post","/v1/integrations",null,1],["getIntegration","get","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegration","put","/v1/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegration","delete","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["queryEvents","post","/v1/integrations/{integrationId}/events",[["integrationId","p",true]],1],["replayEvents","post","/v1/integrations/{integrationId}/events/replay",[["integrationId","p",true]],1],["listUseCases","get","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]]],["createUseCase","post","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]],1],["getUseCase","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["updateUseCase","put","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]],1],["deleteUseCase","delete","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["listUseCaseHistory","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}/history",[["integrationId","p",true],["useCaseId","p",true],["cursor","q"]]],["listIntegrationsV2","get","/v2/integrations"],["createIntegrationV2","post","/v2/integrations",null,1],["getIntegrationV2","get","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegrationV2","put","/v2/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegrationV2","delete","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["getSecureProxyWhitelist","get","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist",[["integrationId","p",true],["useCaseId","p",true]]],["updateSecureProxyWhitelist","put","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist",[["integrationId","p",true],["useCaseId","p",true]],1],["listSecureProxyWhitelistHistory","get","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist/history",[["integrationId","p",true],["useCaseId","p",true],["limit","q"]]],["setIntegrationAppMapping","put","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["deleteIntegrationAppMapping","delete","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["queryInboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/inbound-events",[["integrationId","p",true]],1],["getMonitoringStats","post","/v1/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeries","post","/v1/integrations/{integrationId}/monitoring/timeseries",[["integrationId","p",true]],1],["getOutboundStatus","get","/v1/integrations/{integrationId}/outbound-status",[["integrationId","p",true]]],["queryAccessLogs","post","/v1/integrations/{integrationId}/monitoring/access-logs",[["integrationId","p",true]],1],["queryOutboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/outbound-events",[["integrationId","p",true]],1],["queryMonitoringEventsV2","post","/v2/integrations/{integrationId}/monitoring/events",[["integrationId","p",true]],1],["getMonitoringStatsV2","post","/v2/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeriesV2","post","/v2/integrations/{integrationId}/monitoring/time-series",[["integrationId","p",true]],1],["getAssociatedMonitoringEvents","get","/v2/integrations/{integrationId}/monitoring/events/{eventId}/associated",[["integrationId","p",true],["eventId","p",true]]],["listSecureProxies","get","/v1/integrations/secure-proxies"],["secureProxy","post","/v1/secure-proxy",null,1],["managedCallExecute","post","/v1/managed-call/{slug}/execute",[["slug","p",true]],1],["generateTypesPreview","post","/v1/integrations/{integrationId}/generate-types-preview",[["integrationId","p",true]]],["generateTypes","post","/v1/integrations/{integrationId}/generate-types",[["integrationId","p",true]],1],["commitTypes","post","/v1/integrations/{integrationId}/commit-types",[["integrationId","p",true]],1]],"v":"3.0.3"}