@parallelworks/client 7.103.0 → 7.104.0

package/dist/types/api.d.ts

@@ -48,6 +48,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/admin/agents": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List agents
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     > This is a platform-admin only route.
+         *
+         *     Returns every agent the platform knows about with the version it reports, plus the fleet-wide version distribution
+         */
+        get: operations["list-fleet-agents"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/admin/alerts": {
         parameters: {
             query?: never;
@@ -14389,7 +14413,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/sso/cac/redirect": {
+    "/api/sso/cac/redirect/{authID}": {
         parameters: {
             query?: never;
             header?: never;
@@ -14963,6 +14987,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/user/preferences": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get user preferences
+         * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
+         *
+         *     Returns the current user's saved UI preferences, such as list page display options and filters, keyed by view id.
+         */
+        get: operations["get-user-preferences"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Update user preferences
+         * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
+         *
+         *     Writes the given preference keys for the current user. A null value removes a key; keys not in the request are left unchanged.
+         */
+        patch: operations["update-user-preferences"];
+        trace?: never;
+    };
     "/api/user/profile": {
         parameters: {
             query?: never;
@@ -17041,6 +17093,21 @@ export interface components {
             /** @description User associated with the storage. */
             user: string;
         };
+        AwsEfsDefinition: {
+            /** @description EFS filesystem id at AWS. */
+            fileSystemId?: string;
+            /** @description Mount targets by subnet. */
+            mountTargets?: {
+                [key: string]: string;
+            };
+            /** @description Throughput mode of the filesystem. */
+            throughputMode?: string;
+            /**
+             * @description Type discriminator. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "aws-efs";
+        };
         AwsEfsVersionSettings: {
             efs_encrypted?: boolean;
             efs_performance_mode?: string;
@@ -17346,6 +17413,19 @@ export interface components {
             userBootstrapController?: boolean;
             zone?: string;
         };
+        AzureAzfilesDefinition: {
+            /** @description Name of the file share at Azure, which can differ from the platform name. */
+            azfilesName?: string;
+            /** @description Azure resource group the storage account belongs to. */
+            azureResourceGroup?: string;
+            /** @description Azure storage account hosting the share. */
+            storageAccountName?: string;
+            /**
+             * @description Type discriminator. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "azure-azfiles";
+        };
         AzureAzfilesVersionSettings: {
             region?: string;
             /** Format: int64 */
@@ -17900,6 +17980,19 @@ export interface components {
             /** @description User associated with the storage. */
             user: string;
         };
+        AzureNetappFilesDefinition: {
+            /** @description Export path of the volume. */
+            exportPath?: string;
+            /** @description IP address clients mount the volume from. */
+            mountIp?: string;
+            /** @description Service level of the volume. */
+            service?: string;
+            /**
+             * @description Type discriminator. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "azure-netappfiles";
+        };
         AzureNetappFilesVersionSettings: {
             region?: string;
             service?: string;
@@ -21511,6 +21604,105 @@ export interface components {
             /** @description OpenStack flavor ID */
             id: string;
         };
+        FleetAgent: {
+            /** @description CPU architecture reported by the agent. */
+            arch?: string;
+            /** @description Whether the agent is below the configured minimum agent version. An agent that never reported a version counts as below it, matching how the tunnel gate treats one. Always false for endpoints, which the gate exempts. */
+            belowMinimum: boolean;
+            /** @description Id of the cluster or endpoint session the agent belongs to. */
+            clusterId: string;
+            /** @description Name of the cluster or endpoint session. */
+            clusterName: string;
+            /** @description Whether the agent is reporting right now. */
+            connected: boolean;
+            /** @description Cluster display name. */
+            displayName?: string;
+            /** @description Node hostname, for managed cluster node agents. */
+            hostname?: string;
+            /** @description Stable row id: the cluster id, plus the node hostname for managed cluster nodes. */
+            id: string;
+            /** @description Custom cluster icon, when one was uploaded. */
+            imageUrl?: string;
+            /**
+             * @description Where the agent runs: a cloud cluster, a standalone instance, an existing cluster, a managed cluster node, or a pw CLI serving an endpoint session.
+             * @enum {string}
+             */
+            kind: "cloud" | "instance" | "existing" | "managed" | "endpoint";
+            /**
+             * Format: date-time
+             * @description When the agent last reported.
+             */
+            lastSeenAt?: string;
+            /** @description Organization the cluster belongs to. */
+            organization?: string;
+            /** @description Operating system reported by the agent. */
+            os?: string;
+            /** @description OS release reported by the agent. */
+            osRelease?: string;
+            /** @description Whether the reported version is older than the platform version. */
+            outdated: boolean;
+            /** @description Resource type the icon is derived from: the cloud provider for cloud clusters and instances, existing, or managed-cluster. */
+            resourceType?: string;
+            /** @description Scheduler on the cluster, used as the existing-cluster icon. */
+            schedulerType?: string;
+            /** @description In-flight agent update state: updating or failed. */
+            updateStatus?: string;
+            /** @description Owner of the cluster. */
+            username?: string;
+            /** @description Last reported agent version. Empty when the agent has never reported one. */
+            version?: string;
+        };
+        FleetSummary: {
+            /**
+             * Format: int64
+             * @description Agents below the configured minimum agent version, including those that never reported one. Endpoints are exempt, matching the tunnel gate.
+             */
+            belowMinimum: number;
+            /**
+             * Format: int64
+             * @description Agents reporting right now.
+             */
+            connected: number;
+            /** @description Configured minimum agent version. Empty when enforcement is off. */
+            minimumAgentVersion?: string;
+            /** @description Oldest version any reporting agent runs. This is the version gate the fleet has actually reached. */
+            oldestVersion?: string;
+            /**
+             * Format: int64
+             * @description Agents older than the platform version.
+             */
+            outdated: number;
+            /** @description Version of the platform the agents are compared against. */
+            platformVersion: string;
+            /** @description Whether the platform version is a version agents can be compared against. False for a local development build, where the drift counts carry no meaning. */
+            platformVersionComparable: boolean;
+            /**
+             * Format: int64
+             * @description Agents in the fleet.
+             */
+            total: number;
+            /**
+             * Format: int64
+             * @description Agents that have never reported a version.
+             */
+            unreported: number;
+            /** @description Version distribution across the whole fleet, newest first. */
+            versions: components["schemas"]["FleetVersionCount"][] | null;
+        };
+        FleetVersionCount: {
+            /**
+             * Format: int64
+             * @description Agents on this version that are reporting right now.
+             */
+            connected: number;
+            /**
+             * Format: int64
+             * @description Agents on this version.
+             */
+            count: number;
+            /** @description Reported agent version, or empty for agents that never reported one. */
+            version: string;
+        };
         ForkMarketplaceItemBody: {
             /** @description For remote workflows, convert to local by fetching the YAML. */
             convertToLocal?: boolean;
@@ -22148,6 +22340,17 @@ export interface components {
             /** @description Zone the Google Filestore is in */
             zone?: string;
         };
+        GoogleFilestoreDefinition: {
+            /** @description IP address of the file server. */
+            fileserverIp?: string;
+            /** @description Service tier of the instance. */
+            filestoreTier?: string;
+            /**
+             * @description Type discriminator. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "google-filestore";
+        };
         GoogleFilestoreVersionSettings: {
             filestore_tier?: string;
             region?: string;
@@ -23897,6 +24100,17 @@ export interface components {
         ListAdminProductsOutputBody: {
             products: components["schemas"]["AdminProduct"][] | null;
         };
+        ListAgentsBody: {
+            /** @description One page of agents. */
+            agents: components["schemas"]["FleetAgent"][] | null;
+            /** @description Fleet-wide totals, unaffected by the filters. */
+            summary: components["schemas"]["FleetSummary"];
+            /**
+             * Format: int64
+             * @description Agents matching the filters.
+             */
+            total: number;
+        };
         ListAttachmentsBody: {
             attachments: components["schemas"]["AttachmentResponse"][] | null;
         };
@@ -25911,6 +26125,19 @@ export interface components {
             /** @description User associated with the storage. */
             user: string;
         };
+        OracleFsDefinition: {
+            /** @description Availability domain the file system is in. */
+            availabilityDomain?: string;
+            /** @description Export path of the file system. */
+            exportPath?: string;
+            /** @description IP address of the mount target. */
+            mountTargetIp?: string;
+            /**
+             * @description Type discriminator. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "oracle-oraclefs";
+        };
         OracleOraclefsVersionSettings: {
             availability_domain?: string;
             region?: string;
@@ -30303,7 +30530,7 @@ export interface components {
              * StorageDefinition
              * @description The storage's typed configuration.
              */
-            definition: components["schemas"]["AwsLustreDefinition"] | components["schemas"]["AzureManagedLustreDefinition"] | components["schemas"]["GoogleManagedLustreDefinition"] | components["schemas"]["BucketDefinition"] | components["schemas"]["DiskDefinition"];
+            definition: components["schemas"]["AwsLustreDefinition"] | components["schemas"]["AzureManagedLustreDefinition"] | components["schemas"]["GoogleManagedLustreDefinition"] | components["schemas"]["BucketDefinition"] | components["schemas"]["DiskDefinition"] | components["schemas"]["AwsEfsDefinition"] | components["schemas"]["AzureAzfilesDefinition"] | components["schemas"]["AzureNetappFilesDefinition"] | components["schemas"]["GoogleFilestoreDefinition"] | components["schemas"]["OracleFsDefinition"];
             /** @description Display name of the storage. */
             displayName: string;
             /** @description Whether the storage is ephemeral. */
@@ -31285,6 +31512,12 @@ export interface components {
              */
             resourceGroup: string;
         };
+        UpdateUserPreferencesInputBody: {
+            /** @description Preference keys to write. A null value removes the key; keys not present are left unchanged. */
+            preferences: {
+                [key: string]: unknown;
+            };
+        };
         UpdateUserProfileBody: {
             /** @description Full name of the user */
             name: string;
@@ -31518,6 +31751,12 @@ export interface components {
             resourceType?: string;
             type?: string;
         };
+        UserPreferencesBody: {
+            /** @description The user's saved UI preferences keyed by view id. Values are opaque JSON owned by the client. */
+            preferences: {
+                [key: string]: unknown;
+            };
+        };
         UserProfile: {
             /** @description Cache-buster for the user's avatar image. */
             avatarEtag?: string;
@@ -31776,6 +32015,8 @@ export interface components {
             allowCredentials?: components["schemas"]["WebAuthnCredentialDescriptor"][] | null;
             /** @description Base64url-encoded challenge */
             challenge: string;
+            /** @description Authenticator types the relying party prefers */
+            hints?: string[] | null;
             /** @description Relying party ID */
             rpId?: string;
             /**
@@ -31843,6 +32084,8 @@ export interface components {
             challenge: string;
             /** @description Credentials that may not be re-registered */
             excludeCredentials?: components["schemas"]["WebAuthnCredentialDescriptor"][] | null;
+            /** @description Authenticator types the relying party prefers */
+            hints?: string[] | null;
             /** @description Acceptable credential algorithms */
             pubKeyCredParams: components["schemas"]["WebAuthnRegCredParam"][] | null;
             /** @description Relying party */
@@ -31978,6 +32221,8 @@ export interface components {
             stoppedAt?: string;
             /** @description Worker authentication token. Only returned on creation. */
             readonly token?: string;
+            /** @description Parallel Works URI for the cluster. */
+            readonly uri?: string;
             /** @description User ID. */
             userId?: string;
         };
@@ -32345,6 +32590,48 @@ export interface operations {
             };
         };
     };
+    "list-fleet-agents": {
+        parameters: {
+            query?: {
+                /** @description Filter by where the agent runs. */
+                kind?: ("cloud" | "instance" | "existing" | "managed" | "endpoint")[] | null;
+                /** @description Filter by whether the agent is reporting right now. */
+                connected?: "true" | "false";
+                /** @description Only agents older than the platform version. */
+                outdated?: boolean;
+                /** @description Case-insensitive match on cluster name, display name, hostname, user, organization, or version. */
+                search?: string;
+                /** @description Page size. */
+                limit?: number;
+                /** @description Page offset. */
+                offset?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListAgentsBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "get-platform-alerts": {
         parameters: {
             query?: {
@@ -60730,7 +61017,10 @@ export interface operations {
         parameters: {
             query?: never;
             header?: never;
-            path?: never;
+            path: {
+                /** @description ID of the CAC authentication method */
+                authID: string;
+            };
             cookie?: never;
         };
         requestBody?: never;
@@ -60739,6 +61029,7 @@ export interface operations {
             204: {
                 headers: {
                     Location?: string;
+                    "Set-Cookie"?: string;
                     [name: string]: unknown;
                 };
                 content?: never;
@@ -61595,6 +61886,68 @@ export interface operations {
             };
         };
     };
+    "get-user-preferences": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UserPreferencesBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "update-user-preferences": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateUserPreferencesInputBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UserPreferencesBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "update-user-profile": {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parallelworks/client",
-  "version": "7.103.0",
+  "version": "7.104.0",
   "description": "Official TypeScript client for Parallel Works ACTIVATE API",
   "type": "module",
   "exports": {