@cycleplatform/api-client-typescript 0.3.19 → 0.3.22

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cycleplatform/api-client-typescript",
-    "version": "0.3.19",
+    "version": "0.3.22",
     "description": "A Cycle API client for the web/nodejs with type safety.",
     "main": "./dist/index.umd.cjs",
     "module": "./dist/index.js",

package/src/generated/types.ts

@@ -1289,6 +1289,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/dns/tls/certificates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all TLS Certificates whether user generated or automatically generated by the platform.
+         * @description Retrieve a list of TLS certificates.
+         *
+         *     Requires the `dns-certs-view` capability.
+         */
+        get: operations["getAllTlsCertificates"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/dns/tls/certificates/lookup": {
         parameters: {
             query?: never;
@@ -2830,15 +2852,15 @@ export interface paths {
         patch: operations["updateAutoScaleGroupAccess"];
         trace?: never;
     };
-    "/v1/infrastructure/providers/{providerVendor}/servers": {
+    "/v1/infrastructure/providers/{integrationId}/servers": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** List Provider Servers */
-        get: operations["getProviderServers"];
+        /** List Provider Server Models */
+        get: operations["getProviderServerModels"];
         put?: never;
         post?: never;
         delete?: never;
@@ -2847,7 +2869,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/v1/infrastructure/providers/{providerVendor}/locations": {
+    "/v1/infrastructure/providers/{integrationId}/locations": {
         parameters: {
             query?: never;
             header?: never;
@@ -3069,10 +3091,10 @@ export interface paths {
         get: operations["getServers"];
         put?: never;
         /**
-         * Create Server
+         * Create Servers
          * @description Requires the `servers-provision` capability.
          */
-        post: operations["createServer"];
+        post: operations["createServers"];
         delete?: never;
         options?: never;
         head?: never;
@@ -3593,6 +3615,28 @@ export interface paths {
         patch: operations["updatePipelineAccess"];
         trace?: never;
     };
+    "/v1/pipelines/runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List All Pipeline Runs
+         * @description Lists all pipeline runs, regardless of the pipeline they are associated with.
+         *
+         *     Requires the `pipelines-view` capability.
+         */
+        get: operations["getAllPipelineRuns"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/pipelines/{pipelineId}/runs": {
         parameters: {
             query?: never;
@@ -3951,6 +3995,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/stacks/builds": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List All Builds
+         * @description Fetches all stack builds regardless of their association to a stack.
+         *
+         *     Requires the `stacks-view` capability.
+         */
+        get: operations["getAllStackBuilds"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/stacks/builds/{buildId}": {
         parameters: {
             query?: never;
@@ -4327,7 +4393,48 @@ export interface paths {
         trace?: never;
     };
 }
-export type webhooks = Record<string, never>;
+export interface webhooks {
+    environmentMetricsPush: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Environment Metrics Push
+         * @description Regularly sends metrics from an environment to an endpoint.
+         */
+        post: operations["environmentMetricsPush"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    environmentEventsPush: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Environment Events Push
+         * @description Regularly sends events from an environment to an endpoint.
+         */
+        post: operations["environmentEventsPush"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
 export interface components {
     schemas: {
         /**
@@ -5927,7 +6034,7 @@ export interface components {
             /** @description The number of initial desired instances for a given container. */
             instances: number;
             /** @description The deployment strategy to use when scaling the given container. */
-            strategy?: components["schemas"]["DeploymentStrategyName"];
+            strategy?: components["schemas"]["DeploymentStrategyName"] | null;
             /** @description Configuration options for containers using the 'function' deployment strategy. */
             function?: {
                 /** @description The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances). */
@@ -5939,42 +6046,45 @@ export interface components {
                 /** @description The maximum amount of time Cycle will wait for an instance to be available. */
                 max_queue_time?: components["schemas"]["Duration"] | null;
             } | null;
+            /** @description Configuration options for stateful deployments. */
             stateful?: {
+                /** @description Options that modify behavior for stateful deployments. */
                 options?: {
+                    /** @description When set, the base hostname will be used instead of a generated hostname. */
                     use_base_hostname?: boolean | null;
                 } | null;
-            };
+            } | null;
             /** @description Settings that give more granular control over deployment targets and conditions. */
             constraints?: {
-                /** @description Constraint settings related to which nodes an instance can be deployed to. */
                 node?: {
                     /** @description Lists of server tags that formally declair servers that match the criteria for deployment. */
                     tags: {
                         /** @description A list of tags where a server matching any tags from the list is qualified as a deployment target. */
-                        any?: string[];
+                        any?: string[] | null;
                         /** @description A list of tags where a server matching all tags from the list is the only scenario where the server is qualified as a deployment target. */
-                        all?: string[];
+                        all?: string[] | null;
                     };
-                };
-                secrets?: string[];
-            };
+                } | null;
+                /** @description A list of secret identifiers that will be made available to the container. */
+                secrets?: string[] | null;
+            } | null;
             /** @description Configuration for what to do during container shutdown. */
             shutdown?: {
                 /** @description How long the platform will wait for a container to stop gracefully. */
                 graceful_timeout?: components["schemas"]["Duration"] | null;
                 /** @description Process signal sent to the container process. */
                 signals?: components["schemas"]["ShutdownSignal"][] | null;
-            };
+            } | null;
             /** @description Configurations for container startup. */
             startup?: {
                 /** @description How long the platform will wait before sending the start signal to the given container. */
                 delay?: components["schemas"]["Duration"];
-            };
+            } | null;
             /** @description Configurations for container updates. */
             update?: {
                 /** @description When set, Cycle will pick a random time from `0 - this duration`, and stagger the instances so they all start at different times (up to the time specified here). */
                 stagger?: components["schemas"]["Duration"];
-            };
+            } | null;
             /** @description Configurations for container restart events. */
             restart?: {
                 /**
@@ -5986,7 +6096,14 @@ export interface components {
                 delay: components["schemas"]["Duration"];
                 /** @description The amount of times the platform will attempt the restart policies. */
                 max_attempts: number;
-            };
+            } | null;
+            /** @description Configuration for determining readiness of a container. */
+            readiness_check?: {
+                /** @description The command that will be run to verify readiness of the container. */
+                command: string;
+                interval: components["schemas"]["Duration"];
+                timeout: components["schemas"]["Duration"];
+            } | null;
             /** @description Configuration for determining the health of a container. */
             health_check?: {
                 /** @description The command that will be run to verify the health of the container. */
@@ -5994,14 +6111,14 @@ export interface components {
                 /** @description The number of times the platform will retry the command before marking the container unhealthy. */
                 retries: number;
                 /** @description How long to wait before performing an initial health check when the instance starts. The `state.health.healthy` field of the instance will be `null`` until the first check is performed. */
-                delay: components["schemas"]["Duration"] | null;
+                delay: components["schemas"]["Duration"];
                 /** @description How long to wait between restarts. */
                 interval: components["schemas"]["Duration"];
                 /** @description How long before a health check attempt times out. */
                 timeout: components["schemas"]["Duration"];
                 /** @description A boolean where `true` represents the desire for a container to restart if unhealthy. */
                 restart: boolean;
-            };
+            } | null;
             /** @description Configuration settings for container telemetery reporting. */
             telemetry?: {
                 /** @description How long telemetry data should be retained. */
@@ -6010,7 +6127,7 @@ export interface components {
                 interval: components["schemas"]["Duration"];
                 /** @description A boolean where true disables all telemetry reporting for this container. */
                 disable: boolean;
-            };
+            } | null;
         };
         /**
          * ScaleThresholdMetricRam
@@ -6581,6 +6698,16 @@ export interface components {
             };
             /** @description A LINKED record is a record special to Cycle.  It represents a URL that points to a specific container or deployment of a container, however the IP address mapping in handled automatically by the platform. */
             linked?: {
+                /** @description Rules for routing traffic at the load balancer for this linked record. */
+                routing: {
+                    http?: {
+                        /**
+                         * @description If set, this record will configure the load balancer to only match for paths of this domain matching this string.
+                         *     If the string starts with a /, it will be a literal prefix match (/test matches /test*). Otherwise, regex is used.
+                         */
+                        match_path?: string | null;
+                    } | null;
+                };
                 /** @description Features associated with this record. */
                 features: {
                     /** @description TLS properties of the record. */
@@ -6838,7 +6965,7 @@ export interface components {
          * @description The configuration for environment monitoring.
          */
         EnvironmentMonitoringConfig: {
-            /** @description An object describing the log configuration for the environment. */
+            /** @description An object describing the log monitoring configuration for the environment. */
             logs?: {
                 /** @description An object describing log drain configuration for the environment. */
                 drain?: {
@@ -6850,6 +6977,28 @@ export interface components {
                     exclude_services: boolean;
                 } | null;
             } | null;
+            /** @description An object describing the metrics monitoring configuration for the environment. */
+            metrics?: {
+                /**
+                 * @description Configuration options for pushing metrics externally.
+                 *     For payload see webhook `environmentMetricsPush`
+                 */
+                endpoint?: {
+                    /** @description The destination URL for the metrics. */
+                    url: string;
+                } | null;
+            } | null;
+            /** @description An object describing the events monitoring configuration for the environment. */
+            events?: {
+                /**
+                 * @description Configuration options for pushing events externally.
+                 *     For payload see webhook `environmentEventsPush`
+                 */
+                endpoint?: {
+                    /** @description The destination URL for events. */
+                    url: string;
+                } | null;
+            } | null;
         };
         /**
          * EnvironmentFeatures
@@ -7316,8 +7465,6 @@ export interface components {
          */
         DiscoveryConfig: {
             empty_set_delay?: components["schemas"]["Duration"] | null;
-            /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode.  Otherwise, only IPv4 will be returned. */
-            dual_stack_legacy?: boolean | null;
             /** @description A mapping of hostnames to IP addresses for custom internal resolutions. Acts as a custom /etc/resolv.conf file that works environment wide. */
             hosts?: {
                 [key: string]: {
@@ -7329,6 +7476,12 @@ export interface components {
             } | null;
             /** @description A list of custom DNS resolver strings.  Can specifify domains or ips. */
             custom_resolvers?: string[] | null;
+            /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode.  Otherwise, only IPv4 will be returned. */
+            dual_stack_legacy?: boolean | null;
+            external_resolution?: {
+                /** @enum {string} */
+                preference: "default" | "ipv4" | "ipv6";
+            } | null;
         };
         /**
          * DiscoveryEnvironmentService
@@ -7502,6 +7655,18 @@ export interface components {
                 image: components["schemas"]["ContainerImageSummary"];
                 environment: components["schemas"]["ContainerEnvironmentSummary"];
             }[];
+            /** @description A map where the key is the service and the value describes the version and date of last update. */
+            service_versions?: {
+                [key: string]: {
+                    /**
+                     * @description A string depicting the service version.
+                     * @example v2025.01.01.01
+                     */
+                    version: string;
+                    /** @description The time the version was last updated. */
+                    last_updated: components["schemas"]["DateTime"];
+                };
+            };
         };
         /**
          * Environment
@@ -8218,65 +8383,74 @@ export interface components {
              *     - ** function **: Every ingress request/connection receives its own instance.
              *     - ** manual **: Cycle will not make any decisions on where instances are deployed. Instead, instances must be deployed manually using the portal or API.
              */
-            strategy?: ("resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge" | "function" | null) | components["schemas"]["StackVariable"];
+            strategy?: ("resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge" | "function") | null | components["schemas"]["StackVariable"];
             /** @description Configuration options for containers using the 'function' deployment strategy. */
-            function?: ({
+            function?: {
                 /** @description The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances). */
-                max_pool_size?: (number | null) | components["schemas"]["StackVariable"];
+                max_pool_size?: number | null | components["schemas"]["StackVariable"];
                 /** @description For each shard (scheduler), the maximum number of tasks it can run in parallel. */
-                max_shard_concurrency?: (number | null) | components["schemas"]["StackVariable"];
+                max_shard_concurrency?: number | null | components["schemas"]["StackVariable"];
                 /** @description The maximum amount of time a function instance can run before timing out. */
-                max_runtime?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
+                max_runtime?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
                 /** @description The maximum amount of time Cycle will wait for an instance to be available. */
-                max_queue_time?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
-            } | null) | components["schemas"]["StackVariable"];
+                max_queue_time?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configuration options for stateful containers. */
-            stateful?: ({
+            stateful?: {
                 /** @description Stateful container options. */
                 options: {
                     /** @description When enabled, instances will utilize stateless base hostnames instead of being prefixed with a unique ID. */
                     use_base_hostname?: boolean | null;
-                } | null;
-            } | null) | components["schemas"]["StackVariable"];
+                } | null | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configuration options that provide the ability to set restrictions on which nodes instances of this container are able to be deployed to. (i.e. if you have a GPU container, it should only go on nodes with a GPU). */
-            constraints?: ({
+            constraints?: {
+                /** @description Constraint settings related to which nodes an instance can be deployed to. */
                 node?: {
                     /** @description Tags applied to a node. Cycle generates some automatically, but additional, custom tags can be applied on a per-node basis. */
                     tags: {
                         /** @description If a node has at least one of these tags, it is considered a valid deployment target for this container. */
-                        any?: string[] | components["schemas"]["StackVariable"];
+                        any?: string[] | null | components["schemas"]["StackVariable"];
                         /** @description A node must have **ALL** of these tags to be considered a valid deployment target for this container. */
-                        all?: string[] | components["schemas"]["StackVariable"];
-                    } | components["schemas"]["StackVariable"];
-                } | null;
-            } | null) | components["schemas"]["StackVariable"];
+                        all?: string[] | null | components["schemas"]["StackVariable"];
+                    } | null | components["schemas"]["StackVariable"];
+                } | null | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configuration options for how this container behaves during shutdown. */
-            shutdown?: ({
+            shutdown?: {
                 /** @description How long the platform will wait for a container to stop gracefully. */
                 graceful_timeout?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
-                signals?: components["schemas"]["ShutdownSignal"][] | components["schemas"]["StackVariable"];
-            } | null) | components["schemas"]["StackVariable"];
+                /** @description Signals that should be sent to the container on shutdown. */
+                signals?: components["schemas"]["ShutdownSignal"][] | null | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configuration options for how this container behaves during startup. */
-            startup?: ({
+            startup?: {
                 /** @description How long the platform will wait before sending the start signal to the given container. */
                 delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
-            } | null) | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configurations for how the container behaves during updates. */
-            update?: ({
+            update?: {
                 /** @description When set, Cycle will pick a random time from `0 - this duration`, and stagger the instances so they all start at different times (up to the time specified here). */
                 stagger?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
-            } | null) | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configuration options for how Cycle should handle restarting this container (i.e. in case the process inside the container dies). */
-            restart?: ({
+            restart?: {
                 /** @description Under what circumstances Cycle should try to restart this container. */
                 condition: ("always" | "never" | "failure") | components["schemas"]["StackVariable"];
                 /** @description How long the platform will wait between restart attempts. */
                 delay: components["schemas"]["Duration"] | components["schemas"]["StackVariable"];
                 /** @description The maximum number of restart attempts Cycle will make. */
                 max_attempts: number | components["schemas"]["StackVariable"];
-            } | null) | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
+            /** @description Configuration for determining readiness of a container. */
+            readiness_check?: {
+                /** @description The command that will be run to verify readiness of the container. */
+                command: string;
+                interval: components["schemas"]["Duration"];
+                timeout: components["schemas"]["Duration"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configuration options for automated container health checks. */
-            health_check?: ({
+            health_check?: {
                 /**
                  * @description The command or script to run to verify the health of the container. This script is run inside the container by Cycle.
                  *     This command accepts two types of entries:
@@ -8293,18 +8467,18 @@ export interface components {
                 restart: boolean | components["schemas"]["StackVariable"];
                 /** @description How long to wait after a container start event before running health checks. */
                 delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
-            } | null) | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
             /** @description Configuration options for how the instance telemetry (CPU usage, etc) is handled. */
-            telemetry?: ({
+            telemetry?: {
                 /** @description How long telemetry data should be retained. */
-                retention?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
+                retention?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
                 /** @description The duration between samples. */
-                interval?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
+                interval?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
                 /** @description A URL where Cycle will send telemetry data to. The payload will be an instance resource snapshot. */
-                webhook?: (string | null) | components["schemas"]["StackVariable"];
+                webhook?: string | null | components["schemas"]["StackVariable"];
                 /** @description If true, Cycle will not aggregate telemetry for this container's instances. */
                 disable: boolean | components["schemas"]["StackVariable"];
-            } | null) | components["schemas"]["StackVariable"];
+            } | null | components["schemas"]["StackVariable"];
         };
         /**
          * StackSpecContainerScaleThresholdRam
@@ -8737,8 +8911,6 @@ export interface components {
         /** StackSpecDiscoveryConfig */
         StackSpecDiscoveryConfig: {
             empty_set_delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
-            /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode.  Otherwise, only IPv4 will be returned. */
-            dual_stack_legacy?: boolean | components["schemas"]["StackVariable"] | null;
             /** @description A custom mapping of hosts - for forced resolution of specific IPs for a domain. */
             hosts?: ({
                 [key: string]: {
@@ -8748,6 +8920,12 @@ export interface components {
             } | null) | components["schemas"]["StackVariable"];
             /** @description A list of custom DNS resolver strings.  Can specifify domains or ips. */
             custom_resolvers?: string[] | components["schemas"]["StackVariable"] | null;
+            /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode.  Otherwise, only IPv4 will be returned. */
+            dual_stack_legacy?: boolean | components["schemas"]["StackVariable"] | null;
+            external_resolution?: {
+                /** @enum {string} */
+                preference: "default" | "ipv4" | "ipv6";
+            } | components["schemas"]["StackVariable"] | null;
         };
         /**
          * StackSpecDiscoveryService
@@ -9998,8 +10176,8 @@ export interface components {
             region: string;
         };
         /**
-         * LocationProvider
-         * @description Information about the locaiton of the provider.
+         * ProviderLocationDetails
+         * @description Information about the location of the provider.
          */
         ProviderLocationDetails: {
             /** @description An identifier for the given provider */
@@ -10065,6 +10243,8 @@ export interface components {
             creator: components["schemas"]["CreatorScope"];
             hub_id: components["schemas"]["HubID"];
             acl?: components["schemas"]["ACL"] | null;
+            /** @description Marks a cluster as non-essential. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in. */
+            non_essential: boolean;
             state: components["schemas"]["ClusterState"];
             features: {
                 /** @description The level of monitoring to enable for this cluster. There is a cost associated with higher levels of monitoring. */
@@ -10187,10 +10367,10 @@ export interface components {
             } | null;
         };
         /**
-         * ServerSpecs
+         * ProviderServerModelSpec
          * @description Specs for a given server
          */
-        ServerSpecs: {
+        ProviderServerModelSpec: {
             cpu: components["schemas"]["CPUSpec"];
             gpu: components["schemas"]["GPUSpec"];
             memory: components["schemas"]["MemorySpec"];
@@ -10199,11 +10379,13 @@ export interface components {
             features: components["schemas"]["FeaturesSpec"];
         };
         /**
-         * ProviderServerSpec
+         * ProviderServerModelProviderSpec
          * @description Higher level information about a providers server.
          */
-        ProviderServerSpec: {
-            /** @description A provider identifier */
+        ProviderServerModelProviderSpec: {
+            /** @description The infrastructure vendor for the provider. */
+            vendor?: string;
+            /** @description A provider identifier. */
             identifier: string;
             integration_id?: components["schemas"]["ID"] | null;
             /** @description A category for the server. */
@@ -10228,8 +10410,8 @@ export interface components {
             name: string;
             /** @description A description of the server. */
             description: string;
-            specs: components["schemas"]["ServerSpecs"];
-            provider: components["schemas"]["ProviderServerSpec"];
+            specs: components["schemas"]["ProviderServerModelSpec"];
+            provider: components["schemas"]["ProviderServerModelProviderSpec"];
             price: components["schemas"]["BillingAmount"];
             /** @description A boolean where true signifies this server is compatible with the platform. */
             compatible: boolean;
@@ -10239,10 +10421,10 @@ export interface components {
             location_ids: string[];
         };
         /**
-         * ServerModelIncludes
-         * @description A resources that assocaited with a provider server.
+         * ProviderServerModelsIncludes
+         * @description A resource associated with a server models.
          */
-        ServerModelIncludes: {
+        ProviderServerModelsIncludes: {
             [key: string]: components["schemas"]["ProviderServerModel"];
         };
         /** IntegrationAuth */
@@ -10403,7 +10585,7 @@ export interface components {
             clusters?: {
                 [key: string]: components["schemas"]["Cluster"];
             };
-            models?: components["schemas"]["ServerModelIncludes"];
+            models?: components["schemas"]["ProviderServerModelsIncludes"];
             integrations?: components["schemas"]["IntegrationsIncludes"];
         };
         /**
@@ -10454,6 +10636,18 @@ export interface components {
                 /** @description A timestamp of the last time the instance health was updated. */
                 updated: components["schemas"]["DateTime"];
             } | null;
+            /** @description information about the readiness of the instance. */
+            readiness?: {
+                /**
+                 * @description Describes the readiness of the instance.
+                 *     - `true`: The instance is ready.
+                 *     - `false`: The instance is not ready.
+                 *     - `null`: The instance has not yet reported its readiness, or a readiness check has not yet been performed.
+                 */
+                ready: boolean | null;
+                /** @description A timestamp of the last time the instance readiness was updated. */
+                updated: components["schemas"]["DateTime"];
+            } | null;
         } & components["schemas"]["State"];
         /**
          * InstanceAutoScale
@@ -13739,7 +13933,7 @@ export interface components {
              * @description The current lifecycle state of the volume.
              * @enum {string}
              */
-            current: "new" | "configuring" | "live" | "deleting" | "deleted";
+            current: "new" | "ready" | "configuring" | "live" | "deleting" | "deleted";
         } & components["schemas"]["State"];
         /**
          * ExternalVolumeEvents
@@ -13909,7 +14103,7 @@ export interface components {
          * @description A resource that is associated with activity.
          */
         ComponentsIncludes: {
-            [key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["VirtualProviderIso"] | components["schemas"]["IpPool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["DnsZone"] | components["schemas"]["DnsRecord"] | components["schemas"]["TlsCertificate"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"] | components["schemas"]["AutoScaleGroup"] | components["schemas"]["ExternalVolume"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"];
+            [key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["VirtualProviderIso"] | components["schemas"]["IpPool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["DnsZone"] | components["schemas"]["DnsRecord"] | components["schemas"]["TlsCertificate"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"] | components["schemas"]["AutoScaleGroup"] | components["schemas"]["ExternalVolume"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"] | components["schemas"]["Cluster"];
         };
         /**
          * ActivityIncludes
@@ -14285,20 +14479,13 @@ export interface components {
         };
         /** ExternalVolumeTask */
         ExternalVolumeTask: components["schemas"]["ExternalVolumeServersReconfigureAction"] | components["schemas"]["ExternalVolumeAttachmentReconfigureAction"];
-        /**
-         * ServerModelsIncludes
-         * @description A resource associated with a server models.
-         */
-        ServerModelsIncludes: {
-            [key: string]: components["schemas"]["ProviderServerModel"];
-        };
         /**
          * AutoScaleGroupIncludes
          * @description All includable resource linkable to the given auto-scale group.
          */
         AutoScaleGroupIncludes: {
             integrations?: components["schemas"]["IntegrationsIncludes"];
-            models?: components["schemas"]["ServerModelsIncludes"];
+            models?: components["schemas"]["ProviderServerModelsIncludes"];
             locations?: components["schemas"]["LocationsIncludes"];
         };
         /**
@@ -14798,7 +14985,7 @@ export interface components {
          * EventType
          * @enum {string}
          */
-        EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "environment.service.discovery.client.throttle.hit" | "environment.service.gateway.ips.sync.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.monitoring.throttled" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbors.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.autoscale.up" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed" | "infrastructure.server.checkin.missed" | "infrastructure.server.checkin.resumed" | "infrastructure.server.power.reboot" | "infrastructure.server.power.power-off" | "infrastructure.server.neighbor.incompatible";
+        EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "environment.service.discovery.client.throttle.hit" | "environment.service.gateway.ips.sync.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.compute.start.failure" | "infrastructure.server.compute.died" | "infrastructure.server.compute-spawner.full_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.monitoring.throttled" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbors.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.power.power_off" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.autoscale.up" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed" | "infrastructure.server.checkin.missed" | "infrastructure.server.checkin.resumed" | "infrastructure.server.power.reboot" | "infrastructure.server.neighbor.incompatible";
         /**
          * Event
          * @description A platform-generated event. Describes something happening on the platform at a specific time. Can be informational, security related, or a notice of something important.
@@ -14910,6 +15097,29 @@ export interface components {
             };
             "components:identifiers"?: components["schemas"]["IdentifierIncludes"];
         };
+        /**
+         * IncludedPipelines
+         * @description A map of pipelines, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
+         */
+        IncludedPipelines: {
+            [key: string]: components["schemas"]["Pipeline"];
+        };
+        /**
+         * IncludedTriggerKeys
+         * @description A map of trigger keys, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
+         */
+        IncludedTriggerKeys: {
+            [key: string]: components["schemas"]["TriggerKey"];
+        };
+        /**
+         * PipelineRunIncludes
+         * @description Resources related to a pipeline run, that can be included on supported endpoints when the matching includes query parameter is passed.
+         */
+        PipelineRunIncludes: {
+            creators?: components["schemas"]["CreatorInclude"];
+            pipelines?: components["schemas"]["IncludedPipelines"];
+            keys?: components["schemas"]["IncludedTriggerKeys"];
+        };
         /** TriggerPipelineAction */
         PipelineTriggerAction: {
             /**
@@ -18006,6 +18216,49 @@ export interface operations {
             default: components["responses"]["DefaultError"];
         };
     };
+    getAllTlsCertificates: {
+        parameters: {
+            query?: {
+                /**
+                 * @description ## Filter Field
+                 *     The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
+                 */
+                filter?: {
+                    /** @description `filter[domain]=value1` filter user certificates by associated domain. */
+                    domain?: string;
+                    /** @description `filter[state]=value1,value2` state filtering will allow filtering by the current state. */
+                    state?: string;
+                    /**
+                     * @description `filter[user-supplied]=true` List only those certificates that are user supplied.
+                     *     `filter[user-supplied]=false` List only those certificates that are auto generated.
+                     */
+                    "user-supplied"?: string;
+                };
+                /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
+                sort?: components["parameters"]["SortParam"];
+                /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
+                page?: components["parameters"]["PageParam"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns a TLS certificate. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["TlsCertificate"][];
+                    };
+                };
+            };
+            default: components["responses"]["DefaultError"];
+        };
+    };
     lookupTLSCertificate: {
         parameters: {
             query: {
@@ -18179,7 +18432,7 @@ export interface operations {
         parameters: {
             query?: {
                 /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
-                meta?: ("containers" | "containers_count" | "instances_count")[];
+                meta?: ("containers" | "containers_count" | "instances_count" | "service_versions")[];
                 /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
                 include?: ("creators" | "stacks")[];
                 /**
@@ -18270,7 +18523,7 @@ export interface operations {
         parameters: {
             query?: {
                 /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
-                meta?: ("containers" | "containers_count" | "instances_count")[];
+                meta?: ("containers" | "containers_count" | "instances_count" | "service_versions")[];
                 /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
                 include?: ("creators" | "stacks" | "clusters")[];
             };
@@ -21085,6 +21338,8 @@ export interface operations {
                     cluster?: string;
                     /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the attached volume's current state. */
                     state?: string;
+                    /** @description `filter[unused]=true` List only those external volumes that are unused (not attached). */
+                    unused?: string;
                 };
                 /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
                 sort?: components["parameters"]["SortParam"];
@@ -21617,7 +21872,7 @@ export interface operations {
             default: components["responses"]["DefaultError"];
         };
     };
-    getProviderServers: {
+    getProviderServerModels: {
         parameters: {
             query?: {
                 /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -21635,8 +21890,11 @@ export interface operations {
             };
             header?: never;
             path: {
-                /** @description The vendor for the given provider. Example `gcp`, `equinix-metal`, `abstraction`, etc. Can also use a Provider Integration ID. */
-                providerVendor: string;
+                /**
+                 * @description The infrastructure provider integration ID to query for server models.
+                 *     Can also use a vendor string. Example `gcp`, `equinix-metal`, `abstraction`, etc.
+                 */
+                integrationId: string;
             };
             cookie?: never;
         };
@@ -21666,8 +21924,11 @@ export interface operations {
             };
             header?: never;
             path: {
-                /** @description The vendor for the given Provider Integration. Example `gcp`, `equinix-metal`, `abstraction`, etc. Can also use the Integration ID. */
-                providerVendor: string;
+                /**
+                 * @description The infrastructure provider integration ID to query for server models.
+                 *     Can also use a vendor string. Example `gcp`, `equinix-metal`, `abstraction`, etc.
+                 */
+                integrationId: string;
             };
             cookie?: never;
         };
@@ -21979,6 +22240,19 @@ export interface operations {
             query?: {
                 /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
                 page?: components["parameters"]["PageParam"];
+                /**
+                 * @description ## Filter Field
+                 *     The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
+                 */
+                filter?: {
+                    /** @description `filter[essential]=true` filter for essential/non-essential clusters. */
+                    essential?: string;
+                    /**
+                     * @description `filter[state]=value1,value2` state filtering will allow you to filter by the cluster's current state.
+                     *            `filter[stack_build]=ID` stack build filtering by ID.  Submit the ID of the stack build you wish to filter for and the return sill be any environments that have the stack build deployed to them.
+                     */
+                    state?: string;
+                };
             };
             header?: never;
             path?: never;
@@ -22096,7 +22370,10 @@ export interface operations {
         /** @description Parameters for updating a cluster. */
         requestBody?: {
             content: {
-                "application/json": Record<string, never>;
+                "application/json": {
+                    /** @description Set to true to mark the cluster as 'non-essential'. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in. */
+                    non_essential?: boolean;
+                };
             };
         };
         responses: {
@@ -22227,7 +22504,7 @@ export interface operations {
             default: components["responses"]["DefaultError"];
         };
     };
-    createServer: {
+    createServers: {
         parameters: {
             query?: never;
             header?: never;
@@ -22248,14 +22525,12 @@ export interface operations {
                         model_id: string;
                         /** @description The location ID of the Server. */
                         location_id: string;
-                        /** @description The number of this Server at this location to deploy. */
-                        quantity: number;
-                        /** @description An array of hostnames for the given servers. */
-                        hostnames?: string[];
                         advanced?: {
-                            /** @description Advanced options to apply to the provisioning of a server. */
                             provision_options?: {
-                                /** @description For providers that support setting this value dynamically; A number representing the GB size of the volume to be attached to the server. */
+                                /**
+                                 * @description For providers that support setting this value dynamically;
+                                 *     A number representing the GB size of the volume to be attached to the server.
+                                 */
                                 attached_storage_size?: number | null;
                                 /** @description A reservation ID to be used to provision a server that has been reserved at the provider. */
                                 reservation_id?: string | null;
@@ -22263,7 +22538,7 @@ export interface operations {
                                 encrypt_storage?: boolean | null;
                             } | null;
                             zone?: string | null;
-                        }[];
+                        } | null;
                     }[];
                 };
             };
@@ -23397,6 +23672,37 @@ export interface operations {
             default: components["responses"]["DefaultError"];
         };
     };
+    getAllPipelineRuns: {
+        parameters: {
+            query?: {
+                /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
+                page?: components["parameters"]["PageParam"];
+                /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
+                sort?: components["parameters"]["SortParam"];
+                /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
+                include?: ("creators" | "keys" | "pipelines")[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns a list of pipeline runs. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["PipelineRun"][];
+                        includes?: components["schemas"]["PipelineRunIncludes"];
+                    };
+                };
+            };
+            default: components["responses"]["DefaultError"];
+        };
+    };
     getPipelineRuns: {
         parameters: {
             query?: {
@@ -23414,7 +23720,7 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Returns a list of Pipeline runs. */
+            /** @description Returns a list of pipeline runs. */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -24261,6 +24567,46 @@ export interface operations {
             default: components["responses"]["DefaultError"];
         };
     };
+    getAllStackBuilds: {
+        parameters: {
+            query?: {
+                /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
+                meta?: "containers_count"[];
+                /**
+                 * @description ## Filter Field
+                 *     The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
+                 */
+                filter?: {
+                    /** @description `filter[search]=value` search for a value associated with a field on the given Stack Build(s). */
+                    search?: string;
+                    /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state. */
+                    state?: string;
+                };
+                /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
+                sort?: components["parameters"]["SortParam"];
+                /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
+                page?: components["parameters"]["PageParam"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns a list of stack builds. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["StackBuild"][];
+                    };
+                };
+            };
+            default: components["responses"]["DefaultError"];
+        };
+    };
     lookupStackBuild: {
         parameters: {
             query?: never;
@@ -25125,4 +25471,32 @@ export interface operations {
             default: components["responses"]["DefaultError"];
         };
     };
+    environmentMetricsPush: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["Metric"][];
+            };
+        };
+        responses: never;
+    };
+    environmentEventsPush: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["Event"][];
+            };
+        };
+        responses: never;
+    };
 }