@codiac.io/codiac-cli 1.2.174 → 1.2.202

package/lib/apis/codiac-api/gen/contracts.d.ts

@@ -1,2722 +0,0 @@
-import { BatchResult } from "@codiac.io/codiac-common/contracts";
-/** The security attributes for a user when signed in under a given tenant */
-export interface AccessProfile {
-    tenantCode: string;
-    inactive?: boolean | undefined;
-    roles: AuthRole[];
-}
-/** Historical record of the occurrence of an event. */
-export interface ActivityBase {
-    type: ActivityTypeEnum;
-    title: string;
-    by: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed: Date;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ActivityCriteriaBase {
-    type?: string | undefined;
-    title?: string | undefined;
-    by?: string | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed?: Date | undefined;
-    cabinet?: string | undefined;
-    assetsName?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export declare enum ActivityTypeEnum {
-    cabinetCreate = "cabinetCreate",
-    cabinetDelete = "cabinetDelete",
-    codeCommit = "codeCommit",
-    configDeploy = "configDeploy",
-    deployment = "deployment",
-    imageBuild = "imageBuild",
-    versionCreate = "versionCreate"
-} /** Upsert Request for assignment of a new or existing user to the current tenant. */
-export interface AddTenantUserRequest {
-    login: string;
-    firstName: string;
-    lastName: string;
-    roleNames: string[];
-    email?: string | undefined;
-}
-/** Boolean logic for string values.  Useful for querying on tags */
-export interface AndOrNot {
-    and?: string[] | undefined;
-    or?: string[] | undefined;
-    not?: string[] | undefined;
-}
-/** Boolean logic filter for string values.  Useful for querying on tags */
-export interface AndOrNotFilter {
-    property?: string | undefined;
-    /** DO NOT USE THIS:  It is confusing, and it is only here to comply with IFilter. */
-    $not?: AndOrNotFilter | undefined;
-    and?: string[] | undefined;
-    or?: string[] | undefined;
-    not?: string[] | undefined;
-}
-export interface ApiReadyState {
-    currentState: ApiReadyStateEnum;
-}
-export declare enum ApiReadyStateEnum {
-    bootstrapping = "bootstrapping",
-    initializingPlugins = "initializingPlugins",
-    instantiated = "instantiated",
-    ready = "ready",
-    reflecting = "reflecting"
-} /** A functional unit that is published as an individual container.
- *  Could be an api, service, web app, cloud function, or any other type of containerized executable system. */
-export interface Asset {
-    enterprise: string;
-    code: string;
-    name: string;
-    image: Image;
-    port: number;
-    hasIngress: boolean;
-    routedWithoutName: boolean;
-    id?: string | undefined;
-    /** An asset may be a constituent of only one product.
-     *  NOTE: This setting applies to product versions moving forward,
-     *       and historical product versions remain intact with whatever assets the product included at the time. */
-    product?: string | undefined;
-    /** (Optional: defaults to "service")  Differentiator for various asset behaviors (eg: "job" or "helm"). */
-    type?: "helm" | "job" | "service" | undefined;
-    /** (Optional: defaults to built-in deploymment-labeling convention) Boolean logic by which to recognize the pods
-     *  that belong to this asset among all the other pods in a namespace.
-     *  This property is an array type to allow for an asset to have multiple pod specs that each may have their own replicas.
-     *
-     *  eg:  a simple asset just looks for...
-     *  ```
-     *  (p,a) => x.metadata?labels["AssetName"] == a
-     *  ```
-     *
-     *  eg:  an asset, such as cert manager, with multiple kinds of pods, would have multiple custom pod filters, such as...
-     *  ```
-     *  (p,a) => p.metadata?labels["app.kubernetes.io/component"] == "cainjector" && p.metadata?labels["app.kubernetes.io/name"] == "cert-manager"
-     *  (p,a) => p.metadata?labels["app.kubernetes.io/component"] == "webhook" && p.metadata?labels["app.kubernetes.io/name"] == "cert-manager"
-     *  (p,a) => p.metadata?labels["app.kubernetes.io/component"] == "controller" && p.metadata?labels["app.kubernetes.io/name"] == "cert-manager"
-     *  ``` */
-    customPodFilters?: object[] | undefined;
-    /** Abstract declarations of folder paths inside the image
-     *  that are to be later mapped (at configuration time) to file store definitions.
-     *
-     *  NOTE: These reservations only OPTIONALLY reference existing file stores;
-     *       they merely declare a folder path for a file store to be mapped
-     *       later, when the asset gets configured for use in various cabinets. */
-    reservedFolders?: AssetFolderReservation[] | undefined;
-    /** Declares means by which the container platform can check health and readiness of the assets at runtime. */
-    probes?: Probe[] | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface AssetCriteria {
-    id?: StringFilter | undefined;
-    code?: StringFilter | undefined;
-    name?: StringFilter | undefined;
-    assetType?: string | undefined;
-    enterprise?: string | undefined;
-    environment?: string | undefined;
-    cluster?: string | undefined;
-    hasIngress?: boolean | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Abstract declarations of folder paths inside the image
- *  that are to be later mapped (at configuration time) to file store definitions. */
-export interface AssetFolderReservation {
-    /** Fully qualified path, inside the container, of the folder being mapped as a volume.  Must be unique for the asset. */
-    path: string;
-    /** Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for the asset. */
-    name: string;
-    /** Any notes or other information to help clarify the intended purpose of this folder,
-     *  to assist during the configuration phase
-     *  when assigning an actual physical file store to it. */
-    description?: string | undefined;
-    /** (Optional) The name of an existing FileStoreDef in the enterprise
-     *  to which this folder will get mapped, unless configured otherwise. */
-    defaultFileStore?: string | undefined;
-}
-/** Base class for specifying details for the creation of a specific type of asset. */
-export interface AssetTemplate {
-}
-export declare enum AssetTypesEnum {
-    helm = "helm",
-    job = "job",
-    service = "service"
-}
-export interface AssetVersionConfig {
-    enterprise: string;
-    assetName: string;
-    entityType: string;
-    entityName: string;
-    version: string;
-    tags?: Tag[] | undefined;
-    contents?: IVersionRef[] | undefined;
-    contentHash?: string | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface AssetVersionConfigCriteria {
-    enterprise?: string | undefined;
-    assetName?: string | undefined;
-    version?: string | undefined;
-    contentHash?: string | undefined;
-    multi?: object[] | undefined;
-    /** Boolean logic filter for string values.  Useful for querying on tags */
-    tags?: AndOrNotFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface AuthenticationRequest {
-    login: string;
-    password: string;
-    tenantCode?: string | undefined;
-}
-export interface AuthRole {
-    name: string;
-    id?: string | undefined;
-    /** Standard, reliable, expedient way to identify an entity to a human in a single property
-     *  with more pertinent identifying information than its system id.
-     *  For use in logs, quick lists, and abstracted framework components. */
-    descriptor: string;
-    /** Enables a hierarchy of roles */
-    parent?: AuthRole | undefined;
-}
-export interface AuthRoleCriteria {
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    name?: StringFilter | undefined;
-    descriptor?: StringFilter | undefined;
-    /** Selects Principals that have a tenant profile
-     *  for the given tenantCode. */
-    parent?: AuthRoleParentFilter | undefined;
-}
-/** Selects Principals that have a tenant profile
- *  for the given tenantCode. */
-export interface AuthRoleParentFilter {
-    role: string;
-    property?: string | undefined;
-    $not?: AuthRoleParentFilter | undefined;
-}
-export interface AuthSubscription {
-    tenantId: string;
-    tenantCode: string;
-    name: string;
-    enabled: boolean;
-    status: SubscriptionStatus;
-    maxUsers: number;
-    /** Enables basic storage and retrieval of dates and times. */
-    expiration?: Date | undefined;
-    id?: string | undefined;
-    /** Reference to the susbscription that resides within the billing system.
-     *  This object can be used to help a sync for this tenant. */
-    billingPlan?: IBillingPlanRef | undefined;
-    /** Standard, reliable, expedient way to identify an entity to a human in a single property
-     *  with more pertinent identifying information than its system id.
-     *  For use in logs, quick lists, and abstracted framework components. */
-    descriptor: string;
-}
-export interface AuthTenant {
-    name: string;
-    code: string;
-    currentSubscription?: AuthSubscription | undefined;
-    id?: string | undefined;
-    Users?: TenantUser[] | undefined;
-}
-export interface Buffer {
-}
-export interface Build {
-    name: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface BuildCriteria {
-    name?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface BuildPipeline {
-    name: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface BuildPipelineCriteria {
-    name?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** A placeholder configuring an isolated instance of a fully functional,
- *  independent implementation of the customer's service inventory.
- *  A Cabinet declares the target environment and cluster
- *  to which that inventory instance will be deployed
- *  and the namespace by which it will be isolated.
- *  They can come and go as customers' admin users define them. */
-export interface Cabinet {
-    enterpriseCode: string;
-    environment: string;
-    name: string;
-    id?: string | undefined;
-    /** The name of the branch that targets this cabinet.
-     *  NOTE: This is a NAMESAKE: it applies to ANY REPO.
-     *  NOTE: Child branches may also deploy to this cabinet if they do not have
-     *        another cabinet binding that is closer in their lineage. */
-    branch?: string | undefined;
-    /** Name of the target cluster into which the cabinet will be deployed. */
-    cluster?: string | undefined;
-    /** A list of this cabinet's deployment specs for each service/component in the customer's service inventory. */
-    footprints: Partial<ContainerFootprint>[];
-    /** (Optional) The default resource allocation spec to apply to containers in this cabinet. (compositional?) */
-    defaultFootprint?: Partial<ContainerFootprint> | undefined;
-    /** **DEPRECATED: Use hostNaming instead!!!**
-     *
-     *  Domain names that route ONLY to this cabinet. */
-    domains?: HostNameConfig[] | undefined;
-    /** All of the applicable domain names and their strategies for routing assets.
-     *
-     *  This list is the end result of a smash-merge of all ScopedHostNameConfigs that apply to this cabinet,
-     *  and it is able to be kept in sync by embedding and cascading. */
-    hostNaming?: SingleHostNameStrategyForCabinet[] | undefined;
-    /** Details of the actual physical implementation of this cabinet. */
-    infrx?: CabinetInfrastructure | undefined;
-    /** The enterprise version number that is to be deployed to this cabinet.
-     *  NOTE: The assignment of this version number does not mean that this version IS intact in this cabinet;
-     *        only that it is intended to be.  Look to the EnterpriseRunState for which of the assets of this version are actually deployed. */
-    version?: string | undefined;
-    /** Selection requirements for AssetVersionConfigs
-     *  when assembling a new EnterpriseVersionConfig for this cabinet,
-     *  or for selecting an EnterpriseVersionConfig to assign to this cabinet. */
-    tagFilter?: AndOrNot | undefined;
-    /** The prefix to apply to all port numbers within this cabinet,
-     *  in order to avoid collisions on a single cluster node (or machine). */
-    portPrefix?: number | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-/** A reference to an cabinet and the cluster it's in. */
-export interface CabinetClusterRoot {
-    name: string;
-    id?: string | undefined;
-    cluster?: string | undefined;
-    version?: string | undefined;
-    infrx?: CabinetInfrastructure | undefined;
-    hostNaming?: SingleHostNameStrategyForCabinet[] | undefined;
-}
-/** A reference to an cabinet and the cluster it's in. */
-export interface CabinetClusterScope {
-    name: string;
-    cluster?: string | undefined;
-}
-/** Represents the enterprise configuration currently in play in a given cabinet,
- *  in terms of versions of the enterprise and its assets.
- *  This is a composite/hybrid object made up of a Cabinet, EnterpriseVersionConfig and an EnterpriseRunState.
- *  Compares versions of each asset between the version specified in the assigned enterprise version config
- *  and the version that is actually physically running in the cabinet. */
-export interface CabinetConfigState {
-    enterprise: string;
-    environment: string;
-    cabinet: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    timestamp: Date;
-    /** Undefined if a cluster has not yet been assigned to EITHER the cabinet OR the environment. */
-    clusterName?: string | undefined;
-    /** The enterprise configuration assigned to the cabinet. */
-    versionConfig?: EnterpriseVersionConfig | undefined;
-    /** A snapshot of the assets actually running in the cabinet. */
-    runState?: EnterpriseRunState | undefined;
-}
-export interface CabinetConfigStateRequest {
-    enterprise: string;
-    cabinet: string;
-    forceRefresh?: boolean | undefined;
-}
-export interface CabinetCreateActivity {
-    enterprise: string;
-    environment: string;
-    cabinet: string;
-    cluster: string;
-    type: ActivityTypeEnum;
-    title: string;
-    by: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed: Date;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface CabinetCreateActivityCriteria {
-    enterprise?: string | undefined;
-    environment?: string | undefined;
-    cabinet?: string | undefined;
-    cluster?: string | undefined;
-    type?: string | undefined;
-    title?: string | undefined;
-    by?: string | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed?: Date | undefined;
-    assetsName?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface CabinetCriteria {
-    name?: StringFilter | undefined;
-    enterpriseCode?: string | undefined;
-    environment?: string | undefined;
-    cluster?: string | undefined;
-    branch?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** The host naming strategies applicable in a given cabinet.
- *
- *  NOTE:  This entity is the RESULT of a smash-merge of the applicable ScopedHostNameConfig instances. */
-export interface CabinetHostNameConfig {
-    enterprise: string;
-    cabinet: string;
-    naming: HostNameConfig[];
-}
-/** Requests the host name configuration for each relevant cabinet. */
-export interface CabinetHostNameConfigCriteria {
-    enterprise: string;
-    cluster?: string | undefined;
-    environment?: string | undefined;
-    cabinet?: string | undefined;
-    domainName?: string | undefined;
-    strategy?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Attributes for referencing and creating actual running resources that comprise the infrastructure for a cabinet.
- *  That is, this is the pertinent information required to manage an actual physical implementation of a cabinet. */
-export interface CabinetInfrastructure {
-    enterpriseCode: string;
-    cabinetName: string;
-    namespace: string;
-    ingressSpec: CabinetIngressDef;
-    ingressResourceProperties?: CabinetIngressResourceAttributes | undefined;
-}
-/** Specifications for ingress controllers and request routing.
- *  Based on an ingress controller deployed as a Helm chart. */
-export interface CabinetIngressDef {
-    enterpriseCode: string;
-    cabinet: string;
-    ingress_default_ruleset_name: string;
-    cert_secret_name: string;
-    cert_name: string;
-    cert_issuer: "prod" | "staging";
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-/** Typically hydrated by the cloud platform provider during creation of the infrastructure resources;
- *  the properties of the running ingress infrastructure
- *  that are NOT part of the spec and are unique to the actual instances of the physical resources
- *  (eg: unique resource IDs given by the cloud platform). */
-export interface CabinetIngressResourceAttributes {
-    enterpriseCode: string;
-    cabinetName: string;
-}
-/** Placeholder request to retrieve available FullyQualifiedCabinetScopes.
- *  Actual parameters are all retrieved from the current user context,
- *  not from the request contract. */
-export interface CabinetScopesCriteria {
-    /** Filters for cabinets that are affected by the given scope. */
-    scope?: Scope | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface ChangePasswordRequest {
-    login: string;
-    newPassword: string;
-    oldPassword?: string | undefined;
-}
-/** Identifier for a supported cloud service provider, for use in selecting infrastructure clients, provisioners, and credentials. */
-export declare enum CloudProviderEnum {
-    aws = "aws",
-    azure = "azure",
-    dockerHub = "dockerHub",
-    other = "other"
-}
-export interface Cluster {
-    name: string;
-    location: string;
-    providerSubscription: string;
-    resourceGroupName: string;
-    managedResourceGroupName: string;
-    resourceId: string;
-    ingressIp?: string | undefined;
-    serverUrl?: string | undefined;
-    /** This is the system id for the cluster instance entity,
-     *  NOT the identifier of the concrete cluster instance given by the cloud provider. */
-    id?: string | undefined;
-    /** The version of Kubernetes to use as the cluster. */
-    k8sVersion?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ClusterCriteria {
-    name?: StringFilter | undefined;
-    location?: string | undefined;
-    providerSubscription?: string | undefined;
-    resourceGroupName?: StringFilter | undefined;
-    managedResourceGroupName?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** The specs for a kubernetes cluster to be managed by the Codiac team.
- *  This class is used to programmatically put up and take down clusters. */
-export interface ClusterDef {
-    name: string;
-    provider: CloudProviderEnum;
-    providerSubscription: string;
-    locationName: string;
-    providerGroup: string;
-    nodeCount?: number | undefined;
-    ingressDef?: IngressDef | undefined;
-    privateOwner?: string | undefined;
-    /** This is the system id for the cluster definition, NOT the identifier of the concrete cluster instance given by the cloud provider. */
-    id?: string | undefined;
-    /** The code recognized by the cloud provider for identifying which virtual machine configuration to use as cluster nodes.
-     *  NOTE:  There can only be one, and this cannot be changed after the cluster is created. */
-    nodeSpec: string;
-    /** The quantity of nodes with which to initialize the cluster. */
-    startingNodeCount: number;
-    /** The human-readable name to use for the cloud provider security account
-     *  that will identify the cluster itself. */
-    identitySpec: object;
-    /** The actual resource details of the security identity of the cluster itself.
-     *  (In Azure this is either a Service Principal or a Managed Identity). */
-    identityInstance?: SecurityAccount | undefined;
-    /** (byref) A reference to the most recent concrete cluster implementation of this def.
-     *  Contains only identifying information; to get actual node counts etc,
-     *  you would have to take a snapshot via azaks/kubectl. */
-    instance?: Cluster | undefined;
-    /** (Optional) The default resource allocation spec to apply to containers in this cluster. */
-    defaultFootprint?: ContainerFootprint | undefined;
-    /** Node pools in addition to thw default node pool created with the cluster. */
-    nodePools?: NodePoolDef[] | undefined;
-    /** User account credentials with which to create new Windows nodes in the cluster.
-     *
-     *  A Windows node is required to run a windows image,
-     *  a backward compatibility for a legacy image format called "Windows",
-     *  which is required to run outdated Microsoft proprietary software
-     *  such as Microsoft WCF and classic .Net Framework applications.
-     *  This profile must be applied at cluster creation,
-     *  because a cluster cannot be later updated to support windows node pools. */
-    windowsAdmin?: WindowsAdminProfile | undefined;
-    /** The resourceId of the subnet in which the cluster resides. */
-    subnet?: string | undefined;
-    /** The version of Kubernetes to use as the cluster. */
-    k8sVersion?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ClusterDefCriteria {
-    name?: StringFilter | undefined;
-    providerSubscription?: string | undefined;
-    providerGroup?: string | undefined;
-    locationName?: string | undefined;
-    hasInstance?: boolean | undefined;
-    privateOwner?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface ClusterWithIngress {
-    name: string;
-    provider: CloudProviderEnum;
-    providerSubscriptionId: string;
-    locationName: string;
-    ingressIp?: string | undefined;
-}
-/** Our custom Tenant class. */
-export interface CodiacTenant {
-    name: string;
-    code: string;
-    currentSubscription?: AuthSubscription | undefined;
-    id?: string | undefined;
-    Users?: TenantUser[] | undefined;
-}
-/** search contract for our custom Tenant class. */
-export interface CodiacTenantCriteria {
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    code?: string[] | string | undefined;
-    userLogin?: string | undefined;
-}
-/** Our custom user type. */
-export interface CodiacUser {
-    phone: string;
-    tenantCode: string;
-    firstName: string;
-    lastName: string;
-    email: string;
-    roles: AuthRole[];
-    /** Globally unique, immutable system id, used for data integrity (they can NEVER change this). */
-    id?: string | undefined;
-    /** Globally unique, mutable, user-defined, human-readable identifier. */
-    login: string;
-    /** Obviously passwords are required, but this property is optional to allow it to remain unpopulated */
-    password?: string | undefined;
-    /** Standard, reliable, expedient way to identify an entity to a human in a single property
-     *  with more pertinent identifying information than its system id.
-     *  For use in logs, quick lists, and abstracted framework components. */
-    descriptor: string;
-    /** (Compositional property: AccessProfiles are most likely embedded and not persisted on their own) */
-    profiles: AccessProfile[];
-}
-export interface CodiacUserCriteria {
-    phone?: StringFilter | undefined;
-    tenantId?: string | undefined;
-    /** Selects Principals that have a tenant profile
-     *  for the given tenantCode. */
-    tenantCode?: UserTenantCodeFilter | undefined;
-    role?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    login?: string | undefined;
-    password?: string | undefined;
-}
-export interface CodiacUserPatch {
-    phone?: string | undefined;
-    /** Globally unique, immutable system id, used for data integrity (they can NEVER change this). */
-    id: string;
-    firstName?: string | undefined;
-    lastName?: string | undefined;
-    email?: string | undefined;
-}
-/** An historical record of a change made to the the configuration of the an enterprise for a given cabinet,
- *  to be used, together with the latest preceeding snapshot and other change events, as the specification for a deployment.
- *  This entity reflects only a proposed configuration change for the enterprise on its creation date;
- *  because it was not necessarily deployed, it DOES NOT necessarily reflect the current state of the enterprise running in the targeted cabinet. */
-export interface ConfigChange {
-    enterprise: string;
-    cabinet: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ConfigChangeCriteria {
-    enterprise?: StringFilter | undefined;
-    cabinet?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface ConfigDef {
-    enterprise: string;
-    asset: string;
-    type: ConfigDefTypesEnum;
-    /** This will eventually need to become extensible */
-    format: ConfigFormatsEnum;
-    /** (Applies only when type=file) */
-    targetFile?: string | undefined;
-    description?: string | undefined;
-    settings?: ScopedSetting[] | undefined;
-    id?: string | undefined;
-}
-export interface ConfigDefCriteria {
-    enterprise?: string | undefined;
-    asset?: string | undefined;
-    type?: "env" | "file" | "filestore" | "footprint" | "helm" | undefined;
-    targetFile?: string | undefined;
-    format?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Values of ScopedSetting.targetFile for NON-FILE configs. */
-export declare enum ConfigDefTypesEnum {
-    env = "env",
-    file = "file",
-    filestore = "filestore",
-    footprint = "footprint",
-    helm = "helm"
-}
-export interface ConfigDeploymentActivity {
-    deployAttemptId: string;
-    enterpriseVersion: string;
-    enterprise: string;
-    environment: string;
-    cabinet: string;
-    cluster: string;
-    assetName: string;
-    succeeded: boolean;
-    errorMessage?: string | undefined;
-    type: ActivityTypeEnum;
-    title: string;
-    by: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed: Date;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ConfigDeploymentActivityCriteria {
-    deployAttemptId?: string | undefined;
-    enterpriseVersion?: string | undefined;
-    enterprise?: string | undefined;
-    environment?: string | undefined;
-    cabinet?: string | undefined;
-    cluster?: string | undefined;
-    succeeded?: boolean | undefined;
-    type?: string | undefined;
-    title?: string | undefined;
-    by?: string | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed?: Date | undefined;
-    assetsName?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** An object representation of a config file, assembled from ScopedSettings.
- *  This document can take any form, and is constructed solely from settings and values,
- *  with all meta information omitted to preserve the integrity of the ultimate config file.
- *  NOTE: To view the list of un-smashed settings with metadata from which this document is assembled,
- *  fire the same request object against the ScopedSetting endpoint. */
-export interface ConfigDoc {
-    id?: string | undefined;
-}
-export interface ConfigDocSpecForOne {
-    enterprise: string;
-    asset: string;
-    targetFile: string;
-    cabinet: string;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Serializer declaration for a data document. */
-export declare enum ConfigFormatsEnum {
-    ini = "ini",
-    json = "json",
-    toml = "toml",
-    xml = "xml",
-    yaml = "yaml"
-} /** Structure of settings and their data types supported by an Asset.
- *  (ie: structure of a config file, environment variable list, Asset attributes, etc.) */
-export interface ConfigSchema {
-    definitions: object;
-    /** All properties declared here are required.
-     *  NOTE: Property names cannot overlap with optionalProperties. */
-    properties: object;
-    /** NOTE: Property names cannot overlap with optionalProperties. */
-    optionalProperties: object;
-    /** Indicates that properties may be added that are not defined in the schema. */
-    additionalProperties?: boolean | undefined;
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-/** The resource allocation profile that will be assigned
- *  to a given app/service/component container in the customer's inventory.
- *  Declares requested and maximum memory, cpu, and replicas.
- *  Future:  This class is where we would declare container affinity. */
-export interface ContainerFootprint {
-    assetName: string;
-    replicas: number;
-    cpuRequest?: string | undefined;
-    cpuLimit?: string | undefined;
-    memRequest?: string | undefined;
-    memLimit?: string | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ContainerFootprintCriteria {
-    cabinet?: string | undefined;
-    componentName?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface DeployAttempt {
-    name: string;
-    deploymentId: string;
-    result?: Result | BatchResult<Partial<Asset>> | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface DeployAttemptCriteria {
-    name?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** The specification for a deployment of an enterprise to a cabinet.
- *  NOTE:
- *  Though the deployment does necessarily reflect the comprehensive collection of Snapshot and ConfigChanges to date of its creation,
- *  it does NOT necessarily reflect the entire enterprise: a deployment can certainly be a partial deployment of an enterprise.
- *  eg: a deployment may ony be deploying an upgrade to a single service in the enterprise rather than the whole thing.
- *
- *  TODO:  Provide for specificying hings other than services: eg ConfigMaps, Secrets, Ingress Routes, Footprint mods? */
-export interface Deployment {
-    name: string;
-    enterprise: string;
-    environment: string;
-    cabinet: string;
-    version: EnterpriseVersionConfig;
-    assets?: string[] | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface DeploymentActivity {
-    deployAttemptId: string;
-    enterpriseVersion: string;
-    enterprise: string;
-    environment: string;
-    cabinet: string;
-    cluster: string;
-    assets: object[];
-    succeeded: boolean;
-    errorMessage?: string | undefined;
-    type: ActivityTypeEnum;
-    title: string;
-    by: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed: Date;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface DeploymentActivityCriteria {
-    deployAttemptId?: string | undefined;
-    enterpriseVersion?: string | undefined;
-    enterprise?: string | undefined;
-    environment?: string | undefined;
-    cabinet?: string | undefined;
-    cluster?: string | undefined;
-    succeeded?: boolean | undefined;
-    type?: string | undefined;
-    title?: string | undefined;
-    by?: string | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed?: Date | undefined;
-    assetsName?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface DeploymentCriteria {
-    id?: StringFilter | undefined;
-    name?: StringFilter | undefined;
-    enterprise?: StringFilter | undefined;
-    cabinet?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface DeployPipeline {
-    name: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface DeployPipelineCriteria {
-    name?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Defines a discriminated (tagged) union of different record types.
- *
- *  "Discriminator" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface DiscriminatorTypeDef {
-    /** name of the data member that is the tag of the union. */
-    discriminator: string;
-    /** the dictionary of schemas that are applied according to the value of the tag member in the data. */
-    mapping: object;
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-/** Defines a homogenous array of any size (possibly empty) with the elements that satisfy a given schema.
- *
- *  "Elements" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface ElementsTypeDef {
-    elements: NativeTypeDef;
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-/** Defines a data instance that can be of any type, including JSON null.
- *
- *  "Empty" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface EmptyTypeDef {
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-export interface Enterprise {
-    code: string;
-    subscription: string;
-    id?: string | undefined;
-    /** The definitive list of services comprising this enterprise. */
-    assets: Asset[];
-    products: Product[];
-    defaultFootprint?: Partial<ContainerFootprint> | undefined;
-    domains: HostNameConfig[];
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface EnterpriseCriteria {
-    code?: StringFilter | undefined;
-    subscription?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface EnterpriseRoot {
-    name: string;
-    assets: Asset[];
-    environments: EnvironmentRoot[];
-}
-/** Runstate is an objective observation that gets diff'ed against an entepriseVersionConfig.
- *  As such, it doesn't know what enterprise version is supposed to be delployed,
- *  only the actual asset versions that in fact are. */
-export interface EnterpriseRunState {
-    enterprise: string;
-    cabinet: string;
-    entityType: string;
-    entityName: string;
-    version: string;
-    tags?: Tag[] | undefined;
-    contents?: IVersionRef[] | undefined;
-    contentHash?: string | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface EnterpriseRunStateCriteria {
-    enterprise?: string | undefined;
-    cabinet?: string | undefined;
-    contentHash?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** A reference to an enterprise and its environment scopes. */
-export interface EnterpriseScope {
-    name: string;
-    environments: EnvironmentScope[];
-    id?: string | undefined;
-}
-export interface EnterpriseVersionConfig {
-    enterprise: string;
-    entityType: string;
-    entityName: string;
-    version: string;
-    tags?: Tag[] | undefined;
-    contents?: IVersionRef[] | undefined;
-    contentHash?: string | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface EnterpriseVersionConfigCriteria {
-    enterprise?: string | undefined;
-    version?: string | undefined;
-    contentHash?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Access Control List (ACL) for a single securable object.
- *  A list of permissions declared on a single, identifiable concrete entity. */
-export interface EntityAcl {
-    entityType: string;
-    entityId: string;
-    Permissions: Permission[];
-    /** This is a composite key enforcing uniqueness on a single instance of the entity type. (ie: there can be only one of these per entity id) */
-    id: string;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface EntityAclCriteria {
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    entityType?: string | undefined;
-    entityId?: string | undefined;
-    /** Selects Principals that have a tenant profile
-     *  for the given tenantCode. */
-    role?: EntityAclRoleFilter | undefined;
-}
-/** Selects Principals that have a tenant profile
- *  for the given tenantCode. */
-export interface EntityAclRoleFilter {
-    role: string;
-    property?: string | undefined;
-    $not?: EntityAclRoleFilter | undefined;
-}
-/** "Enum" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface EnumTypeDef {
-    enumValue: string[];
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-export interface Environment {
-    code: string;
-    enterpriseCode: string;
-    subscription: string;
-    sequence: number;
-    id?: string | undefined;
-    /** The collection of placeholders for isolated instances of a customer's service inventory. */
-    cabinets: Cabinet[];
-    /** The collection of predefined specs for the kubernetes clusters in this environment. */
-    clusterDefs: ClusterDef[];
-    /** (Optional) The default resource allocation spec to apply to containers in this cluster. */
-    defaultFootprint?: Partial<ContainerFootprint> | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface EnvironmentCriteria {
-    code?: string | undefined;
-    enterpriseCode?: string | undefined;
-    subscription?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** A reference to an environment and its cabinets. */
-export interface EnvironmentRoot {
-    name: string;
-    cabinets: CabinetClusterRoot[];
-    id?: string | undefined;
-    code?: string | undefined;
-    sequence?: number | undefined;
-    clusters?: ClusterWithIngress[] | undefined;
-}
-/** A reference to an environment and its cabinets. */
-export interface EnvironmentScope {
-    name: string;
-    cabinets: CabinetClusterScope[];
-}
-export interface Error {
-    name: string;
-    message: string;
-    stack?: string | undefined;
-}
-export interface FileRequest {
-    path: string;
-}
-/** Abstraction and specification for a share on a file store,
- *  to be mapped to a reserved folder on an asset.
- *
- *  This class can be used as the specification
- *  to programmatically put up and take down concrete file stores.
- *  As such, it outlives the actual entity described by its "instance" property. */
-export interface FileStoreDef {
-    name: string;
-    type: FileStoreTypeEnum;
-    storageAccount: string;
-    shareName: string;
-    providerSubscriptionId: string;
-    resourceGroup: string;
-    instance?: FileStoreInfrx | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface FileStoreDefCriteria {
-    name?: StringFilter | undefined;
-    /** Supported file store adapters that can be mapped to a reserved folder on an asset. */
-    type?: "AzureBlobStorage" | "AzureDisk" | "AzureFileStorage" | "HostMachineFolder" | undefined;
-    shareName?: StringFilter | undefined;
-    providerSubscriptionId?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Metadata describing an existing concrete instance
- *  of a FileStoreDef resource within a cloud provider. */
-export interface FileStoreInfrx {
-    providerSubscriptionId: string;
-    resourceGroup: string;
-    resourceId: string;
-    accessKey: string;
-}
-/** Supported file store adapters that can be mapped to a reserved folder on an asset. */
-export declare enum FileStoreTypeEnum {
-    AzureBlobStorage = "AzureBlobStorage",
-    AzureDisk = "AzureDisk",
-    AzureFileStorage = "AzureFileStorage",
-    HostMachineFolder = "HostMachineFolder"
-} /** Calls out the cabinet and its parent structures. */
-export interface FullyQualifiedCabinetScopes {
-    enterprises: EnterpriseScope[];
-    clusters: string[];
-}
-export interface HelmAssetTemplate {
-    /** Maps a port number to the associated setting (full dot path name) in the chart config. */
-    portMappings: object;
-    chart: HelmChartSpec;
-    assetType: AssetTypesEnum;
-    defaultName: string;
-    defaultCode: string;
-    hasIngress?: boolean | undefined;
-    /** List of fileStores required by the asset.  Each one requires capture. */
-    fileStores?: object[] | undefined;
-    /** List of secretStores required by the asset.  Each one requires capture. */
-    secretStores?: object[] | undefined;
-    /** Declaration-time attributes of the Asset itself
-     *  (used for managing the asset before deploying, not at runtime) */
-    properties?: ConfigSchema | undefined;
-    /** Config files supported by the asset and their structures.
-     *
-     *  TODO: Need to specify which settings should be secrets.  Might need to define that in the metadata or extend the typedefs */
-    configs?: object | undefined;
-    /** Environment variables supported by the asset. */
-    envs?: object | undefined;
-    /** (Optional: defaults to built-in deploymment-labeling convention) Boolean logic by which to recognize the pods
-     *  that belong to this asset among all the other pods in a namespace.
-     *  This property is an array type to allow for an asset to have multiple pod specs that each may have their own replicas. */
-    customPodFilters?: object[] | undefined;
-    /** Abstract declarations of folder paths inside the image
-     *  that are to be later mapped (at configuration time) to file store definitions. */
-    reservedFolders?: AssetFolderReservation[] | undefined;
-}
-/** An unversioned identification of a particular Helm chart. */
-export interface HelmChartSpec {
-    chartName: string;
-    chartRepoCode: string;
-    chartRepoUrl: string;
-    chartScope?: string | undefined;
-    defaultChartVersion?: string | undefined;
-    helmConfig?: ConfigSchema | undefined;
-}
-/** Declaration of a domain name to use and the specification
- *  for how host names will be created for services and cabinets.
- *
- *  NOTE:  This entity is the RESULT of a smash-merge of the applicable ScopedHostNameConfig instances. */
-export interface HostNameConfig {
-    domainName: string;
-    strategy: object | "cab_dot_cluster_dot_domain_slash_service" | "cab_dot_cluster_dot_enterprise_dot_domain_slash_service" | "cab_dot_domain_slash_service" | "domain_slash_service" | "globally_shared_domain_slash_service" | "service_dot_domain" | "shared_ingress_ip" | "svc_dot_cab_dot_domain"[];
-}
-/** Filter for retrieving all ScopedHostNameConfigs applicable to the given cabinets. */
-export interface HostNameConfigCabinetScopeFilter {
-    cabinets: FullyQualifiedCabinetScopes;
-    $not?: HostNameConfigCabinetScopeFilter | undefined;
-    property?: string | undefined;
-}
-export declare enum HostNameStrategyEnum {
-    cab_dot_cluster_dot_domain_slash_service = "cab_dot_cluster_dot_domain_slash_service",
-    cab_dot_cluster_dot_enterprise_dot_domain_slash_service = "cab_dot_cluster_dot_enterprise_dot_domain_slash_service",
-    cab_dot_domain_slash_service = "cab_dot_domain_slash_service",
-    domain_slash_service = "domain_slash_service",
-    globally_shared_domain_slash_service = "globally_shared_domain_slash_service",
-    service_dot_domain = "service_dot_domain",
-    shared_ingress_ip = "shared_ingress_ip",
-    svc_dot_cab_dot_domain = "svc_dot_cab_dot_domain"
-} /** Identifying information of the subscription as it is represented in the billing system.
- *  This object should get hydrated by a sync task. */
-export interface IBillingPlanRef {
-    /** The name for the plan as it appears to a user. */
-    friendlyName: string;
-    /** The unique plan ID from the billing system. */
-    id: string;
-    /** The unique identifier for this tenant in the billing system. */
-    customerId: string;
-    /** Human-readable immutable identitifer for the plan. */
-    code: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    nextRequiredSync?: Date | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    lastSync?: Date | undefined;
-}
-export interface ICommandLineProbeAction {
-    /** The command line to execute inside the container.
-     *
-     *  The working directory for the command is root ('/') in the container's filesystem.
-     *  The command is simply exec'd, it is not run inside a shell,
-     *  so traditional shell instructions ('|', etc) won't work.
-     *  To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */
-    command: string[];
-    actionType: ProbeActionTypesEnum;
-}
-export interface IGrpcProbeAction {
-    /** Port number of the gRPC service. Number must be in the range 1 to 65535. */
-    port: number;
-    /** Service is the name of the service to place in the gRPC HealthCheckRequest
-     *  (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
-     *  If this is not specified, the default behavior is defined by gRPC. */
-    service: string;
-    actionType: ProbeActionTypesEnum;
-}
-export interface IHttpProbeAction {
-    /** Scheme to use for connecting to the host. */
-    scheme: "http" | "https";
-    /** Host name to connect to, defaults to the pod IP. */
-    host: string;
-    /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */
-    port: string | number;
-    /** Relative url to access on the HTTP server. */
-    path: string;
-    /** Custom headers to set in the request. HTTP allows repeated headers. */
-    httpHeaders?: object[] | undefined;
-    actionType: ProbeActionTypesEnum;
-}
-/** An unversioned reference to an image repository. */
-export interface Image {
-    registry: ImageRegistry;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-    name: string;
-    scope?: string | undefined;
-    os?: "Linux" | "Windows" | undefined;
-    architecture?: "amd64" | "arm32v6" | "arm32v7" | "arm64v8" | "windows-amd64" | undefined;
-}
-export interface ImageCriteria {
-    name?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface ImageRegistry {
-    id?: string | undefined;
-    /** The token to be used by the cluster to authenticate when pulling images from this registry.
-     *  This property references a secret record in a SecretStore. */
-    pullSecret?: PullSecretRef | undefined;
-    /** The backup token to be used by the cluster to authenticate when pulling images from this registry.
-     *  This property references a secret record in a SecretStore.
-     *
-     *  NOTE: The secondary pull secret is available for seamless transitions when replacing the primary.
-     *  The primary and secondary should never have the same expiration dates. */
-    pullSecretSecondary?: PullSecretRef | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-    code: string;
-    url: string;
-    provider: CloudProviderEnum;
-    type: ImageRegistryTypes;
-    pullRequiresAuth?: boolean | undefined;
-    infoUrl?: string | undefined;
-    useRemoteFiltering?: boolean | undefined;
-}
-export interface ImageRegistryCriteria {
-    code?: StringFilter | undefined;
-    url?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Matches an ImageRegistry entity, just isnt a domain entity or auditable.
- *  This class is for use as a request: it is NOT A DOMAIN ENTITY. */
-export interface ImageRegistrySpec {
-    code: string;
-    url: string;
-    provider: CloudProviderEnum;
-    type: ImageRegistryTypes;
-    pullRequiresAuth?: boolean | undefined;
-    infoUrl?: string | undefined;
-    useRemoteFiltering?: boolean | undefined;
-}
-export declare enum ImageRegistryTypes {
-    AmazonEcr = "AmazonEcr",
-    AzureCr = "AzureCr",
-    DockerHub = "DockerHub",
-    Other = "Other",
-    helm = "helm"
-} /** An unversioned reference to an image repository.
- *  Matches an Image entity.  This class is for use as a request: it is NOT A DOMAIN ENTITY. */
-export interface ImageSpec {
-    name: string;
-    registry: ImageRegistrySpec;
-    scope?: string | undefined;
-    os?: "Linux" | "Windows" | undefined;
-    architecture?: "amd64" | "arm32v6" | "arm32v7" | "arm64v8" | "windows-amd64" | undefined;
-}
-/** Specifications for ingress controllers and request routing.
- *  Based on an ingress controller deployed as a Helm chart. */
-export interface IngressDef {
-    chart_name: string;
-    service_name: string;
-    service_namespace: string;
-    replicas: number;
-    ip_name: string;
-    cert_secret_name: string;
-    cert_name: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ISocketProbeAction {
-    /** Host name to connect to, defaults to the pod IP. */
-    host: string;
-    /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */
-    port: string | number;
-    actionType: ProbeActionTypesEnum;
-}
-export interface ISourcedSetting {
-    /** The setting name, using dot notation for hierarchy within the config doc. */
-    setting: string;
-    /** Specs for where to retrieve the value from. */
-    source: KvpReference;
-}
-/** Describes the outcome of an attempt to validate an entity, property or value.
- *  The overall status is determined by whether or not its "failure" property is undefined. */
-export interface IValidationStatus {
-    /** Descriptor for the entity/property/value that was validated */
-    candidate: string;
-    /** Description of why the candidate entity failed validation (undefined for successful validations). */
-    failure?: string | undefined;
-    /** Additional user instructions that may apply despite a successful validation. */
-    warning?: string | undefined;
-    /** Additional layer of granularity on a validation failure.
-     *  eg: if the status describes an entity validation failure, the details are the individual property failures.
-     *  eg: if the status describes a property validation failure, the details may be the various constraints it failed to meet. */
-    details?: IValidationStatus[] | undefined;
-}
-export interface IVersionRef {
-    entityType: string;
-    entityName: string;
-    version: string;
-    contents?: IVersionRef[] | undefined;
-    contentHash?: string | undefined;
-}
-export interface JobAssetTemplate {
-    image: ImageSpec;
-    defaultPort: number;
-    defaultImageVersion?: string | undefined;
-    assetType: AssetTypesEnum;
-    defaultName: string;
-    defaultCode: string;
-    hasIngress?: boolean | undefined;
-    /** List of fileStores required by the asset.  Each one requires capture. */
-    fileStores?: object[] | undefined;
-    /** List of secretStores required by the asset.  Each one requires capture. */
-    secretStores?: object[] | undefined;
-    /** Declaration-time attributes of the Asset itself
-     *  (used for managing the asset before deploying, not at runtime) */
-    properties?: ConfigSchema | undefined;
-    /** Config files supported by the asset and their structures.
-     *
-     *  TODO: Need to specify which settings should be secrets.  Might need to define that in the metadata or extend the typedefs */
-    configs?: object | undefined;
-    /** Environment variables supported by the asset. */
-    envs?: object | undefined;
-    /** (Optional: defaults to built-in deploymment-labeling convention) Boolean logic by which to recognize the pods
-     *  that belong to this asset among all the other pods in a namespace.
-     *  This property is an array type to allow for an asset to have multiple pod specs that each may have their own replicas. */
-    customPodFilters?: object[] | undefined;
-    /** Abstract declarations of folder paths inside the image
-     *  that are to be later mapped (at configuration time) to file store definitions. */
-    reservedFolders?: AssetFolderReservation[] | undefined;
-}
-/** A marketplace entity.
- *
- *  An abstract specification for an asset,
- *  to be used as the instructions for the creation
- *  of a concrete asset in an enterprise.
- *
- *  Allows the avilability to reuse an asset
- *  in separate enterprises (and tenants). */
-export interface Kit {
-    name: string;
-    library: string;
-    version: string;
-    tenantCode: string;
-    accessibleBy: KitAccessibilityEnum;
-    description?: string | undefined;
-    disabled?: boolean | undefined;
-    assetType: AssetTypesEnum;
-    id?: string | undefined;
-    template?: AssetTemplate | undefined;
-    tags: string[];
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-/** Indicates who in the Codiac universe is allowed to view and use a Kit. */
-export declare enum KitAccessibilityEnum {
-    friends = "friends",
-    private = "private",
-    public = "public"
-}
-export interface KitCriteria {
-    name?: StringFilter | undefined;
-    library?: string | undefined;
-    version?: string | undefined;
-    tenantCode?: string | undefined;
-    disabled?: string | undefined;
-    assetType?: "helm" | "job" | "service" | undefined;
-    /** Applies constraints to an entity property that is a list of strings. */
-    tags?: StringListFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** The information needed to access an individual key value pair
- *  from a predefined data store. */
-export interface KvpReference {
-    type: KvpStoreTypesEnum;
-    name: string;
-    key: any;
-}
-/** The specs for a key value store to be managed by the codiac system.
- *  This class is used to programmatically put up and take down concrete key value stores. */
-export interface KvpStoreDef {
-    /** The friendly identifying name under which the key value store resource is registered within an enterprise.
-     *  The concrete instance that gets created will use this name
-     *  (if the instance exists already, this property
-     *  must match the name of the concrete instance). */
-    name: string;
-    /** The third party cloud provider service that is hosting this resource. */
-    provider: CloudProviderEnum;
-    /** Differentiator for key value store resources (eg: KeyVault, etcd, mongo, etc)
-     *  and their various implementations. */
-    type: KvpStoreTypesEnum;
-    /** Info describing the concrete instance of this kvp store
-     *  actually living within a cloud provider subscription. */
-    instance?: KvpStoreInfrx | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface KvpStoreDefCriteria {
-    name?: string | undefined;
-    /** Identifier for a supported cloud service provider, for use in selecting infrastructure clients, provisioners, and credentials. */
-    provider?: "aws" | "azure" | "dockerHub" | "other" | undefined;
-    /** List of codenames for supported KeyValue stores.
-     *  eg: Clients for these types of stores are registered under these values. */
-    type?: "awsKeyVault" | "azBlob" | "azKeyVault" | "etcd" | "mongoCollection" | "mongoDocument" | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface KvpStoreInfrx {
-    type: KvpStoreTypesEnum;
-    /** The friendly, human-readable identifier of this resource,
-     *  as it is known by the cloud provider.
-     *  Its name is unique only within the resource group containing the instance,
-     *  and it necessarily matches the name of the definition from which it was spawned. */
-    name: string;
-    /** The third party cloud service provider that is hosting this resource. */
-    provider: CloudProviderEnum;
-    /** The Id given by the csp. */
-    resourceId: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-/** List of codenames for supported KeyValue stores.
- *  eg: Clients for these types of stores are registered under these values. */
-export declare enum KvpStoreTypesEnum {
-    awsKeyVault = "awsKeyVault",
-    azBlob = "azBlob",
-    azKeyVault = "azKeyVault",
-    etcd = "etcd",
-    mongoCollection = "mongoCollection",
-    mongoDocument = "mongoDocument"
-}
-export interface MyTenantRequest {
-}
-export declare enum NativeDataTypeEnum {
-    boolean = "boolean",
-    float32 = "float32",
-    float64 = "float64",
-    int16 = "int16",
-    int32 = "int32",
-    int8 = "int8",
-    string = "string",
-    timestamp = "timestamp",
-    uint16 = "uint16",
-    uint32 = "uint32",
-    uint8 = "uint8"
-} /** "Type" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface NativeTypeDef {
-    type: NativeDataTypeEnum;
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-/** An arbitrary grouping of OS-specific cluster nodes.
- *  All nodes in a pool are of the same vm type. */
-export interface NodePoolDef {
-    clusterName: string;
-    name: string;
-    nodeSpec: string;
-    startingNodeCount: number;
-    isWindows?: boolean | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface NodePoolDefCriteria {
-    clusterName?: StringFilter | undefined;
-    name?: StringFilter | undefined;
-    nodeSpec?: StringFilter | undefined;
-    /** AUTHOR NOTE:
-     *  This filter approach does NOT provide for:
-     *
-     *  1) Formula-driven filtering:  (property-scoped)  function(propVal: number)
-     *        comparison of calc on the property value ie:  WHERE 2 * [Overhead] <= 50,000
-     *
-     *  2) Entity-scoped formula-driven filtering     function (entity: T)
-     *        comparison of calcs on MANY DIFFERENT property values ie:  WHERE [Overhead] < 0.33 * [Revenue] */
-    startingNodeCount?: NumericFilter | undefined;
-    isWindows?: boolean | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** AUTHOR NOTE:
- *  This filter approach does NOT provide for:
- *
- *  1) Formula-driven filtering:  (property-scoped)  function(propVal: number)
- *        comparison of calc on the property value ie:  WHERE 2 * [Overhead] <= 50,000
- *
- *  2) Entity-scoped formula-driven filtering     function (entity: T)
- *        comparison of calcs on MANY DIFFERENT property values ie:  WHERE [Overhead] < 0.33 * [Revenue] */
-export interface NumericFilter {
-    /** property of the target object to compare (conventional default to the name of the criteria property) */
-    property?: string | undefined;
-    $equalTo?: number | undefined;
-    /** Deprecated:  use the $not operator with $equalTo instead */
-    $notEqualTo?: number | undefined;
-    $greaterThan?: number | undefined;
-    $greaterThanOrEqualTo?: number | undefined;
-    $lessThan?: number | undefined;
-    $lessThanOrEqualTo?: number | undefined;
-    /** A span of numbers from the given lower bound to the given upper bound.
-     *  Used for filtering and comparing of numeric values. */
-    $between?: Range | undefined;
-    $oneOf?: number[] | undefined;
-    /** AUTHOR NOTE:
-     *  This filter approach does NOT provide for:
-     *
-     *  1) Formula-driven filtering:  (property-scoped)  function(propVal: number)
-     *        comparison of calc on the property value ie:  WHERE 2 * [Overhead] <= 50,000
-     *
-     *  2) Entity-scoped formula-driven filtering     function (entity: T)
-     *        comparison of calcs on MANY DIFFERENT property values ie:  WHERE [Overhead] < 0.33 * [Revenue] */
-    $not?: NumericFilter | undefined;
-}
-export interface patchOperation {
-    op: patchOperationType;
-    path: string;
-    value: any;
-}
-export declare enum patchOperationType {
-    add = "add",
-    copy = "copy",
-    move = "move",
-    remove = "remove",
-    replace = "replace",
-    test = "test"
-} /** The granting of priveleges to a given Role. */
-export interface Permission {
-    role: AuthRole;
-    priveleges: Privelege[];
-}
-/** A type of operation that a given Role is allowed to perform on a securable object. */
-export declare enum Privelege {
-    "value0" = 0,
-    "value1" = 1,
-    "value2" = 2,
-    "value3" = 3,
-    "value4" = 4
-} /** Declares a probe action and when to run it against an asset. */
-export interface Probe {
-    enterprise: string;
-    asset: string;
-    type: ProbeUsageTypesEnum;
-    /** EITHER: Immutable unique human-readable identifier for a standard or otherwise predefined probe action.
-     *
-     *  OR: an inline probe action declaration. */
-    action: ICommandLineProbeAction | IHttpProbeAction | IGrpcProbeAction | ISocketProbeAction | string;
-    /** Semantic version range in which this probe is applicable. */
-    versionRange?: string | undefined;
-    initialDelaySeconds?: number | undefined;
-    periodSeconds?: number | undefined;
-    disabled?: boolean | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-/** Type declaration for the Probe sub-class, determining the nature of its behavior and handling. */
-export declare enum ProbeActionTypesEnum {
-    exec = "exec",
-    grpc = "grpc",
-    http = "http",
-    socket = "socket"
-}
-export interface ProbeCriteria {
-    enterprise?: string | undefined;
-    asset?: string | undefined;
-    /** Type declaration for the Probe sub-class, determining the nature of its behavior and handling. */
-    actionType?: "exec" | "grpc" | "http" | "socket" | undefined;
-    disabled?: boolean | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Declaration of what purpose the probe serves,
- *  ie: where a probe is fired in the runtime lifecycle of an asset. */
-export declare enum ProbeUsageTypesEnum {
-    liveness = "liveness",
-    readiness = "readiness",
-    startup = "startup"
-} /** A grouping of assets within an enterprise that are released together. */
-export interface Product {
-    enterpriseCode: string;
-    name: string;
-    assets: Asset[];
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ProductCriteria {
-    name?: StringFilter | undefined;
-    enterprise?: string | undefined;
-    /** Applies constraints to an entity property that is a list of strings. */
-    assetCodes?: StringListFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface ProductVersionConfig {
-    productName: string;
-    enterpriseCode: string;
-    releaseName?: string | undefined;
-    entityType: string;
-    entityName: string;
-    version: string;
-    tags?: Tag[] | undefined;
-    contents?: IVersionRef[] | undefined;
-    contentHash?: string | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ProductVersionConfigCriteria {
-    enterpriseCode?: string | undefined;
-    productName?: string | undefined;
-    releaseName?: string | undefined;
-    version?: string | undefined;
-    contentHash?: string | undefined;
-    multi?: object[] | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Defines an object with required and optional properties
- *
- *  "Properties" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface PropertiesTypeDef {
-    /** All properties declared here are required.
-     *  NOTE: Property names cannot overlap with optionalProperties. */
-    properties: object;
-    /** NOTE: Property names cannot overlap with optionalProperties. */
-    optionalProperties: object;
-    /** Indicates that properties may be added that are not defined in the schema. */
-    additionalProperties?: boolean | undefined;
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-/** Metadata for the credentials that a cluster will use when pulling images from an image registry.
- *  This class points to a a specific secret record in a known secret store. */
-export interface PullSecretRef {
-    /** Enables basic storage and retrieval of dates and times. */
-    expiresOn: Date;
-    /** Applies to the creation of this instance of PullSecretRef, not necessarily the same as the secret itself in the secret store. */
-    created: Date;
-    /** Applies to the creation of this instance of PullSecretRef, not necessarily the same as the secret itself in the secret store. */
-    createdBy: string;
-    /** Applies to the creation of this instance of PullSecretRef, not necessarily the same as the secret itself in the secret store. */
-    modified: Date;
-    /** Applies to the creation of this instance of PullSecretRef, not necessarily the same as the secret itself in the secret store. */
-    modifiedBy: string;
-    type: KvpStoreTypesEnum;
-    name: string;
-    key: any;
-}
-/** A span of numbers from the given lower bound to the given upper bound.
- *  Used for filtering and comparing of numeric values. */
-export interface Range {
-    from: number;
-    to: number;
-    inclusive: RangeBoundary;
-}
-/** Declaration of boundary conditions for a Range instance. */
-export declare enum RangeBoundary {
-    "value0" = 0,
-    "value1" = 1,
-    "value2" = 2,
-    "value3" = 3
-}
-export interface ReadyStateRequest {
-}
-/** The token must be submitted in the
- *  http header designated in the AuthSettings object for the auth api. */
-export interface RefreshTokenRequest {
-}
-/** defines a reference to the schema that is present in the corresponding key
- *  in the definitions member of the root schema.
- *
- *  "Ref" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface RefTypeDef {
-    ref: string;
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-export interface ResetPasswordRequest {
-    userLogin: string;
-}
-export interface Result {
-    success: boolean;
-    message?: string | undefined;
-    error?: Error | undefined;
-    /** Any errors or messages for the consumer about constraints that were not met in order to perform the operation. */
-    validation?: IValidationStatus | undefined;
-}
-export interface RoleAssignmentRequest {
-    userId: string;
-    roleName: string;
-    unassign?: boolean | undefined;
-}
-/** All the enterprises, assets, cabinets, environments, and clusters for a given tenant.
- *  That is, a semi-detailed list of all the primary entities of a tenant's software organization.
- *
- *  NOTE:  Though this is a domain entity, it is an emergent entity, so it will never need an id.
- *        It gets assembled from the tenant code and is filtered within itself. */
-export interface RootMap {
-    enterprises: EnterpriseRoot[];
-    clusters: ClusterWithIngress[];
-    id?: string | undefined;
-}
-export interface RootMapCriteria {
-    cabinet?: string | undefined;
-    enterprise?: string | undefined;
-    environment?: string | undefined;
-    cluster?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface Scope {
-    /** The level of the scope (eg: enterprise, environment, cluster, cabinet, asset, etc).
-     *  This level gives the value its rank in the hierarchy during a smash-merge resolution.
-     *  That is, environment values overwrite enterprise values, and cabinet values overwrite environment values. */
-    scope: string;
-    /** The name of the concrete instance at the given scope level.
-     *  (eg: "devcab1" for a scope of cabinet, "main" for scope of enterprise) */
-    target: string;
-    /** (FUTURE: NOT YET SUPPORTED) Indicates that this value shall govern over otherwise higher ranking scopes during evaluation.
-     *  NOTE: This value can still be overridden by a value in a higher ranking scope whose own governs flag is set. */
-    governs?: boolean | undefined;
-}
-/** Meta container for a ConfigDoc.
- *  based on the asset and target cabinet that config is built for. */
-export interface ScopedConfig {
-    enterprise: string;
-    asset: string;
-    cabinet: string;
-    targetFile: string;
-    sourcedSettings?: ISourcedSetting[] | undefined;
-    id?: string | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    createdBy: string;
-    /** The contents of the config itself. The config file can be produced by writing this property to a file named by this.targetFile. */
-    doc: ConfigDoc;
-}
-export interface ScopedConfigCriteria {
-    cluster?: string | undefined;
-    enterprise?: string | undefined;
-    environment?: string | undefined;
-    cabinet?: StringFilter | undefined;
-    asset?: StringFilter | undefined;
-    targetFile?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** An assignment of a HostNameStrategy for a single domain at a specific scope. */
-export interface ScopedHostNameConfig {
-    /** The level of the scope (eg: enterprise, environment, cluster, cabinet, asset, etc).
-     *  This level gives the value its rank in the hierarchy during a smash-merge resolution.
-     *  That is, environment values overwrite enterprise values, and cabinet values overwrite environment values. */
-    scope: string;
-    /** The name of the concrete instance at the given scope level.
-     *  (eg: "devcab1" for a scope of cabinet, "main" for scope of enterprise) */
-    target: string;
-    domainName: string;
-    strategy: HostNameStrategyEnum;
-    enterprise?: string | undefined;
-    id?: string | undefined;
-    /** (FUTURE: NOT YET SUPPORTED) Indicates that this value shall govern over otherwise higher ranking scopes during evaluation.
-     *  NOTE: This value can still be overridden by a value in a higher ranking scope whose own governs flag is set. */
-    governs?: boolean | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ScopedHostNameConfigCriteria {
-    scope?: StringFilter | undefined;
-    target?: StringFilter | undefined;
-    governs?: boolean | undefined;
-    enterprise?: string | undefined;
-    domainName?: StringFilter | undefined;
-    strategy?: StringFilter | undefined;
-    /** Filter for retrieving all ScopedHostNameConfigs applicable to the given cabinets. */
-    applicableTo?: HostNameConfigCabinetScopeFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** A single key-value setting within a config for an asset, scoped for its ultimate deployment context.
- *  That is, this is the value of one setting within a config file (the targetFile param);
- *  the scope/target (eg: "cabinet"/"cab16") tells us where to use it. */
-export interface ScopedSetting {
-    setting: string;
-    value: any;
-    targetFile: string;
-    asset: string;
-    enterprise: string;
-    scope: ScopeLevel;
-    target: string;
-    description?: string | undefined;
-    source?: KvpReference | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ScopedSettingCriteria {
-    setting?: string | undefined;
-    targetFile?: StringFilter | undefined;
-    asset?: StringFilter | undefined;
-    enterprise?: StringFilter | undefined;
-    scope?: "cabinet" | "enterprise" | "environment" | undefined;
-    target?: string | undefined;
-    /** Creates a filter expression that includes
-     *  all entities whose scopes are relevant input for a smash-merge
-     *  targeting a given context.
-     *  That is: given a cabinet, this filter will invoke a query expression
-     *  that will return all ScopedSettings that are needed
-     *  to perform a smash-merge into a config doc for that cabinet. */
-    targetCabinet?: ScopeFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** Creates a filter expression that includes
- *  all entities whose scopes are relevant input for a smash-merge
- *  targeting a given context.
- *  That is: given a cabinet, this filter will invoke a query expression
- *  that will return all ScopedSettings that are needed
- *  to perform a smash-merge into a config doc for that cabinet. */
-export interface ScopeFilter {
-    enterprise: string;
-    cabinet: string;
-    environment: string;
-    property?: string | undefined;
-    $not?: ScopeFilter | undefined;
-}
-export declare enum ScopeLevel {
-    cabinet = "cabinet",
-    enterprise = "enterprise",
-    environment = "environment"
-} /** A cloud provider account for an individual user or application. */
-export interface SecurityAccount {
-    /** (guid) The id of the service principal, used when assigining permissions. eg: "bf52a5ea-3663-476c-bb54-aacf9a1b39db", */
-    id: string;
-    /** The human readable name we give to the service principal.  eg: "svc-princ-devcluster1", */
-    name: string;
-    /** full url by which Azure identifies the service principal.  eg: "http://svc-princ-devcluster1", */
-    systemName: string;
-    /** (guid) NOT PERSISTED WITH THIS ENTITY.
-     *  This password is typically generated on creation
-     *  and thus needs to be persisted in a separate secret store for future use
-     *  (eg: needed when creating a cluster). */
-    password?: string | undefined;
-}
-/** The security strategy employed on the cluster,
- *  indictating which type of security account
- *  will be used to identify the cluster and enforce its authorizations. */
-export declare enum SecurityAccountTypeEnum {
-    managedIdentity = "managedIdentity",
-    servicePrincipal = "servicePrincipal"
-} /** An asset consisting of a k8s service
- *  backed by a pod replica set (generated via a k8s Deployment entity). */
-export interface ServiceAssetTemplate {
-    defaultPort: number;
-    image: ImageSpec;
-    defaultImageVersion?: string | undefined;
-    assetType: AssetTypesEnum;
-    defaultName: string;
-    defaultCode: string;
-    hasIngress?: boolean | undefined;
-    /** List of fileStores required by the asset.  Each one requires capture. */
-    fileStores?: object[] | undefined;
-    /** List of secretStores required by the asset.  Each one requires capture. */
-    secretStores?: object[] | undefined;
-    /** Declaration-time attributes of the Asset itself
-     *  (used for managing the asset before deploying, not at runtime) */
-    properties?: ConfigSchema | undefined;
-    /** Config files supported by the asset and their structures.
-     *
-     *  TODO: Need to specify which settings should be secrets.  Might need to define that in the metadata or extend the typedefs */
-    configs?: object | undefined;
-    /** Environment variables supported by the asset. */
-    envs?: object | undefined;
-    /** (Optional: defaults to built-in deploymment-labeling convention) Boolean logic by which to recognize the pods
-     *  that belong to this asset among all the other pods in a namespace.
-     *  This property is an array type to allow for an asset to have multiple pod specs that each may have their own replicas. */
-    customPodFilters?: object[] | undefined;
-    /** Abstract declarations of folder paths inside the image
-     *  that are to be later mapped (at configuration time) to file store definitions. */
-    reservedFolders?: AssetFolderReservation[] | undefined;
-}
-/** Component-by-component history of a multi-step infrastructure provisioning operation. */
-export interface SetupJournal {
-    resourceId: string;
-    id?: string | undefined;
-    data: object;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface SetupJournalCriteria {
-    resourceId?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface SetupJournalEntry {
-    name: string;
-    artifactType: string;
-    artifactPartType?: string | undefined;
-    details?: any | undefined;
-}
-/** A concrete declaration of a single host naming strategy for a single domain, for a single cabinet.
- *
- *  DEV NOTE:  We have this entity type so that we can utilize embedding and cascading
- *            to affix host naming strategies to concrete cabinet records.
- *            This class allows us to surgically update one at a time in a post handler for a ScopedHostNameConfig crud. */
-export interface SingleHostNameStrategyForCabinet {
-    isCabinetScoped: boolean;
-    domainName: string;
-    strategy: HostNameStrategyEnum;
-    enterprise: string;
-    cabinet: string;
-    forAsset?: string[] | string | undefined;
-    id?: string | undefined;
-}
-/** An immutable configuration of the an enterprise for a given cabinet,
- *  to be used, together with subsequent change events, as the specification for a deployment.
- *  This entity reflects only the proposed configuration for the enterprise as of its creation date;
- *  the state of the latest PROPOSED configuration can only be reflected
- *  by also including subsequent change events.
- *  AND unlike the RunState, it DOES NOT reflect the current state of the enterprise running in the targeted cabinet. */
-export interface Snapshot {
-    enterprise: string;
-    cabinet: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface SnapshotCriteria {
-    enterprise?: StringFilter | undefined;
-    cabinet?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface SourceRepo {
-    name: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface SourceRepoCriteria {
-    name?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface StringFilter {
-    /** property of the target object to compare (conventional default to the name of the criteria property) */
-    property?: string | undefined;
-    $eq?: string | undefined;
-    $contains?: string | undefined;
-    $startsWith?: string | undefined;
-    $endsWith?: string | undefined;
-    $pattern?: string | undefined;
-    $in?: string[] | undefined;
-    $not?: StringFilter | undefined;
-}
-/** Applies constraints to an entity property that is a list of strings. */
-export interface StringListFilter {
-    /** property of the target object to compare (conventional default to the name of the criteria property) */
-    property?: string | undefined;
-    /** NOTE: Cannot use a NumericFilter here bc MongoDb does not support such a query, and results in error: "$size needs a number".
-     *  From https://docs.mongodb.com/manual/reference/operator/query/size/ ,
-     *  "$size does not accept ranges of values. To select documents based on fields with different numbers of elements,
-     *  create a counter field that you increment when you add elements to a field."
-     *  (Then you'd apply a NumericFilter against that counter field instead of the array field itself).
-     *  TODO:   IF WE START TO REALLY NEED NumericFilters ON THE ARRAY LENGTH,
-     *          THEN consider a conventional syntax for adding a size field on the entity (existing only within the data layer)
-     *          that this operator will always work against,
-     *          eg:  "myEntity.SIZEOF_myArrayProperty" (it's safe bc MongoDbb wont care if we're looking for it when it doesnt exist).
-     *          The problem that would result from that is that the numeric filter wont ever really work
-     *          unless the developer knows enough to go add that field and ensure that it gets updated as required.
-     *          This could be done via a setting in the MongoDbMap for that entity. */
-    length?: number | undefined;
-    contains?: StringFilter | undefined;
-    doesNotContain?: StringFilter | undefined;
-    /** Ensures that the values in the property are matched one-to-one with the given list of values.  (Order is irrelevant) */
-    containsAny?: string[] | undefined;
-    containsEvery?: string[] | undefined;
-    equalTo?: string[] | undefined;
-    /** Applies constraints to an entity property that is a list of strings. */
-    $not?: StringListFilter | undefined;
-}
-/** The concrete collection of all CODIAC services that they are using
- *  (not an Azure subx, not their own SaaS offerings).
- *  ie: It's their infrastructure implementation with us: services, dbs logging tools, etc) */
-export interface Subscription {
-    name: string;
-    id?: string | undefined;
-    environments: Environment[];
-    enterprises: Enterprise[];
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface SubscriptionCriteria {
-    tenantCode?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export declare enum SubscriptionStatus {
-    cancelled = "cancelled",
-    closed = "closed",
-    current = "current",
-    overdue = "overdue",
-    pending = "pending",
-    suspended = "suspended",
-    trial = "trial"
-} /** The token must be submitted in the
- *  http header designated in the AuthSettings object for the auth api. */
-export interface SwitchTenantRequest {
-    newTenantCode: string;
-}
-export interface T {
-}
-export interface T_1 {
-}
-export interface T_2 {
-}
-export interface T_3 {
-}
-export interface Tag {
-    name: string;
-    ownerType: string;
-    ownerId: string;
-    enterprise: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface TagCriteria {
-    name?: StringFilter | undefined;
-    ownerType?: string | undefined;
-    ownerId?: StringFilter | undefined;
-    createdBy?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface TCriteria {
-}
-export interface TenantRegistrationRequest {
-    tenantName: string;
-    newUser: boolean;
-    userName: string;
-    /** TODO: Is this an ecrypted password?  is it hashed?  Is it cleartext? */
-    password: string;
-    tenantCode?: string | undefined;
-    firstName?: string | undefined;
-    lastName?: string | undefined;
-    email?: string | undefined;
-    qtyUsers?: number | undefined;
-}
-export interface TenantStatusChange {
-    enabled: boolean;
-    newStatus: SubscriptionStatus;
-    tenantCode: string;
-}
-export interface TenantSubscriptionCancel {
-}
-export interface TenantSubscriptionUpdate {
-    totalSeats?: number | undefined;
-    enabled?: boolean | undefined;
-    status?: "cancelled" | "closed" | "current" | "overdue" | "pending" | "suspended" | "trial" | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    expiration?: Date | undefined;
-    newName?: string | undefined;
-}
-/** User fully equipped with its access profile for the current tenant.
- *  NOTE:  User.id === Principle.id
- *  It's a merge of a user and the current AccessProfile.
- *  NOTE:  THIS IS AN IN-MEMORY OBJECT - CONTEXTUAL TO CURRENT TENANT.
- *  ONLY THE Principle (its base class) SHOULD EVER BE PERSISTED. */
-export interface TenantUser {
-    tenantCode: string;
-    firstName: string;
-    lastName: string;
-    email: string;
-    roles: AuthRole[];
-    /** Globally unique, immutable system id, used for data integrity (they can NEVER change this). */
-    id?: string | undefined;
-    /** Globally unique, mutable, user-defined, human-readable identifier. */
-    login: string;
-    /** Obviously passwords are required, but this property is optional to allow it to remain unpopulated */
-    password?: string | undefined;
-    /** Standard, reliable, expedient way to identify an entity to a human in a single property
-     *  with more pertinent identifying information than its system id.
-     *  For use in logs, quick lists, and abstracted framework components. */
-    descriptor: string;
-    /** (Compositional property: AccessProfiles are most likely embedded and not persisted on their own) */
-    profiles: AccessProfile[];
-}
-/** Type definition for config objects
- *  (eg: config files, environment variables, Asset properties, etc)
- *
- *  (TBD: Duck-typeable/convertible to a Json Type Definition (JTD) or a JsonSchema) */
-export interface TypeDefBase {
-}
-/** Selects Principals that have a tenant profile
- *  for the given tenantCode. */
-export interface UserTenantCodeFilter {
-    tenantCode: string;
-    property?: string | undefined;
-    $not?: UserTenantCodeFilter | undefined;
-}
-/** defines a homogenous dictionary where the values of members satisfy a given schema.
- *
- *  "Values" form of [RFC8927](https://datatracker.ietf.org/doc/rfc8927/) */
-export interface ValuesTypeDef {
-    values: object;
-    nullable?: boolean | undefined;
-    metadata?: any | undefined;
-}
-export interface VersionConfig {
-    name: string;
-    enterprise: string;
-    assetName: string;
-    assetVersion: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface VersionConfigCriteria {
-    cabinet?: string | undefined;
-    enterprise?: string | undefined;
-    name?: StringFilter | undefined;
-    assetName?: StringFilter | undefined;
-    assetVersion?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface VersionCreateActivity {
-    enterpriseVersion: string;
-    enterprise: string;
-    type: ActivityTypeEnum;
-    title: string;
-    by: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed: Date;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface VersionCreateActivityCriteria {
-    enterpriseVersion?: string | undefined;
-    enterprise?: string | undefined;
-    type?: string | undefined;
-    title?: string | undefined;
-    by?: string | undefined;
-    /** Enables basic storage and retrieval of dates and times. */
-    performed?: Date | undefined;
-    cabinet?: string | undefined;
-    assetsName?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-export interface VersionGetsertRequest {
-    overlays: object[];
-    enterpriseCode: string;
-    startingEntVersion?: string | undefined;
-    targetCabinet?: string | undefined;
-}
-/** A time signature declaring an hour of the day for a day of the week (eg: "Mondays at 8am").
- *
- *  This entity is NOT an actual in time, but instead is essentially a template,
- *  which, only when applied to an actual calendar,
- *  can then produce a concrete point in time. */
-export interface WeeklyTime {
-    day: "fr" | "mo" | "sa" | "su" | "th" | "tu" | "we";
-    hr24: "0" | "1" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "2" | "20" | "21" | "22" | "23" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
-}
-export interface WhoAmIRequest {
-}
-/** Credentials applied to new Windows VMs to enable administrative capabilities required for cluster management.
- *
- *  Backward compatibility for a legacy image format called "Windows",
- *  which is required to run outdated Microsoft proprietary software
- *  such as Microsoft WCF and classic .Net Framework applications.
- *  This is required at cluster creation
- *  because a cluster cannot be later updated to support windows node pools. */
-export interface WindowsAdminProfile {
-    userName: string;
-    password: string;
-}
-export interface WorkFlowStrategy {
-    name: string;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface WorkFlowStrategyCriteria {
-    name?: StringFilter | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}
-/** A declaration of a template for a weekly timespan during which the given scope target will be in zombie mode. */
-export interface ZombiePeriod {
-    enterprise: string;
-    scope: ScopeLevel;
-    target: string;
-    start: WeeklyTime;
-    end: WeeklyTime;
-    name?: string | undefined;
-    description?: string | undefined;
-    id?: string | undefined;
-    createdBy: string;
-    modifiedBy: string;
-    /** Enables basic storage and retrieval of dates and times. */
-    created: Date;
-    /** Enables basic storage and retrieval of dates and times. */
-    modified: Date;
-}
-export interface ZombiePeriodCriteria {
-    enterprise?: string | undefined;
-    scope?: "cabinet" | "enterprise" | "environment" | undefined;
-    target?: string | undefined;
-    name?: string | undefined;
-    ids?: string[] | undefined;
-    all?: boolean | undefined;
-    /** Specification for the sort order of a query.
-     *
-     *  Example:  ```{ "color": "asc", size: OrderEnum.desc }```
-     *
-     *  Example:  ```"color"```
-     *
-     *  Example:  ```[ "color", "lastName" ]``` */
-    sort?: string[] | "asc" | "desc" | string | undefined;
-}