@epilot/cli 0.1.68 → 0.1.70

package/README.md

@@ -29,7 +29,7 @@ npm install -g @epilot/cli
 
 <!-- usage-help -->
 ```
-epilot v0.1.68 — CLI for epilot APIs
+epilot v0.1.70 — CLI for epilot APIs
 
 USAGE
   epilot <api> <operationId> [params...] [flags]

package/definitions/access-token.json

@@ -597,6 +597,12 @@
         "description": "When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.",
         "example": true
       },
+      "Anonymize": {
+        "type": "boolean",
+        "default": false,
+        "description": "Forces PII anonymization on all entity data returned to this token. Cannot be disabled by the token bearer. See entity-api anonymized responses.",
+        "example": true
+      },
       "AccessTokenParameters": {
         "type": "object",
         "additionalProperties": false,
@@ -618,6 +624,9 @@
           },
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
+          },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
           }
         },
         "required": [
@@ -692,6 +701,9 @@
           },
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
+          },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
           }
         },
         "required": [
@@ -719,6 +731,9 @@
           },
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
+          },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
           }
         },
         "required": [
@@ -782,6 +797,9 @@
           "read_only": {
             "$ref": "#/components/schemas/ReadOnly"
           },
+          "anonymize": {
+            "$ref": "#/components/schemas/Anonymize"
+          },
           "last_used": {
             "type": "string",
             "format": "date",

package/definitions/customer-portal.json

@@ -484,25 +484,75 @@
       "post": {
         "operationId": "createExport",
         "summary": "createExport",
-        "description": "Request an asynchronous CSV export of the portal user's contracts, delivery points and meters. Returns a job id to poll.",
+        "description": "Request an asynchronous CSV export of the portal user's entities for one schema. Columns come from the request Returns a job id to poll.\n",
         "tags": [
           "ECP"
         ],
-        "parameters": [
-          {
-            "in": "query",
-            "name": "language",
-            "required": false,
-            "schema": {
-              "type": "string",
-              "enum": [
-                "de",
-                "en"
-              ]
-            },
-            "description": "Output language for headers and value formatting. Defaults to German when omitted or unsupported."
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "schema",
+                  "columns"
+                ],
+                "properties": {
+                  "schema": {
+                    "type": "string",
+                    "description": "Entity schema to export (must be an allowed portal entity)."
+                  },
+                  "search": {
+                    "type": "object",
+                    "description": "Search parameters, same shape the entity list queries with.",
+                    "properties": {
+                      "q": {
+                        "type": "string"
+                      },
+                      "q_fields": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      },
+                      "filters": {
+                        "type": "array",
+                        "items": {
+                          "type": "object"
+                        }
+                      },
+                      "filters_context": {
+                        "type": "array",
+                        "items": {
+                          "type": "object"
+                        }
+                      },
+                      "sort": {}
+                    }
+                  },
+                  "columns": {
+                    "type": "array",
+                    "description": "Ordered column definitions; order is the CSV column order.",
+                    "items": {
+                      "$ref": "#/components/schemas/PortalDataExportColumn"
+                    }
+                  },
+                  "expand_over": {
+                    "type": "string"
+                  },
+                  "language": {
+                    "type": "string",
+                    "enum": [
+                      "de",
+                      "en"
+                    ]
+                  }
+                }
+              }
+            }
           }
-        ],
+        },
         "security": [
           {
             "PortalAuth": []
@@ -540,7 +590,7 @@
             "$ref": "#/components/responses/Forbidden"
           },
           "404": {
-            "description": "No export profile configured for this organization."
+            "description": "Missing or invalid export columns."
           },
           "500": {
             "$ref": "#/components/responses/InternalServerError"
@@ -5879,6 +5929,125 @@
           }
         }
       },
+      "post": {
+        "operationId": "getContractWithTemplates",
+        "summary": "getContractWithTemplates",
+        "description": "Get a contract by id, resolving the provided Handlebars templates against each related meter into templates_output. POST variant of getContract that accepts a request body; the GET remains as a fallback.",
+        "tags": [
+          "ECP"
+        ],
+        "security": [
+          {
+            "PortalAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "$ref": "#/components/schemas/EntityId"
+            },
+            "required": true,
+            "description": "The ID of the contract"
+          }
+        ],
+        "requestBody": {
+          "required": false,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "templates": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "type": "string"
+                    },
+                    "description": "Map of content field name to Handlebars template string. Each template is resolved per related meter and returned as templates_output on the meter."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The requested contract returned successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "entity": {
+                      "$ref": "#/components/schemas/Contract"
+                    },
+                    "orders": {
+                      "type": "array",
+                      "description": "The related orders of the requested contract",
+                      "items": {
+                        "$ref": "#/components/schemas/Order"
+                      }
+                    },
+                    "meters": {
+                      "type": "array",
+                      "description": "The related meters of the requested contract",
+                      "items": {
+                        "allOf": [
+                          {
+                            "$ref": "#/components/schemas/Meter"
+                          },
+                          {
+                            "$ref": "#/components/schemas/EntityTemplates"
+                          }
+                        ]
+                      }
+                    },
+                    "files": {
+                      "type": "array",
+                      "description": "The related files of the requested contract",
+                      "items": {
+                        "$ref": "#/components/schemas/File"
+                      }
+                    },
+                    "relations": {
+                      "type": "array",
+                      "description": "The related entities of the requested contract",
+                      "items": {
+                        "$ref": "#/components/schemas/EntityItem"
+                      }
+                    },
+                    "workflow": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/WorkflowExecution"
+                      }
+                    },
+                    "journey_actions": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/JourneyActions"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      },
       "patch": {
         "operationId": "updateContract",
         "summary": "updateContract",
@@ -12013,6 +12182,13 @@
                     "type": "boolean",
                     "example": true,
                     "description": "Require symbols"
+                  },
+                  "password_history_size": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 24,
+                    "example": 3,
+                    "description": "Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan."
                   }
                 }
               }
@@ -18207,6 +18383,13 @@
                     "type": "boolean",
                     "example": true,
                     "description": "Require symbols"
+                  },
+                  "password_history_size": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 24,
+                    "example": 3,
+                    "description": "Number of previous passwords a user is prevented from reusing. Set to 0 to disable reuse prevention. Maps to Cognito's PasswordHistorySize and requires the user pool to be on the Essentials or Plus feature plan."
                   }
                 }
               }
@@ -18523,6 +18706,90 @@
         "description": "ID of the portal",
         "example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
       },
+      "PortalDataExportColumn": {
+        "type": "object",
+        "description": "One column of the portal data export CSV.",
+        "required": [
+          "key",
+          "header",
+          "source"
+        ],
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Stable, immutable column id (snake_case). Append-only contract: never rename, reorder semantics, or remove an existing key; new columns are appended.\n",
+            "example": "vertragsnummer"
+          },
+          "header": {
+            "type": "object",
+            "description": "Localized header label, keyed by language (de, en).",
+            "additionalProperties": {
+              "type": "string"
+            },
+            "example": {
+              "de": "Vertragsnummer",
+              "en": "Contract number"
+            }
+          },
+          "source": {
+            "type": "object",
+            "description": "Where the value comes from: relation hops from the anchor entity plus the attribute to read on the resolved entity. An empty path means the anchor itself.\n",
+            "required": [
+              "attribute"
+            ],
+            "properties": {
+              "path": {
+                "type": "array",
+                "description": "Relation hops from the anchor entity (max 3).",
+                "items": {
+                  "type": "string"
+                },
+                "example": [
+                  "customer"
+                ]
+              },
+              "attribute": {
+                "type": "string",
+                "description": "Attribute to read on the resolved entity.",
+                "example": "customer_number"
+              },
+              "address_field": {
+                "type": "string",
+                "description": "Which part of an address-typed attribute to render.",
+                "enum": [
+                  "full",
+                  "street",
+                  "street_number",
+                  "postal_code",
+                  "city",
+                  "additional_info",
+                  "country"
+                ]
+              }
+            }
+          },
+          "formatter": {
+            "type": "string",
+            "enum": [
+              "text",
+              "date",
+              "money_cents",
+              "enum",
+              "address"
+            ]
+          },
+          "enum_labels": {
+            "type": "object",
+            "description": "Localized value maps for the enum formatter, keyed by language then raw value.\n",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      },
       "UpsertPortalConfigV3": {
         "allOf": [
           {

package/definitions/message.json

@@ -123,6 +123,34 @@
           },
           "403": {
             "description": "Forbidden"
+          },
+          "409": {
+            "description": "Conflict - the draft was edited by someone else since it was loaded",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "description": "Human-readable conflict message",
+                      "example": "This draft was edited by someone else. Please reload and try again."
+                    },
+                    "current_message": {
+                      "description": "The current server version of the message (includes updated_by / _updated_at)",
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/BaseEntity"
+                        },
+                        {
+                          "$ref": "#/components/schemas/Message"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
           }
         }
       }
@@ -762,6 +790,41 @@
         }
       }
     },
+    "/v2/message/threads:workload": {
+      "post": {
+        "operationId": "getAssigneeWorkload",
+        "summary": "getAssigneeWorkload",
+        "description": "Return the open-thread workload for a set of user ids.\n\nFor each requested user id, returns the number of *open* threads assigned\ndirectly to that user — matching what the user sees in their central-inbox\nopen view: in inbox, not trashed, not done, and excluding notification-only\nand spam threads.\n\nOnly threads assigned directly to a user are counted; threads assigned to a\ngroup the user belongs to are not. Intended for assignment load-balancing\n(e.g. even-distribution automations) that need a consistent, inbox-aligned\nworkload per user.\n",
+        "tags": [
+          "Threads"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AssigneeWorkloadParams"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AssigneeWorkloadResults"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
     "/v1/message/threads": {
       "put": {
         "operationId": "updateThread",
@@ -2242,6 +2305,11 @@
             "description": "User ID of user sends the message.",
             "example": "206801"
           },
+          "updated_by": {
+            "type": "string",
+            "description": "User ID of the user who last updated (edited) the message. Set for drafts on each save.",
+            "example": "206801"
+          },
           "subject": {
             "type": "string",
             "description": "Subject",
@@ -2466,6 +2534,11 @@
             "type": "boolean",
             "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.            In this case, service doesn't process this attachment.\n",
             "default": false
+          },
+          "save_to_entity": {
+            "type": "boolean",
+            "description": "If false, this file relation is kept on the message (e.g. for CID/inline rendering) but is NOT propagated to the entity the email is sent from. Used for inline images such as logos, signatures and social icons. Defaults to true.\n",
+            "default": true
           }
         }
       },
@@ -2481,6 +2554,11 @@
             "description": "Whether the thread is marked as Done immediately after sending the message",
             "default": false
           },
+          "mark_thread_as_read": {
+            "type": "boolean",
+            "description": "Whether to mark the thread as read by the sender's org/user after sending a reply.\nOnly applies when `parent_id` is set. When false, the thread's `org_read_message` and\n`user_read_message` arrays are left unchanged, so the thread remains unread for anyone\nwho had it unread before. Defaults to true for backward compatibility.\n",
+            "default": true
+          },
           "thread": {
             "type": "object",
             "required": [
@@ -2563,6 +2641,19 @@
             "type": "string",
             "description": "Template ID used for sending message.",
             "example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
+          },
+          "source": {
+            "type": "string",
+            "description": "Identifies who triggered the send so server-side policy can branch on it.\nFor `manual` sends, the caller's curated `_tags` are trusted as-is and no\nserver-side enrichment from the referenced `template_id` (e.g. merging the\ntemplate's `email_tags`) is performed. Any non-manual value (or omitting the\nfield) opts into template-derived enrichment.\n",
+            "enum": [
+              "manual",
+              "automation",
+              "workflow",
+              "partner",
+              "bulk",
+              "system"
+            ],
+            "example": "manual"
           }
         }
       },
@@ -2661,6 +2752,60 @@
           }
         }
       },
+      "AssigneeWorkloadParams": {
+        "type": "object",
+        "required": [
+          "user_ids"
+        ],
+        "properties": {
+          "user_ids": {
+            "type": "array",
+            "description": "User ids to compute the open-thread workload for. At most 100 per request; larger requests are rejected with 422.",
+            "minItems": 1,
+            "items": {
+              "type": "string"
+            },
+            "example": [
+              "11000902",
+              "11001053"
+            ]
+          }
+        }
+      },
+      "AssigneeWorkload": {
+        "type": "object",
+        "required": [
+          "user_id",
+          "open_threads"
+        ],
+        "properties": {
+          "user_id": {
+            "type": "string",
+            "description": "The user id.",
+            "example": "11000902"
+          },
+          "open_threads": {
+            "type": "number",
+            "description": "Number of open threads assigned directly to the user.",
+            "example": 2
+          }
+        }
+      },
+      "AssigneeWorkloadResults": {
+        "type": "object",
+        "required": [
+          "workloads"
+        ],
+        "properties": {
+          "workloads": {
+            "type": "array",
+            "description": "Open-thread workload per requested user id, in request order.",
+            "items": {
+              "$ref": "#/components/schemas/AssigneeWorkload"
+            }
+          }
+        }
+      },
       "ReadMessagePayload": {
         "type": "object",
         "required": [
@@ -2785,7 +2930,7 @@
           "timestamp": {
             "type": "string",
             "description": "Timestamp of the event",
-            "example": "2024-01-01T00:00:00Z"
+            "example": "2024-01-01T00:00:00.000Z"
           }
         }
       },

package/definitions/metering.json

@@ -104,7 +104,7 @@
                             "properties": {
                               "last_reading": {
                                 "type": "string",
-                                "example": "2022-10-10",
+                                "example": "2022-10-10T00:00:00.000Z",
                                 "description": "The timestamp of the last reading"
                               },
                               "current_consumption": {
@@ -2035,7 +2035,7 @@
               },
               "calibration_date": {
                 "type": "string",
-                "example": "2022-10-10",
+                "example": "2022-10-10T00:00:00.000Z",
                 "description": "The calibration date of the meter"
               },
               "contract": {
@@ -2151,7 +2151,7 @@
           "timestamp": {
             "type": "string",
             "description": "If the value is not provided, the system will be set with the time the request is processed.",
-            "example": "2022-10-10",
+            "example": "2022-10-10T00:00:00.000Z",
             "format": "date-time"
           },
           "source": {
@@ -2387,7 +2387,7 @@
           "timestamp": {
             "type": "string",
             "description": "If the value is not provided, the system will be set with the time the request is processed.",
-            "example": "2022-10-10",
+            "example": "2022-10-10T00:00:00.000Z",
             "format": "date-time"
           },
           "source": {
@@ -2466,7 +2466,7 @@
               },
               "forecast_as_of": {
                 "type": "string",
-                "example": "2022-12-10",
+                "example": "2022-12-10T00:00:00.000Z",
                 "description": "The date as of which the forecast reading value is applicable"
               },
               "current_consumption": {
@@ -2476,7 +2476,7 @@
               },
               "last_reading": {
                 "type": "string",
-                "example": "2022-10-10",
+                "example": "2022-10-10T00:00:00.000Z",
                 "description": "The timestamp of the last reading"
               },
               "conversion_factor": {