@epilot/sdk 2.4.2 → 2.4.3

package/dist/{pricing.d-Cv39plGm.d.ts → pricing.d-BHpMU4KU.d.ts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
 
 /* Auto-copied from pricing-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -6603,17 +6601,19 @@ declare namespace Components {
                  */
                 description?: string;
                 /**
-                 * Billing Account relation ID
+                 * Billing Account relation
                  */
-                billing_account?: string;
+                billing_account?: {
+                    [key: string]: any;
+                };
                 /**
                  * Account Number
                  */
                 account_number?: string;
                 /**
-                 * Branch/commodity type
+                 * Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value)
                  */
-                branch?: "power" | "gas" | "water" | "waste_water" | "district_heating";
+                branch?: string;
                 /**
                  * Move In Date
                  */
@@ -6633,7 +6633,7 @@ declare namespace Components {
                  */
                 delivery_address?: {
                     [key: string]: any;
-                };
+                }[];
                 /**
                  * Additional Addresses
                  */
@@ -6659,7 +6659,9 @@ declare namespace Components {
                 /**
                  * Customer relation (contact or account)
                  */
-                customer?: string[];
+                customer?: {
+                    [key: string]: any;
+                };
                 /**
                  * Order relation ID
                  */
@@ -6708,28 +6710,21 @@ declare namespace Components {
                  * Billing Due Day
                  */
                 billing_due_day?: number;
-                /**
-                 * Installment Amount
-                 */
-                installment_amount?: {
-                    value?: number;
-                    currency?: string;
-                };
+                installment_amount?: number;
                 /**
                  * Balance
                  */
-                balance?: {
-                    value?: number;
-                    currency?: string;
-                };
+                balance?: number;
                 /**
                  * Meters relation
                  */
                 meters?: string[];
                 /**
-                 * Payment Details relation ID
+                 * Payment Details relation
                  */
-                payment?: string;
+                payment?: {
+                    [key: string]: any;
+                };
                 /**
                  * Last Sync At
                  */
@@ -6863,6 +6858,54 @@ declare namespace Components {
                  */
                 external_id?: string;
             };
+            /**
+             * Address to use for product availability checks. Include when the catalog should filter products by serviceable area (e.g. postal code coverage).
+             *
+             */
+            availability_address?: {
+                /**
+                 * Postal Code
+                 */
+                postal_code?: string;
+                /**
+                 * City
+                 */
+                city?: string;
+                /**
+                 * Street
+                 */
+                street?: string;
+                /**
+                 * Street Number
+                 */
+                street_number?: string;
+                /**
+                 * The journey target block of the availability address <step_index>/<block_name>
+                 */
+                journey_target_block?: string;
+            };
+            /**
+             * Variable inputs (e.g. energy or water consumption) extracted/provided by the portal so the external catalog service can compute amounts for variable prices.
+             *
+             */
+            variable_inputs?: {
+                /**
+                 * The value of the variable input
+                 */
+                value?: number;
+                /**
+                 * The unit of the variable input
+                 */
+                unit?: string;
+                /**
+                 * The frequency unit of the variable input
+                 */
+                frequency_unit?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
+                /**
+                 * The journey target block of the variable input <step_index>/<block_name>
+                 */
+                journey_target_block?: string;
+            }[];
         }
         /**
          * The meter type for power
@@ -10061,6 +10104,12 @@ declare namespace Paths {
         }
     }
     namespace $GetExternalCatalogProductRecommendations {
+        export interface HeaderParameters {
+            "x-epilot-org-id"?: Parameters.XEpilotOrgId;
+        }
+        namespace Parameters {
+            export type XEpilotOrgId = string;
+        }
         export type RequestBody = /**
          * The request payload for the external catalog service.
          * example:
@@ -10111,6 +10160,12 @@ declare namespace Paths {
         }
     }
     namespace $GetExternalCatalogProducts {
+        export interface HeaderParameters {
+            "x-epilot-org-id"?: Parameters.XEpilotOrgId;
+        }
+        namespace Parameters {
+            export type XEpilotOrgId = string;
+        }
         export type RequestBody = /**
          * The request payload for the external catalog service.
          * example:
@@ -11748,7 +11803,7 @@ interface OperationMethods {
    * Returns the list of available external catalog products with computed prices based on a given context
    */
   '$getExternalCatalogProducts'(
-    parameters?: Parameters<UnknownParamsObject> | null,
+    parameters?: Parameters<Paths.$GetExternalCatalogProducts.HeaderParameters> | null,
     data?: Paths.$GetExternalCatalogProducts.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$GetExternalCatalogProducts.Responses.$200>
@@ -11758,7 +11813,7 @@ interface OperationMethods {
    * Returns the list of available external catalog products recommendations based on a given context
    */
   '$getExternalCatalogProductRecommendations'(
-    parameters?: Parameters<UnknownParamsObject> | null,
+    parameters?: Parameters<Paths.$GetExternalCatalogProductRecommendations.HeaderParameters> | null,
     data?: Paths.$GetExternalCatalogProductRecommendations.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$GetExternalCatalogProductRecommendations.Responses.$200>
@@ -12021,7 +12076,7 @@ interface PathsDictionary {
      * Returns the list of available external catalog products with computed prices based on a given context
      */
     'post'(
-      parameters?: Parameters<UnknownParamsObject> | null,
+      parameters?: Parameters<Paths.$GetExternalCatalogProducts.HeaderParameters> | null,
       data?: Paths.$GetExternalCatalogProducts.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$GetExternalCatalogProducts.Responses.$200>
@@ -12033,7 +12088,7 @@ interface PathsDictionary {
      * Returns the list of available external catalog products recommendations based on a given context
      */
     'post'(
-      parameters?: Parameters<UnknownParamsObject> | null,
+      parameters?: Parameters<Paths.$GetExternalCatalogProductRecommendations.HeaderParameters> | null,
       data?: Paths.$GetExternalCatalogProductRecommendations.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$GetExternalCatalogProductRecommendations.Responses.$200>

package/docs/automation.md

@@ -192,6 +192,7 @@ const { data } = await client.searchFlows({
   size: 1,
   from: 1,
   trigger_source_id: 'example',
+  target_workflow: 'example',
   include_flows: true,
 })
 ```
@@ -340,7 +341,14 @@ const { data } = await client.startExecution(
         parent_execution_id: 'string',
         parent_task_id: 'string',
         depth: 0
-      }
+      },
+      entity_contexts: [
+        {
+          entity_id: 'string',
+          entity_schema: 'string',
+          is_primary: true
+        }
+      ]
     },
     flow_execution_id: 'string',
     flow_automation_task_id: 'string'
@@ -451,7 +459,10 @@ const { data } = await client.startExecution(
       "parent_execution_id": "string",
       "parent_task_id": "string",
       "depth": 0
-    }
+    },
+    "entity_contexts": [
+      {}
+    ]
   }
 }
 ```
@@ -735,7 +746,10 @@ const { data } = await client.getExecution({
       "parent_execution_id": "string",
       "parent_task_id": "string",
       "depth": 0
-    }
+    },
+    "entity_contexts": [
+      {}
+    ]
   }
 }
 ```
@@ -859,7 +873,10 @@ const { data } = await client.cancelExecution({
       "parent_execution_id": "string",
       "parent_task_id": "string",
       "depth": 0
-    }
+    },
+    "entity_contexts": [
+      {}
+    ]
   }
 }
 ```
@@ -954,7 +971,8 @@ const { data } = await client.resumeExecutionWithToken(
       "workflow_exec_id": "string",
       "workflow_exec_task_id": "string",
       "workflow_role": "trigger_workflow",
-      "_execution_chain": {}
+      "_execution_chain": {},
+      "entity_contexts": []
     }
   },
   "resumedAction": {
@@ -2176,6 +2194,7 @@ type SendEmailActionConfig = {
     reply_to_sender?: boolean
     reply_mode?: "reply_in_thread" | "new_email"
     mark_as_done?: boolean
+    mark_as_read?: boolean
     attachments?: Array<{
       source_filter?: { ... }
     }>
@@ -2209,6 +2228,7 @@ type SendEmailAction = {
     reply_to_sender?: boolean
     reply_mode?: "reply_in_thread" | "new_email"
     mark_as_done?: boolean
+    mark_as_read?: boolean
     attachments?: Array<{
       source_filter?: { ... }
     }>
@@ -2235,6 +2255,7 @@ type ForwardEmailActionConfig = {
     include_attachments?: boolean
     subject_prefix?: string
     mark_as_done?: boolean
+    mark_as_read?: boolean
   }
   allow_failure?: boolean
   created_automatically?: boolean
@@ -2261,6 +2282,7 @@ type ForwardEmailAction = {
     include_attachments?: boolean
     subject_prefix?: string
     mark_as_done?: boolean
+    mark_as_read?: boolean
   }
 }
 ```
@@ -2276,6 +2298,7 @@ type ForwardEmailConfig = {
   include_attachments?: boolean
   subject_prefix?: string
   mark_as_done?: boolean
+  mark_as_read?: boolean
 }
 ```
 
@@ -2292,6 +2315,7 @@ type ReplyEmailActionConfig = {
     language_code?: "de" | "en"
     reply_mode?: "reply_in_thread" | "new_email"
     mark_as_done?: boolean
+    mark_as_read?: boolean
   }
   allow_failure?: boolean
   created_automatically?: boolean
@@ -2315,6 +2339,7 @@ type ReplyEmailAction = {
     language_code?: "de" | "en"
     reply_mode?: "reply_in_thread" | "new_email"
     mark_as_done?: boolean
+    mark_as_read?: boolean
   }
 }
 ```
@@ -2327,6 +2352,7 @@ type ReplyEmailConfig = {
   language_code?: "de" | "en"
   reply_mode?: "reply_in_thread" | "new_email"
   mark_as_done?: boolean
+  mark_as_read?: boolean
 }
 ```
 
@@ -2342,6 +2368,7 @@ type SendEmailConfig = {
   reply_to_sender?: boolean
   reply_mode?: "reply_in_thread" | "new_email"
   mark_as_done?: boolean
+  mark_as_read?: boolean
   attachments?: Array<{
     source_filter?: {
       limit?: { ... }
@@ -2993,6 +3020,11 @@ type WorkflowExecutionContext = {
     parent_task_id?: string
     depth?: number
   }
+  entity_contexts?: Array<{
+    entity_id?: string
+    entity_schema?: string
+    is_primary?: boolean
+  }>
 }
 ```
 
@@ -3229,6 +3261,11 @@ type StartExecutionRequest = {
       parent_task_id?: { ... }
       depth?: { ... }
     }
+    entity_contexts?: Array<{
+      entity_id?: { ... }
+      entity_schema?: { ... }
+      is_primary?: { ... }
+    }>
   }
   flow_execution_id?: string
   flow_automation_task_id?: string

package/docs/pricing.md

@@ -1473,7 +1473,9 @@ getExternalCatalogProducts
 
 ```ts
 const { data } = await client.$getExternalCatalogProducts(
-  null,
+  {
+    x-epilot-org-id: 'example',
+  },
   {
     config: {
       appId: '1234567890',
@@ -1539,7 +1541,9 @@ getExternalCatalogProductRecommendations
 
 ```ts
 const { data } = await client.$getExternalCatalogProductRecommendations(
-  null,
+  {
+    x-epilot-org-id: 'example',
+  },
   {
     config: {
       appId: '1234567890',
@@ -5598,6 +5602,19 @@ type ExternalCatalogPortalRequest = {
       contracts?: { ... }
       external_id?: { ... }
     }
+    availability_address?: {
+      postal_code?: { ... }
+      city?: { ... }
+      street?: { ... }
+      street_number?: { ... }
+      journey_target_block?: { ... }
+    }
+    variable_inputs?: Array<{
+      value?: { ... }
+      unit?: { ... }
+      frequency_unit?: { ... }
+      journey_target_block?: { ... }
+    }>
   }
 }
 ```
@@ -5651,19 +5668,19 @@ type PortalContext = {
     assignee?: string
     status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired"
     description?: string
-    billing_account?: string
+    billing_account?: object
     account_number?: string
-    branch?: "power" | "gas" | "water" | "waste_water" | "district_heating"
+    branch?: string
     move_in_date?: string // date
     move_out_date?: string // date
     billing_address?: object
-    delivery_address?: object
+    delivery_address?: object[]
     additional_addresses?: object[]
     termination_date?: string // date
     termination_reason?: string
     start_date?: string // date
     end_date?: string // date
-    customer?: string[]
+    customer?: object
     order?: string
     type?: "one_time" | "recurring"
     billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly"
@@ -5676,16 +5693,10 @@ type PortalContext = {
     renewal_duration_amount?: number
     renewal_duration_unit?: "weeks" | "months" | "years"
     billing_due_day?: number
-    installment_amount?: {
-      value?: { ... }
-      currency?: { ... }
-    }
-    balance?: {
-      value?: { ... }
-      currency?: { ... }
-    }
+    installment_amount?: number
+    balance?: number
     meters?: string[]
-    payment?: string
+    payment?: object
     last_sync_at?: string // date
     external_id?: string
   }
@@ -5730,6 +5741,19 @@ type PortalContext = {
     contracts?: string[]
     external_id?: string
   }
+  availability_address?: {
+    postal_code?: string
+    city?: string
+    street?: string
+    street_number?: string
+    journey_target_block?: string
+  }
+  variable_inputs?: Array<{
+    value?: number
+    unit?: string
+    frequency_unit?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time"
+    journey_target_block?: string
+  }>
 }
 ```
 

package/package.json

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