@epilot/sdk 2.4.2 → 2.4.4-alpha.0

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/calendar.md

@@ -0,0 +1,441 @@
+# Calendar API
+
+- **Base URL:** `https://calendar.sls.epilot.io`
+- **Full API Docs:** [https://docs.epilot.io/api/calendar](https://docs.epilot.io/api/calendar)
+
+## Usage
+
+```ts
+import { epilot } from '@epilot/sdk'
+
+epilot.authorize(() => '<token>')
+const { data } = await epilot.calendar.listCalendars(...)
+```
+
+### Tree-shakeable import
+
+```ts
+import { getClient, authorize } from '@epilot/sdk/calendar'
+
+const calendarClient = getClient()
+authorize(calendarClient, () => '<token>')
+const { data } = await calendarClient.listCalendars(...)
+```
+
+## Operations
+
+**Calendars**
+- [`listCalendars`](#listcalendars)
+- [`getCalendar`](#getcalendar)
+
+**Events**
+- [`listEvents`](#listevents)
+- [`getEvent`](#getevent)
+
+**Schemas**
+- [`Calendar`](#calendar)
+- [`CalendarSource`](#calendarsource)
+- [`Provider`](#provider)
+- [`Error`](#error)
+- [`CalendarEvent`](#calendarevent)
+- [`EventType`](#eventtype)
+- [`EventStatus`](#eventstatus)
+- [`Sensitivity`](#sensitivity)
+- [`Importance`](#importance)
+- [`ResponseStatus`](#responsestatus)
+- [`Attendee`](#attendee)
+- [`EventSource`](#eventsource)
+
+### `listCalendars`
+
+List calendars visible to the caller.
+
+`GET /v1/calendar`
+
+```ts
+const { data } = await client.listCalendars({
+  size: 1,
+  cursor: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "_id": "string",
+      "_schema": "calendar",
+      "_org": "string",
+      "_title": "string",
+      "name": "string",
+      "description": "string",
+      "color": "string",
+      "is_default": true,
+      "read_only": true,
+      "owner_email": "user@example.com",
+      "source": {
+        "type": "native",
+        "provider": "outlook",
+        "provider_calendar_id": "string",
+        "last_synced_at": "1970-01-01T00:00:00.000Z"
+      },
+      "_created_at": "1970-01-01T00:00:00.000Z",
+      "_updated_at": "1970-01-01T00:00:00.000Z"
+    }
+  ],
+  "next_cursor": "string"
+}
+```
+
+</details>
+
+---
+
+### `getCalendar`
+
+Get a single calendar by its epilot ID.
+
+`GET /v1/calendar/{calendar_id}`
+
+```ts
+const { data } = await client.getCalendar({
+  calendar_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "_id": "string",
+  "_schema": "calendar",
+  "_org": "string",
+  "_title": "string",
+  "name": "string",
+  "description": "string",
+  "color": "string",
+  "is_default": true,
+  "read_only": true,
+  "owner_email": "user@example.com",
+  "source": {
+    "type": "native",
+    "provider": "outlook",
+    "provider_calendar_id": "string",
+    "last_synced_at": "1970-01-01T00:00:00.000Z"
+  },
+  "_created_at": "1970-01-01T00:00:00.000Z",
+  "_updated_at": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `listEvents`
+
+List events in a time window. Recurring events are returned as expanded occurrences – each instance appears as its own event.
+
+`GET /v1/calendar/events`
+
+```ts
+const { data } = await client.listEvents({
+  from: 'example',
+  to: 'example',
+  calendar_id: 'example',
+  size: 1,
+  cursor: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "_id": "string",
+      "_schema": "calendar_event",
+      "_org": "string",
+      "_title": "string",
+      "_tags": ["string"],
+      "calendar_id": "string",
+      "event_type": "singleInstance",
+      "description": "string",
+      "start_time": "1970-01-01T00:00:00.000Z",
+      "end_time": "1970-01-01T00:00:00.000Z",
+      "timezone": "string",
+      "is_all_day": true,
+      "location": "string",
+      "status": "free",
+      "busy": true,
+      "is_cancelled": true,
+      "sensitivity": "normal",
+      "importance": "low",
+      "is_online_meeting": true,
+      "online_meeting_url": "https://example.com/path",
+      "web_link": "https://example.com/path",
+      "response_status": "none",
+      "organizer_email": "user@example.com",
+      "attendees": [
+        {
+          "email": "user@example.com",
+          "name": "string",
+          "response": "none",
+          "type": "required"
+        }
+      ],
+      "is_recurring": true,
+      "series_master_id": "string",
+      "source": {
+        "type": "native",
+        "provider": "outlook",
+        "provider_event_id": "string",
+        "provider_event_url": "https://example.com/path",
+        "last_synced_at": "1970-01-01T00:00:00.000Z",
+        "etag": "string"
+      },
+      "_created_at": "1970-01-01T00:00:00.000Z",
+      "_updated_at": "1970-01-01T00:00:00.000Z"
+    }
+  ],
+  "next_cursor": "string"
+}
+```
+
+</details>
+
+---
+
+### `getEvent`
+
+Get a single event by its epilot ID.
+
+`GET /v1/calendar/events/{event_id}`
+
+```ts
+const { data } = await client.getEvent({
+  event_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "_id": "string",
+  "_schema": "calendar_event",
+  "_org": "string",
+  "_title": "string",
+  "_tags": ["string"],
+  "calendar_id": "string",
+  "event_type": "singleInstance",
+  "description": "string",
+  "start_time": "1970-01-01T00:00:00.000Z",
+  "end_time": "1970-01-01T00:00:00.000Z",
+  "timezone": "string",
+  "is_all_day": true,
+  "location": "string",
+  "status": "free",
+  "busy": true,
+  "is_cancelled": true,
+  "sensitivity": "normal",
+  "importance": "low",
+  "is_online_meeting": true,
+  "online_meeting_url": "https://example.com/path",
+  "web_link": "https://example.com/path",
+  "response_status": "none",
+  "organizer_email": "user@example.com",
+  "attendees": [
+    {
+      "email": "user@example.com",
+      "name": "string",
+      "response": "none",
+      "type": "required"
+    }
+  ],
+  "is_recurring": true,
+  "series_master_id": "string",
+  "source": {
+    "type": "native",
+    "provider": "outlook",
+    "provider_event_id": "string",
+    "provider_event_url": "https://example.com/path",
+    "last_synced_at": "1970-01-01T00:00:00.000Z",
+    "etag": "string"
+  },
+  "_created_at": "1970-01-01T00:00:00.000Z",
+  "_updated_at": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+## Schemas
+
+### `Calendar`
+
+```ts
+type Calendar = {
+  _id: string
+  _schema: "calendar"
+  _org: string
+  _title?: string
+  name: string
+  description?: string
+  color?: string
+  is_default: boolean
+  read_only: boolean
+  owner_email?: string // email
+  source: {
+    type: "native" | "synced"
+    provider?: "outlook" | "google" | null
+    provider_calendar_id?: string
+    last_synced_at?: string // date-time
+  }
+  _created_at?: string // date-time
+  _updated_at?: string // date-time
+}
+```
+
+### `CalendarSource`
+
+```ts
+type CalendarSource = {
+  type: "native" | "synced"
+  provider?: "outlook" | "google" | null
+  provider_calendar_id?: string
+  last_synced_at?: string // date-time
+}
+```
+
+### `Provider`
+
+Null for native epilot calendars
+
+```ts
+type Provider = "outlook" | "google" | null
+```
+
+### `Error`
+
+```ts
+type Error = {
+  message: string
+  code?: string
+}
+```
+
+### `CalendarEvent`
+
+```ts
+type CalendarEvent = {
+  _id: string
+  _schema: "calendar_event"
+  _org: string
+  _title?: string
+  _tags?: string[]
+  calendar_id: string
+  event_type: "singleInstance" | "occurrence" | "exception" | "seriesMaster"
+  description?: string
+  start_time: string // date-time
+  end_time: string // date-time
+  timezone: string
+  is_all_day: boolean
+  location?: string
+  status: "free" | "tentative" | "busy" | "oof" | "workingElsewhere" | "unknown"
+  busy: boolean
+  is_cancelled: boolean
+  sensitivity: "normal" | "personal" | "private" | "confidential"
+  importance: "low" | "normal" | "high"
+  is_online_meeting: boolean
+  online_meeting_url?: string // uri
+  web_link?: string // uri
+  response_status: "none" | "organizer" | "tentativelyAccepted" | "accepted" | "declined" | "notResponded"
+  organizer_email?: string // email
+  attendees?: Array<{
+    email: string // email
+    name?: string
+    response: "none" | "organizer" | "tentativelyAccepted" | "accepted" | "declined" | "notResponded"
+    type: "required" | "optional" | "resource"
+  }>
+  is_recurring: boolean
+  series_master_id?: string
+  source: {
+    type: "native" | "synced"
+    provider?: "outlook" | "google" | null
+    provider_event_id?: string
+    provider_event_url?: string // uri
+    last_synced_at?: string // date-time
+    etag?: string
+  }
+  _created_at?: string // date-time
+  _updated_at?: string // date-time
+}
+```
+
+### `EventType`
+
+```ts
+type EventType = "singleInstance" | "occurrence" | "exception" | "seriesMaster"
+```
+
+### `EventStatus`
+
+Free/busy state derived from provider `showAs`
+
+```ts
+type EventStatus = "free" | "tentative" | "busy" | "oof" | "workingElsewhere" | "unknown"
+```
+
+### `Sensitivity`
+
+```ts
+type Sensitivity = "normal" | "personal" | "private" | "confidential"
+```
+
+### `Importance`
+
+```ts
+type Importance = "low" | "normal" | "high"
+```
+
+### `ResponseStatus`
+
+Caller's response to the invite
+
+```ts
+type ResponseStatus = "none" | "organizer" | "tentativelyAccepted" | "accepted" | "declined" | "notResponded"
+```
+
+### `Attendee`
+
+```ts
+type Attendee = {
+  email: string // email
+  name?: string
+  response: "none" | "organizer" | "tentativelyAccepted" | "accepted" | "declined" | "notResponded"
+  type: "required" | "optional" | "resource"
+}
+```
+
+### `EventSource`
+
+```ts
+type EventSource = {
+  type: "native" | "synced"
+  provider?: "outlook" | "google" | null
+  provider_event_id?: string
+  provider_event_url?: string // uri
+  last_synced_at?: string // date-time
+  etag?: 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
+  }>
 }
 ```