@epilot/sdk 2.7.1 → 2.8.0-rc.0

package/dist/{customer-portal.d-C7ZCbjiY.d.ts → customer-portal.d-CTTCBAZI.d.ts}

@@ -3384,6 +3384,14 @@ declare namespace Components {
                  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
                  */
                 dataPath?: string;
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                errorMessagePath?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -3513,6 +3521,14 @@ declare namespace Components {
                  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
                  */
                 dataPath?: string;
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                errorMessagePath?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -3566,6 +3582,16 @@ declare namespace Components {
                     [name: string]: string;
                 };
             };
+            resolved?: {
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                errorMessagePath?: string;
+            };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
              * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
@@ -3659,6 +3685,14 @@ declare namespace Components {
                  * {{CallResponse.data.lower_limit}}
                  */
                 lower_limit?: string;
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                errorMessagePath?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -3709,6 +3743,14 @@ declare namespace Components {
                  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
                  */
                 dataPath?: string;
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                errorMessagePath?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -3821,6 +3863,14 @@ declare namespace Components {
                  * Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
                  */
                 dataPath?: string;
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                errorMessagePath?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -4561,8 +4611,9 @@ declare namespace Components {
             schema?: string;
         }
         /**
-         * Mobile OIDC configuration. All string fields support env var interpolation
-         * (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
+         * Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
+         * fields below may reference org env vars via mustache-like templates, e.g.
+         * `{{ env.MOBILE_CLIENT_SECRET }}`.
          *
          */
         export interface MoblieOIDCConfig {
@@ -4582,8 +4633,12 @@ declare namespace Components {
             client_secret?: string;
         }
         /**
-         * OIDC provider configuration. All string fields support env var interpolation
-         * (incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
+         * OIDC provider configuration. Values are resolved at SSO invocation time
+         * (login / callback), so the fields below may reference org env vars via
+         * mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
+         *
+         * Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
+         * `ProviderConfig.display_name`) are NOT interpolated and must be literal.
          *
          */
         export interface OIDCProviderConfig {
@@ -4631,6 +4686,10 @@ declare namespace Components {
             prompt?: "login" | "select_account" | "consent";
         }
         export interface OIDCProviderMetadata {
+            /**
+             * Response modes the provider accepts (e.g. `form_post` for Apple)
+             */
+            response_modes_supported?: ("form_post" | "fragment" | "query")[];
             /**
              * URL of the authorization endpoint
              * example:
@@ -4686,47 +4745,6 @@ declare namespace Components {
              */
             test_auth_password?: string;
         }
-        /**
-         * Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
-         * the `client_secret` field — it is kept server-side and only used to exchange the
-         * authorization code at the SSO callback. String fields are returned with env var
-         * placeholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.
-         *
-         */
-        export interface OIDCProviderPublicConfig {
-            type?: "authorization_code" | "implicit";
-            /**
-             * Issuing Authority URL
-             * example:
-             * https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0
-             */
-            oidc_issuer: string;
-            /**
-             * Redirect URI for the OIDC flow
-             * example:
-             * https://customer-portal.com/login
-             */
-            redirect_uri?: string;
-            /**
-             * example:
-             * ab81daf8-8b1f-42d6-94ca-c51621054c75
-             */
-            client_id: string;
-            /**
-             * Whether the client secret is present (the value itself is kept server-side)
-             * example:
-             * true
-             */
-            has_client_secret?: boolean;
-            /**
-             * Space-separated list of OAuth 2.0 scopes to request from OpenID Connect
-             * example:
-             * openid email
-             */
-            scope: string;
-            metadata?: OIDCProviderMetadata;
-            prompt?: "login" | "select_account" | "consent";
-        }
         /**
          * The opportunity entity
          */
@@ -5797,6 +5815,18 @@ declare namespace Components {
                  */
                 onPendingUser?: AdminUser[];
             };
+            /**
+             * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
+             * the list is fully synced — incoming providers are upserted and any existing
+             * providers not in the list are deleted. Omit the field to leave SSO
+             * configuration unchanged; send an empty array to remove all providers.
+             *
+             * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
+             * as sent. Customers are encouraged to reference an org env secret via
+             * `{{ env.VAR }}` rather than embed raw values.
+             *
+             */
+            identity_providers?: ProviderPublicConfig[];
             /**
              * Enable/Disable the portal access
              */
@@ -6270,7 +6300,6 @@ declare namespace Components {
              * Permissions granted to a portal user while accessing entities
              */
             grants?: Grant[];
-            identity_providers?: ProviderPublicConfig[];
             pages?: Page[];
         }
         /**
@@ -6474,14 +6503,19 @@ declare namespace Components {
             attribute_mappings?: /* Dictionary of epilot user attributes to claims */ AttributeMappingConfig;
             entity_matching?: /* Configuration for matching existing entities during SSO login using token claims */ EntityMatchingConfig;
             oidc_config?: /**
-             * OIDC provider configuration. All string fields support env var interpolation
-             * (incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
+             * OIDC provider configuration. Values are resolved at SSO invocation time
+             * (login / callback), so the fields below may reference org env vars via
+             * mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
+             *
+             * Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
+             * `ProviderConfig.display_name`) are NOT interpolated and must be literal.
              *
              */
             OIDCProviderConfig;
             mobile_oidc_config?: /**
-             * Mobile OIDC configuration. All string fields support env var interpolation
-             * (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
+             * Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
+             * fields below may reference org env vars via mustache-like templates, e.g.
+             * `{{ env.MOBILE_CLIENT_SECRET }}`.
              *
              */
             MoblieOIDCConfig;
@@ -6506,16 +6540,19 @@ declare namespace Components {
              */
             ProviderDisplayName;
             oidc_config?: /**
-             * Public OIDC provider configuration. Same as OIDCProviderConfig but never includes
-             * the `client_secret` field — it is kept server-side and only used to exchange the
-             * authorization code at the SSO callback. String fields are returned with env var
-             * placeholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.
+             * OIDC provider configuration. Values are resolved at SSO invocation time
+             * (login / callback), so the fields below may reference org env vars via
+             * mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.
+             *
+             * Fields used to render the SSO buttons up-front (`ProviderConfig.slug`,
+             * `ProviderConfig.display_name`) are NOT interpolated and must be literal.
              *
              */
-            OIDCProviderPublicConfig;
+            OIDCProviderConfig;
             mobile_oidc_config?: /**
-             * Mobile OIDC configuration. All string fields support env var interpolation
-             * (incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.
+             * Mobile OIDC configuration. Values are resolved at SSO invocation time, so the
+             * fields below may reference org env vars via mustache-like templates, e.g.
+             * `{{ env.MOBILE_CLIENT_SECRET }}`.
              *
              */
             MoblieOIDCConfig;
@@ -7052,6 +7089,32 @@ declare namespace Components {
                  */
                 onPendingUser?: AdminUser[];
             };
+            /**
+             * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
+             * the list is fully synced — incoming providers are upserted and any existing
+             * providers not in the list are deleted. Omit the field to leave SSO
+             * configuration unchanged; send an empty array to remove all providers.
+             *
+             * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
+             * as sent. Customers are encouraged to reference an org env secret via
+             * `{{ env.VAR }}` rather than embed raw values.
+             *
+             */
+            identity_providers?: /**
+             * SSO identity provider configuration.
+             *
+             * Env var interpolation: only string fields under `oidc_config` and
+             * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
+             * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
+             * get resolved at runtime against the organization's environment.
+             *
+             * The following fields are used as literal values and MUST NOT contain
+             * template syntax: `slug`, `display_name`, `provider_type`, all keys and
+             * values under `attribute_mappings` (used as JSONPath-like accessors into
+             * token claims), and all keys and values under `entity_matching`.
+             *
+             */
+            ProviderConfig[];
         }
         export interface UpsertPortalConfig {
             /**
@@ -7094,6 +7157,32 @@ declare namespace Components {
                  */
                 onPendingUser?: AdminUser[];
             };
+            /**
+             * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
+             * the list is fully synced — incoming providers are upserted and any existing
+             * providers not in the list are deleted. Omit the field to leave SSO
+             * configuration unchanged; send an empty array to remove all providers.
+             *
+             * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
+             * as sent. Customers are encouraged to reference an org env secret via
+             * `{{ env.VAR }}` rather than embed raw values.
+             *
+             */
+            identity_providers?: /**
+             * SSO identity provider configuration.
+             *
+             * Env var interpolation: only string fields under `oidc_config` and
+             * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
+             * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
+             * get resolved at runtime against the organization's environment.
+             *
+             * The following fields are used as literal values and MUST NOT contain
+             * template syntax: `slug`, `display_name`, `provider_type`, all keys and
+             * values under `attribute_mappings` (used as JSONPath-like accessors into
+             * token claims), and all keys and values under `entity_matching`.
+             *
+             */
+            ProviderConfig[];
             /**
              * Enable/Disable the portal access
              */
@@ -7573,6 +7662,32 @@ declare namespace Components {
                  */
                 onPendingUser?: AdminUser[];
             };
+            /**
+             * SSO identity providers for the portal. When sent on a portal save (PUT/POST),
+             * the list is fully synced — incoming providers are upserted and any existing
+             * providers not in the list are deleted. Omit the field to leave SSO
+             * configuration unchanged; send an empty array to remove all providers.
+             *
+             * Each provider is persisted verbatim — `oidc_config.client_secret` is stored
+             * as sent. Customers are encouraged to reference an org env secret via
+             * `{{ env.VAR }}` rather than embed raw values.
+             *
+             */
+            identity_providers?: /**
+             * SSO identity provider configuration.
+             *
+             * Env var interpolation: only string fields under `oidc_config` and
+             * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
+             * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
+             * get resolved at runtime against the organization's environment.
+             *
+             * The following fields are used as literal values and MUST NOT contain
+             * template syntax: `slug`, `display_name`, `provider_type`, all keys and
+             * values under `attribute_mappings` (used as JSONPath-like accessors into
+             * token claims), and all keys and values under `entity_matching`.
+             *
+             */
+            ProviderConfig[];
             /**
              * Enable/Disable the portal access
              */
@@ -10908,7 +11023,28 @@ declare namespace Paths {
                  * Permissions granted to a portal user while accessing entities
                  */
                 grants?: Components.Schemas.Grant[];
-                identity_providers?: Components.Schemas.ProviderPublicConfig[];
+                /**
+                 * SSO identity providers configured for the portal. Includes raw
+                 * `oidc_config.client_secret` values so the admin UI can round-trip
+                 * them. Customers are encouraged to reference secrets via env
+                 * templates (`{{ env.VAR }}`) rather than embed raw values.
+                 *
+                 */
+                identity_providers?: /**
+                 * SSO identity provider configuration.
+                 *
+                 * Env var interpolation: only string fields under `oidc_config` and
+                 * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
+                 * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
+                 * get resolved at runtime against the organization's environment.
+                 *
+                 * The following fields are used as literal values and MUST NOT contain
+                 * template syntax: `slug`, `display_name`, `provider_type`, all keys and
+                 * values under `attribute_mappings` (used as JSONPath-like accessors into
+                 * token claims), and all keys and values under `entity_matching`.
+                 *
+                 */
+                Components.Schemas.ProviderConfig[];
                 certificate_details?: {
                     /**
                      * Status of the certificate
@@ -11423,7 +11559,28 @@ declare namespace Paths {
                  * Permissions granted to a portal user while accessing entities
                  */
                 grants?: Components.Schemas.Grant[];
-                identity_providers?: Components.Schemas.ProviderPublicConfig[];
+                /**
+                 * SSO identity providers configured for the portal. Includes raw
+                 * `oidc_config.client_secret` values so the admin UI can round-trip
+                 * them. Customers are encouraged to reference secrets via env
+                 * templates (`{{ env.VAR }}`) rather than embed raw values.
+                 *
+                 */
+                identity_providers?: /**
+                 * SSO identity provider configuration.
+                 *
+                 * Env var interpolation: only string fields under `oidc_config` and
+                 * `mobile_oidc_config` (incl. their nested `metadata`) are passed through
+                 * Liquid templating, so they may contain `{{ env.VAR }}` placeholders that
+                 * get resolved at runtime against the organization's environment.
+                 *
+                 * The following fields are used as literal values and MUST NOT contain
+                 * template syntax: `slug`, `display_name`, `provider_type`, all keys and
+                 * values under `attribute_mappings` (used as JSONPath-like accessors into
+                 * token claims), and all keys and values under `entity_matching`.
+                 *
+                 */
+                Components.Schemas.ProviderConfig[];
                 certificate_details?: {
                     /**
                      * Status of the certificate
@@ -17644,7 +17801,6 @@ type MeterReadingWidget = Components.Schemas.MeterReadingWidget;
 type MoblieOIDCConfig = Components.Schemas.MoblieOIDCConfig;
 type OIDCProviderConfig = Components.Schemas.OIDCProviderConfig;
 type OIDCProviderMetadata = Components.Schemas.OIDCProviderMetadata;
-type OIDCProviderPublicConfig = Components.Schemas.OIDCProviderPublicConfig;
 type Opportunity = Components.Schemas.Opportunity;
 type Order = Components.Schemas.Order;
 type OrganizationSettings = Components.Schemas.OrganizationSettings;
@@ -17704,4 +17860,4 @@ type WorfklowIdentifier = Components.Schemas.WorfklowIdentifier;
 type WorkflowExecution = Components.Schemas.WorkflowExecution;
 type WorkflowStep = Components.Schemas.WorkflowStep;
 
-export { type EntityMatchingConfig as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type Contact as D, type ContactCountRequest as E, type ContactExistsRequest as F, type ContentWidget as G, type ContextEntities as H, type ContextEntity as I, type Contract as J, type ContractIdentifier as K, type CreateUserRequest as L, type Currency as M, type DataRetrievalItem as N, type OperationMethods as O, Paths as P, DeleteEntityFile as Q, type Direction as R, type DocumentWidget as S, type DomainSettings as T, type EmailTemplates as U, type Entity as V, type EntityEditRule as W, type EntityFileCount as X, type EntityGetParams as Y, type EntityId as Z, type EntityItem as _, Components as a, type PublicAppDetails as a$, type EntityResponse as a0, type EntityResponseGroupedWithHits as a1, type EntityResponseWithHits as a2, type EntitySearchParams as a3, type EntitySlug as a4, type EntitySlugConfig as a5, type EntityTemplates as a6, type EntityWidget as a7, type ErrorResp as a8, type Exists as a9, type MeterReading as aA, type MeterReadingPhoto as aB, type MeterReadingPhotoData as aC, type MeterReadingWidget as aD, type MoblieOIDCConfig as aE, type OIDCProviderConfig as aF, type OIDCProviderMetadata as aG, type OIDCProviderPublicConfig as aH, type Opportunity as aI, type Order as aJ, type OrganizationSettings as aK, type Origin as aL, type Page as aM, type PageRequest as aN, type PaymentWidget as aO, type PortalConfig as aP, type PortalConfigV3 as aQ, type PortalId as aR, type PortalUser as aS, type PortalUserRegistrationStatus as aT, type PortalWidget as aU, type Product as aV, type ProductRecommendationsWidget as aW, type ProviderConfig as aX, type ProviderDisplayName as aY, type ProviderPublicConfig as aZ, type ProviderSlug as a_, type Extension as aa, type ExtensionAuthBlock as ab, type ExtensionConfig as ac, type ExtensionHook as ad, type ExtensionHookConsumptionDataRetrieval as ae, type ExtensionHookContractIdentification as af, type ExtensionHookCostDataRetrieval as ag, type ExtensionHookDataExport as ah, type ExtensionHookMeterReadingPlausibilityCheck as ai, type ExtensionHookPriceDataRetrieval as aj, type ExtensionHookRegistrationIdentifiersCheck as ak, type ExtensionHookSelection as al, type ExtensionHookVisualizationMetadata as am, type ExtensionSeamlessLink as an, type ExternalLink as ao, type ExtraSchemaAttributes as ap, type FailedRuleErrorResp as aq, type File as ar, type FileItem as as, type Grant as at, type IdentifierAttribute as au, type InstallmentEvent as av, type JourneyActions as aw, type JuiceSettings as ax, type Meter as ay, type MeterChartWidget as az, type PathsDictionary as b, type PublicContractIdentificationDetails as b0, type PublicDataRetrievalHookDetails as b1, type PublicExtensionCapabilities as b2, type PublicExtensionDetails as b3, type PublicMeterReadingPlausibilityCheckDetails as b4, type ReadBy as b5, type ReadingStatus as b6, type Reason as b7, type RegistrationIdentifier as b8, type ReimbursementEvent as b9, type WorkflowExecution as bA, type WorkflowStep as bB, type Rule as ba, type SAMLProviderConfig as bb, type SSOCallbackRequest as bc, type SSOCallbackResponse as bd, type SSOLoginToken as be, SaveEntityFile as bf, type SavePortalFile as bg, type Schema as bh, type SearchIncludes as bi, type SecureProxyConfig as bj, type Source as bk, type SwappableConfig as bl, type TariffType as bm, type TeaserWidget as bn, type TriggerPortalFlow as bo, type UpdateOnlyPortalConfigAttributes as bp, type UpsertPortalConfig as bq, type UpsertPortalConfigV3 as br, UpsertPortalWidget as bs, type UserRequest as bt, type VisualizationDataRange as bu, type VisualizationMetadata as bv, type VisualizationTypeOption as bw, type WidgetAction as bx, type WidgetBase as by, type WorfklowIdentifier as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdminUser as j, type AllowedFileExtensions as k, type AttributeMappingConfig as l, type AuthConfig as m, type BaseBillingEvent as n, type BaseEntity as o, type BillingAccount as p, type BillingEvent as q, type Block as r, type BlockId as s, type BlockProps as t, type BlockRequest as u, type BlockType as v, type BusinessPartnerItem as w, type CampaignWidget as x, type CommonConfigAttributes as y, type CommonConfigAttributesV3 as z };
+export { type EntityMatchingConfig as $, type AcceptanceDecision as A, type Balance as B, type Client as C, type Contact as D, type ContactCountRequest as E, type ContactExistsRequest as F, type ContentWidget as G, type ContextEntities as H, type ContextEntity as I, type Contract as J, type ContractIdentifier as K, type CreateUserRequest as L, type Currency as M, type DataRetrievalItem as N, type OperationMethods as O, Paths as P, DeleteEntityFile as Q, type Direction as R, type DocumentWidget as S, type DomainSettings as T, type EmailTemplates as U, type Entity as V, type EntityEditRule as W, type EntityFileCount as X, type EntityGetParams as Y, type EntityId as Z, type EntityItem as _, Components as a, type PublicContractIdentificationDetails as a$, type EntityResponse as a0, type EntityResponseGroupedWithHits as a1, type EntityResponseWithHits as a2, type EntitySearchParams as a3, type EntitySlug as a4, type EntitySlugConfig as a5, type EntityTemplates as a6, type EntityWidget as a7, type ErrorResp as a8, type Exists as a9, type MeterReading as aA, type MeterReadingPhoto as aB, type MeterReadingPhotoData as aC, type MeterReadingWidget as aD, type MoblieOIDCConfig as aE, type OIDCProviderConfig as aF, type OIDCProviderMetadata as aG, type Opportunity as aH, type Order as aI, type OrganizationSettings as aJ, type Origin as aK, type Page as aL, type PageRequest as aM, type PaymentWidget as aN, type PortalConfig as aO, type PortalConfigV3 as aP, type PortalId as aQ, type PortalUser as aR, type PortalUserRegistrationStatus as aS, type PortalWidget as aT, type Product as aU, type ProductRecommendationsWidget as aV, type ProviderConfig as aW, type ProviderDisplayName as aX, type ProviderPublicConfig as aY, type ProviderSlug as aZ, type PublicAppDetails as a_, type Extension as aa, type ExtensionAuthBlock as ab, type ExtensionConfig as ac, type ExtensionHook as ad, type ExtensionHookConsumptionDataRetrieval as ae, type ExtensionHookContractIdentification as af, type ExtensionHookCostDataRetrieval as ag, type ExtensionHookDataExport as ah, type ExtensionHookMeterReadingPlausibilityCheck as ai, type ExtensionHookPriceDataRetrieval as aj, type ExtensionHookRegistrationIdentifiersCheck as ak, type ExtensionHookSelection as al, type ExtensionHookVisualizationMetadata as am, type ExtensionSeamlessLink as an, type ExternalLink as ao, type ExtraSchemaAttributes as ap, type FailedRuleErrorResp as aq, type File as ar, type FileItem as as, type Grant as at, type IdentifierAttribute as au, type InstallmentEvent as av, type JourneyActions as aw, type JuiceSettings as ax, type Meter as ay, type MeterChartWidget as az, type PathsDictionary as b, type PublicDataRetrievalHookDetails as b0, type PublicExtensionCapabilities as b1, type PublicExtensionDetails as b2, type PublicMeterReadingPlausibilityCheckDetails as b3, type ReadBy as b4, type ReadingStatus as b5, type Reason as b6, type RegistrationIdentifier as b7, type ReimbursementEvent as b8, type Rule as b9, type WorkflowStep as bA, type SAMLProviderConfig as ba, type SSOCallbackRequest as bb, type SSOCallbackResponse as bc, type SSOLoginToken as bd, SaveEntityFile as be, type SavePortalFile as bf, type Schema as bg, type SearchIncludes as bh, type SecureProxyConfig as bi, type Source as bj, type SwappableConfig as bk, type TariffType as bl, type TeaserWidget as bm, type TriggerPortalFlow as bn, type UpdateOnlyPortalConfigAttributes as bo, type UpsertPortalConfig as bp, type UpsertPortalConfigV3 as bq, UpsertPortalWidget as br, type UserRequest as bs, type VisualizationDataRange as bt, type VisualizationMetadata as bu, type VisualizationTypeOption as bv, type WidgetAction as bw, type WidgetBase as bx, type WorfklowIdentifier as by, type WorkflowExecution as bz, type AccountExistsRequest as c, type ActionLabel as d, type ActionWidget as e, type Activity as f, type ActivityCallerContext as g, type ActivityId as h, type ActivityItem as i, type AdminUser as j, type AllowedFileExtensions as k, type AttributeMappingConfig as l, type AuthConfig as m, type BaseBillingEvent as n, type BaseEntity as o, type BillingAccount as p, type BillingEvent as q, type Block as r, type BlockId as s, type BlockProps as t, type BlockRequest as u, type BlockType as v, type BusinessPartnerItem as w, type CampaignWidget as x, type CommonConfigAttributes as y, type CommonConfigAttributesV3 as z };

package/dist/data-governance-QYFHBCNB.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/data-governance.json
+var data_governance_default = '# Data Governance API\n\n- **Base URL:** `https://data-governance.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-governance](https://docs.epilot.io/api/data-governance)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataGovernance.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-governance\'\n\nconst dataGovernanceClient = getClient()\nauthorize(dataGovernanceClient, () => \'<token>\')\nconst { data } = await dataGovernanceClient.queryEntities(...)\n```\n\n## Operations\n\n**Query**\n- [`queryEntities`](#queryentities)\n\n**Auditable Jobs**\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`createJobForConfig`](#createjobforconfig)\n- [`listJobs`](#listjobs)\n\n**Data Lifecycle Configs**\n- [`getConfig`](#getconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities matching a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    saved_view_id: \'string\',\n    include_deleted: \'true\',\n    filters: [\n      {\n        type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n        related_entity_schemas: [\'string\'],\n        lookback_period_days: 0,\n        message_type: [\'SENT\'],\n        workflow_status: [\'CLOSED\']\n      }\n    ],\n    from: 0,\n    size: 0,\n    hydrate: true,\n    fields: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-governance/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    type: \'deletion\',\n    config_id: \'string\',\n    scheduled_for: \'string\',\n    status: \'in_progress\',\n    started_at: \'1970-01-01T00:00:00.000Z\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-governance/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n  {\n    entity_schema: \'example\',\n    job_id: \'example\',\n  },\n  {\n    status: \'in_progress\',\n    details: {},\n    completed_at: \'1970-01-01T00:00:00.000Z\',\n    error: \'string\',\n    report: {\n      bucket: \'string\',\n      key: \'string\',\n      format: \'csv\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by ID\n\n`GET /data-governance/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-governance/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "url": "string",\n  "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by ID\n\n`GET /data-governance/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "entity_schema": "string",\n  "query": {\n    "saved_view_id": "string",\n    "include_deleted": "true",\n    "filters": [\n      {\n        "type": "entity_workflows_only_in_closed_or_cancelled_status",\n        "related_entity_schemas": ["string"],\n        "lookback_period_days": 0,\n        "message_type": ["SENT"],\n        "workflow_status": ["CLOSED"]\n      }\n    ]\n  },\n  "schedule": {\n    "frequency": "interval",\n    "interval_days": 1,\n    "start_date": "string",\n    "end_date": "string"\n  },\n  "enabled": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "next_run_at": "string",\n  "relations_for_deletion": ["contact"],\n  "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-governance/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nCreate or update a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    type: \'deletion\',\n    query: {\n      saved_view_id: \'string\',\n      include_deleted: \'true\',\n      filters: [\n        {\n          type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n          related_entity_schemas: [\'string\'],\n          lookback_period_days: 0,\n          message_type: [\'SENT\'],\n          workflow_status: [\'CLOSED\']\n        }\n      ]\n    },\n    schedule: {\n      frequency: \'interval\',\n      interval_days: 1,\n      start_date: \'string\',\n      end_date: \'string\'\n    },\n    relations_for_deletion: [\'contact\'],\n    enabled: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "entity_schema": "string",\n  "query": {\n    "saved_view_id": "string",\n    "include_deleted": "true",\n    "filters": [\n      {\n        "type": "entity_workflows_only_in_closed_or_cancelled_status",\n        "related_entity_schemas": ["string"],\n        "lookback_period_days": 0,\n        "message_type": ["SENT"],\n        "workflow_status": ["CLOSED"]\n      }\n    ]\n  },\n  "schedule": {\n    "frequency": "interval",\n    "interval_days": 1,\n    "start_date": "string",\n    "end_date": "string"\n  },\n  "enabled": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "next_run_at": "string",\n  "relations_for_deletion": ["contact"],\n  "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList data lifecycle configs\n\n`GET /data-governance/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n  limit: 1,\n  cursor: \'example\',\n  entity_schema: \'example\',\n  type: \'example\',\n  next_run_at: \'example\',\n  enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "configs": [\n    {\n      "id": "string",\n      "type": "deletion",\n      "entity_schema": "string",\n      "query": {\n        "saved_view_id": "string",\n        "include_deleted": "true",\n        "filters": [\n          {\n            "type": "entity_workflows_only_in_closed_or_cancelled_status",\n            "related_entity_schemas": ["string"],\n            "lookback_period_days": 0,\n            "message_type": ["SENT"],\n            "workflow_status": ["CLOSED"]\n          }\n        ]\n      },\n      "schedule": {\n        "frequency": "interval",\n        "interval_days": 1,\n        "start_date": "string",\n        "end_date": "string"\n      },\n      "enabled": true,\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "last_updated_at": "1970-01-01T00:00:00.000Z",\n      "next_run_at": "string",\n      "relations_for_deletion": ["contact"],\n      "last_run_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList job runs\n\n`GET /data-governance/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n  limit: 1,\n  cursor: \'example\',\n  entity_schema: \'example\',\n  type: \'example\',\n  status: \'example\',\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "jobs": [\n    {\n      "id": "string",\n      "type": "deletion",\n      "config_id": "string",\n      "entity_schema": "string",\n      "scheduled_for": "string",\n      "status": "in_progress",\n      "details": {},\n      "started_at": "1970-01-01T00:00:00.000Z",\n      "completed_at": "1970-01-01T00:00:00.000Z",\n      "error": "string",\n      "report": {\n        "bucket": "string",\n        "key": "string",\n        "format": "csv"\n      },\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "last_updated_at": "1970-01-01T00:00:00.000Z",\n      "trigger": "schedule",\n      "triggered_by": "string"\n    }\n  ],\n  "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nThe governance action type. Determines what operation is performed on\nmatched entities when a job runs. Currently only `deletion` is supported.\n\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\nCurrent execution status of a job run.\n- `in_progress` \u2014 the job is actively processing entities.\n- `success` \u2014 the job completed without critical errors.\n- `failed` \u2014 the job terminated due to an error.\n\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\nIndicates how the job was initiated.\n- `schedule` \u2014 automatically created by the background scheduler.\n- `manual` \u2014 explicitly triggered by a user via the API.\n\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\nFile format of the job report. Currently only CSV is supported.\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\nReference to a report file stored in S3 that details the outcome of a\njob run (e.g., which entities were deleted or failed).\n\n\n```ts\ntype JobReport = {\n  bucket?: string\n  key?: string\n  format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\nRequest payload for creating a new job run.\n\n```ts\ntype CreateJobRequest = {\n  type: "deletion"\n  config_id: string\n  scheduled_for: string // date\n  status?: "in_progress" | "success" | "failed"\n  started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nType-specific job outcome payload. The shape depends on the config type.\nFor `deletion` jobs, typical fields include:\n- `matched_count` \u2014 total entities matched by the query\n- `deleted_count` \u2014 entities successfully deleted\n- `failed_count` \u2014 entities that could not be deleted\n\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\nPartial update payload for an existing job. Only the fields provided\nwill be merged into the job record.\n\n\n```ts\ntype UpdateJobRequest = {\n  status?: "in_progress" | "success" | "failed"\n  details?: Record<string, unknown>\n  completed_at?: string // date-time\n  error?: string\n  report?: {\n    bucket?: string\n    key?: string\n    format?: "csv"\n  }\n}\n```\n\n### `Job`\n\nRepresents a single execution run of a data lifecycle config. Tracks the\nfull lifecycle from creation through completion, including outcome\ndetails and an optional downloadable report.\n\n\n```ts\ntype Job = {\n  id: string\n  type: "deletion"\n  config_id: string\n  entity_schema: string\n  scheduled_for: string // date\n  status: "in_progress" | "success" | "failed"\n  details?: Record<string, unknown>\n  started_at?: string // date-time\n  completed_at?: string // date-time\n  error?: string\n  report?: {\n    bucket?: string\n    key?: string\n    format?: "csv"\n  }\n  created_at: string // date-time\n  last_updated_at: string // date-time\n  trigger?: "schedule" | "manual"\n  triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\nPaginated response containing a list of job runs.\n\n```ts\ntype ListJobsResponse = {\n  jobs?: Array<{\n    id: string\n    type: "deletion"\n    config_id: string\n    entity_schema: string\n    scheduled_for: string // date\n    status: "in_progress" | "success" | "failed"\n    details?: Record<string, unknown>\n    started_at?: string // date-time\n    completed_at?: string // date-time\n    error?: string\n    report?: {\n      bucket?: { ... }\n      key?: { ... }\n      format?: { ... }\n    }\n    created_at: string // date-time\n    last_updated_at: string // date-time\n    trigger?: "schedule" | "manual"\n    triggered_by?: string\n  }>\n  cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\nContains a time-limited pre-signed URL to download a job report.\n\n```ts\ntype JobReportUrlResponse = {\n  url?: string\n  expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\nPredefined data governance filter types that can be layered on top of\na saved view to narrow down target entities:\n- `entity_workflows_only_in_closed_or_cancelled_status` \u2014 include only\n  entities whose own workflows are all in a closed/cancelled state.\n- `no_related_entities` \u2014 include only entitie\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\nA single governance filter condition applied during entity querying.\nThe required and optional fields depend on the `type`.\n\n\n```ts\ntype QueryFilter = {\n  type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n  related_entity_schemas?: string[]\n  lookback_period_days?: number\n  message_type?: "SENT" | "RECEIVED"[]\n  workflow_status?: "CLOSED" | "DONE"[]\n}\n```\n\n### `QueryConfig`\n\nDefines the query used by a data lifecycle config to identify target\nentities. Combines a saved view with optional governance filters.\n\n\n```ts\ntype QueryConfig = {\n  saved_view_id: string\n  include_deleted?: "true" | "false" | "only"\n  filters?: Array<{\n    type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n    related_entity_schemas?: string[]\n    lookback_period_days?: number\n    message_type?: "SENT" | "RECEIVED"[]\n    workflow_status?: "CLOSED" | "DONE"[]\n  }>\n}\n```\n\n### `QueryEntitiesRequest`\n\nRequest body for the query endpoint. Extends `QueryConfig` with\npagination and projection options.\n\n\n```ts\ntype QueryEntitiesRequest = {\n  saved_view_id: string\n  include_deleted?: "true" | "false" | "only"\n  filters?: Array<{\n    type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n    related_entity_schemas?: string[]\n    lookback_period_days?: number\n    message_type?: "SENT" | "RECEIVED"[]\n    workflow_status?: "CLOSED" | "DONE"[]\n  }>\n  from?: number\n  size?: number\n  hydrate?: boolean\n  fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\nResponse from the entity query endpoint.\n\n```ts\ntype QueryEntitiesResult = {\n  hits?: number\n  results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype ConfigSchedule = {\n  frequency: "interval"\n  interval_days: number\n  start_date?: string // date\n  end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype IntervalConfigSchedule = {\n  frequency: "interval"\n  interval_days: number\n  start_date?: string // date\n  end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\nRequest payload for creating or updating a data lifecycle config.\n\n```ts\ntype UpsertConfigRequest = {\n  type: "deletion"\n  query: {\n    saved_view_id: string\n    include_deleted?: "true" | "false" | "only"\n    filters?: Array<{\n      type: { ... }\n      related_entity_schemas?: { ... }\n      lookback_period_days?: { ... }\n      message_type?: { ... }\n      workflow_status?: { ... }\n    }>\n  }\n  schedule: {\n    frequency: "interval"\n    interval_days: number\n    start_date?: string // date\n    end_date?: string // date\n  }\n  relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n  enabled?: boolean\n}\n```\n\n### `Config`\n\nA data lifecycle config defining an automated policy (e.g., scheduled\nentity deletion) for a specific entity schema.\n\n\n```ts\ntype Config = {\n  id: string\n  type: "deletion"\n  entity_schema: string\n  query: {\n    saved_view_id: string\n    include_deleted?: "true" | "false" | "only"\n    filters?: Array<{\n      type: { ... }\n      related_entity_schemas?: { ... }\n      lookback_period_days?: { ... }\n      message_type?: { ... }\n      workflow_status?: { ... }\n    }>\n  }\n  schedule?: {\n    frequency: "interval"\n    interval_days: number\n    start_date?: string // date\n    end_date?: string // date\n  }\n  enabled?: boolean\n  created_at?: string // date-time\n  last_updated_at?: string // date-time\n  next_run_at?: string // date\n  relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n  last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\nEntity schema slug that can be specified as a cascading deletion\ntarget. When a primary entity is deleted, related entities of these\nschemas are also removed.\n\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\nPaginated response containing a list of data lifecycle configs.\n\n```ts\ntype ListConfigsResponse = {\n  configs?: Array<{\n    id: string\n    type: "deletion"\n    entity_schema: string\n    query: {\n      saved_view_id: { ... }\n      include_deleted?: { ... }\n      filters?: { ... }\n    }\n    schedule?: {\n      frequency: { ... }\n      interval_days: { ... }\n      start_date?: { ... }\n      end_date?: { ... }\n    }\n    enabled?: boolean\n    created_at?: string // date-time\n    last_updated_at?: string // date-time\n    next_run_at?: string // date\n    relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n    last_run_at?: string // date-time\n  }>\n  cursor?: string\n}\n```\n';
+
+
+exports.default = data_governance_default;

package/dist/data-governance-YS2NA6W4.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/data-governance.json
+var data_governance_default = '# Data Governance API\n\n- **Base URL:** `https://data-governance.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-governance](https://docs.epilot.io/api/data-governance)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataGovernance.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-governance\'\n\nconst dataGovernanceClient = getClient()\nauthorize(dataGovernanceClient, () => \'<token>\')\nconst { data } = await dataGovernanceClient.queryEntities(...)\n```\n\n## Operations\n\n**Query**\n- [`queryEntities`](#queryentities)\n\n**Auditable Jobs**\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`createJobForConfig`](#createjobforconfig)\n- [`listJobs`](#listjobs)\n\n**Data Lifecycle Configs**\n- [`getConfig`](#getconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities matching a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    saved_view_id: \'string\',\n    include_deleted: \'true\',\n    filters: [\n      {\n        type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n        related_entity_schemas: [\'string\'],\n        lookback_period_days: 0,\n        message_type: [\'SENT\'],\n        workflow_status: [\'CLOSED\']\n      }\n    ],\n    from: 0,\n    size: 0,\n    hydrate: true,\n    fields: [\'string\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-governance/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    type: \'deletion\',\n    config_id: \'string\',\n    scheduled_for: \'string\',\n    status: \'in_progress\',\n    started_at: \'1970-01-01T00:00:00.000Z\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-governance/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n  {\n    entity_schema: \'example\',\n    job_id: \'example\',\n  },\n  {\n    status: \'in_progress\',\n    details: {},\n    completed_at: \'1970-01-01T00:00:00.000Z\',\n    error: \'string\',\n    report: {\n      bucket: \'string\',\n      key: \'string\',\n      format: \'csv\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by ID\n\n`GET /data-governance/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-governance/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n  job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "url": "string",\n  "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by ID\n\n`GET /data-governance/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "entity_schema": "string",\n  "query": {\n    "saved_view_id": "string",\n    "include_deleted": "true",\n    "filters": [\n      {\n        "type": "entity_workflows_only_in_closed_or_cancelled_status",\n        "related_entity_schemas": ["string"],\n        "lookback_period_days": 0,\n        "message_type": ["SENT"],\n        "workflow_status": ["CLOSED"]\n      }\n    ]\n  },\n  "schedule": {\n    "frequency": "interval",\n    "interval_days": 1,\n    "start_date": "string",\n    "end_date": "string"\n  },\n  "enabled": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "next_run_at": "string",\n  "relations_for_deletion": ["contact"],\n  "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-governance/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "config_id": "string",\n  "entity_schema": "string",\n  "scheduled_for": "string",\n  "status": "in_progress",\n  "details": {},\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "error": "string",\n  "report": {\n    "bucket": "string",\n    "key": "string",\n    "format": "csv"\n  },\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "trigger": "schedule",\n  "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nCreate or update a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n  {\n    entity_schema: \'example\',\n  },\n  {\n    type: \'deletion\',\n    query: {\n      saved_view_id: \'string\',\n      include_deleted: \'true\',\n      filters: [\n        {\n          type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n          related_entity_schemas: [\'string\'],\n          lookback_period_days: 0,\n          message_type: [\'SENT\'],\n          workflow_status: [\'CLOSED\']\n        }\n      ]\n    },\n    schedule: {\n      frequency: \'interval\',\n      interval_days: 1,\n      start_date: \'string\',\n      end_date: \'string\'\n    },\n    relations_for_deletion: [\'contact\'],\n    enabled: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "string",\n  "type": "deletion",\n  "entity_schema": "string",\n  "query": {\n    "saved_view_id": "string",\n    "include_deleted": "true",\n    "filters": [\n      {\n        "type": "entity_workflows_only_in_closed_or_cancelled_status",\n        "related_entity_schemas": ["string"],\n        "lookback_period_days": 0,\n        "message_type": ["SENT"],\n        "workflow_status": ["CLOSED"]\n      }\n    ]\n  },\n  "schedule": {\n    "frequency": "interval",\n    "interval_days": 1,\n    "start_date": "string",\n    "end_date": "string"\n  },\n  "enabled": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "last_updated_at": "1970-01-01T00:00:00.000Z",\n  "next_run_at": "string",\n  "relations_for_deletion": ["contact"],\n  "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList data lifecycle configs\n\n`GET /data-governance/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n  limit: 1,\n  cursor: \'example\',\n  entity_schema: \'example\',\n  type: \'example\',\n  next_run_at: \'example\',\n  enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "configs": [\n    {\n      "id": "string",\n      "type": "deletion",\n      "entity_schema": "string",\n      "query": {\n        "saved_view_id": "string",\n        "include_deleted": "true",\n        "filters": [\n          {\n            "type": "entity_workflows_only_in_closed_or_cancelled_status",\n            "related_entity_schemas": ["string"],\n            "lookback_period_days": 0,\n            "message_type": ["SENT"],\n            "workflow_status": ["CLOSED"]\n          }\n        ]\n      },\n      "schedule": {\n        "frequency": "interval",\n        "interval_days": 1,\n        "start_date": "string",\n        "end_date": "string"\n      },\n      "enabled": true,\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "last_updated_at": "1970-01-01T00:00:00.000Z",\n      "next_run_at": "string",\n      "relations_for_deletion": ["contact"],\n      "last_run_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList job runs\n\n`GET /data-governance/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n  limit: 1,\n  cursor: \'example\',\n  entity_schema: \'example\',\n  type: \'example\',\n  status: \'example\',\n  config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "jobs": [\n    {\n      "id": "string",\n      "type": "deletion",\n      "config_id": "string",\n      "entity_schema": "string",\n      "scheduled_for": "string",\n      "status": "in_progress",\n      "details": {},\n      "started_at": "1970-01-01T00:00:00.000Z",\n      "completed_at": "1970-01-01T00:00:00.000Z",\n      "error": "string",\n      "report": {\n        "bucket": "string",\n        "key": "string",\n        "format": "csv"\n      },\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "last_updated_at": "1970-01-01T00:00:00.000Z",\n      "trigger": "schedule",\n      "triggered_by": "string"\n    }\n  ],\n  "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nThe governance action type. Determines what operation is performed on\nmatched entities when a job runs. Currently only `deletion` is supported.\n\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\nCurrent execution status of a job run.\n- `in_progress` \u2014 the job is actively processing entities.\n- `success` \u2014 the job completed without critical errors.\n- `failed` \u2014 the job terminated due to an error.\n\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\nIndicates how the job was initiated.\n- `schedule` \u2014 automatically created by the background scheduler.\n- `manual` \u2014 explicitly triggered by a user via the API.\n\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\nFile format of the job report. Currently only CSV is supported.\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\nReference to a report file stored in S3 that details the outcome of a\njob run (e.g., which entities were deleted or failed).\n\n\n```ts\ntype JobReport = {\n  bucket?: string\n  key?: string\n  format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\nRequest payload for creating a new job run.\n\n```ts\ntype CreateJobRequest = {\n  type: "deletion"\n  config_id: string\n  scheduled_for: string // date\n  status?: "in_progress" | "success" | "failed"\n  started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nType-specific job outcome payload. The shape depends on the config type.\nFor `deletion` jobs, typical fields include:\n- `matched_count` \u2014 total entities matched by the query\n- `deleted_count` \u2014 entities successfully deleted\n- `failed_count` \u2014 entities that could not be deleted\n\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\nPartial update payload for an existing job. Only the fields provided\nwill be merged into the job record.\n\n\n```ts\ntype UpdateJobRequest = {\n  status?: "in_progress" | "success" | "failed"\n  details?: Record<string, unknown>\n  completed_at?: string // date-time\n  error?: string\n  report?: {\n    bucket?: string\n    key?: string\n    format?: "csv"\n  }\n}\n```\n\n### `Job`\n\nRepresents a single execution run of a data lifecycle config. Tracks the\nfull lifecycle from creation through completion, including outcome\ndetails and an optional downloadable report.\n\n\n```ts\ntype Job = {\n  id: string\n  type: "deletion"\n  config_id: string\n  entity_schema: string\n  scheduled_for: string // date\n  status: "in_progress" | "success" | "failed"\n  details?: Record<string, unknown>\n  started_at?: string // date-time\n  completed_at?: string // date-time\n  error?: string\n  report?: {\n    bucket?: string\n    key?: string\n    format?: "csv"\n  }\n  created_at: string // date-time\n  last_updated_at: string // date-time\n  trigger?: "schedule" | "manual"\n  triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\nPaginated response containing a list of job runs.\n\n```ts\ntype ListJobsResponse = {\n  jobs?: Array<{\n    id: string\n    type: "deletion"\n    config_id: string\n    entity_schema: string\n    scheduled_for: string // date\n    status: "in_progress" | "success" | "failed"\n    details?: Record<string, unknown>\n    started_at?: string // date-time\n    completed_at?: string // date-time\n    error?: string\n    report?: {\n      bucket?: { ... }\n      key?: { ... }\n      format?: { ... }\n    }\n    created_at: string // date-time\n    last_updated_at: string // date-time\n    trigger?: "schedule" | "manual"\n    triggered_by?: string\n  }>\n  cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\nContains a time-limited pre-signed URL to download a job report.\n\n```ts\ntype JobReportUrlResponse = {\n  url?: string\n  expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\nPredefined data governance filter types that can be layered on top of\na saved view to narrow down target entities:\n- `entity_workflows_only_in_closed_or_cancelled_status` \u2014 include only\n  entities whose own workflows are all in a closed/cancelled state.\n- `no_related_entities` \u2014 include only entitie\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\nA single governance filter condition applied during entity querying.\nThe required and optional fields depend on the `type`.\n\n\n```ts\ntype QueryFilter = {\n  type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n  related_entity_schemas?: string[]\n  lookback_period_days?: number\n  message_type?: "SENT" | "RECEIVED"[]\n  workflow_status?: "CLOSED" | "DONE"[]\n}\n```\n\n### `QueryConfig`\n\nDefines the query used by a data lifecycle config to identify target\nentities. Combines a saved view with optional governance filters.\n\n\n```ts\ntype QueryConfig = {\n  saved_view_id: string\n  include_deleted?: "true" | "false" | "only"\n  filters?: Array<{\n    type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n    related_entity_schemas?: string[]\n    lookback_period_days?: number\n    message_type?: "SENT" | "RECEIVED"[]\n    workflow_status?: "CLOSED" | "DONE"[]\n  }>\n}\n```\n\n### `QueryEntitiesRequest`\n\nRequest body for the query endpoint. Extends `QueryConfig` with\npagination and projection options.\n\n\n```ts\ntype QueryEntitiesRequest = {\n  saved_view_id: string\n  include_deleted?: "true" | "false" | "only"\n  filters?: Array<{\n    type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n    related_entity_schemas?: string[]\n    lookback_period_days?: number\n    message_type?: "SENT" | "RECEIVED"[]\n    workflow_status?: "CLOSED" | "DONE"[]\n  }>\n  from?: number\n  size?: number\n  hydrate?: boolean\n  fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\nResponse from the entity query endpoint.\n\n```ts\ntype QueryEntitiesResult = {\n  hits?: number\n  results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype ConfigSchedule = {\n  frequency: "interval"\n  interval_days: number\n  start_date?: string // date\n  end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype IntervalConfigSchedule = {\n  frequency: "interval"\n  interval_days: number\n  start_date?: string // date\n  end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\nRequest payload for creating or updating a data lifecycle config.\n\n```ts\ntype UpsertConfigRequest = {\n  type: "deletion"\n  query: {\n    saved_view_id: string\n    include_deleted?: "true" | "false" | "only"\n    filters?: Array<{\n      type: { ... }\n      related_entity_schemas?: { ... }\n      lookback_period_days?: { ... }\n      message_type?: { ... }\n      workflow_status?: { ... }\n    }>\n  }\n  schedule: {\n    frequency: "interval"\n    interval_days: number\n    start_date?: string // date\n    end_date?: string // date\n  }\n  relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n  enabled?: boolean\n}\n```\n\n### `Config`\n\nA data lifecycle config defining an automated policy (e.g., scheduled\nentity deletion) for a specific entity schema.\n\n\n```ts\ntype Config = {\n  id: string\n  type: "deletion"\n  entity_schema: string\n  query: {\n    saved_view_id: string\n    include_deleted?: "true" | "false" | "only"\n    filters?: Array<{\n      type: { ... }\n      related_entity_schemas?: { ... }\n      lookback_period_days?: { ... }\n      message_type?: { ... }\n      workflow_status?: { ... }\n    }>\n  }\n  schedule?: {\n    frequency: "interval"\n    interval_days: number\n    start_date?: string // date\n    end_date?: string // date\n  }\n  enabled?: boolean\n  created_at?: string // date-time\n  last_updated_at?: string // date-time\n  next_run_at?: string // date\n  relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n  last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\nEntity schema slug that can be specified as a cascading deletion\ntarget. When a primary entity is deleted, related entities of these\nschemas are also removed.\n\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\nPaginated response containing a list of data lifecycle configs.\n\n```ts\ntype ListConfigsResponse = {\n  configs?: Array<{\n    id: string\n    type: "deletion"\n    entity_schema: string\n    query: {\n      saved_view_id: { ... }\n      include_deleted?: { ... }\n      filters?: { ... }\n    }\n    schedule?: {\n      frequency: { ... }\n      interval_days: { ... }\n      start_date?: { ... }\n      end_date?: { ... }\n    }\n    enabled?: boolean\n    created_at?: string // date-time\n    last_updated_at?: string // date-time\n    next_run_at?: string // date\n    relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n    last_run_at?: string // date-time\n  }>\n  cursor?: string\n}\n```\n';
+export {
+  data_governance_default as default
+};