@epilot/sdk 2.17.0 → 2.18.0

package/dist/{integration-toolkit.d-BkWRJ8Xm.d.cts → integration-toolkit.d-D5HZSNUf.d.cts}

@@ -1728,6 +1728,50 @@ declare namespace Components {
              */
             change_description?: string;
         }
+        /**
+         * A resolved entity prune scope. At runtime, entities of `entity_slug` found within `scope` whose unique identifiers are not listed in `keep_unique_ids` are removed using `deletion_mode`.
+         */
+        export interface EntityPruneScopeUpdate {
+            /**
+             * The entity type that would be pruned
+             */
+            entity_slug: string;
+            /**
+             * The scope configuration resolved against the payload
+             */
+            scope: {
+                /**
+                 * How the entities in scope are found
+                 */
+                scope_mode: "relations" | "query";
+                /**
+                 * Schema of the related entity defining the scope (`relations` scope_mode only)
+                 */
+                schema?: string;
+                /**
+                 * Resolved unique identifiers of the related scope entity (`relations` scope_mode only)
+                 */
+                unique_ids?: {
+                    [name: string]: any;
+                };
+                /**
+                 * Resolved query parameters used to find entities in scope (`query` scope_mode only)
+                 */
+                query?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Unique identifiers of the entities upserted by this payload. Everything else found in scope would be deleted.
+             */
+            keep_unique_ids: {
+                [name: string]: any;
+            }[];
+            /**
+             * `delete` soft deletes the pruned entities, `purge` removes them permanently
+             */
+            deletion_mode: "delete" | "purge";
+        }
         export interface EntityUpdate {
             /**
              * The entity type slug
@@ -1745,6 +1789,27 @@ declare namespace Components {
             attributes: {
                 [name: string]: any;
             };
+            /**
+             * Present when the entity mapping has a `pricing` block. Echoes the pricing configuration and the data extracted for it, so mapping authors can see what would be sent to the pricing service.
+             */
+            pricing?: {
+                /**
+                 * The pricing configuration from the entity mapping
+                 */
+                config: {
+                    [name: string]: any;
+                };
+                /**
+                 * The pricing input data extracted from the payload
+                 */
+                data: {
+                    [name: string]: any;
+                }[];
+            };
+            /**
+             * Effective operation mode applied to this entity at runtime. `upsert-prune-scope-purge` / `upsert-prune-scope-delete` configurations report `upsert` here, because the individual entities in the payload are upserted — the destructive part of those modes is reported separately in `prune_scope_updates`. For `delete` / `purge`, `attributes` are still mapped and returned but ignored at runtime: only `unique_identifiers` are used to locate the entity to remove.
+             */
+            mode: "upsert" | "delete" | "purge";
         }
         /**
          * 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.
@@ -4013,6 +4078,14 @@ declare namespace Components {
         export interface MappingSimulationResponse {
             entity_updates: EntityUpdate[];
             meter_readings_updates?: MeterReadingUpdate[];
+            /**
+             * Resolved prune scopes produced by entity mappings using `upsert-prune-scope-purge` / `upsert-prune-scope-delete`. Each entry describes the entities that would be deleted at runtime because they exist in scope but were not part of this payload.
+             */
+            prune_scope_updates?: /* A resolved entity prune scope. At runtime, entities of `entity_slug` found within `scope` whose unique identifiers are not listed in `keep_unique_ids` are removed using `deletion_mode`. */ EntityPruneScopeUpdate[];
+            /**
+             * Resolved prune scopes produced by meter reading mappings using `upsert-prune-scope`. Each entry describes the readings that would be deleted at runtime for a meter (+ counter) because they were not part of this payload.
+             */
+            meter_readings_prune_scope_updates?: /* A resolved meter reading prune scope. At runtime, readings of the given meter (+ counter) whose external ids are not listed in `keep_external_ids` are deleted. */ MeterReadingPruneScopeUpdate[];
             /**
              * Validation warnings about the configuration (e.g., unique_ids referencing non-indexed fields)
              */
@@ -4063,6 +4136,35 @@ declare namespace Components {
              */
             source?: string;
         }
+        /**
+         * A resolved meter reading prune scope. At runtime, readings of the given meter (+ counter) whose external ids are not listed in `keep_external_ids` are deleted.
+         */
+        export interface MeterReadingPruneScopeUpdate {
+            meter: {
+                /**
+                 * Unique identifiers for the meter
+                 */
+                $entity_unique_ids: {
+                    [name: string]: any;
+                };
+            };
+            meter_counter?: {
+                /**
+                 * Unique identifiers for the meter counter
+                 */
+                $entity_unique_ids?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * External ids of the readings present in this payload. All other readings in scope would be deleted. An empty array means every reading in scope would be deleted.
+             */
+            keep_external_ids: string[];
+            /**
+             * When set, only readings with this source are eligible for pruning (e.g. `ERP`)
+             */
+            source?: string;
+        }
         export interface MeterReadingUpdate {
             meter: {
                 /**
@@ -4086,6 +4188,10 @@ declare namespace Components {
             attributes: {
                 [name: string]: any;
             };
+            /**
+             * Effective operation mode applied to this reading at runtime. `upsert-prune-scope` configurations report `upsert` here — their destructive part is reported separately in `meter_readings_prune_scope_updates`.
+             */
+            mode: "upsert" | "delete";
         }
         export interface MeterUniqueIdsConfig {
             /**
@@ -9364,6 +9470,7 @@ type EmbeddedOutboundUseCaseRequest = Components.Schemas.EmbeddedOutboundUseCase
 type EmbeddedSecureProxyUseCaseRequest = Components.Schemas.EmbeddedSecureProxyUseCaseRequest;
 type EmbeddedUseCaseRequest = Components.Schemas.EmbeddedUseCaseRequest;
 type EmbeddedUseCaseRequestBase = Components.Schemas.EmbeddedUseCaseRequestBase;
+type EntityPruneScopeUpdate = Components.Schemas.EntityPruneScopeUpdate;
 type EntityUpdate = Components.Schemas.EntityUpdate;
 type EnvVarRefConfig = Components.Schemas.EnvVarRefConfig;
 type EnvironmentFieldConfig = Components.Schemas.EnvironmentFieldConfig;
@@ -9428,6 +9535,7 @@ type MappingSimulationResponse = Components.Schemas.MappingSimulationResponse;
 type MappingSimulationV2Request = Components.Schemas.MappingSimulationV2Request;
 type MappingSimulationWarning = Components.Schemas.MappingSimulationWarning;
 type MeterReadingPruneScopeConfig = Components.Schemas.MeterReadingPruneScopeConfig;
+type MeterReadingPruneScopeUpdate = Components.Schemas.MeterReadingPruneScopeUpdate;
 type MeterReadingUpdate = Components.Schemas.MeterReadingUpdate;
 type MeterUniqueIdsConfig = Components.Schemas.MeterUniqueIdsConfig;
 type MonitoringEventV2 = Components.Schemas.MonitoringEventV2;
@@ -9518,4 +9626,4 @@ type UseCaseTypePreview = Components.Schemas.UseCaseTypePreview;
 type WebhookDeliveryConfig = Components.Schemas.WebhookDeliveryConfig;
 type WebhookStatus = Components.Schemas.WebhookStatus;
 
-export { type FileProxyUrlParams as $, type AccessLogEntry as A, type EntityUpdate as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type EnvVarRefConfig as F, type EnvironmentFieldConfig as G, type ErpEvent as H, type ErpEventV3 as I, type ErpImportError as J, type ErpImportJob as K, type ErpImportList as L, type ErpImportProgress as M, type ErpImportValidation as N, type OperationMethods as O, Paths as P, type ErpUpdatesEventsV2Request as Q, type ErpUpdatesEventsV3Request as R, type ErrorResponseBase as S, type ExternalMonitoringSpan as T, type FileProxyAuth as U, type FileProxyParam as V, type FileProxyResponseConfig as W, type FileProxySecureProxyAttachment as X, type FileProxyStep as Y, type FileProxyUrlConfig as Z, type FileProxyUrlParam as _, Components as a, type OutboundPollStatus as a$, type FileProxyUseCase as a0, type FileProxyUseCaseConfiguration as a1, type FileProxyUseCaseHistoryEntry as a2, type GenerateTypesPreviewResponse as a3, type GenerateTypesRequest as a4, type GenerateTypesResponse as a5, type GetMonitoringStatsRequest as a6, type GetMonitoringStatsV2Request as a7, type GetMonitoringTimeSeriesRequest as a8, type GetMonitoringTimeSeriesV2Request as a9, type ManagedCallUseCaseHistoryEntry as aA, type MappingSimulationRequest as aB, type MappingSimulationResponse as aC, type MappingSimulationV2Request as aD, type MappingSimulationWarning as aE, type MeterReadingPruneScopeConfig as aF, type MeterReadingUpdate as aG, type MeterUniqueIdsConfig as aH, type MonitoringEventV2 as aI, type MonitoringStats as aJ, type MonitoringStatsV2 as aK, type MonitoringTraceResponse as aL, type NotificationChannelSet as aM, type NotificationDigestConfig as aN, type NotificationHistoryItem as aO, type NotificationHistoryResponse as aP, type NotificationRecipient as aQ, type NotificationRule as aR, type NotificationRuleStatus as aS, type NotificationStatusResponse as aT, type OutboundConflict as aU, type OutboundDlqListResponse as aV, type OutboundDlqMessage as aW, type OutboundIntegrationEventConfiguration as aX, type OutboundMapping as aY, type OutboundMessage as aZ, type OutboundMonitoringEvent as a_, type InboundIntegrationEventConfiguration as aa, type InboundMonitoringEvent as ab, type InboundUseCase as ac, type InboundUseCaseHistoryEntry as ad, type IngestExternalMonitoringEventsRequest as ae, type IngestExternalMonitoringEventsResponse as af, type Integration as ag, type IntegrationAppMapping as ah, type IntegrationConfigurationV1 as ai, type IntegrationConfigurationV2 as aj, type IntegrationEditableFields as ak, type IntegrationEntity as al, type IntegrationEntityField as am, type IntegrationFieldV1 as an, type IntegrationMeterReading as ao, type IntegrationNotificationConfig as ap, type IntegrationObjectV1 as aq, type IntegrationSettings as ar, type IntegrationWithUseCases as as, type ManagedCallAuth as at, type ManagedCallErrorResponse as au, type ManagedCallExecuteRequest as av, type ManagedCallExecuteResponse as aw, type ManagedCallOperation as ax, type ManagedCallOperationConfig as ay, type ManagedCallUseCase as az, type PathsDictionary as b, type UseCaseHistoryEntryBase as b$, type OutboundStatusResponse as b0, type OutboundUseCase as b1, type OutboundUseCaseHistoryEntry as b2, type OutboundUseCaseStatus as b3, type PollDeliveryConfig as b4, type PollOutboundMessagesRequest as b5, type PollOutboundMessagesResponse as b6, type PortalOrigin as b7, type PortalRefConfig as b8, type PortalRefFilter as b9, type SecureProxyUseCaseHistoryEntry as bA, type SecureProxyWhitelist as bB, type SecureProxyWhitelistUpdate as bC, type SetIntegrationAppMappingRequest as bD, type TestNotificationRequest as bE, type TestNotificationResponse as bF, type TimeSeriesBreakdownItemV2 as bG, type TimeSeriesBucket as bH, type TimeSeriesBucketV2 as bI, type TriggerErpActionRequest as bJ, type TriggerWebhookResp as bK, type TypeAnnotations as bL, type TypeDescriptor as bM, type UnblockOutboundStreamRequest as bN, type UnblockOutboundStreamResponse as bO, type UpdateFileProxyUseCaseRequest as bP, type UpdateInboundUseCaseRequest as bQ, type UpdateIntegrationRequest as bR, type UpdateManagedCallUseCaseRequest as bS, type UpdateOutboundUseCaseRequest as bT, type UpdateSecureProxyUseCaseRequest as bU, type UpdateUseCaseRequest as bV, type UpdateUseCaseRequestBase as bW, type UpsertIntegrationWithUseCasesRequest as bX, type UseCase as bY, type UseCaseBase as bZ, type UseCaseHistoryEntry as b_, type PruneScopeConfig as ba, type QueryAccessLogsRequest as bb, type QueryEventsRequest as bc, type QueryInboundMonitoringEventsRequest as bd, type QueryMonitoringEventsV2Request as be, type QueryOutboundMonitoringEventsRequest as bf, type RedriveOutboundDlqRequest as bg, type RedriveOutboundDlqResponse as bh, type RedriveOutboundDlqResult as bi, type RelationConfig as bj, type RelationItemConfig as bk, type RelationRefItemConfig as bl, type RelationRefValueConfig as bm, type RelationRefsConfig as bn, type RelationUniqueIdField as bo, type RepeatableFieldType as bp, type ReplayEventsRequest as bq, type RuleBaselineBucket as br, type RuleBaselineStatus as bs, type S3Reference as bt, type SecureProxyRequest as bu, type SecureProxyResponse as bv, type SecureProxySummary as bw, type SecureProxyUpstreamError as bx, type SecureProxyUseCase as by, type SecureProxyUseCaseConfiguration as bz, type AckOutboundMessagesRequest as c, type UseCaseTypePreview as c0, type WebhookDeliveryConfig as c1, type WebhookStatus as c2, type AckOutboundMessagesResponse as d, type AckResult as e, type AutoRefreshSettings as f, type CommitTypesRequest as g, type CommitTypesResponse as h, type ConnectorConfig as i, type CreateErpImportRequest as j, type CreateErpImportResponse as k, type CreateFileProxyUseCaseRequest as l, type CreateInboundUseCaseRequest as m, type CreateIntegrationRequest as n, type CreateManagedCallUseCaseRequest as o, type CreateOutboundUseCaseRequest as p, type CreateSecureProxyUseCaseRequest as q, type CreateUseCaseRequest as r, type CreateUseCaseRequestBase as s, type DeliveryConfig as t, type EmbeddedInboundUseCaseRequest as u, type EmbeddedManagedCallUseCaseRequest as v, type EmbeddedOutboundUseCaseRequest as w, type EmbeddedSecureProxyUseCaseRequest as x, type EmbeddedUseCaseRequest as y, type EmbeddedUseCaseRequestBase as z };
+export { type FileProxyUrlParam as $, type AccessLogEntry as A, type EntityPruneScopeUpdate as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type EntityUpdate as F, type EnvVarRefConfig as G, type EnvironmentFieldConfig as H, type ErpEvent as I, type ErpEventV3 as J, type ErpImportError as K, type ErpImportJob as L, type ErpImportList as M, type ErpImportProgress as N, type OperationMethods as O, Paths as P, type ErpImportValidation as Q, type ErpUpdatesEventsV2Request as R, type ErpUpdatesEventsV3Request as S, type ErrorResponseBase as T, type ExternalMonitoringSpan as U, type FileProxyAuth as V, type FileProxyParam as W, type FileProxyResponseConfig as X, type FileProxySecureProxyAttachment as Y, type FileProxyStep as Z, type FileProxyUrlConfig as _, Components as a, type OutboundMessage as a$, type FileProxyUrlParams as a0, type FileProxyUseCase as a1, type FileProxyUseCaseConfiguration as a2, type FileProxyUseCaseHistoryEntry as a3, type GenerateTypesPreviewResponse as a4, type GenerateTypesRequest as a5, type GenerateTypesResponse as a6, type GetMonitoringStatsRequest as a7, type GetMonitoringStatsV2Request as a8, type GetMonitoringTimeSeriesRequest as a9, type ManagedCallUseCase as aA, type ManagedCallUseCaseHistoryEntry as aB, type MappingSimulationRequest as aC, type MappingSimulationResponse as aD, type MappingSimulationV2Request as aE, type MappingSimulationWarning as aF, type MeterReadingPruneScopeConfig as aG, type MeterReadingPruneScopeUpdate as aH, type MeterReadingUpdate as aI, type MeterUniqueIdsConfig as aJ, type MonitoringEventV2 as aK, type MonitoringStats as aL, type MonitoringStatsV2 as aM, type MonitoringTraceResponse as aN, type NotificationChannelSet as aO, type NotificationDigestConfig as aP, type NotificationHistoryItem as aQ, type NotificationHistoryResponse as aR, type NotificationRecipient as aS, type NotificationRule as aT, type NotificationRuleStatus as aU, type NotificationStatusResponse as aV, type OutboundConflict as aW, type OutboundDlqListResponse as aX, type OutboundDlqMessage as aY, type OutboundIntegrationEventConfiguration as aZ, type OutboundMapping as a_, type GetMonitoringTimeSeriesV2Request as aa, type InboundIntegrationEventConfiguration as ab, type InboundMonitoringEvent as ac, type InboundUseCase as ad, type InboundUseCaseHistoryEntry as ae, type IngestExternalMonitoringEventsRequest as af, type IngestExternalMonitoringEventsResponse as ag, type Integration as ah, type IntegrationAppMapping as ai, type IntegrationConfigurationV1 as aj, type IntegrationConfigurationV2 as ak, type IntegrationEditableFields as al, type IntegrationEntity as am, type IntegrationEntityField as an, type IntegrationFieldV1 as ao, type IntegrationMeterReading as ap, type IntegrationNotificationConfig as aq, type IntegrationObjectV1 as ar, type IntegrationSettings as as, type IntegrationWithUseCases as at, type ManagedCallAuth as au, type ManagedCallErrorResponse as av, type ManagedCallExecuteRequest as aw, type ManagedCallExecuteResponse as ax, type ManagedCallOperation as ay, type ManagedCallOperationConfig as az, type PathsDictionary as b, type UseCaseBase as b$, type OutboundMonitoringEvent as b0, type OutboundPollStatus as b1, type OutboundStatusResponse as b2, type OutboundUseCase as b3, type OutboundUseCaseHistoryEntry as b4, type OutboundUseCaseStatus as b5, type PollDeliveryConfig as b6, type PollOutboundMessagesRequest as b7, type PollOutboundMessagesResponse as b8, type PortalOrigin as b9, type SecureProxyUseCase as bA, type SecureProxyUseCaseConfiguration as bB, type SecureProxyUseCaseHistoryEntry as bC, type SecureProxyWhitelist as bD, type SecureProxyWhitelistUpdate as bE, type SetIntegrationAppMappingRequest as bF, type TestNotificationRequest as bG, type TestNotificationResponse as bH, type TimeSeriesBreakdownItemV2 as bI, type TimeSeriesBucket as bJ, type TimeSeriesBucketV2 as bK, type TriggerErpActionRequest as bL, type TriggerWebhookResp as bM, type TypeAnnotations as bN, type TypeDescriptor as bO, type UnblockOutboundStreamRequest as bP, type UnblockOutboundStreamResponse as bQ, type UpdateFileProxyUseCaseRequest as bR, type UpdateInboundUseCaseRequest as bS, type UpdateIntegrationRequest as bT, type UpdateManagedCallUseCaseRequest as bU, type UpdateOutboundUseCaseRequest as bV, type UpdateSecureProxyUseCaseRequest as bW, type UpdateUseCaseRequest as bX, type UpdateUseCaseRequestBase as bY, type UpsertIntegrationWithUseCasesRequest as bZ, type UseCase as b_, type PortalRefConfig as ba, type PortalRefFilter as bb, type PruneScopeConfig as bc, type QueryAccessLogsRequest as bd, type QueryEventsRequest as be, type QueryInboundMonitoringEventsRequest as bf, type QueryMonitoringEventsV2Request as bg, type QueryOutboundMonitoringEventsRequest as bh, type RedriveOutboundDlqRequest as bi, type RedriveOutboundDlqResponse as bj, type RedriveOutboundDlqResult as bk, type RelationConfig as bl, type RelationItemConfig as bm, type RelationRefItemConfig as bn, type RelationRefValueConfig as bo, type RelationRefsConfig as bp, type RelationUniqueIdField as bq, type RepeatableFieldType as br, type ReplayEventsRequest as bs, type RuleBaselineBucket as bt, type RuleBaselineStatus as bu, type S3Reference as bv, type SecureProxyRequest as bw, type SecureProxyResponse as bx, type SecureProxySummary as by, type SecureProxyUpstreamError as bz, type AckOutboundMessagesRequest as c, type UseCaseHistoryEntry as c0, type UseCaseHistoryEntryBase as c1, type UseCaseTypePreview as c2, type WebhookDeliveryConfig as c3, type WebhookStatus as c4, type AckOutboundMessagesResponse as d, type AckResult as e, type AutoRefreshSettings as f, type CommitTypesRequest as g, type CommitTypesResponse as h, type ConnectorConfig as i, type CreateErpImportRequest as j, type CreateErpImportResponse as k, type CreateFileProxyUseCaseRequest as l, type CreateInboundUseCaseRequest as m, type CreateIntegrationRequest as n, type CreateManagedCallUseCaseRequest as o, type CreateOutboundUseCaseRequest as p, type CreateSecureProxyUseCaseRequest as q, type CreateUseCaseRequest as r, type CreateUseCaseRequestBase as s, type DeliveryConfig as t, type EmbeddedInboundUseCaseRequest as u, type EmbeddedManagedCallUseCaseRequest as v, type EmbeddedOutboundUseCaseRequest as w, type EmbeddedSecureProxyUseCaseRequest as x, type EmbeddedUseCaseRequest as y, type EmbeddedUseCaseRequestBase as z };

package/dist/{integration-toolkit.d-BkWRJ8Xm.d.ts → integration-toolkit.d-D5HZSNUf.d.ts}

@@ -1728,6 +1728,50 @@ declare namespace Components {
              */
             change_description?: string;
         }
+        /**
+         * A resolved entity prune scope. At runtime, entities of `entity_slug` found within `scope` whose unique identifiers are not listed in `keep_unique_ids` are removed using `deletion_mode`.
+         */
+        export interface EntityPruneScopeUpdate {
+            /**
+             * The entity type that would be pruned
+             */
+            entity_slug: string;
+            /**
+             * The scope configuration resolved against the payload
+             */
+            scope: {
+                /**
+                 * How the entities in scope are found
+                 */
+                scope_mode: "relations" | "query";
+                /**
+                 * Schema of the related entity defining the scope (`relations` scope_mode only)
+                 */
+                schema?: string;
+                /**
+                 * Resolved unique identifiers of the related scope entity (`relations` scope_mode only)
+                 */
+                unique_ids?: {
+                    [name: string]: any;
+                };
+                /**
+                 * Resolved query parameters used to find entities in scope (`query` scope_mode only)
+                 */
+                query?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Unique identifiers of the entities upserted by this payload. Everything else found in scope would be deleted.
+             */
+            keep_unique_ids: {
+                [name: string]: any;
+            }[];
+            /**
+             * `delete` soft deletes the pruned entities, `purge` removes them permanently
+             */
+            deletion_mode: "delete" | "purge";
+        }
         export interface EntityUpdate {
             /**
              * The entity type slug
@@ -1745,6 +1789,27 @@ declare namespace Components {
             attributes: {
                 [name: string]: any;
             };
+            /**
+             * Present when the entity mapping has a `pricing` block. Echoes the pricing configuration and the data extracted for it, so mapping authors can see what would be sent to the pricing service.
+             */
+            pricing?: {
+                /**
+                 * The pricing configuration from the entity mapping
+                 */
+                config: {
+                    [name: string]: any;
+                };
+                /**
+                 * The pricing input data extracted from the payload
+                 */
+                data: {
+                    [name: string]: any;
+                }[];
+            };
+            /**
+             * Effective operation mode applied to this entity at runtime. `upsert-prune-scope-purge` / `upsert-prune-scope-delete` configurations report `upsert` here, because the individual entities in the payload are upserted — the destructive part of those modes is reported separately in `prune_scope_updates`. For `delete` / `purge`, `attributes` are still mapped and returned but ignored at runtime: only `unique_identifiers` are used to locate the entity to remove.
+             */
+            mode: "upsert" | "delete" | "purge";
         }
         /**
          * 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.
@@ -4013,6 +4078,14 @@ declare namespace Components {
         export interface MappingSimulationResponse {
             entity_updates: EntityUpdate[];
             meter_readings_updates?: MeterReadingUpdate[];
+            /**
+             * Resolved prune scopes produced by entity mappings using `upsert-prune-scope-purge` / `upsert-prune-scope-delete`. Each entry describes the entities that would be deleted at runtime because they exist in scope but were not part of this payload.
+             */
+            prune_scope_updates?: /* A resolved entity prune scope. At runtime, entities of `entity_slug` found within `scope` whose unique identifiers are not listed in `keep_unique_ids` are removed using `deletion_mode`. */ EntityPruneScopeUpdate[];
+            /**
+             * Resolved prune scopes produced by meter reading mappings using `upsert-prune-scope`. Each entry describes the readings that would be deleted at runtime for a meter (+ counter) because they were not part of this payload.
+             */
+            meter_readings_prune_scope_updates?: /* A resolved meter reading prune scope. At runtime, readings of the given meter (+ counter) whose external ids are not listed in `keep_external_ids` are deleted. */ MeterReadingPruneScopeUpdate[];
             /**
              * Validation warnings about the configuration (e.g., unique_ids referencing non-indexed fields)
              */
@@ -4063,6 +4136,35 @@ declare namespace Components {
              */
             source?: string;
         }
+        /**
+         * A resolved meter reading prune scope. At runtime, readings of the given meter (+ counter) whose external ids are not listed in `keep_external_ids` are deleted.
+         */
+        export interface MeterReadingPruneScopeUpdate {
+            meter: {
+                /**
+                 * Unique identifiers for the meter
+                 */
+                $entity_unique_ids: {
+                    [name: string]: any;
+                };
+            };
+            meter_counter?: {
+                /**
+                 * Unique identifiers for the meter counter
+                 */
+                $entity_unique_ids?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * External ids of the readings present in this payload. All other readings in scope would be deleted. An empty array means every reading in scope would be deleted.
+             */
+            keep_external_ids: string[];
+            /**
+             * When set, only readings with this source are eligible for pruning (e.g. `ERP`)
+             */
+            source?: string;
+        }
         export interface MeterReadingUpdate {
             meter: {
                 /**
@@ -4086,6 +4188,10 @@ declare namespace Components {
             attributes: {
                 [name: string]: any;
             };
+            /**
+             * Effective operation mode applied to this reading at runtime. `upsert-prune-scope` configurations report `upsert` here — their destructive part is reported separately in `meter_readings_prune_scope_updates`.
+             */
+            mode: "upsert" | "delete";
         }
         export interface MeterUniqueIdsConfig {
             /**
@@ -9364,6 +9470,7 @@ type EmbeddedOutboundUseCaseRequest = Components.Schemas.EmbeddedOutboundUseCase
 type EmbeddedSecureProxyUseCaseRequest = Components.Schemas.EmbeddedSecureProxyUseCaseRequest;
 type EmbeddedUseCaseRequest = Components.Schemas.EmbeddedUseCaseRequest;
 type EmbeddedUseCaseRequestBase = Components.Schemas.EmbeddedUseCaseRequestBase;
+type EntityPruneScopeUpdate = Components.Schemas.EntityPruneScopeUpdate;
 type EntityUpdate = Components.Schemas.EntityUpdate;
 type EnvVarRefConfig = Components.Schemas.EnvVarRefConfig;
 type EnvironmentFieldConfig = Components.Schemas.EnvironmentFieldConfig;
@@ -9428,6 +9535,7 @@ type MappingSimulationResponse = Components.Schemas.MappingSimulationResponse;
 type MappingSimulationV2Request = Components.Schemas.MappingSimulationV2Request;
 type MappingSimulationWarning = Components.Schemas.MappingSimulationWarning;
 type MeterReadingPruneScopeConfig = Components.Schemas.MeterReadingPruneScopeConfig;
+type MeterReadingPruneScopeUpdate = Components.Schemas.MeterReadingPruneScopeUpdate;
 type MeterReadingUpdate = Components.Schemas.MeterReadingUpdate;
 type MeterUniqueIdsConfig = Components.Schemas.MeterUniqueIdsConfig;
 type MonitoringEventV2 = Components.Schemas.MonitoringEventV2;
@@ -9518,4 +9626,4 @@ type UseCaseTypePreview = Components.Schemas.UseCaseTypePreview;
 type WebhookDeliveryConfig = Components.Schemas.WebhookDeliveryConfig;
 type WebhookStatus = Components.Schemas.WebhookStatus;
 
-export { type FileProxyUrlParams as $, type AccessLogEntry as A, type EntityUpdate as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type EnvVarRefConfig as F, type EnvironmentFieldConfig as G, type ErpEvent as H, type ErpEventV3 as I, type ErpImportError as J, type ErpImportJob as K, type ErpImportList as L, type ErpImportProgress as M, type ErpImportValidation as N, type OperationMethods as O, Paths as P, type ErpUpdatesEventsV2Request as Q, type ErpUpdatesEventsV3Request as R, type ErrorResponseBase as S, type ExternalMonitoringSpan as T, type FileProxyAuth as U, type FileProxyParam as V, type FileProxyResponseConfig as W, type FileProxySecureProxyAttachment as X, type FileProxyStep as Y, type FileProxyUrlConfig as Z, type FileProxyUrlParam as _, Components as a, type OutboundPollStatus as a$, type FileProxyUseCase as a0, type FileProxyUseCaseConfiguration as a1, type FileProxyUseCaseHistoryEntry as a2, type GenerateTypesPreviewResponse as a3, type GenerateTypesRequest as a4, type GenerateTypesResponse as a5, type GetMonitoringStatsRequest as a6, type GetMonitoringStatsV2Request as a7, type GetMonitoringTimeSeriesRequest as a8, type GetMonitoringTimeSeriesV2Request as a9, type ManagedCallUseCaseHistoryEntry as aA, type MappingSimulationRequest as aB, type MappingSimulationResponse as aC, type MappingSimulationV2Request as aD, type MappingSimulationWarning as aE, type MeterReadingPruneScopeConfig as aF, type MeterReadingUpdate as aG, type MeterUniqueIdsConfig as aH, type MonitoringEventV2 as aI, type MonitoringStats as aJ, type MonitoringStatsV2 as aK, type MonitoringTraceResponse as aL, type NotificationChannelSet as aM, type NotificationDigestConfig as aN, type NotificationHistoryItem as aO, type NotificationHistoryResponse as aP, type NotificationRecipient as aQ, type NotificationRule as aR, type NotificationRuleStatus as aS, type NotificationStatusResponse as aT, type OutboundConflict as aU, type OutboundDlqListResponse as aV, type OutboundDlqMessage as aW, type OutboundIntegrationEventConfiguration as aX, type OutboundMapping as aY, type OutboundMessage as aZ, type OutboundMonitoringEvent as a_, type InboundIntegrationEventConfiguration as aa, type InboundMonitoringEvent as ab, type InboundUseCase as ac, type InboundUseCaseHistoryEntry as ad, type IngestExternalMonitoringEventsRequest as ae, type IngestExternalMonitoringEventsResponse as af, type Integration as ag, type IntegrationAppMapping as ah, type IntegrationConfigurationV1 as ai, type IntegrationConfigurationV2 as aj, type IntegrationEditableFields as ak, type IntegrationEntity as al, type IntegrationEntityField as am, type IntegrationFieldV1 as an, type IntegrationMeterReading as ao, type IntegrationNotificationConfig as ap, type IntegrationObjectV1 as aq, type IntegrationSettings as ar, type IntegrationWithUseCases as as, type ManagedCallAuth as at, type ManagedCallErrorResponse as au, type ManagedCallExecuteRequest as av, type ManagedCallExecuteResponse as aw, type ManagedCallOperation as ax, type ManagedCallOperationConfig as ay, type ManagedCallUseCase as az, type PathsDictionary as b, type UseCaseHistoryEntryBase as b$, type OutboundStatusResponse as b0, type OutboundUseCase as b1, type OutboundUseCaseHistoryEntry as b2, type OutboundUseCaseStatus as b3, type PollDeliveryConfig as b4, type PollOutboundMessagesRequest as b5, type PollOutboundMessagesResponse as b6, type PortalOrigin as b7, type PortalRefConfig as b8, type PortalRefFilter as b9, type SecureProxyUseCaseHistoryEntry as bA, type SecureProxyWhitelist as bB, type SecureProxyWhitelistUpdate as bC, type SetIntegrationAppMappingRequest as bD, type TestNotificationRequest as bE, type TestNotificationResponse as bF, type TimeSeriesBreakdownItemV2 as bG, type TimeSeriesBucket as bH, type TimeSeriesBucketV2 as bI, type TriggerErpActionRequest as bJ, type TriggerWebhookResp as bK, type TypeAnnotations as bL, type TypeDescriptor as bM, type UnblockOutboundStreamRequest as bN, type UnblockOutboundStreamResponse as bO, type UpdateFileProxyUseCaseRequest as bP, type UpdateInboundUseCaseRequest as bQ, type UpdateIntegrationRequest as bR, type UpdateManagedCallUseCaseRequest as bS, type UpdateOutboundUseCaseRequest as bT, type UpdateSecureProxyUseCaseRequest as bU, type UpdateUseCaseRequest as bV, type UpdateUseCaseRequestBase as bW, type UpsertIntegrationWithUseCasesRequest as bX, type UseCase as bY, type UseCaseBase as bZ, type UseCaseHistoryEntry as b_, type PruneScopeConfig as ba, type QueryAccessLogsRequest as bb, type QueryEventsRequest as bc, type QueryInboundMonitoringEventsRequest as bd, type QueryMonitoringEventsV2Request as be, type QueryOutboundMonitoringEventsRequest as bf, type RedriveOutboundDlqRequest as bg, type RedriveOutboundDlqResponse as bh, type RedriveOutboundDlqResult as bi, type RelationConfig as bj, type RelationItemConfig as bk, type RelationRefItemConfig as bl, type RelationRefValueConfig as bm, type RelationRefsConfig as bn, type RelationUniqueIdField as bo, type RepeatableFieldType as bp, type ReplayEventsRequest as bq, type RuleBaselineBucket as br, type RuleBaselineStatus as bs, type S3Reference as bt, type SecureProxyRequest as bu, type SecureProxyResponse as bv, type SecureProxySummary as bw, type SecureProxyUpstreamError as bx, type SecureProxyUseCase as by, type SecureProxyUseCaseConfiguration as bz, type AckOutboundMessagesRequest as c, type UseCaseTypePreview as c0, type WebhookDeliveryConfig as c1, type WebhookStatus as c2, type AckOutboundMessagesResponse as d, type AckResult as e, type AutoRefreshSettings as f, type CommitTypesRequest as g, type CommitTypesResponse as h, type ConnectorConfig as i, type CreateErpImportRequest as j, type CreateErpImportResponse as k, type CreateFileProxyUseCaseRequest as l, type CreateInboundUseCaseRequest as m, type CreateIntegrationRequest as n, type CreateManagedCallUseCaseRequest as o, type CreateOutboundUseCaseRequest as p, type CreateSecureProxyUseCaseRequest as q, type CreateUseCaseRequest as r, type CreateUseCaseRequestBase as s, type DeliveryConfig as t, type EmbeddedInboundUseCaseRequest as u, type EmbeddedManagedCallUseCaseRequest as v, type EmbeddedOutboundUseCaseRequest as w, type EmbeddedSecureProxyUseCaseRequest as x, type EmbeddedUseCaseRequest as y, type EmbeddedUseCaseRequestBase as z };
+export { type FileProxyUrlParam as $, type AccessLogEntry as A, type EntityPruneScopeUpdate as B, type Client as C, type DeleteIntegrationAppMappingRequest as D, type EmbeddedFileProxyUseCaseRequest as E, type EntityUpdate as F, type EnvVarRefConfig as G, type EnvironmentFieldConfig as H, type ErpEvent as I, type ErpEventV3 as J, type ErpImportError as K, type ErpImportJob as L, type ErpImportList as M, type ErpImportProgress as N, type OperationMethods as O, Paths as P, type ErpImportValidation as Q, type ErpUpdatesEventsV2Request as R, type ErpUpdatesEventsV3Request as S, type ErrorResponseBase as T, type ExternalMonitoringSpan as U, type FileProxyAuth as V, type FileProxyParam as W, type FileProxyResponseConfig as X, type FileProxySecureProxyAttachment as Y, type FileProxyStep as Z, type FileProxyUrlConfig as _, Components as a, type OutboundMessage as a$, type FileProxyUrlParams as a0, type FileProxyUseCase as a1, type FileProxyUseCaseConfiguration as a2, type FileProxyUseCaseHistoryEntry as a3, type GenerateTypesPreviewResponse as a4, type GenerateTypesRequest as a5, type GenerateTypesResponse as a6, type GetMonitoringStatsRequest as a7, type GetMonitoringStatsV2Request as a8, type GetMonitoringTimeSeriesRequest as a9, type ManagedCallUseCase as aA, type ManagedCallUseCaseHistoryEntry as aB, type MappingSimulationRequest as aC, type MappingSimulationResponse as aD, type MappingSimulationV2Request as aE, type MappingSimulationWarning as aF, type MeterReadingPruneScopeConfig as aG, type MeterReadingPruneScopeUpdate as aH, type MeterReadingUpdate as aI, type MeterUniqueIdsConfig as aJ, type MonitoringEventV2 as aK, type MonitoringStats as aL, type MonitoringStatsV2 as aM, type MonitoringTraceResponse as aN, type NotificationChannelSet as aO, type NotificationDigestConfig as aP, type NotificationHistoryItem as aQ, type NotificationHistoryResponse as aR, type NotificationRecipient as aS, type NotificationRule as aT, type NotificationRuleStatus as aU, type NotificationStatusResponse as aV, type OutboundConflict as aW, type OutboundDlqListResponse as aX, type OutboundDlqMessage as aY, type OutboundIntegrationEventConfiguration as aZ, type OutboundMapping as a_, type GetMonitoringTimeSeriesV2Request as aa, type InboundIntegrationEventConfiguration as ab, type InboundMonitoringEvent as ac, type InboundUseCase as ad, type InboundUseCaseHistoryEntry as ae, type IngestExternalMonitoringEventsRequest as af, type IngestExternalMonitoringEventsResponse as ag, type Integration as ah, type IntegrationAppMapping as ai, type IntegrationConfigurationV1 as aj, type IntegrationConfigurationV2 as ak, type IntegrationEditableFields as al, type IntegrationEntity as am, type IntegrationEntityField as an, type IntegrationFieldV1 as ao, type IntegrationMeterReading as ap, type IntegrationNotificationConfig as aq, type IntegrationObjectV1 as ar, type IntegrationSettings as as, type IntegrationWithUseCases as at, type ManagedCallAuth as au, type ManagedCallErrorResponse as av, type ManagedCallExecuteRequest as aw, type ManagedCallExecuteResponse as ax, type ManagedCallOperation as ay, type ManagedCallOperationConfig as az, type PathsDictionary as b, type UseCaseBase as b$, type OutboundMonitoringEvent as b0, type OutboundPollStatus as b1, type OutboundStatusResponse as b2, type OutboundUseCase as b3, type OutboundUseCaseHistoryEntry as b4, type OutboundUseCaseStatus as b5, type PollDeliveryConfig as b6, type PollOutboundMessagesRequest as b7, type PollOutboundMessagesResponse as b8, type PortalOrigin as b9, type SecureProxyUseCase as bA, type SecureProxyUseCaseConfiguration as bB, type SecureProxyUseCaseHistoryEntry as bC, type SecureProxyWhitelist as bD, type SecureProxyWhitelistUpdate as bE, type SetIntegrationAppMappingRequest as bF, type TestNotificationRequest as bG, type TestNotificationResponse as bH, type TimeSeriesBreakdownItemV2 as bI, type TimeSeriesBucket as bJ, type TimeSeriesBucketV2 as bK, type TriggerErpActionRequest as bL, type TriggerWebhookResp as bM, type TypeAnnotations as bN, type TypeDescriptor as bO, type UnblockOutboundStreamRequest as bP, type UnblockOutboundStreamResponse as bQ, type UpdateFileProxyUseCaseRequest as bR, type UpdateInboundUseCaseRequest as bS, type UpdateIntegrationRequest as bT, type UpdateManagedCallUseCaseRequest as bU, type UpdateOutboundUseCaseRequest as bV, type UpdateSecureProxyUseCaseRequest as bW, type UpdateUseCaseRequest as bX, type UpdateUseCaseRequestBase as bY, type UpsertIntegrationWithUseCasesRequest as bZ, type UseCase as b_, type PortalRefConfig as ba, type PortalRefFilter as bb, type PruneScopeConfig as bc, type QueryAccessLogsRequest as bd, type QueryEventsRequest as be, type QueryInboundMonitoringEventsRequest as bf, type QueryMonitoringEventsV2Request as bg, type QueryOutboundMonitoringEventsRequest as bh, type RedriveOutboundDlqRequest as bi, type RedriveOutboundDlqResponse as bj, type RedriveOutboundDlqResult as bk, type RelationConfig as bl, type RelationItemConfig as bm, type RelationRefItemConfig as bn, type RelationRefValueConfig as bo, type RelationRefsConfig as bp, type RelationUniqueIdField as bq, type RepeatableFieldType as br, type ReplayEventsRequest as bs, type RuleBaselineBucket as bt, type RuleBaselineStatus as bu, type S3Reference as bv, type SecureProxyRequest as bw, type SecureProxyResponse as bx, type SecureProxySummary as by, type SecureProxyUpstreamError as bz, type AckOutboundMessagesRequest as c, type UseCaseHistoryEntry as c0, type UseCaseHistoryEntryBase as c1, type UseCaseTypePreview as c2, type WebhookDeliveryConfig as c3, type WebhookStatus as c4, type AckOutboundMessagesResponse as d, type AckResult as e, type AutoRefreshSettings as f, type CommitTypesRequest as g, type CommitTypesResponse as h, type ConnectorConfig as i, type CreateErpImportRequest as j, type CreateErpImportResponse as k, type CreateFileProxyUseCaseRequest as l, type CreateInboundUseCaseRequest as m, type CreateIntegrationRequest as n, type CreateManagedCallUseCaseRequest as o, type CreateOutboundUseCaseRequest as p, type CreateSecureProxyUseCaseRequest as q, type CreateUseCaseRequest as r, type CreateUseCaseRequestBase as s, type DeliveryConfig as t, type EmbeddedInboundUseCaseRequest as u, type EmbeddedManagedCallUseCaseRequest as v, type EmbeddedOutboundUseCaseRequest as w, type EmbeddedSecureProxyUseCaseRequest as x, type EmbeddedUseCaseRequest as y, type EmbeddedUseCaseRequestBase as z };

package/docs/deduplication.md

@@ -28,6 +28,7 @@ const { data } = await deduplicationClient.deduplicate(...)
 - [`deduplicateAsync`](#deduplicateasync)
 - [`getDeduplicationJob`](#getdeduplicationjob)
 - [`detectDuplicates`](#detectduplicates)
+- [`dismissDuplicates`](#dismissduplicates)
 - [`listUniquenessCriteria`](#listuniquenesscriteria)
 - [`createUniquenessCriteria`](#createuniquenesscriteria)
 - [`getUniquenessCriteria`](#getuniquenesscriteria)
@@ -44,6 +45,8 @@ const { data } = await deduplicationClient.deduplicate(...)
 - [`DetectDuplicatesRequestBody`](#detectduplicatesrequestbody)
 - [`DetectDuplicatesResponse`](#detectduplicatesresponse)
 - [`DetectedDuplicateMatch`](#detectedduplicatematch)
+- [`DismissDuplicatesRequestBody`](#dismissduplicatesrequestbody)
+- [`DismissDuplicatesResponse`](#dismissduplicatesresponse)
 - [`UniquenessCriteriaListResponse`](#uniquenesscriterialistresponse)
 - [`UniquenessCriteria`](#uniquenesscriteria)
 - [`MatchRule`](#matchrule)
@@ -73,26 +76,28 @@ const { data } = await client.deduplicate(
 <summary>Response</summary>
 
 ```json
-[
-  {
-    "_id": "string",
-    "_org": "string",
-    "_schema": "string",
-    "_created_at": "1970-01-01T00:00:00.000Z",
-    "_updated_at": "1970-01-01T00:00:00.000Z",
-    "_created_by": "string",
-    "created_by": "string",
-    "_tags": ["string"],
-    "_acl": {},
-    "_owners": [
-      {
-        "org_id": "string",
-        "user_id": "string"
-      }
-    ],
-    "type": "string"
-  }
-]
+{
+  "deduplicatedEntities": [
+    {
+      "_id": "string",
+      "_org": "string",
+      "_schema": "string",
+      "_created_at": "1970-01-01T00:00:00.000Z",
+      "_updated_at": "1970-01-01T00:00:00.000Z",
+      "_created_by": "string",
+      "created_by": "string",
+      "_tags": ["string"],
+      "_acl": {},
+      "_owners": [
+        {
+          "org_id": "string",
+          "user_id": "string"
+        }
+      ],
+      "type": "string"
+    }
+  ]
+}
 ```
 
 </details>
@@ -220,6 +225,35 @@ const { data } = await client.detectDuplicates(
 
 ---
 
+### `dismissDuplicates`
+
+Confirms entities as NOT duplicates: clears the internal duplicate-detection flags (_matching_entities) on each given entity, so they stop appearing as open duplicate sets. The records themselves are 
+
+`POST /v1/duplicates/dismiss`
+
+```ts
+const { data } = await client.dismissDuplicates(
+  null,
+  {
+    schema: 'string',
+    entityIds: ['string']
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "dismissed": ["string"]
+}
+```
+
+</details>
+
+---
+
 ### `listUniquenessCriteria`
 
 Lists UniquenessCriteria for the requesting organization. Optionally filtered by schema.
@@ -441,22 +475,24 @@ type DeduplicateRequestBody = Array<{
 ### `DeduplicateRequestResponse`
 
 ```ts
-type DeduplicateRequestResponse = Array<{
-  _id: string
-  _org?: string
-  _schema?: string
-  _created_at?: string // date-time
-  _updated_at?: string // date-time
-  _created_by?: string | number
-  created_by?: string | number
-  _tags?: string[]
-  _acl?: Record<string, string[]>
-  _owners?: Array<{
-    org_id: string
-    user_id: string
+type DeduplicateRequestResponse = {
+  deduplicatedEntities: Array<{
+    _id: string
+    _org?: string
+    _schema?: string
+    _created_at?: string // date-time
+    _updated_at?: string // date-time
+    _created_by?: string | number
+    created_by?: string | number
+    _tags?: string[]
+    _acl?: Record<string, string[]>
+    _owners?: Array<{
+      org_id: { ... }
+      user_id: { ... }
+    }>
+    type?: string
   }>
-  type?: string
-}>
+}
 ```
 
 ### `Entity`
@@ -588,6 +624,23 @@ type DetectedDuplicateMatch = {
 }
 ```
 
+### `DismissDuplicatesRequestBody`
+
+```ts
+type DismissDuplicatesRequestBody = {
+  schema: string
+  entityIds: string[]
+}
+```
+
+### `DismissDuplicatesResponse`
+
+```ts
+type DismissDuplicatesResponse = {
+  dismissed: string[]
+}
+```
+
 ### `UniquenessCriteriaListResponse`
 
 ```ts