@epilot/sdk 2.20.32 → 2.20.34

package/dist/{metering.d-DomHYl06.d.ts → metering.d-BP04w-gR.d.cts}

@@ -850,7 +850,9 @@ declare namespace Components {
              */
             counter_id?: EntityId /* uuid */;
             /**
-             * The direction of the reading (feed-in or feed-out)
+             * The direction of the reading. Optional, but **strongly recommended**: readings are keyed by direction in storage, so every reading is stored with one.
+             * Resolution order: the value sent here, else the `direction` of the reading's counter, else a value derived from the counter's `obis_number` — `2.x.x` on an electricity counter is `feed-in`, and everything else (including heat, gas and water, which have no meaningful direction) is `feed-out`.
+             * Relying on the derived fallback is fine for single-flow media. For electricity, set `direction` on the reading or on the counter: an electricity export counter that carries neither, and whose OBIS code does not say `2.x.x`, will be stored as `feed-out`.
              */
             direction?: Direction;
             /**
@@ -1836,6 +1838,7 @@ declare namespace Paths {
             export type $400 = Components.Responses.InvalidRequest;
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
+            export type $413 = Components.Schemas.ErrorResp;
             export type $500 = Components.Responses.InternalServerError;
         }
     }
@@ -2150,7 +2153,10 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
   /**
-   * getReadingChangesets - List pending reading changesets for a counter
+   * getReadingChangesets - getReadingChangesets
+   * 
+   * Lists the pending reading changesets for a counter.
+   * 
    */
   'getReadingChangesets'(
     parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2158,9 +2164,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetReadingChangesets.Responses.$200>
   /**
-   * applyReadingChangeset - Apply (approve) a pending reading changeset
+   * applyReadingChangeset - applyReadingChangeset
    * 
-   * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+   * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2171,9 +2177,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ApplyReadingChangeset.Responses.$200>
   /**
-   * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+   * dismissReadingChangeset - dismissReadingChangeset
    * 
-   * Removes the pending changeset without applying it. The reading value remains unchanged.
+   * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2184,9 +2190,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DismissReadingChangeset.Responses.$200>
   /**
-   * updateReadingChangeset - Edit a pending reading changeset
+   * updateReadingChangeset - updateReadingChangeset
    * 
-   * Updates the proposed value of a pending changeset without going through the normal write path.
+   * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
    * 
    */
   'updateReadingChangeset'(
@@ -2459,7 +2465,10 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets']: {
     /**
-     * getReadingChangesets - List pending reading changesets for a counter
+     * getReadingChangesets - getReadingChangesets
+     * 
+     * Lists the pending reading changesets for a counter.
+     * 
      */
     'get'(
       parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2469,9 +2478,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:apply']: {
     /**
-     * applyReadingChangeset - Apply (approve) a pending reading changeset
+     * applyReadingChangeset - applyReadingChangeset
      * 
-     * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+     * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2484,9 +2493,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:dismiss']: {
     /**
-     * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+     * dismissReadingChangeset - dismissReadingChangeset
      * 
-     * Removes the pending changeset without applying it. The reading value remains unchanged.
+     * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2499,9 +2508,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}']: {
     /**
-     * updateReadingChangeset - Edit a pending reading changeset
+     * updateReadingChangeset - updateReadingChangeset
      * 
-     * Updates the proposed value of a pending changeset without going through the normal write path.
+     * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
      * 
      */
     'patch'(

package/dist/{metering.d-DomHYl06.d.cts → metering.d-BP04w-gR.d.ts}

@@ -850,7 +850,9 @@ declare namespace Components {
              */
             counter_id?: EntityId /* uuid */;
             /**
-             * The direction of the reading (feed-in or feed-out)
+             * The direction of the reading. Optional, but **strongly recommended**: readings are keyed by direction in storage, so every reading is stored with one.
+             * Resolution order: the value sent here, else the `direction` of the reading's counter, else a value derived from the counter's `obis_number` — `2.x.x` on an electricity counter is `feed-in`, and everything else (including heat, gas and water, which have no meaningful direction) is `feed-out`.
+             * Relying on the derived fallback is fine for single-flow media. For electricity, set `direction` on the reading or on the counter: an electricity export counter that carries neither, and whose OBIS code does not say `2.x.x`, will be stored as `feed-out`.
              */
             direction?: Direction;
             /**
@@ -1836,6 +1838,7 @@ declare namespace Paths {
             export type $400 = Components.Responses.InvalidRequest;
             export type $401 = Components.Responses.Unauthorized;
             export type $403 = Components.Responses.Forbidden;
+            export type $413 = Components.Schemas.ErrorResp;
             export type $500 = Components.Responses.InternalServerError;
         }
     }
@@ -2150,7 +2153,10 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
   /**
-   * getReadingChangesets - List pending reading changesets for a counter
+   * getReadingChangesets - getReadingChangesets
+   * 
+   * Lists the pending reading changesets for a counter.
+   * 
    */
   'getReadingChangesets'(
     parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2158,9 +2164,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetReadingChangesets.Responses.$200>
   /**
-   * applyReadingChangeset - Apply (approve) a pending reading changeset
+   * applyReadingChangeset - applyReadingChangeset
    * 
-   * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+   * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2171,9 +2177,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ApplyReadingChangeset.Responses.$200>
   /**
-   * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+   * dismissReadingChangeset - dismissReadingChangeset
    * 
-   * Removes the pending changeset without applying it. The reading value remains unchanged.
+   * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
    * 
    * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
    * 
@@ -2184,9 +2190,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DismissReadingChangeset.Responses.$200>
   /**
-   * updateReadingChangeset - Edit a pending reading changeset
+   * updateReadingChangeset - updateReadingChangeset
    * 
-   * Updates the proposed value of a pending changeset without going through the normal write path.
+   * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
    * 
    */
   'updateReadingChangeset'(
@@ -2459,7 +2465,10 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets']: {
     /**
-     * getReadingChangesets - List pending reading changesets for a counter
+     * getReadingChangesets - getReadingChangesets
+     * 
+     * Lists the pending reading changesets for a counter.
+     * 
      */
     'get'(
       parameters?: Parameters<Paths.GetReadingChangesets.PathParameters> | null,
@@ -2469,9 +2478,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:apply']: {
     /**
-     * applyReadingChangeset - Apply (approve) a pending reading changeset
+     * applyReadingChangeset - applyReadingChangeset
      * 
-     * Applies the proposed reading value to ClickHouse and removes the pending changeset.
+     * Applies (approves) a pending reading changeset: the proposed reading value is written to ClickHouse and the pending changeset is removed.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2484,9 +2493,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}:dismiss']: {
     /**
-     * dismissReadingChangeset - Dismiss (reject) a pending reading changeset
+     * dismissReadingChangeset - dismissReadingChangeset
      * 
-     * Removes the pending changeset without applying it. The reading value remains unchanged.
+     * Dismisses (rejects) a pending reading changeset: the changeset is removed without being applied. The reading value remains unchanged.
      * 
      * Requires `meter_reading:edit` permission (approval workflow action on the reading's approval state).
      * 
@@ -2499,9 +2508,9 @@ interface PathsDictionary {
   }
   ['/v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id}']: {
     /**
-     * updateReadingChangeset - Edit a pending reading changeset
+     * updateReadingChangeset - updateReadingChangeset
      * 
-     * Updates the proposed value of a pending changeset without going through the normal write path.
+     * Edits a pending reading changeset by updating its proposed value, without going through the normal write path.
      * 
      */
     'patch'(

package/docs/automation.md

@@ -53,6 +53,9 @@ const { data } = await automationClient.searchFlows(...)
 - [`AutomationFlow`](#automationflow)
 - [`WorkflowContextRole`](#workflowcontextrole)
 - [`SearchAutomationsResp`](#searchautomationsresp)
+- [`JourneyContextUsagesReq`](#journeycontextusagesreq)
+- [`JourneyContextUsage`](#journeycontextusage)
+- [`JourneyContextUsagesResp`](#journeycontextusagesresp)
 - [`AnyTrigger`](#anytrigger)
 - [`AnyAction`](#anyaction)
 - [`AnyActionConfig`](#anyactionconfig)
@@ -154,6 +157,9 @@ const { data } = await automationClient.searchFlows(...)
 - [`SearchExecutionsReq`](#searchexecutionsreq)
 - [`SearchExecutionsResp`](#searchexecutionsresp)
 - [`StartExecutionRequest`](#startexecutionrequest)
+- [`ActionInputs`](#actioninputs)
+- [`SendEmailInputs`](#sendemailinputs)
+- [`FlowExecutionCancelInputs`](#flowexecutioncancelinputs)
 - [`PatchBulkJobRequest`](#patchbulkjobrequest)
 - [`BulkTriggerRequest`](#bulktriggerrequest)
 - [`EntityRef`](#entityref)
@@ -328,6 +334,7 @@ const { data } = await client.getExecutions({
       "conditions": [],
       "schedules": [],
       "actions": [],
+      "action_inputs": {},
       "resume_token": "eyJraWQiOiJrZXkifQ==",
       "trigger_context": {},
       "version": 2,
@@ -378,7 +385,23 @@ const { data } = await client.startExecution(
       trigger_user_id: '10006129'
     },
     flow_execution_id: 'string',
-    flow_automation_task_id: 'string'
+    flow_automation_task_id: 'string',
+    action_inputs: {
+      'cancel-flow-execution': {
+        selected_reasons: [
+          {
+            id: '_6kITMwkv_0Uo4i7fO7Ja',
+            title: 'Process completed successfully'
+          }
+        ],
+        extra_description: 'string'
+      },
+      'send-email': {
+        subject: 'string',
+        body: 'string',
+        attachment_entity_ids: ['string']
+      }
+    }
   },
 )
 ```
@@ -472,6 +495,17 @@ const { data } = await client.startExecution(
       "iterations": []
     }
   ],
+  "action_inputs": {
+    "cancel-flow-execution": {
+      "selected_reasons": [],
+      "extra_description": "string"
+    },
+    "send-email": {
+      "subject": "string",
+      "body": "string",
+      "attachment_entity_ids": ["string"]
+    }
+  },
   "resume_token": "eyJraWQiOiJrZXkifQ==",
   "trigger_context": {
     "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -566,6 +600,7 @@ const { data } = await client.searchExecutions(
       "conditions": [],
       "schedules": [],
       "actions": [],
+      "action_inputs": {},
       "resume_token": "eyJraWQiOiJrZXkifQ==",
       "trigger_context": {},
       "version": 2,
@@ -846,6 +881,17 @@ const { data } = await client.getExecution({
       "iterations": []
     }
   ],
+  "action_inputs": {
+    "cancel-flow-execution": {
+      "selected_reasons": [],
+      "extra_description": "string"
+    },
+    "send-email": {
+      "subject": "string",
+      "body": "string",
+      "attachment_entity_ids": ["string"]
+    }
+  },
   "resume_token": "eyJraWQiOiJrZXkifQ==",
   "trigger_context": {
     "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -998,6 +1044,17 @@ const { data } = await client.cancelExecution({
       "iterations": []
     }
   ],
+  "action_inputs": {
+    "cancel-flow-execution": {
+      "selected_reasons": [],
+      "extra_description": "string"
+    },
+    "send-email": {
+      "subject": "string",
+      "body": "string",
+      "attachment_entity_ids": ["string"]
+    }
+  },
   "resume_token": "eyJraWQiOiJrZXkifQ==",
   "trigger_context": {
     "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -1120,6 +1177,10 @@ const { data } = await client.resumeExecutionWithToken(
       {},
       {}
     ],
+    "action_inputs": {
+      "cancel-flow-execution": {},
+      "send-email": {}
+    },
     "resume_token": "eyJraWQiOiJrZXkifQ==",
     "trigger_context": {
       "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
@@ -1472,6 +1533,72 @@ type SearchAutomationsResp = {
 }
 ```
 
+### `JourneyContextUsagesReq`
+
+```ts
+type JourneyContextUsagesReq = {
+  journey_id: string // uuid
+  param_keys: string[]
+  param_ids?: string[]
+}
+```
+
+### `JourneyContextUsage`
+
+```ts
+type JourneyContextUsage = {
+  kind: "automation"
+  resource: {
+    type: "automation_flow"
+    id: string
+    name?: string
+  }
+  location?: {
+    action_id?: string
+    action_type?: string
+  }
+  matched_as: {
+    dialect: "name"
+    token: string
+    at: string
+  }
+  link_hint: {
+    route: "automation-flow"
+    params: Record<string, string>
+  }
+}
+```
+
+### `JourneyContextUsagesResp`
+
+```ts
+type JourneyContextUsagesResp = {
+  usages: Array<{
+    kind: "automation"
+    resource: {
+      type: { ... }
+      id: { ... }
+      name?: { ... }
+    }
+    location?: {
+      action_id?: { ... }
+      action_type?: { ... }
+    }
+    matched_as: {
+      dialect: { ... }
+      token: { ... }
+      at: { ... }
+    }
+    link_hint: {
+      route: { ... }
+      params: { ... }
+    }
+  }>
+  status: "ok" | "partial"
+  scanned: number
+}
+```
+
 ### `AnyTrigger`
 
 ```ts
@@ -2840,6 +2967,7 @@ type ForwardEmailActionConfig = {
     }>
     include_attachments?: boolean
     subject_prefix?: string
+    language_code?: "de" | "en"
     mark_as_done?: boolean
     mark_as_read?: boolean
   }
@@ -2868,6 +2996,7 @@ type ForwardEmailAction = {
     }>
     include_attachments?: boolean
     subject_prefix?: string
+    language_code?: "de" | "en"
     mark_as_done?: boolean
     mark_as_read?: boolean
   }
@@ -2884,6 +3013,7 @@ type ForwardEmailConfig = {
   }>
   include_attachments?: boolean
   subject_prefix?: string
+  language_code?: "de" | "en"
   mark_as_done?: boolean
   mark_as_read?: boolean
 }
@@ -2963,6 +3093,8 @@ type SendEmailConfig = {
     source_filter?: {
       limit?: { ... }
       filename_regex?: { ... }
+      filename?: { ... }
+      filename_pattern?: { ... }
       attribute?: { ... }
       relation_tag?: { ... }
       tag?: { ... }
@@ -3391,7 +3523,7 @@ type FlowExecutionCancelAction = {
 
 ### `FlowExecutionCancelConfig`
 
-Configuration for cancelling a flow execution with selected reasons
+Configuration for cancelling a flow execution. The selected reasons are optional; a semi-automated step lets the person running it choose them when the execution starts.
 
 ```ts
 type FlowExecutionCancelConfig = {
@@ -3647,7 +3779,7 @@ type WorkflowExecutionContext = {
 
 ### `WorkflowWaitContext`
 
-Correlation stamped when the triggering submission entity carried workflow wait claims from a journey link (AL-2521). Consumed by svc-workflows to resume a task waiting on this journey submission.
+Correlation stamped when the triggering submission entity carried workflow wait claims from a journey link. Consumed by svc-workflows to resume a task waiting on this journey submission.
 
 
 ```ts
@@ -4055,6 +4187,71 @@ type StartExecutionRequest = {
   }
   flow_execution_id?: string
   flow_automation_task_id?: string
+  action_inputs?: {
+    cancel-flow-execution?: {
+      selected_reasons: { ... }
+      extra_description?: { ... }
+    }
+    send-email?: {
+      subject?: { ... }
+      body?: { ... }
+      attachment_entity_ids?: { ... }
+    }
+  }
+}
+```
+
+### `ActionInputs`
+
+Internal. Run-time inputs for the actions of this execution, keyed by
+action type. An action reads the entry for its own type and treats it
+as replacing the matching configured values; an action whose type has
+no entry runs entirely from its configuration.
+
+Only the workflows service may set this fi
+
+```ts
+type ActionInputs = {
+  cancel-flow-execution?: {
+    selected_reasons: Array<{
+      id: { ... }
+      title: { ... }
+    }>
+    extra_description?: string
+  }
+  send-email?: {
+    subject?: string
+    body?: string
+    attachment_entity_ids?: string[]
+  }
+}
+```
+
+### `SendEmailInputs`
+
+Adjustments a person made to an email before sending it, replacing the rendered values the template produced. The template itself is untouched.
+
+`attachment_entity_ids` is a request, not an instruction: the worker keeps only the ids that are genuinely files of the entity this execution runs on, so a
+
+```ts
+type SendEmailInputs = {
+  subject?: string
+  body?: string
+  attachment_entity_ids?: string[]
+}
+```
+
+### `FlowExecutionCancelInputs`
+
+The cancellation reasons a person chose when running a semi-automated cancel step, replacing `selected_reasons` from the action's configuration.
+
+```ts
+type FlowExecutionCancelInputs = {
+  selected_reasons: Array<{
+    id: string
+    title: string
+  }>
+  extra_description?: string
 }
 ```