@epilot/sdk 2.5.0 → 2.7.0
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/event-catalog-runtime.json +1 -1
- package/definitions/event-catalog.json +256 -1
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +480 -4
- package/definitions/metering-runtime.json +1 -1
- package/definitions/metering.json +728 -64
- package/definitions/webhooks.json +19 -4
- 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.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 +8 -8
- package/dist/apis/event-catalog.d.cts +2 -2
- package/dist/apis/event-catalog.d.ts +2 -2
- package/dist/apis/event-catalog.js +2 -2
- 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 +8 -8
- package/dist/apis/metering.d.cts +2 -2
- package/dist/apis/metering.d.ts +2 -2
- package/dist/apis/metering.js +2 -2
- 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/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.d.cts +2 -2
- package/dist/apis/webhooks.d.ts +2 -2
- 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-C7GDYBXX.cjs → chunk-35CN2YFK.cjs} +7 -7
- package/dist/{chunk-JTFWOEZF.cjs → chunk-4FFGRWLS.cjs} +1 -1
- package/dist/chunk-56MMZJOD.js +14 -0
- package/dist/{chunk-BLNXQAMX.cjs → chunk-CBDKPGO5.cjs} +1 -1
- package/dist/{chunk-WRD2XFHY.js → chunk-JB7LITSP.js} +7 -7
- package/dist/{chunk-TME4YJNP.js → chunk-OCMIXJWC.js} +1 -1
- package/dist/chunk-T6A22LSD.cjs +14 -0
- package/dist/chunk-WM74R3BD.js +14 -0
- package/dist/event-catalog-37B6JC7G.js +7 -0
- package/dist/event-catalog-5JBHJJ2I.cjs +7 -0
- package/dist/{event-catalog-runtime-5HQSAJVX.cjs → event-catalog-runtime-B2BPKQVG.cjs} +2 -2
- package/dist/{event-catalog-runtime-6FA3SCRI.js → event-catalog-runtime-N262TQ3Y.js} +1 -1
- package/dist/{event-catalog.d-ENw6HO-w.d.cts → event-catalog.d-mQJLSYUo.d.cts} +351 -6
- package/dist/{event-catalog.d-ENw6HO-w.d.ts → event-catalog.d-mQJLSYUo.d.ts} +351 -6
- package/dist/index.cjs +14 -14
- package/dist/index.d.cts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +4 -4
- package/dist/integration-toolkit-3I3IPVFN.cjs +7 -0
- package/dist/integration-toolkit-XAFQXNQY.js +7 -0
- package/dist/{integration-toolkit-runtime-5KG3LGXF.cjs → integration-toolkit-runtime-YHTU4X5J.cjs} +2 -2
- package/dist/{integration-toolkit-runtime-LYHFVIRW.js → integration-toolkit-runtime-YR4CIMKH.js} +1 -1
- package/dist/{integration-toolkit.d-Ry-KC9ow.d.cts → integration-toolkit.d-BstNqiJb.d.cts} +460 -20
- package/dist/{integration-toolkit.d-Ry-KC9ow.d.ts → integration-toolkit.d-BstNqiJb.d.ts} +460 -20
- package/dist/metering-3IUSYAGN.js +7 -0
- package/dist/metering-MHBFU7QH.cjs +7 -0
- package/dist/{metering-runtime-HAIWXZXJ.cjs → metering-runtime-IUZJHBVS.cjs} +2 -2
- package/dist/{metering-runtime-NJ6NEUMB.js → metering-runtime-KZMJKKUZ.js} +1 -1
- package/dist/{metering.d-DvtPv7wk.d.ts → metering.d-CUICZDiL.d.cts} +718 -130
- package/dist/{metering.d-DvtPv7wk.d.cts → metering.d-CUICZDiL.d.ts} +718 -130
- package/dist/{webhooks-XLBUXXCS.js → webhooks-NZHJBT64.js} +1 -1
- package/dist/{webhooks-NZ3TM3AY.cjs → webhooks-SK2STDKR.cjs} +1 -1
- package/dist/{webhooks.d-D79qib9f.d.cts → webhooks.d-ByePoUWs.d.cts} +40 -4
- package/dist/{webhooks.d-D79qib9f.d.ts → webhooks.d-ByePoUWs.d.ts} +40 -4
- package/docs/event-catalog.md +247 -1
- package/docs/integration-toolkit.md +334 -19
- package/docs/metering.md +570 -48
- package/docs/webhooks.md +3 -1
- package/package.json +1 -1
- package/dist/chunk-265TE2OV.js +0 -14
- package/dist/chunk-4ZMLRFDX.cjs +0 -14
- package/dist/chunk-U4PUHKZC.js +0 -14
- package/dist/event-catalog-C45ISVMP.cjs +0 -7
- package/dist/event-catalog-D7VJ7WRS.js +0 -7
- package/dist/integration-toolkit-FRPFOYT2.js +0 -7
- package/dist/integration-toolkit-VNMDI55O.cjs +0 -7
- package/dist/metering-DZNZPPY6.cjs +0 -7
- package/dist/metering-KOSCPPKB.js +0 -7
|
@@ -293,10 +293,10 @@ declare namespace Components {
|
|
|
293
293
|
*/
|
|
294
294
|
name: string;
|
|
295
295
|
/**
|
|
296
|
-
* URL-safe identifier for the use case.
|
|
296
|
+
* URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
297
297
|
*
|
|
298
298
|
*/
|
|
299
|
-
slug
|
|
299
|
+
slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
300
300
|
/**
|
|
301
301
|
* Whether the use case is enabled
|
|
302
302
|
*/
|
|
@@ -321,10 +321,10 @@ declare namespace Components {
|
|
|
321
321
|
*/
|
|
322
322
|
name: string;
|
|
323
323
|
/**
|
|
324
|
-
* URL-safe identifier for the use case.
|
|
324
|
+
* URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
325
325
|
*
|
|
326
326
|
*/
|
|
327
|
-
slug
|
|
327
|
+
slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
328
328
|
/**
|
|
329
329
|
* Whether the use case is enabled
|
|
330
330
|
*/
|
|
@@ -378,10 +378,10 @@ declare namespace Components {
|
|
|
378
378
|
*/
|
|
379
379
|
name: string;
|
|
380
380
|
/**
|
|
381
|
-
* URL-safe identifier for the use case.
|
|
381
|
+
* URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
382
382
|
*
|
|
383
383
|
*/
|
|
384
|
-
slug
|
|
384
|
+
slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
385
385
|
/**
|
|
386
386
|
* Whether the use case is enabled
|
|
387
387
|
*/
|
|
@@ -398,10 +398,10 @@ declare namespace Components {
|
|
|
398
398
|
*/
|
|
399
399
|
name: string;
|
|
400
400
|
/**
|
|
401
|
-
* URL-safe identifier for the use case.
|
|
401
|
+
* URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
402
402
|
*
|
|
403
403
|
*/
|
|
404
|
-
slug
|
|
404
|
+
slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
405
405
|
/**
|
|
406
406
|
* Whether the use case is enabled
|
|
407
407
|
*/
|
|
@@ -418,10 +418,10 @@ declare namespace Components {
|
|
|
418
418
|
*/
|
|
419
419
|
name: string;
|
|
420
420
|
/**
|
|
421
|
-
* URL-safe identifier for the use case.
|
|
421
|
+
* URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
422
422
|
*
|
|
423
423
|
*/
|
|
424
|
-
slug
|
|
424
|
+
slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
425
425
|
/**
|
|
426
426
|
* Whether the use case is enabled
|
|
427
427
|
*/
|
|
@@ -443,10 +443,10 @@ declare namespace Components {
|
|
|
443
443
|
*/
|
|
444
444
|
name: string;
|
|
445
445
|
/**
|
|
446
|
-
* URL-safe identifier for the use case.
|
|
446
|
+
* URL-safe identifier for the use case. Required for explicit creates so every use case has a portable cross-environment identifier. Must be unique per integration. Immutable after creation. Lowercase alphanumeric, hyphens, and underscores only.
|
|
447
447
|
*
|
|
448
448
|
*/
|
|
449
|
-
slug
|
|
449
|
+
slug: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
450
450
|
/**
|
|
451
451
|
* Whether the use case is enabled
|
|
452
452
|
*/
|
|
@@ -497,7 +497,7 @@ declare namespace Components {
|
|
|
497
497
|
*/
|
|
498
498
|
name: string;
|
|
499
499
|
/**
|
|
500
|
-
* URL-safe identifier for the use case.
|
|
500
|
+
* URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
|
|
501
501
|
*
|
|
502
502
|
*/
|
|
503
503
|
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
@@ -537,7 +537,7 @@ declare namespace Components {
|
|
|
537
537
|
*/
|
|
538
538
|
name: string;
|
|
539
539
|
/**
|
|
540
|
-
* URL-safe identifier for the use case.
|
|
540
|
+
* URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
|
|
541
541
|
*
|
|
542
542
|
*/
|
|
543
543
|
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
@@ -569,7 +569,7 @@ declare namespace Components {
|
|
|
569
569
|
*/
|
|
570
570
|
name: string;
|
|
571
571
|
/**
|
|
572
|
-
* URL-safe identifier for the use case.
|
|
572
|
+
* URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
|
|
573
573
|
*
|
|
574
574
|
*/
|
|
575
575
|
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
@@ -601,7 +601,7 @@ declare namespace Components {
|
|
|
601
601
|
*/
|
|
602
602
|
name: string;
|
|
603
603
|
/**
|
|
604
|
-
* URL-safe identifier for the use case.
|
|
604
|
+
* URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
|
|
605
605
|
*
|
|
606
606
|
*/
|
|
607
607
|
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
@@ -633,7 +633,7 @@ declare namespace Components {
|
|
|
633
633
|
*/
|
|
634
634
|
name: string;
|
|
635
635
|
/**
|
|
636
|
-
* URL-safe identifier for the use case.
|
|
636
|
+
* URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
|
|
637
637
|
*
|
|
638
638
|
*/
|
|
639
639
|
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
@@ -670,7 +670,7 @@ declare namespace Components {
|
|
|
670
670
|
*/
|
|
671
671
|
name: string;
|
|
672
672
|
/**
|
|
673
|
-
* URL-safe identifier for the use case.
|
|
673
|
+
* URL-safe identifier for the use case. Optional on this upsert/sync endpoint — when omitted, the server derives one from the name and ensures uniqueness within the integration. Immutable after creation.
|
|
674
674
|
*
|
|
675
675
|
*/
|
|
676
676
|
slug?: string; // ^[a-z0-9][a-z0-9_-]*$
|
|
@@ -701,6 +701,43 @@ declare namespace Components {
|
|
|
701
701
|
[name: string]: any;
|
|
702
702
|
};
|
|
703
703
|
}
|
|
704
|
+
/**
|
|
705
|
+
* Resolves to an org-scoped environment variable from the epilot environments-api service at runtime, replacing hard-coded environment-specific values (URLs, prefixes, identifiers) in inbound mappings. Secrets (`SecretString` values) are never exposed; the runtime treats both "missing key" and "secret-typed key" as identical `undefined` outcomes (no info disclosure via error code). For secret-resolving contexts (e.g. authorization headers in managed-call or file-proxy step configurations), use the templated `{{ env.<key> }}` syntax instead — that mechanism does decrypt secrets.
|
|
706
|
+
*
|
|
707
|
+
*/
|
|
708
|
+
export type EnvVarRefConfig = /**
|
|
709
|
+
* Resolves to an org-scoped environment variable from the epilot environments-api service at runtime, replacing hard-coded environment-specific values (URLs, prefixes, identifiers) in inbound mappings. Secrets (`SecretString` values) are never exposed; the runtime treats both "missing key" and "secret-typed key" as identical `undefined` outcomes (no info disclosure via error code). For secret-resolving contexts (e.g. authorization headers in managed-call or file-proxy step configurations), use the templated `{{ env.<key> }}` syntax instead — that mechanism does decrypt secrets.
|
|
710
|
+
*
|
|
711
|
+
*/
|
|
712
|
+
{
|
|
713
|
+
/**
|
|
714
|
+
* Environment variable key. Must match the environments-api key contract (lowercase, digits, `_`, `.`, `-`; max 128 chars; starts with a lowercase letter or digit). Supports dot-namespaced keys like `erp_api.base_url`.
|
|
715
|
+
*
|
|
716
|
+
*/
|
|
717
|
+
key: string; // ^[a-z0-9][a-z0-9_.-]{0,127}$
|
|
718
|
+
/**
|
|
719
|
+
* Literal string returned when the key is missing (or is a secret). When provided, the `ENV_VAR_REF_NOT_FOUND` warning is suppressed because the author signalled the absence is expected.
|
|
720
|
+
*
|
|
721
|
+
*/
|
|
722
|
+
default?: string;
|
|
723
|
+
/**
|
|
724
|
+
* `value` returns the resolved env-var string as-is.
|
|
725
|
+
*
|
|
726
|
+
*/
|
|
727
|
+
return?: "value";
|
|
728
|
+
} | {
|
|
729
|
+
key: string; // ^[a-z0-9][a-z0-9_.-]{0,127}$
|
|
730
|
+
default?: string;
|
|
731
|
+
/**
|
|
732
|
+
* Evaluate the sibling `jsonataExpression` against the resolved env-var value (the input `$` is the string value).
|
|
733
|
+
*
|
|
734
|
+
*/
|
|
735
|
+
return: "jsonata";
|
|
736
|
+
/**
|
|
737
|
+
* JSONata expression evaluated against the resolved env-var value.
|
|
738
|
+
*/
|
|
739
|
+
jsonataExpression: string;
|
|
740
|
+
};
|
|
704
741
|
export interface EnvironmentFieldConfig {
|
|
705
742
|
/**
|
|
706
743
|
* Environment variable key, used to look up the value in the Environments API.
|
|
@@ -876,6 +913,31 @@ declare namespace Components {
|
|
|
876
913
|
* Optional ID that identifies the specific request for debugging purposes
|
|
877
914
|
*/
|
|
878
915
|
correlation_id?: string;
|
|
916
|
+
/**
|
|
917
|
+
* Controls ordering and parallelism for this request's events.
|
|
918
|
+
*
|
|
919
|
+
* By default, all events for a given `integration_id` are processed
|
|
920
|
+
* **strictly in order, one at a time**. For high-volume integrations this
|
|
921
|
+
* can become a throughput bottleneck.
|
|
922
|
+
*
|
|
923
|
+
* Set `group_id` to opt into **parallel processing**:
|
|
924
|
+
* - Events sharing the same `group_id` are processed in the order received.
|
|
925
|
+
* - Events with different `group_id` values are processed in parallel.
|
|
926
|
+
*
|
|
927
|
+
* Typical usage is to derive `group_id` from a logical partition key in
|
|
928
|
+
* your payload — for example the customer ID, contract ID, or meter ID —
|
|
929
|
+
* so updates to the same business object remain ordered while unrelated
|
|
930
|
+
* objects are processed concurrently.
|
|
931
|
+
*
|
|
932
|
+
* Notes:
|
|
933
|
+
* - Up to 20 groups per integration are processed concurrently. Using
|
|
934
|
+
* more distinct values than that yields no additional parallelism.
|
|
935
|
+
* - Omit this field if strict per-integration ordering is required.
|
|
936
|
+
*
|
|
937
|
+
* example:
|
|
938
|
+
* customer-42
|
|
939
|
+
*/
|
|
940
|
+
group_id?: string;
|
|
879
941
|
/**
|
|
880
942
|
* List of ERP events to process
|
|
881
943
|
*/
|
|
@@ -1128,6 +1190,10 @@ declare namespace Components {
|
|
|
1128
1190
|
* Additional use-case-specific parameters expected in the download URL query string (beyond the required orgId, integrationId, and useCaseSlug or useCaseId)
|
|
1129
1191
|
*/
|
|
1130
1192
|
params?: FileProxyParam[];
|
|
1193
|
+
/**
|
|
1194
|
+
* Additional origins permitted to call /download for this use case (CORS, exact match). Portal origins are always allowed.
|
|
1195
|
+
*/
|
|
1196
|
+
allowed_origins?: string /* uri ^https?:// */[];
|
|
1131
1197
|
/**
|
|
1132
1198
|
* Ordered list of HTTP steps to execute to retrieve the file
|
|
1133
1199
|
*/
|
|
@@ -1166,6 +1232,10 @@ declare namespace Components {
|
|
|
1166
1232
|
* Description of the change that was made at this point in history
|
|
1167
1233
|
*/
|
|
1168
1234
|
change_description?: string;
|
|
1235
|
+
/**
|
|
1236
|
+
* User ID of the user who made the change that produced this history entry
|
|
1237
|
+
*/
|
|
1238
|
+
changed_by?: string;
|
|
1169
1239
|
/**
|
|
1170
1240
|
* ISO-8601 timestamp when the use case was originally created
|
|
1171
1241
|
*/
|
|
@@ -1502,6 +1572,10 @@ declare namespace Components {
|
|
|
1502
1572
|
* Description of the change that was made at this point in history
|
|
1503
1573
|
*/
|
|
1504
1574
|
change_description?: string;
|
|
1575
|
+
/**
|
|
1576
|
+
* User ID of the user who made the change that produced this history entry
|
|
1577
|
+
*/
|
|
1578
|
+
changed_by?: string;
|
|
1505
1579
|
/**
|
|
1506
1580
|
* ISO-8601 timestamp when the use case was originally created
|
|
1507
1581
|
*/
|
|
@@ -1726,6 +1800,16 @@ declare namespace Components {
|
|
|
1726
1800
|
*
|
|
1727
1801
|
*/
|
|
1728
1802
|
FileProxyUrlConfig;
|
|
1803
|
+
portal_ref?: /**
|
|
1804
|
+
* Resolves to a property of one of the calling organization's epilot portal configurations at runtime, replacing hard-coded environment-specific portal UUIDs in inbound mappings. Matched portals are sorted ascending by `(_created_at, portal_id)`; portals without `_created_at` sort first (treated as oldest). When `select: "single"` matches more than one portal, the resolver still returns the oldest match and emits a `PORTAL_REF_AMBIGUOUS` warning.
|
|
1805
|
+
*
|
|
1806
|
+
*/
|
|
1807
|
+
PortalRefConfig;
|
|
1808
|
+
env_var_ref?: /**
|
|
1809
|
+
* Resolves to an org-scoped environment variable from the epilot environments-api service at runtime, replacing hard-coded environment-specific values (URLs, prefixes, identifiers) in inbound mappings. Secrets (`SecretString` values) are never exposed; the runtime treats both "missing key" and "secret-typed key" as identical `undefined` outcomes (no info disclosure via error code). For secret-resolving contexts (e.g. authorization headers in managed-call or file-proxy step configurations), use the templated `{{ env.<key> }}` syntax instead — that mechanism does decrypt secrets.
|
|
1810
|
+
*
|
|
1811
|
+
*/
|
|
1812
|
+
EnvVarRefConfig;
|
|
1729
1813
|
}
|
|
1730
1814
|
export interface IntegrationFieldV1 {
|
|
1731
1815
|
/**
|
|
@@ -2084,6 +2168,10 @@ declare namespace Components {
|
|
|
2084
2168
|
* Description of the change that was made at this point in history
|
|
2085
2169
|
*/
|
|
2086
2170
|
change_description?: string;
|
|
2171
|
+
/**
|
|
2172
|
+
* User ID of the user who made the change that produced this history entry
|
|
2173
|
+
*/
|
|
2174
|
+
changed_by?: string;
|
|
2087
2175
|
/**
|
|
2088
2176
|
* ISO-8601 timestamp when the use case was originally created
|
|
2089
2177
|
*/
|
|
@@ -2198,7 +2286,7 @@ declare namespace Components {
|
|
|
2198
2286
|
};
|
|
2199
2287
|
};
|
|
2200
2288
|
/**
|
|
2201
|
-
* Meter reading attributes. Required: external_id, timestamp, source, value. `source` must be one of: ECP, ERP, 360, journey-submission. `reason` (optional) must be one of: regular, irregular, last, first, meter_change, contract_change, meter_adjustment (or empty/null).
|
|
2289
|
+
* Meter reading attributes. Required: external_id, timestamp, source, value. `timestamp` must be ISO 8601 — either `YYYY-MM-DD` or `YYYY-MM-DDTHH:mm:ss` (with optional fractional seconds and optional `Z` / `±HH:mm` timezone offset); non-ISO formats (e.g. `DD.MM.YYYY` or epoch numbers) are rejected and must be converted upstream via a `jsonataExpression` (e.g. `$fromMillis(...)`). Date-only values are normalized to midnight UTC and offset-less date-times are anchored to UTC before being forwarded to the metering API. `source` must be one of: ECP, ERP, 360, journey-submission. `reason` (optional) must be one of: regular, irregular, last, first, meter_change, contract_change, meter_adjustment (or empty/null).
|
|
2202
2290
|
*/
|
|
2203
2291
|
attributes: {
|
|
2204
2292
|
[name: string]: any;
|
|
@@ -2587,6 +2675,10 @@ declare namespace Components {
|
|
|
2587
2675
|
* Description of the change that was made at this point in history
|
|
2588
2676
|
*/
|
|
2589
2677
|
change_description?: string;
|
|
2678
|
+
/**
|
|
2679
|
+
* User ID of the user who made the change that produced this history entry
|
|
2680
|
+
*/
|
|
2681
|
+
changed_by?: string;
|
|
2590
2682
|
/**
|
|
2591
2683
|
* ISO-8601 timestamp when the use case was originally created
|
|
2592
2684
|
*/
|
|
@@ -2642,6 +2734,80 @@ declare namespace Components {
|
|
|
2642
2734
|
*/
|
|
2643
2735
|
conflicts?: OutboundConflict[];
|
|
2644
2736
|
}
|
|
2737
|
+
/**
|
|
2738
|
+
* Origin/type of an epilot portal configuration.
|
|
2739
|
+
*/
|
|
2740
|
+
export type PortalOrigin = "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL" | "B2B_PORTAL" | "ADDITIONAL_PORTAL";
|
|
2741
|
+
/**
|
|
2742
|
+
* Resolves to a property of one of the calling organization's epilot portal configurations at runtime, replacing hard-coded environment-specific portal UUIDs in inbound mappings. Matched portals are sorted ascending by `(_created_at, portal_id)`; portals without `_created_at` sort first (treated as oldest). When `select: "single"` matches more than one portal, the resolver still returns the oldest match and emits a `PORTAL_REF_AMBIGUOUS` warning.
|
|
2743
|
+
*
|
|
2744
|
+
*/
|
|
2745
|
+
export type PortalRefConfig = /**
|
|
2746
|
+
* Resolves to a property of one of the calling organization's epilot portal configurations at runtime, replacing hard-coded environment-specific portal UUIDs in inbound mappings. Matched portals are sorted ascending by `(_created_at, portal_id)`; portals without `_created_at` sort first (treated as oldest). When `select: "single"` matches more than one portal, the resolver still returns the oldest match and emits a `PORTAL_REF_AMBIGUOUS` warning.
|
|
2747
|
+
*
|
|
2748
|
+
*/
|
|
2749
|
+
{
|
|
2750
|
+
filter?: /**
|
|
2751
|
+
* Filter applied to the org's portal configurations before selection. All filters default to "match any" except `enabled` (default `true`) and `is_dummy` (default `false`). Set `enabled` or `is_dummy` to `null` to opt out of the default.
|
|
2752
|
+
*
|
|
2753
|
+
*/
|
|
2754
|
+
PortalRefFilter;
|
|
2755
|
+
/**
|
|
2756
|
+
* `single` returns one literal value (the oldest matching portal); `all` returns an array of literal values (0, 1, or many).
|
|
2757
|
+
*
|
|
2758
|
+
*/
|
|
2759
|
+
select?: "single" | "all";
|
|
2760
|
+
/**
|
|
2761
|
+
* Which portal field to emit.
|
|
2762
|
+
*/
|
|
2763
|
+
return?: "portal_id" | "origin" | "domain" | "name";
|
|
2764
|
+
} | {
|
|
2765
|
+
filter?: /**
|
|
2766
|
+
* Filter applied to the org's portal configurations before selection. All filters default to "match any" except `enabled` (default `true`) and `is_dummy` (default `false`). Set `enabled` or `is_dummy` to `null` to opt out of the default.
|
|
2767
|
+
*
|
|
2768
|
+
*/
|
|
2769
|
+
PortalRefFilter;
|
|
2770
|
+
select?: "single" | "all";
|
|
2771
|
+
/**
|
|
2772
|
+
* Evaluate the sibling `jsonataExpression` against the matched portal(s). With `select: "single"` the input is the matched PortalConfig object; with `select: "all"` it is the full filtered+sorted array.
|
|
2773
|
+
*
|
|
2774
|
+
*/
|
|
2775
|
+
return: "jsonata";
|
|
2776
|
+
/**
|
|
2777
|
+
* JSONata expression evaluated against the matched portal(s).
|
|
2778
|
+
*/
|
|
2779
|
+
jsonataExpression: string;
|
|
2780
|
+
};
|
|
2781
|
+
/**
|
|
2782
|
+
* Filter applied to the org's portal configurations before selection. All filters default to "match any" except `enabled` (default `true`) and `is_dummy` (default `false`). Set `enabled` or `is_dummy` to `null` to opt out of the default.
|
|
2783
|
+
*
|
|
2784
|
+
*/
|
|
2785
|
+
export interface PortalRefFilter {
|
|
2786
|
+
/**
|
|
2787
|
+
* Single origin or array of origins (matches if origin is in the array).
|
|
2788
|
+
*/
|
|
2789
|
+
origin?: /* Single origin or array of origins (matches if origin is in the array). */ /* Origin/type of an epilot portal configuration. */ PortalOrigin | /* Origin/type of an epilot portal configuration. */ PortalOrigin[];
|
|
2790
|
+
/**
|
|
2791
|
+
* Match portals with this `enabled` value. Default `true`. Set to `null` to ignore.
|
|
2792
|
+
*/
|
|
2793
|
+
enabled?: boolean | null;
|
|
2794
|
+
/**
|
|
2795
|
+
* Match portals with this `is_dummy` value. Default `false`. Set to `null` to ignore.
|
|
2796
|
+
*/
|
|
2797
|
+
is_dummy?: boolean | null;
|
|
2798
|
+
/**
|
|
2799
|
+
* Optional restriction on `is_epilot_domain`.
|
|
2800
|
+
*/
|
|
2801
|
+
is_epilot_domain?: boolean;
|
|
2802
|
+
/**
|
|
2803
|
+
* Exact match on the portal's `name`.
|
|
2804
|
+
*/
|
|
2805
|
+
name?: string;
|
|
2806
|
+
/**
|
|
2807
|
+
* Exact match on the portal's `domain`.
|
|
2808
|
+
*/
|
|
2809
|
+
domain?: string;
|
|
2810
|
+
}
|
|
2645
2811
|
/**
|
|
2646
2812
|
* Scope configuration for upsert-prune-scope modes.
|
|
2647
2813
|
* Defines how to find entities that should be pruned if not in the upsert payload.
|
|
@@ -3351,6 +3517,10 @@ declare namespace Components {
|
|
|
3351
3517
|
* Description of the change that was made at this point in history
|
|
3352
3518
|
*/
|
|
3353
3519
|
change_description?: string;
|
|
3520
|
+
/**
|
|
3521
|
+
* User ID of the user who made the change that produced this history entry
|
|
3522
|
+
*/
|
|
3523
|
+
changed_by?: string;
|
|
3354
3524
|
/**
|
|
3355
3525
|
* ISO-8601 timestamp when the use case was originally created
|
|
3356
3526
|
*/
|
|
@@ -3373,6 +3543,53 @@ declare namespace Components {
|
|
|
3373
3543
|
*/
|
|
3374
3544
|
SecureProxyUseCaseConfiguration;
|
|
3375
3545
|
}
|
|
3546
|
+
/**
|
|
3547
|
+
* Current whitelist state for a secure_proxy use case. vpc_mode is read-only
|
|
3548
|
+
* context so the UI can show the user what mode the pool is in.
|
|
3549
|
+
*
|
|
3550
|
+
*/
|
|
3551
|
+
export interface SecureProxyWhitelist {
|
|
3552
|
+
/**
|
|
3553
|
+
* VPC routing mode (read-only). `null` if not yet set.
|
|
3554
|
+
*/
|
|
3555
|
+
vpc_mode: "static_ip" | "secure_link";
|
|
3556
|
+
/**
|
|
3557
|
+
* Exact domain ("api.example.com") or wildcard prefix ("*.example.com").
|
|
3558
|
+
* Wildcards must have at least 2 labels in the suffix.
|
|
3559
|
+
*
|
|
3560
|
+
*/
|
|
3561
|
+
allowed_domains: string[];
|
|
3562
|
+
/**
|
|
3563
|
+
* CIDR-notation IP ranges, e.g. "10.0.0.0/24".
|
|
3564
|
+
*/
|
|
3565
|
+
allowed_ips: string[];
|
|
3566
|
+
}
|
|
3567
|
+
/**
|
|
3568
|
+
* Partial update for a secure_proxy whitelist. At least one of
|
|
3569
|
+
* `allowed_domains` or `allowed_ips` must be provided.
|
|
3570
|
+
*
|
|
3571
|
+
* Per-field semantics:
|
|
3572
|
+
* - **omitted** — the field is not modified; the stored value is preserved.
|
|
3573
|
+
* - **non-empty array** — the stored value is replaced with the supplied list.
|
|
3574
|
+
* - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is the
|
|
3575
|
+
* canonical way to remove all entries from a list. `null` is not accepted.
|
|
3576
|
+
*
|
|
3577
|
+
*/
|
|
3578
|
+
export interface SecureProxyWhitelistUpdate {
|
|
3579
|
+
/**
|
|
3580
|
+
* Exact domain ("api.example.com") or wildcard prefix ("*.example.com").
|
|
3581
|
+
* Wildcards must have at least 2 labels in the suffix.
|
|
3582
|
+
* Pass `[]` to clear all allowed domains.
|
|
3583
|
+
*
|
|
3584
|
+
*/
|
|
3585
|
+
allowed_domains?: string[];
|
|
3586
|
+
/**
|
|
3587
|
+
* CIDR-notation IP ranges, e.g. "10.0.0.0/24".
|
|
3588
|
+
* Pass `[]` to clear all allowed IPs.
|
|
3589
|
+
*
|
|
3590
|
+
*/
|
|
3591
|
+
allowed_ips?: string[];
|
|
3592
|
+
}
|
|
3376
3593
|
export interface SetIntegrationAppMappingRequest {
|
|
3377
3594
|
/**
|
|
3378
3595
|
* UUID of the integration app instance
|
|
@@ -3858,6 +4075,10 @@ declare namespace Components {
|
|
|
3858
4075
|
* Description of the change that was made at this point in history
|
|
3859
4076
|
*/
|
|
3860
4077
|
change_description?: string;
|
|
4078
|
+
/**
|
|
4079
|
+
* User ID of the user who made the change that produced this history entry
|
|
4080
|
+
*/
|
|
4081
|
+
changed_by?: string;
|
|
3861
4082
|
/**
|
|
3862
4083
|
* ISO-8601 timestamp when the use case was originally created
|
|
3863
4084
|
*/
|
|
@@ -4202,6 +4423,29 @@ declare namespace Paths {
|
|
|
4202
4423
|
export type $500 = Components.Responses.InternalServerError;
|
|
4203
4424
|
}
|
|
4204
4425
|
}
|
|
4426
|
+
namespace GetSecureProxyWhitelist {
|
|
4427
|
+
namespace Parameters {
|
|
4428
|
+
export type IntegrationId = string; // uuid
|
|
4429
|
+
export type UseCaseId = string; // uuid
|
|
4430
|
+
}
|
|
4431
|
+
export interface PathParameters {
|
|
4432
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
4433
|
+
useCaseId: Parameters.UseCaseId /* uuid */;
|
|
4434
|
+
}
|
|
4435
|
+
namespace Responses {
|
|
4436
|
+
export type $200 = /**
|
|
4437
|
+
* Current whitelist state for a secure_proxy use case. vpc_mode is read-only
|
|
4438
|
+
* context so the UI can show the user what mode the pool is in.
|
|
4439
|
+
*
|
|
4440
|
+
*/
|
|
4441
|
+
Components.Schemas.SecureProxyWhitelist;
|
|
4442
|
+
export type $400 = Components.Responses.BadRequest;
|
|
4443
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
4444
|
+
export type $403 = Components.Responses.Forbidden;
|
|
4445
|
+
export interface $404 {
|
|
4446
|
+
}
|
|
4447
|
+
}
|
|
4448
|
+
}
|
|
4205
4449
|
namespace GetUseCase {
|
|
4206
4450
|
namespace Parameters {
|
|
4207
4451
|
export type IntegrationId = string; // uuid
|
|
@@ -4246,6 +4490,37 @@ declare namespace Paths {
|
|
|
4246
4490
|
export type $500 = Components.Responses.InternalServerError;
|
|
4247
4491
|
}
|
|
4248
4492
|
}
|
|
4493
|
+
namespace ListSecureProxyWhitelistHistory {
|
|
4494
|
+
namespace Parameters {
|
|
4495
|
+
export type IntegrationId = string; // uuid
|
|
4496
|
+
export type Limit = number;
|
|
4497
|
+
export type UseCaseId = string; // uuid
|
|
4498
|
+
}
|
|
4499
|
+
export interface PathParameters {
|
|
4500
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
4501
|
+
useCaseId: Parameters.UseCaseId /* uuid */;
|
|
4502
|
+
}
|
|
4503
|
+
export interface QueryParameters {
|
|
4504
|
+
limit?: Parameters.Limit;
|
|
4505
|
+
}
|
|
4506
|
+
namespace Responses {
|
|
4507
|
+
export interface $200 {
|
|
4508
|
+
/**
|
|
4509
|
+
* Entries are `SecureProxyUseCaseHistoryEntry` in reverse
|
|
4510
|
+
* chronological order (newest first). Entries older than the
|
|
4511
|
+
* requested `limit` are not returned.
|
|
4512
|
+
*
|
|
4513
|
+
*/
|
|
4514
|
+
history: Components.Schemas.SecureProxyUseCaseHistoryEntry[];
|
|
4515
|
+
}
|
|
4516
|
+
export type $400 = Components.Responses.BadRequest;
|
|
4517
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
4518
|
+
export type $403 = Components.Responses.Forbidden;
|
|
4519
|
+
export interface $404 {
|
|
4520
|
+
}
|
|
4521
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
4522
|
+
}
|
|
4523
|
+
}
|
|
4249
4524
|
namespace ListUseCaseHistory {
|
|
4250
4525
|
namespace Parameters {
|
|
4251
4526
|
export type Cursor = string;
|
|
@@ -4569,6 +4844,41 @@ declare namespace Paths {
|
|
|
4569
4844
|
export type $500 = Components.Responses.InternalServerError;
|
|
4570
4845
|
}
|
|
4571
4846
|
}
|
|
4847
|
+
namespace UpdateSecureProxyWhitelist {
|
|
4848
|
+
namespace Parameters {
|
|
4849
|
+
export type IntegrationId = string; // uuid
|
|
4850
|
+
export type UseCaseId = string; // uuid
|
|
4851
|
+
}
|
|
4852
|
+
export interface PathParameters {
|
|
4853
|
+
integrationId: Parameters.IntegrationId /* uuid */;
|
|
4854
|
+
useCaseId: Parameters.UseCaseId /* uuid */;
|
|
4855
|
+
}
|
|
4856
|
+
export type RequestBody = /**
|
|
4857
|
+
* Partial update for a secure_proxy whitelist. At least one of
|
|
4858
|
+
* `allowed_domains` or `allowed_ips` must be provided.
|
|
4859
|
+
*
|
|
4860
|
+
* Per-field semantics:
|
|
4861
|
+
* - **omitted** — the field is not modified; the stored value is preserved.
|
|
4862
|
+
* - **non-empty array** — the stored value is replaced with the supplied list.
|
|
4863
|
+
* - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is the
|
|
4864
|
+
* canonical way to remove all entries from a list. `null` is not accepted.
|
|
4865
|
+
*
|
|
4866
|
+
*/
|
|
4867
|
+
Components.Schemas.SecureProxyWhitelistUpdate;
|
|
4868
|
+
namespace Responses {
|
|
4869
|
+
export type $200 = /**
|
|
4870
|
+
* Current whitelist state for a secure_proxy use case. vpc_mode is read-only
|
|
4871
|
+
* context so the UI can show the user what mode the pool is in.
|
|
4872
|
+
*
|
|
4873
|
+
*/
|
|
4874
|
+
Components.Schemas.SecureProxyWhitelist;
|
|
4875
|
+
export type $400 = Components.Responses.BadRequest;
|
|
4876
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
4877
|
+
export type $403 = Components.Responses.Forbidden;
|
|
4878
|
+
export interface $404 {
|
|
4879
|
+
}
|
|
4880
|
+
}
|
|
4881
|
+
}
|
|
4572
4882
|
namespace UpdateUseCase {
|
|
4573
4883
|
namespace Parameters {
|
|
4574
4884
|
export type IntegrationId = string; // uuid
|
|
@@ -4868,6 +5178,66 @@ interface OperationMethods {
|
|
|
4868
5178
|
data?: any,
|
|
4869
5179
|
config?: AxiosRequestConfig
|
|
4870
5180
|
): OperationResponse<Paths.DeleteIntegrationV2.Responses.$200>
|
|
5181
|
+
/**
|
|
5182
|
+
* getSecureProxyWhitelist - Get secure_proxy whitelist (admin portal only)
|
|
5183
|
+
*
|
|
5184
|
+
* Returns the current allowed_domains, allowed_ips, and vpc_mode for a secure_proxy use case.
|
|
5185
|
+
* Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool membership.
|
|
5186
|
+
* Rejects Login-As tokens.
|
|
5187
|
+
*
|
|
5188
|
+
*/
|
|
5189
|
+
'getSecureProxyWhitelist'(
|
|
5190
|
+
parameters?: Parameters<Paths.GetSecureProxyWhitelist.PathParameters> | null,
|
|
5191
|
+
data?: any,
|
|
5192
|
+
config?: AxiosRequestConfig
|
|
5193
|
+
): OperationResponse<Paths.GetSecureProxyWhitelist.Responses.$200>
|
|
5194
|
+
/**
|
|
5195
|
+
* updateSecureProxyWhitelist - Update secure_proxy whitelist (admin portal only)
|
|
5196
|
+
*
|
|
5197
|
+
* Replaces allowed_domains and/or allowed_ips on a secure_proxy use case.
|
|
5198
|
+
* At least one of the two fields is required. Validation mirrors the CLI's
|
|
5199
|
+
* `validateDomainPatterns` / `validateCidrs`. Writes a USECASE_HISTORY row
|
|
5200
|
+
* with the admin user's email as `changed_by`.
|
|
5201
|
+
*
|
|
5202
|
+
* Update semantics per field:
|
|
5203
|
+
* - **omitted** — field is not modified; the stored value is preserved.
|
|
5204
|
+
* - **non-empty array** — the stored value is replaced with the supplied list.
|
|
5205
|
+
* - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is
|
|
5206
|
+
* the canonical way to remove all entries. `null` is not accepted.
|
|
5207
|
+
*
|
|
5208
|
+
* Staff-only — same auth gates as GET.
|
|
5209
|
+
*
|
|
5210
|
+
*/
|
|
5211
|
+
'updateSecureProxyWhitelist'(
|
|
5212
|
+
parameters?: Parameters<Paths.UpdateSecureProxyWhitelist.PathParameters> | null,
|
|
5213
|
+
data?: Paths.UpdateSecureProxyWhitelist.RequestBody,
|
|
5214
|
+
config?: AxiosRequestConfig
|
|
5215
|
+
): OperationResponse<Paths.UpdateSecureProxyWhitelist.Responses.$200>
|
|
5216
|
+
/**
|
|
5217
|
+
* listSecureProxyWhitelistHistory - List secure_proxy whitelist change history (admin portal only)
|
|
5218
|
+
*
|
|
5219
|
+
* Returns the most recent USECASE_HISTORY entries for a secure_proxy use case,
|
|
5220
|
+
* in reverse chronological order (newest first). Each entry includes the
|
|
5221
|
+
* actor email (`changed_by`), the ISO-8601 timestamp (`history_created_at`),
|
|
5222
|
+
* the `change_description` (free-text action), and the full `configuration`
|
|
5223
|
+
* snapshot — from which UI-08 computes a before/after diff between consecutive
|
|
5224
|
+
* entries.
|
|
5225
|
+
*
|
|
5226
|
+
* Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool
|
|
5227
|
+
* membership. Rejects Login-As tokens (same auth gate as the GET / PUT
|
|
5228
|
+
* secure-proxy-whitelist operations).
|
|
5229
|
+
*
|
|
5230
|
+
* Thin wrapper over the service-layer `listUseCaseHistory` that powers
|
|
5231
|
+
* `GET /v1/integrations/{integrationId}/use-cases/{useCaseId}/history` — the
|
|
5232
|
+
* separate path exists because the /v1 variant is tenant-gated and admin-portal
|
|
5233
|
+
* internal-auth tokens do not carry tenant permissions.
|
|
5234
|
+
*
|
|
5235
|
+
*/
|
|
5236
|
+
'listSecureProxyWhitelistHistory'(
|
|
5237
|
+
parameters?: Parameters<Paths.ListSecureProxyWhitelistHistory.QueryParameters & Paths.ListSecureProxyWhitelistHistory.PathParameters> | null,
|
|
5238
|
+
data?: any,
|
|
5239
|
+
config?: AxiosRequestConfig
|
|
5240
|
+
): OperationResponse<Paths.ListSecureProxyWhitelistHistory.Responses.$200>
|
|
4871
5241
|
/**
|
|
4872
5242
|
* setIntegrationAppMapping - setIntegrationAppMapping
|
|
4873
5243
|
*
|
|
@@ -5400,6 +5770,70 @@ interface PathsDictionary {
|
|
|
5400
5770
|
config?: AxiosRequestConfig
|
|
5401
5771
|
): OperationResponse<Paths.DeleteIntegrationV2.Responses.$200>
|
|
5402
5772
|
}
|
|
5773
|
+
['/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist']: {
|
|
5774
|
+
/**
|
|
5775
|
+
* getSecureProxyWhitelist - Get secure_proxy whitelist (admin portal only)
|
|
5776
|
+
*
|
|
5777
|
+
* Returns the current allowed_domains, allowed_ips, and vpc_mode for a secure_proxy use case.
|
|
5778
|
+
* Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool membership.
|
|
5779
|
+
* Rejects Login-As tokens.
|
|
5780
|
+
*
|
|
5781
|
+
*/
|
|
5782
|
+
'get'(
|
|
5783
|
+
parameters?: Parameters<Paths.GetSecureProxyWhitelist.PathParameters> | null,
|
|
5784
|
+
data?: any,
|
|
5785
|
+
config?: AxiosRequestConfig
|
|
5786
|
+
): OperationResponse<Paths.GetSecureProxyWhitelist.Responses.$200>
|
|
5787
|
+
/**
|
|
5788
|
+
* updateSecureProxyWhitelist - Update secure_proxy whitelist (admin portal only)
|
|
5789
|
+
*
|
|
5790
|
+
* Replaces allowed_domains and/or allowed_ips on a secure_proxy use case.
|
|
5791
|
+
* At least one of the two fields is required. Validation mirrors the CLI's
|
|
5792
|
+
* `validateDomainPatterns` / `validateCidrs`. Writes a USECASE_HISTORY row
|
|
5793
|
+
* with the admin user's email as `changed_by`.
|
|
5794
|
+
*
|
|
5795
|
+
* Update semantics per field:
|
|
5796
|
+
* - **omitted** — field is not modified; the stored value is preserved.
|
|
5797
|
+
* - **non-empty array** — the stored value is replaced with the supplied list.
|
|
5798
|
+
* - **empty array (`[]`)** — the list is cleared (stored as `[]`). This is
|
|
5799
|
+
* the canonical way to remove all entries. `null` is not accepted.
|
|
5800
|
+
*
|
|
5801
|
+
* Staff-only — same auth gates as GET.
|
|
5802
|
+
*
|
|
5803
|
+
*/
|
|
5804
|
+
'put'(
|
|
5805
|
+
parameters?: Parameters<Paths.UpdateSecureProxyWhitelist.PathParameters> | null,
|
|
5806
|
+
data?: Paths.UpdateSecureProxyWhitelist.RequestBody,
|
|
5807
|
+
config?: AxiosRequestConfig
|
|
5808
|
+
): OperationResponse<Paths.UpdateSecureProxyWhitelist.Responses.$200>
|
|
5809
|
+
}
|
|
5810
|
+
['/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist/history']: {
|
|
5811
|
+
/**
|
|
5812
|
+
* listSecureProxyWhitelistHistory - List secure_proxy whitelist change history (admin portal only)
|
|
5813
|
+
*
|
|
5814
|
+
* Returns the most recent USECASE_HISTORY entries for a secure_proxy use case,
|
|
5815
|
+
* in reverse chronological order (newest first). Each entry includes the
|
|
5816
|
+
* actor email (`changed_by`), the ISO-8601 timestamp (`history_created_at`),
|
|
5817
|
+
* the `change_description` (free-text action), and the full `configuration`
|
|
5818
|
+
* snapshot — from which UI-08 computes a before/after diff between consecutive
|
|
5819
|
+
* entries.
|
|
5820
|
+
*
|
|
5821
|
+
* Staff-only — gated by internal-auth issuer AND admin-portal Cognito user pool
|
|
5822
|
+
* membership. Rejects Login-As tokens (same auth gate as the GET / PUT
|
|
5823
|
+
* secure-proxy-whitelist operations).
|
|
5824
|
+
*
|
|
5825
|
+
* Thin wrapper over the service-layer `listUseCaseHistory` that powers
|
|
5826
|
+
* `GET /v1/integrations/{integrationId}/use-cases/{useCaseId}/history` — the
|
|
5827
|
+
* separate path exists because the /v1 variant is tenant-gated and admin-portal
|
|
5828
|
+
* internal-auth tokens do not carry tenant permissions.
|
|
5829
|
+
*
|
|
5830
|
+
*/
|
|
5831
|
+
'get'(
|
|
5832
|
+
parameters?: Parameters<Paths.ListSecureProxyWhitelistHistory.QueryParameters & Paths.ListSecureProxyWhitelistHistory.PathParameters> | null,
|
|
5833
|
+
data?: any,
|
|
5834
|
+
config?: AxiosRequestConfig
|
|
5835
|
+
): OperationResponse<Paths.ListSecureProxyWhitelistHistory.Responses.$200>
|
|
5836
|
+
}
|
|
5403
5837
|
['/v1/integrations/{integrationId}/app-mapping']: {
|
|
5404
5838
|
/**
|
|
5405
5839
|
* setIntegrationAppMapping - setIntegrationAppMapping
|
|
@@ -5683,6 +6117,7 @@ type EmbeddedSecureProxyUseCaseRequest = Components.Schemas.EmbeddedSecureProxyU
|
|
|
5683
6117
|
type EmbeddedUseCaseRequest = Components.Schemas.EmbeddedUseCaseRequest;
|
|
5684
6118
|
type EmbeddedUseCaseRequestBase = Components.Schemas.EmbeddedUseCaseRequestBase;
|
|
5685
6119
|
type EntityUpdate = Components.Schemas.EntityUpdate;
|
|
6120
|
+
type EnvVarRefConfig = Components.Schemas.EnvVarRefConfig;
|
|
5686
6121
|
type EnvironmentFieldConfig = Components.Schemas.EnvironmentFieldConfig;
|
|
5687
6122
|
type ErpEvent = Components.Schemas.ErpEvent;
|
|
5688
6123
|
type ErpEventV3 = Components.Schemas.ErpEventV3;
|
|
@@ -5749,6 +6184,9 @@ type OutboundStatusResponse = Components.Schemas.OutboundStatusResponse;
|
|
|
5749
6184
|
type OutboundUseCase = Components.Schemas.OutboundUseCase;
|
|
5750
6185
|
type OutboundUseCaseHistoryEntry = Components.Schemas.OutboundUseCaseHistoryEntry;
|
|
5751
6186
|
type OutboundUseCaseStatus = Components.Schemas.OutboundUseCaseStatus;
|
|
6187
|
+
type PortalOrigin = Components.Schemas.PortalOrigin;
|
|
6188
|
+
type PortalRefConfig = Components.Schemas.PortalRefConfig;
|
|
6189
|
+
type PortalRefFilter = Components.Schemas.PortalRefFilter;
|
|
5752
6190
|
type PruneScopeConfig = Components.Schemas.PruneScopeConfig;
|
|
5753
6191
|
type QueryAccessLogsRequest = Components.Schemas.QueryAccessLogsRequest;
|
|
5754
6192
|
type QueryEventsRequest = Components.Schemas.QueryEventsRequest;
|
|
@@ -5769,6 +6207,8 @@ type SecureProxySummary = Components.Schemas.SecureProxySummary;
|
|
|
5769
6207
|
type SecureProxyUseCase = Components.Schemas.SecureProxyUseCase;
|
|
5770
6208
|
type SecureProxyUseCaseConfiguration = Components.Schemas.SecureProxyUseCaseConfiguration;
|
|
5771
6209
|
type SecureProxyUseCaseHistoryEntry = Components.Schemas.SecureProxyUseCaseHistoryEntry;
|
|
6210
|
+
type SecureProxyWhitelist = Components.Schemas.SecureProxyWhitelist;
|
|
6211
|
+
type SecureProxyWhitelistUpdate = Components.Schemas.SecureProxyWhitelistUpdate;
|
|
5772
6212
|
type SetIntegrationAppMappingRequest = Components.Schemas.SetIntegrationAppMappingRequest;
|
|
5773
6213
|
type TimeSeriesBreakdownItemV2 = Components.Schemas.TimeSeriesBreakdownItemV2;
|
|
5774
6214
|
type TimeSeriesBucket = Components.Schemas.TimeSeriesBucket;
|
|
@@ -5793,4 +6233,4 @@ type UseCaseHistoryEntryBase = Components.Schemas.UseCaseHistoryEntryBase;
|
|
|
5793
6233
|
type UseCaseTypePreview = Components.Schemas.UseCaseTypePreview;
|
|
5794
6234
|
type WebhookStatus = Components.Schemas.WebhookStatus;
|
|
5795
6235
|
|
|
5796
|
-
export { type
|
|
6236
|
+
export { type InboundIntegrationEventConfiguration as $, type AccessLogEntry as A, type ErpUpdatesEventsV2Request as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type ErpUpdatesEventsV3Request as F, type ErrorResponseBase as G, type FileProxyAuth as H, type FileProxyParam as I, type FileProxyResponseConfig as J, type FileProxySecureProxyAttachment as K, type FileProxyStep as L, type FileProxyUrlConfig as M, type FileProxyUrlParam as N, type OperationMethods as O, Paths as P, type FileProxyUrlParams as Q, type FileProxyUseCase as R, type FileProxyUseCaseConfiguration as S, type FileProxyUseCaseHistoryEntry as T, type GenerateTypesPreviewResponse as U, type GenerateTypesRequest as V, type GenerateTypesResponse as W, type GetMonitoringStatsRequest as X, type GetMonitoringStatsV2Request as Y, type GetMonitoringTimeSeriesRequest as Z, type GetMonitoringTimeSeriesV2Request as _, Components as a, type SecureProxyUseCaseHistoryEntry as a$, type InboundMonitoringEvent as a0, type InboundUseCase as a1, type InboundUseCaseHistoryEntry as a2, type Integration as a3, type IntegrationAppMapping as a4, type IntegrationConfigurationV1 as a5, type IntegrationConfigurationV2 as a6, type IntegrationEditableFields as a7, type IntegrationEntity as a8, type IntegrationEntityField as a9, type OutboundMonitoringEvent as aA, type OutboundStatusResponse as aB, type OutboundUseCase as aC, type OutboundUseCaseHistoryEntry as aD, type OutboundUseCaseStatus as aE, type PortalOrigin as aF, type PortalRefConfig as aG, type PortalRefFilter as aH, type PruneScopeConfig as aI, type QueryAccessLogsRequest as aJ, type QueryEventsRequest as aK, type QueryInboundMonitoringEventsRequest as aL, type QueryMonitoringEventsV2Request as aM, type QueryOutboundMonitoringEventsRequest as aN, type RelationConfig as aO, type RelationItemConfig as aP, type RelationRefItemConfig as aQ, type RelationRefValueConfig as aR, type RelationRefsConfig as aS, type RelationUniqueIdField as aT, type RepeatableFieldType as aU, type ReplayEventsRequest as aV, type SecureProxyRequest as aW, type SecureProxyResponse as aX, type SecureProxySummary as aY, type SecureProxyUseCase as aZ, type SecureProxyUseCaseConfiguration as a_, type IntegrationFieldV1 as aa, type IntegrationMeterReading as ab, type IntegrationObjectV1 as ac, type IntegrationSettings as ad, type IntegrationWithUseCases as ae, type ManagedCallAuth as af, type ManagedCallErrorResponse as ag, type ManagedCallExecuteRequest as ah, type ManagedCallExecuteResponse as ai, type ManagedCallOperation as aj, type ManagedCallOperationConfig as ak, type ManagedCallUseCase as al, type ManagedCallUseCaseHistoryEntry as am, type MappingSimulationRequest as an, type MappingSimulationResponse as ao, type MappingSimulationV2Request as ap, type MappingSimulationWarning as aq, type MeterReadingPruneScopeConfig as ar, type MeterReadingUpdate as as, type MeterUniqueIdsConfig as at, type MonitoringEventV2 as au, type MonitoringStats as av, type MonitoringStatsV2 as aw, type OutboundConflict as ax, type OutboundIntegrationEventConfiguration as ay, type OutboundMapping as az, type PathsDictionary as b, type SecureProxyWhitelist as b0, type SecureProxyWhitelistUpdate as b1, type SetIntegrationAppMappingRequest as b2, type TimeSeriesBreakdownItemV2 as b3, type TimeSeriesBucket as b4, type TimeSeriesBucketV2 as b5, type TriggerErpActionRequest as b6, type TriggerWebhookResp as b7, type TypeAnnotations as b8, type TypeDescriptor as b9, type UpdateFileProxyUseCaseRequest as ba, type UpdateInboundUseCaseRequest as bb, type UpdateIntegrationRequest as bc, type UpdateManagedCallUseCaseRequest as bd, type UpdateOutboundUseCaseRequest as be, type UpdateSecureProxyUseCaseRequest as bf, type UpdateUseCaseRequest as bg, type UpdateUseCaseRequestBase as bh, type UpsertIntegrationWithUseCasesRequest as bi, type UseCase as bj, type UseCaseBase as bk, type UseCaseHistoryEntry as bl, type UseCaseHistoryEntryBase as bm, type UseCaseTypePreview as bn, type WebhookStatus as bo, type AutoRefreshSettings as c, type CommitTypesRequest as d, type CommitTypesResponse as e, type ConnectorConfig as f, type CreateFileProxyUseCaseRequest as g, type CreateInboundUseCaseRequest as h, type CreateIntegrationRequest as i, type CreateManagedCallUseCaseRequest as j, type CreateOutboundUseCaseRequest as k, type CreateSecureProxyUseCaseRequest as l, type CreateUseCaseRequest as m, type CreateUseCaseRequestBase as n, type DeliveryConfig as o, type EmbeddedInboundUseCaseRequest as p, type EmbeddedManagedCallUseCaseRequest as q, type EmbeddedOutboundUseCaseRequest as r, type EmbeddedSecureProxyUseCaseRequest as s, type EmbeddedUseCaseRequest as t, type EmbeddedUseCaseRequestBase as u, type EntityUpdate as v, type EnvVarRefConfig as w, type EnvironmentFieldConfig as x, type ErpEvent as y, type ErpEventV3 as z };
|