@codiac.io/codiac-cli 1.3.64 → 1.3.65

package/dist/apis/codiac-relay/gen/contracts.d.ts

@@ -1,4 +1,4 @@
-import { SingleResult } from "@codiac.io/codiac-common/contracts";
+import { BatchResult, SingleResult } from "@codiac.io/codiac-common/contracts";
 export interface AccessGrant {
     userId: string;
     level?: string | undefined;
@@ -13,12 +13,28 @@ export interface AndOrNot {
     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;
+}
 /** An expiring token scoped for a specific repository and actions within it. */
 export interface ApiAuthToken {
+    /** The content of a bearer token without its header prefix.
+     *  ie: the Authorization http header will need this value to be prefixed with "Bearer". */
     token: string;
+    /** The name of the entity on/in which actions will be performed with this token (eg: for a registry token, this would be the image name). */
     actionScope: string;
+    /** The Access Control List (ACL) of permissions this token has been granted.  eg:  pull, push, *. */
     permissions: string[];
+    /** The instant after which this token will fail to authenticate a registry request. */
     expirationUtc: Date;
+    refreshToken?: string | undefined;
+    meta?: IApiAuthTokenMeta | undefined;
 }
 export interface ApiReadyState {
     currentState: ApiReadyStateEnum;
@@ -30,12 +46,132 @@ export declare enum ApiReadyStateEnum {
     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: PortMapping | PortMapping | number[] | 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;
+    /** Overrides for the the container startup command. */
+    entryPoints?: EntryPoint[] | undefined;
+    /** Rules for the selecting which nodes on which this asset will be run (aka: NodeSelectors, affinities, and taints). */
+    nodeRequirements?: NodePlacement[] | undefined;
+    /** Scripts to run (via init containers) before the asset's own container starts. */
+    beforeStartup?: InitContainer[] | undefined;
+    /** Command line script (NOT run within a shell) to run within the asset container
+     *  AFTER the asset has succcessfully completed its startup.
+     *
+     *  From K8s Docs:
+     *  Management of the container blocks until this action is complete,
+     *  unless the container process fails, in which case the handler is aborted.
+     *
+     *  called immediately after a container is created.
+     *  If the handler fails, the container is terminated and restarted according to its restart policy.
+     *  Other management of the container blocks until the hook completes.
+     *  More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+     *
+     *  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. */
+    postStartup?: string[] | undefined;
+    /** Enable this setting to allow http (ie: non-SSL/TLS) requests in through the ingress controller without getting redirected to https.
+     *
+     *  That is, Setting this to true will prevent the ingress controller from invoking an automatic redirect to https on any inbound http requests. */
+    allowHttp?: boolean | undefined;
+    /** (Applies only when `hasIngress=true`, defaults to false, aka: external)
+     *  indicates whether this asset shall be available
+     *  only through the internal ingress controller.
+     *
+     *  NOTE: When set, this asset will only be accessible
+     *  on a cluster with an internal ingress controller. */
+    ingressInternal?: boolean | undefined;
+    /** Freeform url paths to use as an override for the asset code property
+     *  when assembling ingress routing
+     *  for domain mapping strategies
+     *  that place the "service" segment
+     *  into the url path.
+     *
+     *  *NOTE: Each entry must be unique within the enterprise,
+     *  cannot be null or empty,
+     *  cannot start or end with a slash character,
+     *  and must uniquely identify this asset within the enterprise.*
+     *
+     *  eg:
+     *
+     *  For a domain mapping strategy: `cab-dot-domain-slash-service`
+     *
+     *  and an asset with code: `my-api`
+     *
+     *  When `mydomain.com` gets applied to cabinet `dev`,
+     *  default ingress routing will yield: `dev.mydomain.com/my-api`
+     *
+     *  So.  Adding a path `v1/the-api` to this property
+     *  will INSTEAD yield an ingress rule supporting this url:
+     *
+     *  `dev.domain.com/v1/the-api`
+     *
+     *  NOTE: *Adding paths to this list prevents the default ingress path (as `Asset.code`) from being mapped in the ingress.  If you still want that behavior in the ingress rules, you will have to add it to this list.* */
+    ingressPaths?: string[] | undefined;
+    createdBy: string;
+    modifiedBy: string;
+    created: Date;
+    modified: Date;
+}
 export interface AssetConfigSchemaRequest {
     enterprise: string;
     asset: string;
     configType: ConfigDefTypesEnum;
     targetFile?: string | undefined;
 }
+/** Overall hashcode plus individual hashcodes for all the concrete rendered configs of a given asset.
+ *  (scope has been deliberately left out bc this class is to be included in a contextual object itself,
+ *  (such as a CabinetState).  This way it could be part of a given concrete cabinet deployment,
+ *  or just to a given scope within the config tree).
+ *
+ *  (useful for diff/change detection). */
+export interface AssetConfigState {
+    asset: string;
+    hash: string;
+    configs: object;
+}
 /** Abstract declarations of folder paths inside the image
  *  that are to be later mapped (at configuration time) to file store definitions. */
 export interface AssetFolderReservation {
@@ -51,6 +187,15 @@ export interface AssetFolderReservation {
      *  to which this folder will get mapped, unless configured otherwise. */
     defaultFileStore?: string | undefined;
 }
+/** Identifies a single asset, either by id
+ *  or by one of its composite indexes (enterprise/name or enterprise/code),
+ *  as defined by the unique indexes declared in the AssetDataMap. */
+export interface AssetIdentifier {
+    id?: string | undefined;
+    enterprise?: string | undefined;
+    name?: string | undefined;
+    code?: string | undefined;
+}
 /** Identifies a single asset replica (in Codiac terms). */
 export interface AssetReplicaContext {
     asset: string;
@@ -134,6 +279,11 @@ export interface AsyncAck {
     correlationId: string;
     taskMap: TaskMap;
 }
+export interface AssetWhereRequest {
+    asset: string;
+    /** Optional unless there are more than one. */
+    enterprise?: string | undefined;
+}
 export interface AuthRole {
     name: string;
     id?: string | undefined;
@@ -198,6 +348,32 @@ export interface AzureAcr {
     location: string;
     loginServer: 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.
+ *
+ * @param name  The name by which to identify this fileshare definition within the enterprise (Optional: defaults to the shareName).
+ * @param type  Indicator of which type of fileshare resource is being used.
+ * @param storageAccount  The name within the cloud provider of the file storage account within which the share resides.
+ * @param shareName  The name of the fileshare to connect to within the file storage account.
+ * @param providerSubscriptionId The Id of the physical Cloud Provider Subscription in which this filestore exists (Azure-specific).
+ * @param resourceGroup  The name of the Azure resource group under which the instance is to be created  (Azure-specific).
+ * @param instance  Info describing the concrete instance of this file store actually living within a cloud provider subscription.
+ */
+export interface AzureFileStoreDef extends FileStoreDef {
+    storageAccount: string;
+    resourceGroup: string;
+    instance?: AzureFileStoreInstance | undefined;
+}
+/** Metadata describing an existing concrete instance
+ *  of a FileStoreDef resource within a cloud provider. */
+export interface AzureFileStoreInstance extends FileStoreInfrx {
+    resourceGroup: string;
+    accessKey: string;
+}
 /** Use the `name` property as the human readable identifier to declare a location in a contract.
  *
  *  EXAMPLE:
@@ -325,8 +501,6 @@ export interface AzUser {
     name: string;
     type: string;
 }
-export interface Boolean {
-}
 /** Raw data is stored in instances of the Buffer class.
  *  A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap.  A Buffer cannot be resized.
  *  Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' */
@@ -390,6 +564,14 @@ export interface CabinetAssetList {
     cabinetName: string;
     assetNames: string[];
 }
+export interface CabinetAssetVersion {
+    enterprise: string;
+    environment: string;
+    cabinet: string;
+    asset: string;
+    enterpriseVersion?: string | undefined;
+    assetVersion?: string | undefined;
+}
 /** A reference to an cabinet and the cluster it's in. */
 export interface CabinetClusterRoot {
     name: string;
@@ -407,6 +589,39 @@ export interface CabinetClusterScope {
     name: string;
     cluster?: string | undefined;
 }
+export interface CabinetCriteria {
+    name?: StringFilter | undefined;
+    enterpriseCode?: string | undefined;
+    environment?: string | undefined;
+    cluster?: string | undefined;
+    branch?: StringFilter | undefined;
+    /** Boolean logic filter for string values.  Useful for querying on tags */
+    tags?: AndOrNotFilter | undefined;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | 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 {
@@ -465,6 +680,13 @@ export interface CabinetSelector {
      *  * `none`: targets only cabinets that have **none** of the given tags (aka: NOT logic). */
     matchTags?: AnyAllNoneEnum | undefined;
 }
+/** Manifest of all versions and configs currently deployed to a specific cabinet. */
+export interface CabinetState {
+    enterprise: string;
+    cabinet: string;
+    cluster: string;
+    contents?: DeployedState | undefined;
+}
 /** Identifier for a supported cloud service provider, for use in selecting infrastructure clients, provisioners, and credentials. */
 export declare enum CloudProviderEnum {
     artifactHub = "artifactHub",
@@ -496,8 +718,12 @@ export interface ClusterAccessGrantRequest {
     clusterName: string;
     users: AccessGrant | string[];
 }
+export interface ClusterAttachRequest {
+    environmentId: string;
+    cluster: string;
+}
 export interface ClusterConnectionRequest {
-    cluster?: string;
+    cluster?: string | undefined;
     cabinet?: {
         enterprise: string;
         environment: string;
@@ -571,23 +797,78 @@ export interface ClusterDefaults {
     nodeCount: number;
     nodePools: NodePoolDef[];
 }
-export interface ClusterTillerInstallRequest {
-    clusterName?: string | undefined;
-    userContext?: UserContext | undefined;
-    codiacAPiUrl?: string | undefined;
+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;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
 }
-export interface ClusterTillerInstallResponse {
-    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 ClusterDetachRequest {
+    environmentId: string;
+    cluster: string;
+}
+export interface ClusterWithIngress {
+    name: string;
+    provider: CloudProviderEnum;
+    providerSubscriptionId: string;
+    locationName: string;
+    k8sVersion: string;
+    ingressIp?: string | undefined;
+    modified?: Date | undefined;
+    modifiedBy?: string | undefined;
+    created?: Date | undefined;
+    createdBy?: string | undefined;
 }
 /** Specs describing an available WebSocket on which the client and server
  *  can exchange messages related to a given transaction. */
 export interface CommChannelRef {
     socketId: string;
 }
+/** A key-value pair applied to an entity in an enterprise. */
+export interface Comment {
+    markdown: string;
+    ownerType: string;
+    ownerId: string;
+    enterprise: string;
+    /** Optional subject line of the comment.  For use when larger comments are typical (such as in product reviews) */
+    headline?: string | undefined;
+    /** Indicates that this comment can be rendered just as an emoji decoration instead of as a full comment. */
+    isEmoji?: boolean | undefined;
+    /** The id of the comment (if any) that this one is responding to. */
+    parentId?: string | undefined;
+    responses?: Comment[] | undefined;
+    id?: string | undefined;
+    createdBy: string;
+    modifiedBy: string;
+    created: Date;
+    modified: Date;
+}
 /** Values of ScopedSetting.targetFile for NON-FILE configs. */
 export declare enum ConfigDefTypesEnum {
     annotation = "annotation",
@@ -599,28 +880,66 @@ export declare enum ConfigDefTypesEnum {
     label = "label",
     probing = "probing"
 }
-/** 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;
+/** 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;
 }
-/** 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;
+export interface ConfigDocSpecForOne {
+    enterprise: string;
+    asset: string;
+    targetFile: string;
+    cabinet: string;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
+}
+/** 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;
@@ -636,13 +955,6 @@ export interface CreateClusterAck extends AsyncAck {
     correlationId: string;
     taskMap: TaskMap;
 }
-export interface CreateClusterRequest {
-    spec?: ClusterDef | undefined;
-    acrs?: object[] | undefined;
-    userContext?: UserContext | undefined;
-    codiacAPiUrl?: string | undefined;
-    skipInit?: Boolean | undefined;
-}
 export interface CreateClusterRequestAsync {
     spec?: ClusterDef | undefined;
     skipInit?: boolean | undefined;
@@ -664,14 +976,6 @@ export interface CreateClusterRequestAsync {
     userContext?: UserContext | undefined;
     codiacAPiUrl?: string | undefined;
 }
-export interface CreateClusterResponse {
-    clusterDef?: ClusterDef | undefined;
-    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 type CredentialType = "client_credentials" | "username_password" | "refresh_token";
 /** This is actually the result returned (via querystring params on a redirect)
  *  by the external csp login service,
@@ -718,7 +1022,7 @@ export interface CspLoginAuthCodeCatcherRequest {
     /** (Successful scenario) */
     session_state?: string | undefined;
     /** Cloud Service Provider (CSP) code.  eg: `azure`, `aws`, etc. */
-    providerCode?: "aws" | "azure" | "dockerHub" | "other" | undefined;
+    providerCode?: "artifactHub" | "aws" | "azure" | "dockerHub" | "other" | undefined;
     /** (Access Token Error scenario) A list of STS-specific error codes that can help in diagnostics. */
     error_codes?: string[] | undefined;
     /** (Access Token Error scenario) The time at which the error occurred. */
@@ -764,9 +1068,66 @@ export interface CspLogoutInteractiveResponse {
     /** Will be undefined if we have no tokens or credentials cached. */
     cspUserName?: string | undefined;
 }
+export interface CspPrimaryCredsMeta {
+    tenantCode: string;
+    provider: CloudProviderEnum;
+    username: string;
+    created: Date;
+    /** eg: The AccountId in AWS or SubscriptionId in Azure. */
+    subscriptionId?: string | undefined;
+    expiration?: Date | undefined;
+    modified?: Date | undefined;
+}
 export interface CspTokenAndUserMeta {
     tokenObject: ApiAuthToken;
-    cspUser: CloudProviderUser;
+    cspUser: ICspPrimaryCredsMeta;
+}
+/** Access Control List (ACL) to be applied to any new child entity created within the parent.
+ *
+ *  Only stands as a default template for permissions on FUTURE new child entities;
+ *  DOES NOT get directly used to enforce permissions on any existing ones. */
+export interface DefaultChildAcl {
+    parentType: string;
+    parentId: string;
+    childType: string;
+    dotPath: string;
+    permissions: object;
+    /** 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;
+    created: Date;
+    modified: Date;
+}
+export interface DefaultChildAclCriteria {
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    parentType?: string | undefined;
+    parentId?: string | undefined;
+    childType?: string | undefined;
+    dotPath?: string | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
 }
 export interface DeleteClusterInstanceRequest {
     name?: string | undefined;
@@ -782,6 +1143,43 @@ export interface DeleteClusterInstanceResponse {
     /** Any errors or messages for the consumer about constraints that were not met in order to perform the operation. */
     validation?: IValidationStatus | undefined;
 }
+export interface DeployAttempt {
+    name: string;
+    deploymentId: string;
+    result?: Result | BatchResult<Partial<Asset>> | undefined;
+    id?: string | undefined;
+    createdBy: string;
+    modifiedBy: string;
+    created: Date;
+    modified: Date;
+}
+export interface DeployAttemptCriteria {
+    name?: StringFilter | undefined;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
+}
 /** Envelope for the contents of a ConfigDoc
  *  compiled into its specific content format (eg: json, yaml, ini, etc). */
 export interface DeployedConfig {
@@ -819,7 +1217,63 @@ export interface DeployedConfigCriteria {
      *  ```
      *
      *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
-    sort?: string[] | object | string | undefined;
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
+}
+export interface DeployedState {
+    version: EnterpriseVersionConfig;
+    configState: object;
+    deployedOn: Date;
+    deployedBy: string;
+}
+/** 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;
+    created: Date;
+    modified: Date;
+}
+export interface DeploymentCriteria {
+    id?: StringFilter | undefined;
+    name?: StringFilter | undefined;
+    enterprise?: StringFilter | undefined;
+    cabinet?: StringFilter | undefined;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
     skip?: number | undefined;
     take?: number | undefined;
     /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
@@ -840,6 +1294,10 @@ export interface DiscriminatorTypeDef {
     nullable?: boolean | undefined;
     metadata?: any | undefined;
 }
+export interface DnsConnectionRequest {
+    domain?: string | undefined;
+    ingressIp?: string | undefined;
+}
 /** Requirements for a DNS host record
  *  that routes requests within a given domain. */
 export interface DnsRecord {
@@ -855,8 +1313,11 @@ export interface DnsRecord {
      *  for this host.domain combination shall be routed. */
     destinationIp: string;
 }
+export interface DNSResponse {
+    results: boolean;
+}
 export interface DomainDeleteRequest {
-    id?: string;
+    id?: string | undefined;
 }
 /** Defines a homogenous array of any size (possibly empty) with the elements that satisfy a given schema.
  *
@@ -880,12 +1341,105 @@ export interface EnterprisePointer {
     asset?: string | undefined;
     cabinet?: string | undefined;
 }
+export interface EnterpriseRoot {
+    name: string;
+    assets: Asset[];
+    environments: EnvironmentRoot[];
+    id: string;
+    defaultEnvironmentAcl?: DefaultChildAcl | undefined;
+}
+/** 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;
+    created: Date;
+    modified: Date;
+    /** Markdown block of instructions or other descriptions from the author about this particular version. */
+    notes?: string | undefined;
+    /** Key-value pairs (aka: property bag) for this particular version. */
+    labels?: Label[] | undefined;
+    /** Starting point for threaded discussions on this particular version. */
+    comments?: Comment[] | undefined;
+}
+export interface EnterpriseRunStateCriteria {
+    enterprise?: string | undefined;
+    cabinet?: string | undefined;
+    contentHash?: string | undefined;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
+}
 /** A reference to an enterprise and its environment scopes. */
 export interface EnterpriseScope {
     name: string;
     environments: EnvironmentScope[];
     id?: string | undefined;
 }
+/** Manifest of all versions and configs currently deployed within an enterprise. */
+export interface EnterpriseState {
+    enterprise: string;
+    environments: object;
+    id?: string | undefined;
+}
+export interface EnterpriseStateRequest {
+    enterprise: string;
+    environment?: string | undefined;
+    cabinet?: string | undefined;
+    cluster?: string | undefined;
+    noCacheRead?: boolean | 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;
+    created: Date;
+    modified: Date;
+    /** Markdown block of instructions or other descriptions from the author about this particular version. */
+    notes?: string | undefined;
+    /** Key-value pairs (aka: property bag) for this particular version. */
+    labels?: Label[] | undefined;
+    /** Starting point for threaded discussions on this particular version. */
+    comments?: Comment[] | undefined;
+}
 /** Access Control List (ACL) for a single securable object.
  *  A list of permissions declared on a single, identifiable concrete entity. */
 export interface EntityAcl {
@@ -941,11 +1495,77 @@ export interface EnumTypeDef {
     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;
+    /** The default privileges to grant to each role on new cabinets created within this environment
+     *  (optional: defaults to the permissions assigned to this environment). */
+    defaultCabinetAcl?: DefaultChildAcl | undefined;
+    createdBy: string;
+    modifiedBy: string;
+    created: Date;
+    modified: Date;
+}
+export interface EnvironmentCriteria {
+    code?: string | undefined;
+    enterpriseCode?: string | undefined;
+    subscription?: string | undefined;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | 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;
+    /** The default privileges to grant to each role on new cabinets created within this environment
+     *  (optional: defaults to the permissions assigned to this environment). */
+    defaultCabinetAcl?: DefaultChildAcl | undefined;
+}
 /** A reference to an environment and its cabinets. */
 export interface EnvironmentScope {
     name: string;
     cabinets: CabinetClusterScope[];
 }
+/** Manifest of all versions and configs currently deployed within a specific environment. */
+export interface EnviroState {
+    name: string;
+    cabinets: object;
+}
 export interface Error {
     name: string;
     message: string;
@@ -954,11 +1574,16 @@ export interface Error {
 export interface ExecuteCabinetKillerRequest {
     target?: CabinetScope | undefined;
 }
-export interface ExecuteCabinetMakerResponse {
-    /** 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. */
-    cabinet?: CabinetInfrastructure | undefined;
-    k8sService?: Cabinet | undefined;
+export interface ExecuteClusterIngressDeleteRequest {
+    clusterName?: string | undefined;
+    cabinetUniqueDomains?: HostNameConfig[] | undefined;
+    userContext?: UserContext | undefined;
+    codiacAPiUrl?: string | undefined;
+}
+export interface ExecuteClusterIngressDeleteResponse {
+    /** Specifications for ingress controllers and request routing.
+     *  Based on an ingress controller deployed as a Helm chart. */
+    ingressDef?: IngressDef | undefined;
     success: boolean;
     message?: string | undefined;
     error?: Error | undefined;
@@ -974,23 +1599,7 @@ export interface ExecuteClusterInitRequestAsync {
     correlationId?: string;
     callbackUrl?: string;
 }
-export interface ExecuteClusterIngressCreateResponse {
-    /** Specifications for ingress controllers and request routing.
-     *  Based on an ingress controller deployed as a Helm chart. */
-    ingressDef?: IngressDef | undefined;
-    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 ExecuteClusterIngressDeleteRequest {
-    clusterName?: string | undefined;
-    cabinetUniqueDomains?: HostNameConfig[] | undefined;
-    userContext?: UserContext | undefined;
-    codiacAPiUrl?: string | undefined;
-}
-export interface ExecuteClusterIngressDeleteResponse {
+export interface ExecuteClusterInitResponse {
     /** Specifications for ingress controllers and request routing.
      *  Based on an ingress controller deployed as a Helm chart. */
     ingressDef?: IngressDef | undefined;
@@ -1031,19 +1640,6 @@ export interface ExecuteDeployIngressForAssetsResponse {
     /** Any errors or messages for the consumer about constraints that were not met in order to perform the operation. */
     validation?: IValidationStatus | undefined;
 }
-export interface ExecuteDestroyAssetsRequest {
-    target?: CabinetScope | undefined;
-    assetsNames?: string[] | undefined;
-    userContext?: UserContext | undefined;
-    codiacAPiUrl?: string | undefined;
-}
-export interface ExecuteDestroyAssetsResponse {
-    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 ExecuteDomainUpsertRequest {
     domain: string;
     namingStrategy: HostNameStrategyEnum;
@@ -1067,16 +1663,7 @@ export interface FileRequest {
  *
  *  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.
- *
- * @param name  The name by which to identify this fileshare definition within the enterprise (Optional: defaults to the shareName).
- * @param type  Indicator of which type of fileshare resource is being used.
- * @param storageAccount  The name within the cloud provider of the file storage account within which the share resides.
- * @param shareName  The name of the fileshare to connect to within the file storage account.
- * @param providerSubscriptionId The Id of the physical Cloud Provider Subscription in which this filestore exists (Azure-specific).
- * @param resourceGroup  The name of the Azure resource group under which the instance is to be created  (Azure-specific).
- * @param instance  Info describing the concrete instance of this file store actually living within a cloud provider subscription.
- */
+ *  As such, it outlives the actual entity described by its "instance" property. */
 export interface FileStoreDef {
     name: string;
     type: FileStoreTypeEnum;
@@ -1090,25 +1677,38 @@ export interface FileStoreDef {
     created: Date;
     modified: Date;
 }
-/** 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.
- *
- * @param name  The name by which to identify this fileshare definition within the enterprise (Optional: defaults to the shareName).
- * @param type  Indicator of which type of fileshare resource is being used.
- * @param storageAccount  The name within the cloud provider of the file storage account within which the share resides.
- * @param shareName  The name of the fileshare to connect to within the file storage account.
- * @param providerSubscriptionId The Id of the physical Cloud Provider Subscription in which this filestore exists (Azure-specific).
- * @param resourceGroup  The name of the Azure resource group under which the instance is to be created  (Azure-specific).
- * @param instance  Info describing the concrete instance of this file store actually living within a cloud provider subscription.
- */
-export interface AzureFileStoreDef extends FileStoreDef {
-    storageAccount: string;
-    resourceGroup: string;
-    instance?: AzureFileStoreInstance | undefined;
+export interface FileStoreDefCriteria {
+    name?: StringFilter | undefined;
+    /** Supported file store adapters that can be mapped to a reserved folder on an asset. */
+    type?: "AwsEbs" | "AwsEfs" | "AwsS3Bucket" | "AzureBlobStorage" | "AzureDisk" | "AzureFileStorage" | "HostMachineFolder" | undefined;
+    shareName?: StringFilter | undefined;
+    /** Identifier for a supported cloud service provider, for use in selecting infrastructure clients, provisioners, and credentials. */
+    provider?: "artifactHub" | "aws" | "azure" | "dockerHub" | "other" | undefined;
+    providerSubscriptionId?: StringFilter | undefined;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
 }
 /** Metadata describing an existing concrete instance
  *  of a FileStoreDef resource within a cloud provider. */
@@ -1116,20 +1716,14 @@ export interface FileStoreInfrx {
     providerSubscriptionId: string;
     resourceId: string;
 }
-/** Metadata describing an existing concrete instance
- *  of a FileStoreDef resource within a cloud provider. */
-export interface AzureFileStoreInstance extends FileStoreInfrx {
-    resourceGroup: string;
-    accessKey: string;
-}
 /** Supported file store adapters that can be mapped to a reserved folder on an asset. */
 export declare enum FileStoreTypeEnum {
+    AwsEbs = "AwsEbs",
+    AwsEfs = "AwsEfs",
+    AwsS3Bucket = "AwsS3Bucket",
     AzureBlobStorage = "AzureBlobStorage",
     AzureDisk = "AzureDisk",
     AzureFileStorage = "AzureFileStorage",
-    AwsEfs = "AwsEfs",
-    AwsEbs = "AwsEbs",
-    AwsS3Bucket = "AwsS3Bucket",
     HostMachineFolder = "HostMachineFolder"
 }
 /** Calls out the cabinet and its parent structures. */
@@ -1165,6 +1759,7 @@ export interface GetAwsS3BucketsRequest {
 export interface GetAwsUserRequest {
     accessKeyId?: string | undefined;
     secretAccessKey?: string | undefined;
+    sessionToken?: string | undefined;
     accountId?: string | undefined;
 }
 export interface GetAzureContainerRegistriesRequest {
@@ -1213,6 +1808,7 @@ export interface GetExistingCspClustersRequest {
     location?: string | undefined;
 }
 export interface GetFileStoresRequest {
+    provider: CloudProviderEnum;
     providerSubscriptionId: string;
     storageAccount: StorageAccount;
     resourceGroup: string;
@@ -1237,16 +1833,16 @@ export interface GetSecretStoresRequest {
     provider: CloudProviderEnum;
     spec: Partial<SecretStore>;
 }
-export interface GetStorageAccountRequest {
-    provider: CloudProviderEnum;
-    providerSubscriptionId: string;
-}
 export interface GetStorageAccountKeysRequest {
     provider: CloudProviderEnum;
     subscriptionId: string;
     resourceGroup: string;
     storageAccountName: string;
 }
+export interface GetStorageAccountRequest {
+    provider: CloudProviderEnum;
+    providerSubscriptionId: string;
+}
 export interface HelmAssetTemplate {
     /** Maps a port number to the associated setting (full dot path name) in the chart config.
      *
@@ -1311,6 +1907,18 @@ export declare enum HostNameStrategyEnum {
     shared_ingress_ip = "shared_ingress_ip",
     svc_dot_cab_dot_domain = "svc_dot_cab_dot_domain"
 }
+export interface IApiAuthTokenMeta {
+    isDefault?: boolean | undefined;
+    userName?: string | undefined;
+    givenName?: string | undefined;
+    familyName?: string | undefined;
+    /** The ApplicationId assigned to Codiac when it was registered in AzureAD. */
+    clientId: string;
+    /** Azure TenantId.
+     *  Id code for the tenant account with the cloud service provider
+     *  (This is NOT the Codiac tenant code). */
+    cspTenantId: string;
+}
 export interface IAssetLog {
     assetName: string;
     logs: object[];
@@ -1332,6 +1940,18 @@ export interface ICommandLineProbeAction {
     command: string[];
     actionType: ProbeActionTypesEnum;
 }
+export interface ICspPrimaryCredsMeta {
+    username: string;
+    created: Date;
+    modified?: Date | undefined;
+    expiration?: Date | undefined;
+    tenantCode: string;
+    provider: CloudProviderEnum;
+    /** eg: The AccountId in AWS or SubscriptionId in Azure.
+     *
+     *  TODO: Make this required. */
+    subscriptionId?: string | undefined;
+}
 export interface IGrpcProbeAction {
     /** Port number of the gRPC service. Number must be in the range 1 to 65535. */
     port: number;
@@ -1389,6 +2009,7 @@ export interface ImageRegistry {
     pullRequiresAuth?: boolean | undefined;
     infoUrl?: string | undefined;
     useRemoteFiltering?: boolean | undefined;
+    helmSupport?: "classic" | "oci" | 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. */
@@ -1400,6 +2021,7 @@ export interface ImageRegistrySpec {
     pullRequiresAuth?: boolean | undefined;
     infoUrl?: string | undefined;
     useRemoteFiltering?: boolean | undefined;
+    helmSupport?: "classic" | "oci" | undefined;
 }
 export declare enum ImageRegistryTypes {
     AmazonEcr = "AmazonEcr",
@@ -1410,8 +2032,8 @@ export declare enum ImageRegistryTypes {
 }
 export interface ImageRepository {
     name: string;
-    scope?: string;
-    registry?: Omit<ImageRegistry, "created" | "createdBy" | "modified" | "modifiedBy">;
+    scope?: string | undefined;
+    registry?: Omit<ImageRegistry, "createdBy" | "modifiedBy" | "created" | "modified"> | undefined;
 }
 /** 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. */
@@ -1440,10 +2062,11 @@ export interface IngressDef {
     service_name: string;
     service_namespace: string;
     replicas: number;
-    internal?: boolean | undefined;
     ip_name: string;
     cert_secret_name: string;
     cert_name: string;
+    internal?: boolean | undefined;
+    disableExternal?: boolean | undefined;
     id?: string | undefined;
     createdBy: string;
     modifiedBy: string;
@@ -1577,7 +2200,7 @@ export interface InitContainer {
     /** (optional; defaults to false) UNLESS this is set to true, the init container will also get the volume mounts that are declared in Codiac for the asset. */
     preventAssetVolumes?: boolean | undefined;
     /** (optional) Min/Max Mem and CPU allocations */
-    footprint?: Pick<ContainerFootprint, "memLimit" | "memRequest" | "cpuLimit" | "cpuRequest"> | undefined;
+    footprint?: Pick<ContainerFootprint, "cpuRequest" | "cpuLimit" | "memRequest" | "memLimit"> | undefined;
     /** (optional: defaults to all) The versions of the parent asset for which this init container is to be used. */
     versionRange?: string | undefined;
 }
@@ -1652,6 +2275,13 @@ export interface IPartialAsset {
      *
      *  That is, Setting this to true will prevent the ingress controller from invoking an automatic redirect to https on any inbound http requests. */
     allowHttp?: boolean | undefined;
+    /** (Applies only when `hasIngress=true`, defaults to false, aka: external)
+     *  indicates whether this asset shall be available
+     *  only through the internal ingress controller.
+     *
+     *  NOTE: When set, this asset will only be accessible
+     *  on a cluster with an internal ingress controller. */
+    ingressInternal?: boolean | undefined;
     /** Freeform url paths to use as an override for the asset code property
      *  when assembling ingress routing
      *  for domain mapping strategies
@@ -1714,6 +2344,13 @@ export interface IValidationStatus {
      *  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: PortMapping | PortMapping | number[] | number;
@@ -1801,6 +2438,13 @@ export interface KnownPortNumberAssignment {
     reservedFor: string;
     group?: "privateUse" | "registered" | "wellknown" | 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 {
@@ -1850,6 +2494,19 @@ export declare enum KvpStoreTypesEnum {
     mongoCollection = "mongoCollection",
     mongoDocument = "mongoDocument"
 }
+/** A key-value pair applied to an entity in an enterprise. */
+export interface Label {
+    value: string;
+    name: string;
+    ownerType: string;
+    ownerId: string;
+    enterprise: string;
+    id?: string | undefined;
+    createdBy: string;
+    modifiedBy: string;
+    created: Date;
+    modified: Date;
+}
 export interface LogintoCloudProviderRequest {
     providerCode: CloudProviderEnum;
     providerSubscription?: string | undefined;
@@ -1985,10 +2642,10 @@ export declare enum patchOperationType {
     replace = "replace",
     test = "test"
 }
-/** The granting of priveleges to a given Role. */
+/** The granting of privileges to a given Role. */
 export interface Permission {
     role: AuthRole;
-    priveleges: Privelege[];
+    privileges: Privilege[];
 }
 /** Instructs the kube-scheduler how to place each incoming Pod in relation to the existing Pods across your cluster.
  *
@@ -2008,12 +2665,12 @@ export interface PortMapping {
     internal?: number | undefined;
 }
 /** 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
+export declare enum Privilege {
+    Create = "Create",
+    Delete = "Delete",
+    Execute = "Execute",
+    Read = "Read",
+    Update = "Update"
 }
 /** Declares a probe action and when to run it against an asset. */
 export interface Probe {
@@ -2094,18 +2751,6 @@ export interface PropertiesTypeDef {
     nullable?: boolean | undefined;
     metadata?: any | undefined;
 }
-export interface PublishServiceRequest {
-    serviceName: string;
-    toyboxName: string;
-}
-export interface PublishServiceResponse {
-    correlationId: string;
-    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;
-}
 /** 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 {
@@ -2184,6 +2829,46 @@ export interface Result {
     /** Any errors or messages for the consumer about constraints that were not met in order to perform the operation. */
     validation?: IValidationStatus | 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;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
+}
 export interface ScaleAssetRequest {
     enterprise: string;
     asset: string;
@@ -2211,11 +2896,120 @@ export interface ScopedHostNameConfig {
     /** (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;
+    /** When set, the domain mapping will not be available on the internet,
+     *  and shall only be exposed on ingress controllers in the internal network.
+     *  That is, the domain mapping gets omitted from any internet-facing ingress controllers. */
+    isPrivate?: boolean | undefined;
+    createdBy: string;
+    modifiedBy: string;
+    created: Date;
+    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;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | 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;
     created: Date;
     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;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | 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",
@@ -2290,6 +3084,49 @@ export interface ServiceAssetTemplate {
      *  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;
+    created: Date;
+    modified: Date;
+}
+export interface SetupJournalCriteria {
+    resourceId?: string | undefined;
+    ids?: string[] | undefined;
+    all?: boolean | undefined;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | "asc" | "desc" | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | 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
@@ -2303,6 +3140,10 @@ export interface SingleHostNameStrategyForCabinet {
     cabinet: string;
     forAsset?: string[] | string | undefined;
     id?: string | undefined;
+    /** When set, the domain mapping will not be available on the internet,
+     *  and shall only be exposed on ingress controllers in the internal network.
+     *  That is, the domain mapping gets omitted from any internet-facing ingress controllers. */
+    isPrivate?: boolean | undefined;
 }
 export interface StorageAccount {
     name: string;
@@ -2368,6 +3209,11 @@ export interface TaskMap {
  *  (TBD: Duck-typeable/convertible to a Json Type Definition (JTD) or a JsonSchema) */
 export interface TypeDefBase {
 }
+/** request contract for UN-deploying an asset from a cabinet. */
+export interface UndeployAssetsRequest {
+    target: CabinetScope;
+    assetsNames: string[];
+}
 /** Archived identifier for a Toyhauler user and their accumulated tenant tokens.
  *  NOTE:  This data is simply archived and is likely to be stale,
  *  so it should be refreshed frequently.
@@ -2376,6 +3222,7 @@ export interface TypeDefBase {
 export interface UserContext {
     currentTenantCode?: string | undefined;
     currentToken?: string | undefined;
+    roles?: string[] | undefined;
     /** the full login id for the user on the Toyhauler system (defaults to anonymous). */
     userName: string;
     /** Dictionary of user-tenant tokens, mapped by tenant code. */
@@ -3700,6 +4547,17 @@ export interface ValuesTypeDef {
     nullable?: boolean | undefined;
     metadata?: any | 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";
+    /** DEVNOTE:  Do these need to be strings?  why not integers? */
+    m?: string | undefined;
+}
 /** Credentials applied to new Windows VMs to enable administrative capabilities required for cluster management.
  *
  *  Backward compatibility for a legacy image format called "Windows",
@@ -3711,6 +4569,51 @@ export interface WindowsAdminProfile {
     userName: string;
     password: string;
 }
+/** 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;
+    created: Date;
+    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;
+    /** supports a single field name
+     *  ```json
+     *  "sort": "name"
+     *  ```
+     *  or an array of field names
+     *  ```json
+     *  "sort": ["name", "lastModified~desc"]
+     *  ```
+     *  or an object dictionary of `fieldName: asc|desc` pairs, eg:
+     *  ```json
+     *  "sort": {
+     *    "name": "asc",
+     *    "lastModified": "desc"
+     *  }
+     *  ```
+     *
+     *  NOTE: Regarding sort field order, (aka: `asc|desc`) : Sort field names can be specified as EITHER: field name alone (implies asc order), eg: `"favColor"`, OR field name with order suffix `asc|desc` (delimited by tilde). eg: `"favColor~desc"`. */
+    sort?: string[] | string | undefined;
+    skip?: number | undefined;
+    take?: number | undefined;
+    /** Declares that the data be returned in the opposite order than what is specified by the `sort` property. */
+    reverse?: number | boolean | undefined;
+}
 export interface ZombieRefreshRequest {
     enterprise: string;
     environment?: string | undefined;