@epilot/sdk 2.15.2 → 2.15.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/customer-portal.json +36 -8
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +290 -3
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +8 -8
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +2 -2
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-LNQHT4WZ.js → chunk-7LWNOS5V.js} +3 -3
- package/dist/{chunk-YISO22FS.cjs → chunk-7YXY2AFM.cjs} +1 -1
- package/dist/{chunk-YYWUKE4L.cjs → chunk-E7FFVRBQ.cjs} +3 -3
- package/dist/{chunk-7WGJSGWE.js → chunk-U6KIZOOU.js} +1 -1
- package/dist/customer-portal-7ZNROWXS.js +7 -0
- package/dist/customer-portal-ZW4I52KG.cjs +7 -0
- package/dist/{customer-portal.d-CJgDRoOo.d.cts → customer-portal.d-DsB3qJro.d.cts} +54 -21
- package/dist/{customer-portal.d-CJgDRoOo.d.ts → customer-portal.d-DsB3qJro.d.ts} +54 -21
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/integration-toolkit-MQ6PTYCJ.cjs +7 -0
- package/dist/integration-toolkit-Y43WV22G.js +7 -0
- package/dist/{integration-toolkit-runtime-5K3AAC63.js → integration-toolkit-runtime-O4742UZV.js} +1 -1
- package/dist/{integration-toolkit-runtime-4LHEPGGC.cjs → integration-toolkit-runtime-SX6HZTRB.cjs} +2 -2
- package/dist/{integration-toolkit.d-7q19qDTD.d.cts → integration-toolkit.d-BUCHo8ZQ.d.cts} +764 -6
- package/dist/{integration-toolkit.d-7q19qDTD.d.ts → integration-toolkit.d-BUCHo8ZQ.d.ts} +764 -6
- package/docs/customer-portal.md +8 -2
- package/docs/integration-toolkit.md +161 -0
- package/package.json +1 -1
- package/dist/customer-portal-2KYG4NWA.js +0 -7
- package/dist/customer-portal-WAHU36H2.cjs +0 -7
- package/dist/integration-toolkit-2BLX4CSH.cjs +0 -7
- package/dist/integration-toolkit-OLFKCTLY.js +0 -7
package/docs/customer-portal.md
CHANGED
|
@@ -1774,6 +1774,7 @@ const { data } = await client.getPublicPortalExtensionDetails({
|
|
|
1774
1774
|
},
|
|
1775
1775
|
"hook": {
|
|
1776
1776
|
"id": "string",
|
|
1777
|
+
"change_mode": "asynchronous",
|
|
1777
1778
|
"require_password_confirmation": true,
|
|
1778
1779
|
"explanation": {}
|
|
1779
1780
|
}
|
|
@@ -2008,6 +2009,7 @@ const { data } = await client.getPublicPortalExtensionDetailsV3({
|
|
|
2008
2009
|
},
|
|
2009
2010
|
"hook": {
|
|
2010
2011
|
"id": "string",
|
|
2012
|
+
"change_mode": "asynchronous",
|
|
2011
2013
|
"require_password_confirmation": true,
|
|
2012
2014
|
"explanation": {}
|
|
2013
2015
|
}
|
|
@@ -12302,8 +12304,8 @@ type PublicExtensionCapabilities = {
|
|
|
12302
12304
|
}
|
|
12303
12305
|
hook?: {
|
|
12304
12306
|
id?: { ... }
|
|
12307
|
+
change_mode?: { ... }
|
|
12305
12308
|
require_password_confirmation?: { ... }
|
|
12306
|
-
explanation?: { ... }
|
|
12307
12309
|
// ...
|
|
12308
12310
|
}
|
|
12309
12311
|
```
|
|
@@ -12323,6 +12325,7 @@ type PublicSelfManagementExplanation = {
|
|
|
12323
12325
|
```ts
|
|
12324
12326
|
type PublicChangeEmailDetails = {
|
|
12325
12327
|
id?: string
|
|
12328
|
+
change_mode?: "synchronous" | "asynchronous"
|
|
12326
12329
|
require_password_confirmation?: boolean
|
|
12327
12330
|
explanation?: {
|
|
12328
12331
|
en: string
|
|
@@ -12907,11 +12910,13 @@ type ExtensionHookCostDataRetrieval = {
|
|
|
12907
12910
|
|
|
12908
12911
|
### `ExtensionHookChangeEmail`
|
|
12909
12912
|
|
|
12910
|
-
Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not
|
|
12913
|
+
Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.
|
|
12914
|
+
The `change_mode` controls what the portal d
|
|
12911
12915
|
|
|
12912
12916
|
```ts
|
|
12913
12917
|
type ExtensionHookChangeEmail = {
|
|
12914
12918
|
type: "changeEmail"
|
|
12919
|
+
change_mode?: "synchronous" | "asynchronous"
|
|
12915
12920
|
require_password_confirmation?: boolean
|
|
12916
12921
|
explanation?: {
|
|
12917
12922
|
en: string
|
|
@@ -12992,6 +12997,7 @@ The `deletion_mode` controls what the portal does aft
|
|
|
12992
12997
|
type ExtensionHookDeleteAccount = {
|
|
12993
12998
|
type: "deleteAccount"
|
|
12994
12999
|
deletion_mode?: "synchronous" | "asynchronous"
|
|
13000
|
+
delete_contact?: "none" | "soft" | "hard"
|
|
12995
13001
|
explanation?: {
|
|
12996
13002
|
en: string
|
|
12997
13003
|
}
|
|
@@ -79,6 +79,8 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
|
|
|
79
79
|
- [`getMonitoringStatsV2`](#getmonitoringstatsv2)
|
|
80
80
|
- [`getMonitoringTimeSeriesV2`](#getmonitoringtimeseriesv2)
|
|
81
81
|
- [`getAssociatedMonitoringEvents`](#getassociatedmonitoringevents)
|
|
82
|
+
- [`ingestExternalMonitoringEvents`](#ingestexternalmonitoringevents)
|
|
83
|
+
- [`getMonitoringTraceByCorrelation`](#getmonitoringtracebycorrelation)
|
|
82
84
|
|
|
83
85
|
**proxy**
|
|
84
86
|
- [`secureProxy`](#secureproxy)
|
|
@@ -249,6 +251,10 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
|
|
|
249
251
|
- [`MonitoringStats`](#monitoringstats)
|
|
250
252
|
- [`InboundMonitoringEvent`](#inboundmonitoringevent)
|
|
251
253
|
- [`QueryMonitoringEventsV2Request`](#querymonitoringeventsv2request)
|
|
254
|
+
- [`ExternalMonitoringSpan`](#externalmonitoringspan)
|
|
255
|
+
- [`IngestExternalMonitoringEventsRequest`](#ingestexternalmonitoringeventsrequest)
|
|
256
|
+
- [`IngestExternalMonitoringEventsResponse`](#ingestexternalmonitoringeventsresponse)
|
|
257
|
+
- [`MonitoringTraceResponse`](#monitoringtraceresponse)
|
|
252
258
|
- [`MonitoringEventV2`](#monitoringeventv2)
|
|
253
259
|
- [`GetMonitoringStatsV2Request`](#getmonitoringstatsv2request)
|
|
254
260
|
- [`MonitoringStatsV2`](#monitoringstatsv2)
|
|
@@ -909,6 +915,7 @@ const { data } = await client.queryEvents(
|
|
|
909
915
|
"format": "json",
|
|
910
916
|
"payload": "string",
|
|
911
917
|
"deduplication_id": "evt-2025-05-01-12345-create-bp",
|
|
918
|
+
"correlation_id": "bp-8f3a2c-7d4e-4b1a-9c2f-1e6d5a4b3c21",
|
|
912
919
|
"use_case_id": "string"
|
|
913
920
|
}
|
|
914
921
|
],
|
|
@@ -2801,6 +2808,86 @@ const { data } = await client.getAssociatedMonitoringEvents({
|
|
|
2801
2808
|
|
|
2802
2809
|
---
|
|
2803
2810
|
|
|
2811
|
+
### `ingestExternalMonitoringEvents`
|
|
2812
|
+
|
|
2813
|
+
Ingest monitoring spans produced by an EXTERNAL system (e.g. an integration
|
|
2814
|
+
middleware), so the Integration Hub is the central monitoring point and the
|
|
2815
|
+
cross-system event trace spans both the external
|
|
2816
|
+
|
|
2817
|
+
`POST /v2/integrations/{integrationId}/monitoring/external-events`
|
|
2818
|
+
|
|
2819
|
+
```ts
|
|
2820
|
+
const { data } = await client.ingestExternalMonitoringEvents(
|
|
2821
|
+
{
|
|
2822
|
+
integrationId: 'example',
|
|
2823
|
+
},
|
|
2824
|
+
{
|
|
2825
|
+
events: [
|
|
2826
|
+
{
|
|
2827
|
+
correlation_id: 'string',
|
|
2828
|
+
level: 'string',
|
|
2829
|
+
use_case_slug: 'string',
|
|
2830
|
+
occurred_at: '1970-01-01T00:00:00.000Z',
|
|
2831
|
+
message: 'string',
|
|
2832
|
+
detail: {}
|
|
2833
|
+
}
|
|
2834
|
+
]
|
|
2835
|
+
},
|
|
2836
|
+
)
|
|
2837
|
+
```
|
|
2838
|
+
|
|
2839
|
+
---
|
|
2840
|
+
|
|
2841
|
+
### `getMonitoringTraceByCorrelation`
|
|
2842
|
+
|
|
2843
|
+
Returns the cross-system event trace for a `correlation_id`: every monitoring
|
|
2844
|
+
span sharing it — external spans (middleware) plus epilot's own processing spans
|
|
2845
|
+
— ordered chronologically, with a rolled-
|
|
2846
|
+
|
|
2847
|
+
`GET /v2/integrations/{integrationId}/monitoring/traces/{correlationId}`
|
|
2848
|
+
|
|
2849
|
+
```ts
|
|
2850
|
+
const { data } = await client.getMonitoringTraceByCorrelation({
|
|
2851
|
+
integrationId: 'example',
|
|
2852
|
+
correlationId: 'example',
|
|
2853
|
+
})
|
|
2854
|
+
```
|
|
2855
|
+
|
|
2856
|
+
<details>
|
|
2857
|
+
<summary>Response</summary>
|
|
2858
|
+
|
|
2859
|
+
```json
|
|
2860
|
+
{
|
|
2861
|
+
"correlation_id": "string",
|
|
2862
|
+
"status": "success",
|
|
2863
|
+
"started_at": "1970-01-01T00:00:00.000Z",
|
|
2864
|
+
"ended_at": "1970-01-01T00:00:00.000Z",
|
|
2865
|
+
"span_count": 0,
|
|
2866
|
+
"truncated": true,
|
|
2867
|
+
"spans": [
|
|
2868
|
+
{
|
|
2869
|
+
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
2870
|
+
"org_id": "string",
|
|
2871
|
+
"integration_id": "string",
|
|
2872
|
+
"event_id": "string",
|
|
2873
|
+
"correlation_id": "string",
|
|
2874
|
+
"use_case_id": "string",
|
|
2875
|
+
"use_case_type": "inbound",
|
|
2876
|
+
"level": "success",
|
|
2877
|
+
"code": "string",
|
|
2878
|
+
"message": "string",
|
|
2879
|
+
"detail": {},
|
|
2880
|
+
"created_at": "1970-01-01T00:00:00.000Z"
|
|
2881
|
+
}
|
|
2882
|
+
],
|
|
2883
|
+
"inbound_event": {}
|
|
2884
|
+
}
|
|
2885
|
+
```
|
|
2886
|
+
|
|
2887
|
+
</details>
|
|
2888
|
+
|
|
2889
|
+
---
|
|
2890
|
+
|
|
2804
2891
|
### `listSecureProxies`
|
|
2805
2892
|
|
|
2806
2893
|
List all secure proxy use cases
|
|
@@ -3147,6 +3234,7 @@ type ErpEvent = {
|
|
|
3147
3234
|
format: "json" | "xml"
|
|
3148
3235
|
payload: string | Record<string, unknown>
|
|
3149
3236
|
deduplication_id?: string
|
|
3237
|
+
correlation_id?: string
|
|
3150
3238
|
use_case_id?: string
|
|
3151
3239
|
}
|
|
3152
3240
|
```
|
|
@@ -3164,6 +3252,7 @@ type ErpUpdatesEventsV2Request = {
|
|
|
3164
3252
|
format: "json" | "xml"
|
|
3165
3253
|
payload: string | Record<string, unknown>
|
|
3166
3254
|
deduplication_id?: string
|
|
3255
|
+
correlation_id?: string
|
|
3167
3256
|
use_case_id?: string
|
|
3168
3257
|
}>
|
|
3169
3258
|
}
|
|
@@ -7247,6 +7336,78 @@ type QueryMonitoringEventsV2Request = {
|
|
|
7247
7336
|
}
|
|
7248
7337
|
```
|
|
7249
7338
|
|
|
7339
|
+
### `ExternalMonitoringSpan`
|
|
7340
|
+
|
|
7341
|
+
A single monitoring span produced by an external system. `correlation_id`, `level`, `use_case_slug`, `occurred_at` and `message` are all required and `level` must be one of success|error|warning|info — but these are validated PER SPAN at ingest and reported in the per-item `results[]`, so one malfor
|
|
7342
|
+
|
|
7343
|
+
```ts
|
|
7344
|
+
type ExternalMonitoringSpan = {
|
|
7345
|
+
correlation_id?: string
|
|
7346
|
+
level?: string
|
|
7347
|
+
use_case_slug?: string
|
|
7348
|
+
occurred_at?: string // date-time
|
|
7349
|
+
message?: string
|
|
7350
|
+
detail?: Record<string, unknown>
|
|
7351
|
+
}
|
|
7352
|
+
```
|
|
7353
|
+
|
|
7354
|
+
### `IngestExternalMonitoringEventsRequest`
|
|
7355
|
+
|
|
7356
|
+
```ts
|
|
7357
|
+
type IngestExternalMonitoringEventsRequest = {
|
|
7358
|
+
events: Array<{
|
|
7359
|
+
correlation_id?: string
|
|
7360
|
+
level?: string
|
|
7361
|
+
use_case_slug?: string
|
|
7362
|
+
occurred_at?: string // date-time
|
|
7363
|
+
message?: string
|
|
7364
|
+
detail?: Record<string, unknown>
|
|
7365
|
+
}>
|
|
7366
|
+
}
|
|
7367
|
+
```
|
|
7368
|
+
|
|
7369
|
+
### `IngestExternalMonitoringEventsResponse`
|
|
7370
|
+
|
|
7371
|
+
```ts
|
|
7372
|
+
type IngestExternalMonitoringEventsResponse = {
|
|
7373
|
+
accepted: number
|
|
7374
|
+
rejected: number
|
|
7375
|
+
results?: Array<{
|
|
7376
|
+
index: number
|
|
7377
|
+
status: "accepted" | "rejected"
|
|
7378
|
+
reason?: string
|
|
7379
|
+
}>
|
|
7380
|
+
}
|
|
7381
|
+
```
|
|
7382
|
+
|
|
7383
|
+
### `MonitoringTraceResponse`
|
|
7384
|
+
|
|
7385
|
+
```ts
|
|
7386
|
+
type MonitoringTraceResponse = {
|
|
7387
|
+
correlation_id: string
|
|
7388
|
+
status: "success" | "error" | "warning" | "info"
|
|
7389
|
+
started_at?: string // date-time
|
|
7390
|
+
ended_at?: string // date-time
|
|
7391
|
+
span_count: number
|
|
7392
|
+
truncated: boolean
|
|
7393
|
+
spans: Array<{
|
|
7394
|
+
id: string // uuid
|
|
7395
|
+
org_id: string
|
|
7396
|
+
integration_id: string
|
|
7397
|
+
event_id: string
|
|
7398
|
+
correlation_id?: string
|
|
7399
|
+
use_case_id?: string
|
|
7400
|
+
use_case_type: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy" | ""
|
|
7401
|
+
level: "success" | "error" | "skipped" | "warning"
|
|
7402
|
+
code?: string
|
|
7403
|
+
message?: string
|
|
7404
|
+
detail?: Record<string, unknown>
|
|
7405
|
+
created_at: string // date-time
|
|
7406
|
+
}>
|
|
7407
|
+
inbound_event?: Record<string, unknown>
|
|
7408
|
+
}
|
|
7409
|
+
```
|
|
7410
|
+
|
|
7250
7411
|
### `MonitoringEventV2`
|
|
7251
7412
|
|
|
7252
7413
|
```ts
|