@epilot/sdk 2.20.47 → 2.20.49

package/dist/{integration-toolkit.d-93TYFohH.d.cts → integration-toolkit.d-CLlaZx6b.d.cts}

@@ -5797,7 +5797,7 @@ declare namespace Components {
          * `monitoring-code-enum.test.ts`, which fails if the two diverge.
          *
          */
-        export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
+        export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
         export interface MonitoringEventV2 {
             /**
              * Unique monitoring event ID

package/dist/{integration-toolkit.d-93TYFohH.d.ts → integration-toolkit.d-CLlaZx6b.d.ts}

@@ -5797,7 +5797,7 @@ declare namespace Components {
          * `monitoring-code-enum.test.ts`, which fails if the two diverge.
          *
          */
-        export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
+        export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
         export interface MonitoringEventV2 {
             /**
              * Unique monitoring event ID

package/docs/chat.md

@@ -55,6 +55,8 @@ const { data } = await chatClient.listWebsiteChats(...)
 - [`ListWebsiteChatsResponse`](#listwebsitechatsresponse)
 - [`WebsiteChat`](#websitechat)
 - [`WebsiteChatSettings`](#websitechatsettings)
+- [`SelfServiceSettings`](#selfservicesettings)
+- [`SelfServiceAction`](#selfserviceaction)
 - [`Error`](#error)
 - [`CreateWebsiteChatRequest`](#createwebsitechatrequest)
 - [`UpdateWebsiteChatRequest`](#updatewebsitechatrequest)
@@ -68,6 +70,7 @@ const { data } = await chatClient.listWebsiteChats(...)
 - [`PublicWebsiteChat`](#publicwebsitechat)
 - [`WebsiteChatDesign`](#websitechatdesign)
 - [`PublicEvent`](#publicevent)
+- [`SelfServiceDirective`](#selfservicedirective)
 - [`PublicChatError`](#publicchaterror)
 
 ### `listWebsiteChats`
@@ -101,6 +104,19 @@ const { data } = await client.listWebsiteChats({
           "portal": {
             "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
           }
+        },
+        "self_service": {
+          "actions": [
+            {
+              "action": "submit_meter_reading",
+              "enabled": true,
+              "fulfilment": "in_chat",
+              "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+              "url": "string",
+              "access": "anonymous",
+              "guidance": "string"
+            }
+          ]
         }
       },
       "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -146,6 +162,19 @@ const { data } = await client.createWebsiteChat(
         portal: {
           portal_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
         }
+      },
+      self_service: {
+        actions: [
+          {
+            action: 'submit_meter_reading',
+            enabled: true,
+            fulfilment: 'in_chat',
+            journey_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
+            url: 'string',
+            access: 'anonymous',
+            guidance: 'string'
+          }
+        ]
       }
     }
   },
@@ -171,6 +200,19 @@ const { data } = await client.createWebsiteChat(
       "portal": {
         "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
       }
+    },
+    "self_service": {
+      "actions": [
+        {
+          "action": "submit_meter_reading",
+          "enabled": true,
+          "fulfilment": "in_chat",
+          "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "url": "string",
+          "access": "anonymous",
+          "guidance": "string"
+        }
+      ]
     }
   },
   "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -220,6 +262,19 @@ const { data } = await client.getWebsiteChat({
       "portal": {
         "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
       }
+    },
+    "self_service": {
+      "actions": [
+        {
+          "action": "submit_meter_reading",
+          "enabled": true,
+          "fulfilment": "in_chat",
+          "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "url": "string",
+          "access": "anonymous",
+          "guidance": "string"
+        }
+      ]
     }
   },
   "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -264,6 +319,19 @@ const { data } = await client.updateWebsiteChat(
         portal: {
           portal_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
         }
+      },
+      self_service: {
+        actions: [
+          {
+            action: 'submit_meter_reading',
+            enabled: true,
+            fulfilment: 'in_chat',
+            journey_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
+            url: 'string',
+            access: 'anonymous',
+            guidance: 'string'
+          }
+        ]
       }
     },
     version: 1
@@ -290,6 +358,19 @@ const { data } = await client.updateWebsiteChat(
       "portal": {
         "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
       }
+    },
+    "self_service": {
+      "actions": [
+        {
+          "action": "submit_meter_reading",
+          "enabled": true,
+          "fulfilment": "in_chat",
+          "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "url": "string",
+          "access": "anonymous",
+          "guidance": "string"
+        }
+      ]
     }
   },
   "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1109,6 +1190,7 @@ type ListWebsiteChatsResponse = {
       default_locale: { ... }
       design_id?: { ... }
       authentication?: { ... }
+      self_service?: { ... }
     }
     website_chat_id: string // uuid
     org_id: string
@@ -1141,6 +1223,9 @@ type WebsiteChat = {
       email_code?: { ... }
       portal?: { ... }
     }
+    self_service?: {
+      actions: { ... }
+    }
   }
   website_chat_id: string // uuid
   org_id: string
@@ -1172,6 +1257,51 @@ type WebsiteChatSettings = {
       portal_id: { ... }
     }
   }
+  self_service?: {
+    actions: Array<{
+      action: { ... }
+      enabled: { ... }
+      fulfilment: { ... }
+      journey_id?: { ... }
+      url?: { ... }
+      access: { ... }
+      guidance?: { ... }
+    }>
+  }
+}
+```
+
+### `SelfServiceSettings`
+
+Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.
+
+```ts
+type SelfServiceSettings = {
+  actions: Array<{
+    action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"
+    enabled: boolean
+    fulfilment: "in_chat" | "journey" | "link"
+    journey_id?: string // uuid
+    url?: string
+    access: "anonymous" | "identified" | "verified"
+    guidance?: string
+  }>
+}
+```
+
+### `SelfServiceAction`
+
+How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.
+
+```ts
+type SelfServiceAction = {
+  action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"
+  enabled: boolean
+  fulfilment: "in_chat" | "journey" | "link"
+  journey_id?: string // uuid
+  url?: string
+  access: "anonymous" | "identified" | "verified"
+  guidance?: string
 }
 ```
 
@@ -1200,6 +1330,9 @@ type CreateWebsiteChatRequest = {
       email_code?: { ... }
       portal?: { ... }
     }
+    self_service?: {
+      actions: { ... }
+    }
   }
 }
 ```
@@ -1219,6 +1352,9 @@ type UpdateWebsiteChatRequest = {
       email_code?: { ... }
       portal?: { ... }
     }
+    self_service?: {
+      actions: { ... }
+    }
   }
   version: number
 }
@@ -1431,6 +1567,28 @@ type PublicEvent = {
   type: "error"
   code: "UNAVAILABLE"
   request_id: string // uuid
+} | {
+  type: "action"
+  action: {
+    action: string
+    fulfilment: "in_chat" | "journey" | "link"
+    journey_id?: string // uuid
+    url?: string
+    access: "anonymous" | "identified" | "verified"
+  }
+  request_id: string // uuid
+}
+```
+
+### `SelfServiceDirective`
+
+```ts
+type SelfServiceDirective = {
+  action: string
+  fulfilment: "in_chat" | "journey" | "link"
+  journey_id?: string // uuid
+  url?: string
+  access: "anonymous" | "identified" | "verified"
 }
 ```
 

package/docs/event-catalog.md

@@ -105,6 +105,7 @@ const { data } = await client.listEvents()
       "event_description": "Triggered when a new meter reading is added",
       "event_version": "1.0",
       "event_status": "active",
+      "deprecated_at": "2026-09-30T12:00:00.000Z",
       "event_tags": ["builtin", "metering", "erp"],
       "schema_fields": {},
       "entity_graph": {
@@ -144,7 +145,8 @@ const { data } = await client.listEvents()
       "event_origin": "builtin",
       "mapping": {
         "mode": "guided",
-        "jsonata": "string"
+        "jsonata": "string",
+        "payload": "extend"
       },
       "lineage": {
         "base_event_name": "string",
@@ -218,7 +220,8 @@ const { data } = await client.createCustomEvent(
     automation_trigger_seed_node: 'string',
     mapping: {
       mode: 'guided',
-      jsonata: 'string'
+      jsonata: 'string',
+      payload: 'extend'
     },
     lineage: {
       base_event_name: 'string',
@@ -239,6 +242,7 @@ const { data } = await client.createCustomEvent(
   "event_description": "Triggered when a new meter reading is added",
   "event_version": "1.0",
   "event_status": "active",
+  "deprecated_at": "2026-09-30T12:00:00.000Z",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
   "entity_graph": {
@@ -278,7 +282,8 @@ const { data } = await client.createCustomEvent(
   "event_origin": "builtin",
   "mapping": {
     "mode": "guided",
-    "jsonata": "string"
+    "jsonata": "string",
+    "payload": "extend"
   },
   "lineage": {
     "base_event_name": "string",
@@ -323,6 +328,7 @@ const { data } = await client.getEvent({
   "event_description": "Triggered when a new meter reading is added",
   "event_version": "1.0",
   "event_status": "active",
+  "deprecated_at": "2026-09-30T12:00:00.000Z",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
   "entity_graph": {
@@ -362,7 +368,8 @@ const { data } = await client.getEvent({
   "event_origin": "builtin",
   "mapping": {
     "mode": "guided",
-    "jsonata": "string"
+    "jsonata": "string",
+    "payload": "extend"
   },
   "lineage": {
     "base_event_name": "string",
@@ -419,6 +426,7 @@ const { data } = await client.patchEvent(
   "event_description": "Triggered when a new meter reading is added",
   "event_version": "1.0",
   "event_status": "active",
+  "deprecated_at": "2026-09-30T12:00:00.000Z",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
   "entity_graph": {
@@ -458,7 +466,8 @@ const { data } = await client.patchEvent(
   "event_origin": "builtin",
   "mapping": {
     "mode": "guided",
-    "jsonata": "string"
+    "jsonata": "string",
+    "payload": "extend"
   },
   "lineage": {
     "base_event_name": "string",
@@ -534,7 +543,8 @@ const { data } = await client.replaceCustomEventDraft(
     automation_trigger_seed_node: 'string',
     mapping: {
       mode: 'guided',
-      jsonata: 'string'
+      jsonata: 'string',
+      payload: 'extend'
     },
     lineage: {
       base_event_name: 'string',
@@ -555,6 +565,7 @@ const { data } = await client.replaceCustomEventDraft(
   "event_description": "Triggered when a new meter reading is added",
   "event_version": "1.0",
   "event_status": "active",
+  "deprecated_at": "2026-09-30T12:00:00.000Z",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
   "entity_graph": {
@@ -594,7 +605,8 @@ const { data } = await client.replaceCustomEventDraft(
   "event_origin": "builtin",
   "mapping": {
     "mode": "guided",
-    "jsonata": "string"
+    "jsonata": "string",
+    "payload": "extend"
   },
   "lineage": {
     "base_event_name": "string",
@@ -701,6 +713,7 @@ const { data } = await client.publishCustomEventDefinition(
   "event_description": "Triggered when a new meter reading is added",
   "event_version": "1.0",
   "event_status": "active",
+  "deprecated_at": "2026-09-30T12:00:00.000Z",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
   "entity_graph": {
@@ -740,7 +753,8 @@ const { data } = await client.publishCustomEventDefinition(
   "event_origin": "builtin",
   "mapping": {
     "mode": "guided",
-    "jsonata": "string"
+    "jsonata": "string",
+    "payload": "extend"
   },
   "lineage": {
     "base_event_name": "string",
@@ -787,6 +801,7 @@ const { data } = await client.getCustomEventVersionDraft({
     "event_description": "Triggered when a new meter reading is added",
     "event_version": "1.0",
     "event_status": "active",
+    "deprecated_at": "2026-09-30T12:00:00.000Z",
     "event_tags": ["builtin", "metering", "erp"],
     "schema_fields": {},
     "entity_graph": {
@@ -826,7 +841,8 @@ const { data } = await client.getCustomEventVersionDraft({
     "event_origin": "builtin",
     "mapping": {
       "mode": "guided",
-      "jsonata": "string"
+      "jsonata": "string",
+      "payload": "extend"
     },
     "lineage": {
       "base_event_name": "string",
@@ -915,7 +931,8 @@ const { data } = await client.putCustomEventVersionDraft(
     automation_trigger_seed_node: 'string',
     mapping: {
       mode: 'guided',
-      jsonata: 'string'
+      jsonata: 'string',
+      payload: 'extend'
     },
     lineage: {
       base_event_name: 'string',
@@ -937,6 +954,7 @@ const { data } = await client.putCustomEventVersionDraft(
     "event_description": "Triggered when a new meter reading is added",
     "event_version": "1.0",
     "event_status": "active",
+    "deprecated_at": "2026-09-30T12:00:00.000Z",
     "event_tags": ["builtin", "metering", "erp"],
     "schema_fields": {},
     "entity_graph": {
@@ -976,7 +994,8 @@ const { data } = await client.putCustomEventVersionDraft(
     "event_origin": "builtin",
     "mapping": {
       "mode": "guided",
-      "jsonata": "string"
+      "jsonata": "string",
+      "payload": "extend"
     },
     "lineage": {
       "base_event_name": "string",
@@ -1055,6 +1074,7 @@ const { data } = await client.publishCustomEventVersion(
   "event_description": "Triggered when a new meter reading is added",
   "event_version": "1.0",
   "event_status": "active",
+  "deprecated_at": "2026-09-30T12:00:00.000Z",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
   "entity_graph": {
@@ -1094,7 +1114,8 @@ const { data } = await client.publishCustomEventVersion(
   "event_origin": "builtin",
   "mapping": {
     "mode": "guided",
-    "jsonata": "string"
+    "jsonata": "string",
+    "payload": "extend"
   },
   "lineage": {
     "base_event_name": "string",
@@ -1532,6 +1553,7 @@ type EventConfigBase = {
   event_description?: string
   event_version?: string
   event_status?: "active" | "deprecated" | "draft" | "disabled"
+  deprecated_at?: string // date-time
   event_tags?: string[]
   schema_fields?: Record<string, {
     json_schema: object
@@ -1584,6 +1606,7 @@ type EventConfigBase = {
   mapping?: {
     mode: "guided" | "jsonata"
     jsonata?: string
+    payload?: "extend" | "replace"
   }
   lineage?: {
     base_event_name: string
@@ -1607,6 +1630,7 @@ type EventConfig = {
   event_description?: string
   event_version: string
   event_status?: "active" | "deprecated" | "draft" | "disabled"
+  deprecated_at?: string // date-time
   event_tags?: string[]
   schema_fields: Record<string, {
     json_schema: object
@@ -1659,6 +1683,7 @@ type EventConfig = {
   mapping?: {
     mode: "guided" | "jsonata"
     jsonata?: string
+    payload?: "extend" | "replace"
   }
   lineage?: {
     base_event_name: string
@@ -1718,6 +1743,7 @@ type CreateCustomEventPayload = {
   mapping?: {
     mode: "guided" | "jsonata"
     jsonata?: string
+    payload?: "extend" | "replace"
   }
   lineage?: {
     base_event_name: string
@@ -1735,6 +1761,7 @@ Guided mappings use schema_fields graph_source expressions; raw mode evaluates o
 type EventMapping = {
   mode: "guided" | "jsonata"
   jsonata?: string
+  payload?: "extend" | "replace"
 }
 ```
 
@@ -1781,6 +1808,7 @@ type CustomEventVersionDraft = {
     event_description?: string
     event_version: string
     event_status?: "active" | "deprecated" | "draft" | "disabled"
+    deprecated_at?: string // date-time
     event_tags?: string[]
     schema_fields: Record<string, {
       json_schema: { ... }
@@ -1814,6 +1842,7 @@ type CustomEventVersionDraft = {
     mapping?: {
       mode: { ... }
       jsonata?: { ... }
+      payload?: { ... }
     }
     lineage?: {
       base_event_name: { ... }

package/docs/integration-toolkit.md

@@ -9590,7 +9590,7 @@ This schema exists so consumers can import the union as a type. It is
 deliberately 
 
 ```ts
-type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED"
+type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED"
 ```
 
 ### `MonitoringEventV2`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.47",
+  "version": "2.20.49",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",