@epilot/sdk 2.15.1 → 2.15.3
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/app-runtime.json +1 -1
- package/definitions/app.json +458 -3
- 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 +8 -8
- package/dist/apis/app.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- package/dist/apis/app.js +2 -2
- 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.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/app-2PHMS5XK.js +7 -0
- package/dist/app-J4RJL6KV.cjs +7 -0
- package/dist/app-runtime-2QBLB4AK.cjs +5 -0
- package/dist/{app-runtime-DBUXZL6E.js → app-runtime-6T473MHJ.js} +1 -1
- package/dist/{app.d-BOR23dso.d.cts → app.d-E1es05Ga.d.cts} +380 -4
- package/dist/{app.d-BOR23dso.d.ts → app.d-E1es05Ga.d.ts} +380 -4
- package/dist/{chunk-TGKYRQMO.js → chunk-47HX62Q6.js} +4 -4
- package/dist/{chunk-YISO22FS.cjs → chunk-7YXY2AFM.cjs} +1 -1
- package/dist/{chunk-3SG23C54.cjs → chunk-OGBOIHHV.cjs} +4 -4
- package/dist/{chunk-7WGJSGWE.js → chunk-U6KIZOOU.js} +1 -1
- package/dist/{chunk-KMVJYNLB.cjs → chunk-W6BCTQLU.cjs} +1 -1
- package/dist/{chunk-Z4H2FZ2K.js → chunk-ZEOU24C3.js} +1 -1
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- 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/app.md +215 -10
- package/docs/integration-toolkit.md +161 -0
- package/package.json +1 -1
- package/dist/app-74LECFMK.cjs +0 -7
- package/dist/app-GNUHCGPO.js +0 -7
- package/dist/app-runtime-AFNM67YN.cjs +0 -5
- package/dist/integration-toolkit-2BLX4CSH.cjs +0 -7
- package/dist/integration-toolkit-OLFKCTLY.js +0 -7
package/docs/app.md
CHANGED
|
@@ -63,6 +63,9 @@ const { data } = await appClient.getPublicFacingComponent(...)
|
|
|
63
63
|
**App Proxy**
|
|
64
64
|
- [`publicProxyGet`](#publicproxyget)
|
|
65
65
|
- [`publicProxyPost`](#publicproxypost)
|
|
66
|
+
- [`publicProxyPut`](#publicproxyput)
|
|
67
|
+
- [`publicProxyPatch`](#publicproxypatch)
|
|
68
|
+
- [`publicProxyDelete`](#publicproxydelete)
|
|
66
69
|
|
|
67
70
|
**Schemas**
|
|
68
71
|
- [`Role`](#role)
|
|
@@ -103,6 +106,9 @@ const { data } = await appClient.getPublicFacingComponent(...)
|
|
|
103
106
|
- [`PortalExtensionHookDataExport`](#portalextensionhookdataexport)
|
|
104
107
|
- [`PortalExtensionHookVisualizationMetadata`](#portalextensionhookvisualizationmetadata)
|
|
105
108
|
- [`PortalExtensionHookCostDataRetrieval`](#portalextensionhookcostdataretrieval)
|
|
109
|
+
- [`PortalExtensionHookChangeEmail`](#portalextensionhookchangeemail)
|
|
110
|
+
- [`PortalExtensionHookChangePassword`](#portalextensionhookchangepassword)
|
|
111
|
+
- [`PortalExtensionHookDeleteAccount`](#portalextensionhookdeleteaccount)
|
|
106
112
|
- [`PortalExtensionSeamlessLink`](#portalextensionseamlesslink)
|
|
107
113
|
- [`PortalExtensionAuthBlock`](#portalextensionauthblock)
|
|
108
114
|
- [`PortalExtensionSecureProxy`](#portalextensionsecureproxy)
|
|
@@ -1713,6 +1719,60 @@ const { data } = await client.publicProxyPost(
|
|
|
1713
1719
|
|
|
1714
1720
|
---
|
|
1715
1721
|
|
|
1722
|
+
### `publicProxyPut`
|
|
1723
|
+
|
|
1724
|
+
Forward a PUT request to a registered proxy target from a public-facing component
|
|
1725
|
+
|
|
1726
|
+
`PUT /v1/public/app/{appId}/proxy/{proxyName}/{path}`
|
|
1727
|
+
|
|
1728
|
+
```ts
|
|
1729
|
+
const { data } = await client.publicProxyPut(
|
|
1730
|
+
{
|
|
1731
|
+
appId: 'example',
|
|
1732
|
+
proxyName: 'example',
|
|
1733
|
+
path: 'example',
|
|
1734
|
+
},
|
|
1735
|
+
{},
|
|
1736
|
+
)
|
|
1737
|
+
```
|
|
1738
|
+
|
|
1739
|
+
---
|
|
1740
|
+
|
|
1741
|
+
### `publicProxyPatch`
|
|
1742
|
+
|
|
1743
|
+
Forward a PATCH request to a registered proxy target from a public-facing component
|
|
1744
|
+
|
|
1745
|
+
`PATCH /v1/public/app/{appId}/proxy/{proxyName}/{path}`
|
|
1746
|
+
|
|
1747
|
+
```ts
|
|
1748
|
+
const { data } = await client.publicProxyPatch(
|
|
1749
|
+
{
|
|
1750
|
+
appId: 'example',
|
|
1751
|
+
proxyName: 'example',
|
|
1752
|
+
path: 'example',
|
|
1753
|
+
},
|
|
1754
|
+
{},
|
|
1755
|
+
)
|
|
1756
|
+
```
|
|
1757
|
+
|
|
1758
|
+
---
|
|
1759
|
+
|
|
1760
|
+
### `publicProxyDelete`
|
|
1761
|
+
|
|
1762
|
+
Forward a DELETE request to a registered proxy target from a public-facing component
|
|
1763
|
+
|
|
1764
|
+
`DELETE /v1/public/app/{appId}/proxy/{proxyName}/{path}`
|
|
1765
|
+
|
|
1766
|
+
```ts
|
|
1767
|
+
const { data } = await client.publicProxyDelete({
|
|
1768
|
+
appId: 'example',
|
|
1769
|
+
proxyName: 'example',
|
|
1770
|
+
path: 'example',
|
|
1771
|
+
})
|
|
1772
|
+
```
|
|
1773
|
+
|
|
1774
|
+
---
|
|
1775
|
+
|
|
1716
1776
|
## Schemas
|
|
1717
1777
|
|
|
1718
1778
|
### `Role`
|
|
@@ -1902,10 +1962,11 @@ type ApiProxyComponent = {
|
|
|
1902
1962
|
component_type: "API_PROXY"
|
|
1903
1963
|
configuration: {
|
|
1904
1964
|
name: string
|
|
1905
|
-
target: string
|
|
1965
|
+
target: string
|
|
1906
1966
|
auth_type: "header" | "bearer" | "oauth2" | "none"
|
|
1907
1967
|
auth_header?: string
|
|
1908
1968
|
token_url?: string // uri
|
|
1969
|
+
headers?: Record<string, string>
|
|
1909
1970
|
}
|
|
1910
1971
|
}
|
|
1911
1972
|
```
|
|
@@ -2327,17 +2388,24 @@ type PortalExtensionComponent = {
|
|
|
2327
2388
|
resolved?: { ... }
|
|
2328
2389
|
use_static_ips?: { ... }
|
|
2329
2390
|
secure_proxy?: { ... }
|
|
2330
|
-
}
|
|
2331
|
-
links?: Array<{
|
|
2391
|
+
} | {
|
|
2332
2392
|
id: { ... }
|
|
2333
|
-
name
|
|
2334
|
-
description?: { ... }
|
|
2393
|
+
name?: { ... }
|
|
2335
2394
|
type: { ... }
|
|
2336
|
-
|
|
2395
|
+
change_mode?: { ... }
|
|
2396
|
+
require_password_confirmation?: { ... }
|
|
2397
|
+
explanation?: { ... }
|
|
2337
2398
|
auth?: { ... }
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2399
|
+
call: { ... }
|
|
2400
|
+
resolved?: { ... }
|
|
2401
|
+
secure_proxy?: { ... }
|
|
2402
|
+
} | {
|
|
2403
|
+
id: { ... }
|
|
2404
|
+
name?: { ... }
|
|
2405
|
+
type: { ... }
|
|
2406
|
+
require_new_password?: { ... }
|
|
2407
|
+
explanation?: { ... }
|
|
2408
|
+
// ...
|
|
2341
2409
|
}
|
|
2342
2410
|
```
|
|
2343
2411
|
|
|
@@ -2819,6 +2887,142 @@ type PortalExtensionHookCostDataRetrieval = {
|
|
|
2819
2887
|
}
|
|
2820
2888
|
```
|
|
2821
2889
|
|
|
2890
|
+
### `PortalExtensionHookChangeEmail`
|
|
2891
|
+
|
|
2892
|
+
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.
|
|
2893
|
+
The `change_mode` controls what the portal d
|
|
2894
|
+
|
|
2895
|
+
```ts
|
|
2896
|
+
type PortalExtensionHookChangeEmail = {
|
|
2897
|
+
id: string
|
|
2898
|
+
name?: {
|
|
2899
|
+
en?: string
|
|
2900
|
+
de: string
|
|
2901
|
+
}
|
|
2902
|
+
type: "changeEmail"
|
|
2903
|
+
change_mode?: "synchronous" | "asynchronous"
|
|
2904
|
+
require_password_confirmation?: boolean
|
|
2905
|
+
explanation?: {
|
|
2906
|
+
en: string
|
|
2907
|
+
}
|
|
2908
|
+
auth?: {
|
|
2909
|
+
method?: string
|
|
2910
|
+
url: string
|
|
2911
|
+
params?: Record<string, string>
|
|
2912
|
+
headers?: Record<string, string>
|
|
2913
|
+
body?: Record<string, unknown>
|
|
2914
|
+
cache?: {
|
|
2915
|
+
key: { ... }
|
|
2916
|
+
ttl: { ... }
|
|
2917
|
+
}
|
|
2918
|
+
}
|
|
2919
|
+
call: {
|
|
2920
|
+
method?: string
|
|
2921
|
+
url: string
|
|
2922
|
+
params?: Record<string, string>
|
|
2923
|
+
headers: Record<string, string>
|
|
2924
|
+
body?: object
|
|
2925
|
+
}
|
|
2926
|
+
resolved?: {
|
|
2927
|
+
error_message_path?: string
|
|
2928
|
+
}
|
|
2929
|
+
secure_proxy?: {
|
|
2930
|
+
integration_id: string // uuid
|
|
2931
|
+
use_case_slug: string
|
|
2932
|
+
}
|
|
2933
|
+
}
|
|
2934
|
+
```
|
|
2935
|
+
|
|
2936
|
+
### `PortalExtensionHookChangePassword`
|
|
2937
|
+
|
|
2938
|
+
Hook that replaces the built-in change password functionality for portal users. When configured, the portal does not change the user's password itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the password change (most likely by sending the user in
|
|
2939
|
+
|
|
2940
|
+
```ts
|
|
2941
|
+
type PortalExtensionHookChangePassword = {
|
|
2942
|
+
id: string
|
|
2943
|
+
name?: {
|
|
2944
|
+
en?: string
|
|
2945
|
+
de: string
|
|
2946
|
+
}
|
|
2947
|
+
type: "changePassword"
|
|
2948
|
+
require_new_password?: boolean
|
|
2949
|
+
explanation?: {
|
|
2950
|
+
en: string
|
|
2951
|
+
}
|
|
2952
|
+
auth?: {
|
|
2953
|
+
method?: string
|
|
2954
|
+
url: string
|
|
2955
|
+
params?: Record<string, string>
|
|
2956
|
+
headers?: Record<string, string>
|
|
2957
|
+
body?: Record<string, unknown>
|
|
2958
|
+
cache?: {
|
|
2959
|
+
key: { ... }
|
|
2960
|
+
ttl: { ... }
|
|
2961
|
+
}
|
|
2962
|
+
}
|
|
2963
|
+
call: {
|
|
2964
|
+
method?: string
|
|
2965
|
+
url: string
|
|
2966
|
+
params?: Record<string, string>
|
|
2967
|
+
headers: Record<string, string>
|
|
2968
|
+
body?: object
|
|
2969
|
+
}
|
|
2970
|
+
resolved?: {
|
|
2971
|
+
error_message_path?: string
|
|
2972
|
+
}
|
|
2973
|
+
secure_proxy?: {
|
|
2974
|
+
integration_id: string // uuid
|
|
2975
|
+
use_case_slug: string
|
|
2976
|
+
}
|
|
2977
|
+
}
|
|
2978
|
+
```
|
|
2979
|
+
|
|
2980
|
+
### `PortalExtensionHookDeleteAccount`
|
|
2981
|
+
|
|
2982
|
+
Hook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.
|
|
2983
|
+
The `deletion_mode` controls what the portal does aft
|
|
2984
|
+
|
|
2985
|
+
```ts
|
|
2986
|
+
type PortalExtensionHookDeleteAccount = {
|
|
2987
|
+
id: string
|
|
2988
|
+
name?: {
|
|
2989
|
+
en?: string
|
|
2990
|
+
de: string
|
|
2991
|
+
}
|
|
2992
|
+
type: "deleteAccount"
|
|
2993
|
+
deletion_mode?: "synchronous" | "asynchronous"
|
|
2994
|
+
delete_contact?: "none" | "soft" | "hard"
|
|
2995
|
+
explanation?: {
|
|
2996
|
+
en: string
|
|
2997
|
+
}
|
|
2998
|
+
auth?: {
|
|
2999
|
+
method?: string
|
|
3000
|
+
url: string
|
|
3001
|
+
params?: Record<string, string>
|
|
3002
|
+
headers?: Record<string, string>
|
|
3003
|
+
body?: Record<string, unknown>
|
|
3004
|
+
cache?: {
|
|
3005
|
+
key: { ... }
|
|
3006
|
+
ttl: { ... }
|
|
3007
|
+
}
|
|
3008
|
+
}
|
|
3009
|
+
call: {
|
|
3010
|
+
method?: string
|
|
3011
|
+
url: string
|
|
3012
|
+
params?: Record<string, string>
|
|
3013
|
+
headers: Record<string, string>
|
|
3014
|
+
body?: object
|
|
3015
|
+
}
|
|
3016
|
+
resolved?: {
|
|
3017
|
+
error_message_path?: string
|
|
3018
|
+
}
|
|
3019
|
+
secure_proxy?: {
|
|
3020
|
+
integration_id: string // uuid
|
|
3021
|
+
use_case_slug: string
|
|
3022
|
+
}
|
|
3023
|
+
}
|
|
3024
|
+
```
|
|
3025
|
+
|
|
2822
3026
|
### `PortalExtensionSeamlessLink`
|
|
2823
3027
|
|
|
2824
3028
|
```ts
|
|
@@ -3174,10 +3378,11 @@ Configuration for an API proxy component
|
|
|
3174
3378
|
```ts
|
|
3175
3379
|
type ApiProxyConfig = {
|
|
3176
3380
|
name: string
|
|
3177
|
-
target: string
|
|
3381
|
+
target: string
|
|
3178
3382
|
auth_type: "header" | "bearer" | "oauth2" | "none"
|
|
3179
3383
|
auth_header?: string
|
|
3180
3384
|
token_url?: string // uri
|
|
3385
|
+
headers?: Record<string, string>
|
|
3181
3386
|
}
|
|
3182
3387
|
```
|
|
3183
3388
|
|
|
@@ -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
|