@epilot/sdk 2.20.24 → 2.20.26
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/integration-toolkit.json +44 -7
- package/definitions/journey.json +80 -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/chat.cjs +6 -6
- package/dist/apis/chat.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 +6 -6
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- 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-B43U4DLU.cjs → chunk-6CWZ6WAC.cjs} +2 -2
- package/dist/{chunk-5D6VD6OZ.js → chunk-ELW5R5D6.js} +2 -2
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/integration-toolkit-FHPQSYLH.js +7 -0
- package/dist/integration-toolkit-YBZJK4IG.cjs +7 -0
- package/dist/{integration-toolkit.d-bhpB79pc.d.cts → integration-toolkit.d--hon4GPp.d.cts} +79 -26
- package/dist/{integration-toolkit.d-bhpB79pc.d.ts → integration-toolkit.d--hon4GPp.d.ts} +79 -26
- package/dist/journey-IVIBYU5V.js +7 -0
- package/dist/journey-ZN46FFPM.cjs +7 -0
- package/dist/{journey.d-DvwLALwc.d.cts → journey.d-Dj93v-Lw.d.cts} +54 -5
- package/dist/{journey.d-DvwLALwc.d.ts → journey.d-Dj93v-Lw.d.ts} +54 -5
- package/docs/integration-toolkit.md +19 -250
- package/docs/journey.md +47 -2
- package/package.json +1 -1
- package/dist/integration-toolkit-GOFVOMNH.js +0 -7
- package/dist/integration-toolkit-XMM5LLK6.cjs +0 -7
- package/dist/journey-LIJDXSEC.js +0 -7
- package/dist/journey-LNA7JFP3.cjs +0 -7
|
@@ -76,11 +76,7 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
|
|
|
76
76
|
- [`commitTypes`](#committypes)
|
|
77
77
|
|
|
78
78
|
**monitoring**
|
|
79
|
-
- [`queryInboundMonitoringEvents`](#queryinboundmonitoringevents)
|
|
80
|
-
- [`getMonitoringStats`](#getmonitoringstats)
|
|
81
|
-
- [`getMonitoringTimeSeries`](#getmonitoringtimeseries)
|
|
82
79
|
- [`queryAccessLogs`](#queryaccesslogs)
|
|
83
|
-
- [`queryOutboundMonitoringEvents`](#queryoutboundmonitoringevents)
|
|
84
80
|
- [`queryMonitoringEventsV2`](#querymonitoringeventsv2)
|
|
85
81
|
- [`getMonitoringStatsV2`](#getmonitoringstatsv2)
|
|
86
82
|
- [`getMonitoringTimeSeriesV2`](#getmonitoringtimeseriesv2)
|
|
@@ -2279,6 +2275,12 @@ const { data } = await client.getNotificationStatus({
|
|
|
2279
2275
|
"state": "ok",
|
|
2280
2276
|
"last_fired_at": "1970-01-01T00:00:00.000Z",
|
|
2281
2277
|
"last_cleared_at": "1970-01-01T00:00:00.000Z",
|
|
2278
|
+
"last_evaluation": {
|
|
2279
|
+
"evaluated_at": "1970-01-01T00:00:00.000Z",
|
|
2280
|
+
"observed": 0,
|
|
2281
|
+
"threshold": 0,
|
|
2282
|
+
"suppressed_reason": "sample_size"
|
|
2283
|
+
},
|
|
2282
2284
|
"baseline": {
|
|
2283
2285
|
"is_mature": true,
|
|
2284
2286
|
"computed_at": "1970-01-01T00:00:00.000Z",
|
|
@@ -2483,189 +2485,6 @@ const { data } = await client.deleteIntegrationAppMapping(
|
|
|
2483
2485
|
|
|
2484
2486
|
---
|
|
2485
2487
|
|
|
2486
|
-
### `queryInboundMonitoringEvents`
|
|
2487
|
-
|
|
2488
|
-
Query inbound monitoring events for a specific integration.
|
|
2489
|
-
Returns detailed information about inbound sync events from ERP systems,
|
|
2490
|
-
including success rates, error breakdowns, and processing metrics.
|
|
2491
|
-
|
|
2492
|
-
`POST /v1/integrations/{integrationId}/monitoring/inbound-events`
|
|
2493
|
-
|
|
2494
|
-
```ts
|
|
2495
|
-
const { data } = await client.queryInboundMonitoringEvents(
|
|
2496
|
-
{
|
|
2497
|
-
integrationId: 'example',
|
|
2498
|
-
},
|
|
2499
|
-
{
|
|
2500
|
-
use_case_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
|
|
2501
|
-
event_type: 'CREATE',
|
|
2502
|
-
sync_type: 'entity',
|
|
2503
|
-
status: 'success',
|
|
2504
|
-
error_category: 'validation',
|
|
2505
|
-
correlation_id: 'string',
|
|
2506
|
-
object_type: 'string',
|
|
2507
|
-
event_name: 'string',
|
|
2508
|
-
event_id: 'string',
|
|
2509
|
-
from_date: '2025-01-01T00:00:00Z',
|
|
2510
|
-
to_date: '2025-01-31T23:59:59Z',
|
|
2511
|
-
limit: 50,
|
|
2512
|
-
cursor: {
|
|
2513
|
-
completed_at: '1970-01-01T00:00:00.000Z',
|
|
2514
|
-
event_id: 'string'
|
|
2515
|
-
}
|
|
2516
|
-
},
|
|
2517
|
-
)
|
|
2518
|
-
```
|
|
2519
|
-
|
|
2520
|
-
<details>
|
|
2521
|
-
<summary>Response</summary>
|
|
2522
|
-
|
|
2523
|
-
```json
|
|
2524
|
-
{
|
|
2525
|
-
"data": [
|
|
2526
|
-
{
|
|
2527
|
-
"org_id": "string",
|
|
2528
|
-
"event_id": "string",
|
|
2529
|
-
"correlation_id": "string",
|
|
2530
|
-
"integration_id": "string",
|
|
2531
|
-
"use_case_id": "string",
|
|
2532
|
-
"event_type": "CREATE",
|
|
2533
|
-
"object_type": "string",
|
|
2534
|
-
"sync_type": "entity",
|
|
2535
|
-
"status": "success",
|
|
2536
|
-
"error_code": "string",
|
|
2537
|
-
"error_message": "string",
|
|
2538
|
-
"error_category": "validation",
|
|
2539
|
-
"processing_duration_ms": 0,
|
|
2540
|
-
"received_at": "1970-01-01T00:00:00.000Z",
|
|
2541
|
-
"completed_at": "1970-01-01T00:00:00.000Z"
|
|
2542
|
-
}
|
|
2543
|
-
],
|
|
2544
|
-
"next_cursor": {
|
|
2545
|
-
"completed_at": "1970-01-01T00:00:00.000Z",
|
|
2546
|
-
"event_id": "string"
|
|
2547
|
-
},
|
|
2548
|
-
"has_more": true
|
|
2549
|
-
}
|
|
2550
|
-
```
|
|
2551
|
-
|
|
2552
|
-
</details>
|
|
2553
|
-
|
|
2554
|
-
---
|
|
2555
|
-
|
|
2556
|
-
### `getMonitoringStats`
|
|
2557
|
-
|
|
2558
|
-
Get aggregated statistics for both inbound and outbound monitoring events for a specific integration.
|
|
2559
|
-
Returns summary metrics for inbound (ERP sync) and outbound (webhook delivery) events,
|
|
2560
|
-
including s
|
|
2561
|
-
|
|
2562
|
-
`POST /v1/integrations/{integrationId}/monitoring/stats`
|
|
2563
|
-
|
|
2564
|
-
```ts
|
|
2565
|
-
const { data } = await client.getMonitoringStats(
|
|
2566
|
-
{
|
|
2567
|
-
integrationId: 'example',
|
|
2568
|
-
},
|
|
2569
|
-
{
|
|
2570
|
-
from_date: '2025-01-01T00:00:00Z',
|
|
2571
|
-
to_date: '2025-01-31T23:59:59Z',
|
|
2572
|
-
inbound_group_by: ['use_case_id', 'status'],
|
|
2573
|
-
outbound_group_by: ['event_name', 'status']
|
|
2574
|
-
},
|
|
2575
|
-
)
|
|
2576
|
-
```
|
|
2577
|
-
|
|
2578
|
-
<details>
|
|
2579
|
-
<summary>Response</summary>
|
|
2580
|
-
|
|
2581
|
-
```json
|
|
2582
|
-
{
|
|
2583
|
-
"inbound": {
|
|
2584
|
-
"total_events": 0,
|
|
2585
|
-
"total_correlations": 0,
|
|
2586
|
-
"success_count": 0,
|
|
2587
|
-
"error_count": 0,
|
|
2588
|
-
"skipped_count": 0,
|
|
2589
|
-
"warning_count": 0,
|
|
2590
|
-
"success_rate": 0,
|
|
2591
|
-
"last_error_at": "1970-01-01T00:00:00.000Z",
|
|
2592
|
-
"breakdown": [
|
|
2593
|
-
{}
|
|
2594
|
-
]
|
|
2595
|
-
},
|
|
2596
|
-
"outbound": {
|
|
2597
|
-
"total_events": 0,
|
|
2598
|
-
"success_count": 0,
|
|
2599
|
-
"error_count": 0,
|
|
2600
|
-
"pending_count": 0,
|
|
2601
|
-
"success_rate": 0,
|
|
2602
|
-
"last_error_at": "1970-01-01T00:00:00.000Z",
|
|
2603
|
-
"breakdown": [
|
|
2604
|
-
{}
|
|
2605
|
-
]
|
|
2606
|
-
}
|
|
2607
|
-
}
|
|
2608
|
-
```
|
|
2609
|
-
|
|
2610
|
-
</details>
|
|
2611
|
-
|
|
2612
|
-
---
|
|
2613
|
-
|
|
2614
|
-
### `getMonitoringTimeSeries`
|
|
2615
|
-
|
|
2616
|
-
Get time-series aggregated event counts for monitoring charts.
|
|
2617
|
-
Returns pre-bucketed counts at configurable intervals for both inbound and outbound events.
|
|
2618
|
-
Maximum of 200 buckets per request. Returns 4
|
|
2619
|
-
|
|
2620
|
-
`POST /v1/integrations/{integrationId}/monitoring/timeseries`
|
|
2621
|
-
|
|
2622
|
-
```ts
|
|
2623
|
-
const { data } = await client.getMonitoringTimeSeries(
|
|
2624
|
-
{
|
|
2625
|
-
integrationId: 'example',
|
|
2626
|
-
},
|
|
2627
|
-
{
|
|
2628
|
-
from_date: '2025-01-01T00:00:00Z',
|
|
2629
|
-
to_date: '2025-01-31T23:59:59Z',
|
|
2630
|
-
interval: '1h',
|
|
2631
|
-
direction: 'both'
|
|
2632
|
-
},
|
|
2633
|
-
)
|
|
2634
|
-
```
|
|
2635
|
-
|
|
2636
|
-
<details>
|
|
2637
|
-
<summary>Response</summary>
|
|
2638
|
-
|
|
2639
|
-
```json
|
|
2640
|
-
{
|
|
2641
|
-
"interval": "5m",
|
|
2642
|
-
"from_date": "1970-01-01T00:00:00.000Z",
|
|
2643
|
-
"to_date": "1970-01-01T00:00:00.000Z",
|
|
2644
|
-
"buckets": [
|
|
2645
|
-
{
|
|
2646
|
-
"timestamp": "1970-01-01T00:00:00.000Z",
|
|
2647
|
-
"inbound": {
|
|
2648
|
-
"success_count": 0,
|
|
2649
|
-
"error_count": 0,
|
|
2650
|
-
"warning_count": 0,
|
|
2651
|
-
"skipped_count": 0,
|
|
2652
|
-
"total_count": 0
|
|
2653
|
-
},
|
|
2654
|
-
"outbound": {
|
|
2655
|
-
"success_count": 0,
|
|
2656
|
-
"error_count": 0,
|
|
2657
|
-
"pending_count": 0,
|
|
2658
|
-
"total_count": 0
|
|
2659
|
-
}
|
|
2660
|
-
}
|
|
2661
|
-
]
|
|
2662
|
-
}
|
|
2663
|
-
```
|
|
2664
|
-
|
|
2665
|
-
</details>
|
|
2666
|
-
|
|
2667
|
-
---
|
|
2668
|
-
|
|
2669
2488
|
### `getOutboundStatus`
|
|
2670
2489
|
|
|
2671
2490
|
Get the status of all outbound use cases for a specific integration.
|
|
@@ -3044,68 +2863,6 @@ const { data } = await client.queryAccessLogs(
|
|
|
3044
2863
|
|
|
3045
2864
|
---
|
|
3046
2865
|
|
|
3047
|
-
### `queryOutboundMonitoringEvents`
|
|
3048
|
-
|
|
3049
|
-
Query outbound monitoring events for a specific integration.
|
|
3050
|
-
Returns detailed information about outbound event deliveries,
|
|
3051
|
-
filtered by event_name (event_catalog_event) linked to the integration's outb
|
|
3052
|
-
|
|
3053
|
-
`POST /v1/integrations/{integrationId}/monitoring/outbound-events`
|
|
3054
|
-
|
|
3055
|
-
```ts
|
|
3056
|
-
const { data } = await client.queryOutboundMonitoringEvents(
|
|
3057
|
-
{
|
|
3058
|
-
integrationId: 'example',
|
|
3059
|
-
},
|
|
3060
|
-
{
|
|
3061
|
-
event_name: 'automation_flow_target',
|
|
3062
|
-
status: 'succeeded',
|
|
3063
|
-
webhook_config_id: 'string',
|
|
3064
|
-
from_date: '2025-01-01T00:00:00Z',
|
|
3065
|
-
to_date: '2025-01-31T23:59:59Z',
|
|
3066
|
-
limit: 50,
|
|
3067
|
-
cursor: {
|
|
3068
|
-
created_at: '1970-01-01T00:00:00.000Z',
|
|
3069
|
-
event_id: 'string'
|
|
3070
|
-
}
|
|
3071
|
-
},
|
|
3072
|
-
)
|
|
3073
|
-
```
|
|
3074
|
-
|
|
3075
|
-
<details>
|
|
3076
|
-
<summary>Response</summary>
|
|
3077
|
-
|
|
3078
|
-
```json
|
|
3079
|
-
{
|
|
3080
|
-
"data": [
|
|
3081
|
-
{
|
|
3082
|
-
"org_id": "string",
|
|
3083
|
-
"event_id": "string",
|
|
3084
|
-
"event_name": "string",
|
|
3085
|
-
"status": "succeeded",
|
|
3086
|
-
"url": "string",
|
|
3087
|
-
"http_method": "string",
|
|
3088
|
-
"http_response": {},
|
|
3089
|
-
"webhook_config_id": "string",
|
|
3090
|
-
"metadata": {},
|
|
3091
|
-
"execution_context": {},
|
|
3092
|
-
"payload": {},
|
|
3093
|
-
"created_at": "1970-01-01T00:00:00.000Z",
|
|
3094
|
-
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
3095
|
-
}
|
|
3096
|
-
],
|
|
3097
|
-
"next_cursor": {
|
|
3098
|
-
"created_at": "1970-01-01T00:00:00.000Z",
|
|
3099
|
-
"event_id": "string"
|
|
3100
|
-
},
|
|
3101
|
-
"has_more": true
|
|
3102
|
-
}
|
|
3103
|
-
```
|
|
3104
|
-
|
|
3105
|
-
</details>
|
|
3106
|
-
|
|
3107
|
-
---
|
|
3108
|
-
|
|
3109
2866
|
### `queryMonitoringEventsV2`
|
|
3110
2867
|
|
|
3111
2868
|
Query monitoring events from the unified erp_monitoring_v2 table.
|
|
@@ -4348,6 +4105,12 @@ type NotificationStatusResponse = {
|
|
|
4348
4105
|
state: "ok" | "alerting" | "recovered"
|
|
4349
4106
|
last_fired_at?: string // date-time
|
|
4350
4107
|
last_cleared_at?: string // date-time
|
|
4108
|
+
last_evaluation?: {
|
|
4109
|
+
evaluated_at: { ... }
|
|
4110
|
+
observed: { ... }
|
|
4111
|
+
threshold?: { ... }
|
|
4112
|
+
suppressed_reason?: { ... }
|
|
4113
|
+
}
|
|
4351
4114
|
baseline?: {
|
|
4352
4115
|
is_mature: { ... }
|
|
4353
4116
|
computed_at?: { ... }
|
|
@@ -4368,6 +4131,12 @@ type NotificationRuleStatus = {
|
|
|
4368
4131
|
state: "ok" | "alerting" | "recovered"
|
|
4369
4132
|
last_fired_at?: string // date-time
|
|
4370
4133
|
last_cleared_at?: string // date-time
|
|
4134
|
+
last_evaluation?: {
|
|
4135
|
+
evaluated_at: string // date-time
|
|
4136
|
+
observed: number
|
|
4137
|
+
threshold?: number
|
|
4138
|
+
suppressed_reason?: "sample_size"
|
|
4139
|
+
}
|
|
4371
4140
|
baseline?: {
|
|
4372
4141
|
is_mature: boolean
|
|
4373
4142
|
computed_at?: string // date-time
|
|
@@ -9295,7 +9064,7 @@ type InboundMonitoringEvent = {
|
|
|
9295
9064
|
type QueryMonitoringEventsV2Request = {
|
|
9296
9065
|
use_case_id?: string
|
|
9297
9066
|
use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
|
|
9298
|
-
level?: "success" | "error" | "info" | "warning"
|
|
9067
|
+
level?: "success" | "error" | "info" | "warning" | "skipped"
|
|
9299
9068
|
code?: string
|
|
9300
9069
|
event_id?: string
|
|
9301
9070
|
correlation_id?: string
|
package/docs/journey.md
CHANGED
|
@@ -54,6 +54,8 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
|
|
|
54
54
|
**Schemas**
|
|
55
55
|
- [`EnvironmentMapEntry`](#environmentmapentry)
|
|
56
56
|
- [`EnvironmentMap`](#environmentmap)
|
|
57
|
+
- [`EnvironmentLink`](#environmentlink)
|
|
58
|
+
- [`EnvironmentLinkList`](#environmentlinklist)
|
|
57
59
|
- [`JourneyEnvironmentResponse`](#journeyenvironmentresponse)
|
|
58
60
|
- [`JourneyEnvironmentVariablesResponse`](#journeyenvironmentvariablesresponse)
|
|
59
61
|
- [`GetJourneysResponse`](#getjourneysresponse)
|
|
@@ -2198,16 +2200,55 @@ type EnvironmentMap = {
|
|
|
2198
2200
|
}
|
|
2199
2201
|
```
|
|
2200
2202
|
|
|
2203
|
+
### `EnvironmentLink`
|
|
2204
|
+
|
|
2205
|
+
One link a customer clicks. `label` and `description` are each either a
|
|
2206
|
+
plain string or one string per language, deciding that independently.
|
|
2207
|
+
Mirrors environments-api's `LinkFields`.
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
```ts
|
|
2211
|
+
type EnvironmentLink = {
|
|
2212
|
+
url: string
|
|
2213
|
+
label: string | Record<string, string>
|
|
2214
|
+
description?: string | Record<string, string>
|
|
2215
|
+
}
|
|
2216
|
+
```
|
|
2217
|
+
|
|
2218
|
+
### `EnvironmentLinkList`
|
|
2219
|
+
|
|
2220
|
+
A list of links, served under this service's own `List`<Link>`` type
|
|
2221
|
+
token. environments-api types the variable `List` and declares the
|
|
2222
|
+
element type inside the value; journey-api composes the two so a
|
|
2223
|
+
consumer needs only one discriminant.
|
|
2224
|
+
|
|
2225
|
+
|
|
2226
|
+
```ts
|
|
2227
|
+
type EnvironmentLinkList = {
|
|
2228
|
+
itemType: "Link"
|
|
2229
|
+
fallbackLanguage?: string
|
|
2230
|
+
items: Array<{
|
|
2231
|
+
url: string
|
|
2232
|
+
label: string | Record<string, string>
|
|
2233
|
+
description?: string | Record<string, string>
|
|
2234
|
+
}>
|
|
2235
|
+
}
|
|
2236
|
+
```
|
|
2237
|
+
|
|
2201
2238
|
### `JourneyEnvironmentResponse`
|
|
2202
2239
|
|
|
2203
2240
|
```ts
|
|
2204
2241
|
type JourneyEnvironmentResponse = {
|
|
2205
2242
|
items: Array<{
|
|
2206
2243
|
datasourceId: string
|
|
2207
|
-
type: "Text" | "Number" | "Boolean" | "Map"
|
|
2244
|
+
type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>"
|
|
2208
2245
|
value: string | number | boolean | {
|
|
2209
2246
|
fallbackLanguage?: { ... }
|
|
2210
2247
|
options: { ... }
|
|
2248
|
+
} | {
|
|
2249
|
+
itemType: { ... }
|
|
2250
|
+
fallbackLanguage?: { ... }
|
|
2251
|
+
items: { ... }
|
|
2211
2252
|
}
|
|
2212
2253
|
}>
|
|
2213
2254
|
errors: Array<{
|
|
@@ -2223,10 +2264,14 @@ type JourneyEnvironmentResponse = {
|
|
|
2223
2264
|
type JourneyEnvironmentVariablesResponse = {
|
|
2224
2265
|
items: Array<{
|
|
2225
2266
|
key: string
|
|
2226
|
-
type: "Map"
|
|
2267
|
+
type: "Map" | "List<Link>"
|
|
2227
2268
|
value: {
|
|
2228
2269
|
fallbackLanguage?: { ... }
|
|
2229
2270
|
options: { ... }
|
|
2271
|
+
} | {
|
|
2272
|
+
itemType: { ... }
|
|
2273
|
+
fallbackLanguage?: { ... }
|
|
2274
|
+
items: { ... }
|
|
2230
2275
|
}
|
|
2231
2276
|
description?: string
|
|
2232
2277
|
}>
|