@parallelworks/client 7.104.0 → 7.105.0

package/dist/types/api.d.ts

@@ -150,6 +150,138 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/admin/billing/realtime-accuracy": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get realtime estimator accuracy summary
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Returns per-CSP accuracy of the flexA realtime cost estimator against invoiced costs, from a periodically refreshed view. Requires platform admin or billing admin.
+         */
+        get: operations["get-realtime-accuracy-summary"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/admin/billing/realtime-accuracy/categories": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get realtime estimator accuracy by category
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Returns estimator accuracy per CSP, cost type and subtype. Requires platform admin or billing admin.
+         */
+        get: operations["get-realtime-accuracy-categories"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/admin/billing/realtime-accuracy/export": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Export realtime estimator accuracy data
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Downloads the accuracy data with its definitions and a code map, as a Markdown report or as JSON. Requires platform admin or billing admin.
+         */
+        get: operations["export-realtime-accuracy"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/admin/billing/realtime-accuracy/outliers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get realtime estimator accuracy outliers
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Returns the deployment-days where the realtime estimate missed the invoice by the most. Requires platform admin or billing admin.
+         */
+        get: operations["get-realtime-accuracy-outliers"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/admin/billing/realtime-accuracy/refresh": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Rebuild realtime estimator accuracy data
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Starts a background rebuild of the realtime accuracy view. Responds 409 while a rebuild is already running. Requires platform admin or billing admin.
+         */
+        post: operations["refresh-realtime-accuracy"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/admin/billing/realtime-accuracy/trend": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get realtime estimator accuracy trend
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Returns the daily estimate-to-invoice ratio per CSP. Requires platform admin or billing admin.
+         */
+        get: operations["get-realtime-accuracy-trend"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/admin/billing/runs": {
         parameters: {
             query?: never;
@@ -15448,6 +15580,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/workflow-runs/{slug}/running-steps": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Workflow Run Running Steps
+         * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
+         *
+         *     Reads where each running job of a workflow run has got to.
+         */
+        get: operations["get-workflow-run-running-steps"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/workflow-variables": {
         parameters: {
             query?: never;
@@ -20728,7 +20882,10 @@ export interface components {
             yaml?: string;
         };
         CreateWorkflowRunOutputBody: {
+            /** @description Name of the session to open once the run starts. */
             redirect?: string;
+            /** @description Key into the run's links of the link to open once it resolves. */
+            redirectLink?: string;
             run: components["schemas"]["WorkflowRunResponse"];
         };
         CreateWorkflowSavedInputsInputBody: {
@@ -24113,6 +24270,10 @@ export interface components {
         };
         ListAttachmentsBody: {
             attachments: components["schemas"]["AttachmentResponse"][] | null;
+            /** @description Whether another page follows */
+            hasMore: boolean;
+            /** @description Pass as cursor to read the next page */
+            nextCursor?: string;
         };
         ListConversationsBody: {
             conversations: components["schemas"]["ConversationSummary"][] | null;
@@ -24238,7 +24399,14 @@ export interface components {
         };
         ListUserAttachmentsBody: {
             attachments: components["schemas"]["AttachmentResponse"][] | null;
-            /** Format: int64 */
+            /** @description Whether another page follows */
+            hasMore: boolean;
+            /** @description Pass as cursor to read the next page */
+            nextCursor?: string;
+            /**
+             * Format: int64
+             * @description Matching attachments, capped at 10000
+             */
             total: number;
         };
         ListUserThumbnailsOutputBody: {
@@ -28954,6 +29122,192 @@ export interface components {
             /** @description Zones whose project offers an IRDMA (Falcon) network profile. */
             zones: string[] | null;
         };
+        RealtimeAccuracyCategoryRow: {
+            /** @description Cloud service provider */
+            csp: string;
+            /**
+             * Format: double
+             * @description Sum of estimates
+             */
+            estimated: number;
+            /**
+             * Format: double
+             * @description Sum of prorated invoice amounts
+             */
+            invoiced: number;
+            /**
+             * Format: int64
+             * @description Deployment-day keys
+             */
+            keys: number;
+            /**
+             * Format: double
+             * @description Median per-key ratio over measurable keys
+             */
+            medianRatio: number | null;
+            /**
+             * Format: int64
+             * @description Keys with an estimate but no invoice line
+             */
+            noInvoiceLine: number;
+            /**
+             * Format: double
+             * @description Estimated divided by invoiced; null without a measurable invoice
+             */
+            ratio: number | null;
+            /** @description Cost subtype */
+            subtype: string;
+            /** @description Cost type */
+            type: string;
+            /**
+             * Format: double
+             * @description Percentage of measurable keys whose ratio is within 0.9 to 1.1
+             */
+            withinTenPct: number | null;
+        };
+        RealtimeAccuracyOutlier: {
+            /** @description Cloud service provider */
+            csp: string;
+            /** @description Calendar day, YYYY-MM-DD */
+            day: string;
+            /** @description Deployment the estimate was attributed to */
+            deploymentId: string;
+            /**
+             * Format: double
+             * @description Estimated minus prorated invoice
+             */
+            error: number;
+            /**
+             * Format: double
+             * @description Estimate for the key
+             */
+            estimated: number;
+            /**
+             * Format: double
+             * @description Full-day invoice amount; null when no invoice line exists
+             */
+            invoiced: number | null;
+            /**
+             * Format: double
+             * @description Invoice amount prorated to the estimated hours
+             */
+            invoicedProrated: number | null;
+            /**
+             * Format: double
+             * @description Estimated divided by prorated invoice; null without a measurable invoice
+             */
+            ratio: number | null;
+            /** @description The estimate came from a reprocess */
+            reprocessed: boolean;
+            /** @description One of the resources behind the estimate */
+            resourceName: string | null;
+            /** @description Cost subtype */
+            subtype: string;
+            /** @description Cost type */
+            type: string;
+        };
+        RealtimeAccuracySummary: {
+            /**
+             * Format: int64
+             * @description How long the last successful rebuild took
+             */
+            durationMs: number | null;
+            /** @description Error from the most recent failed rebuild, if any */
+            lastError: string | null;
+            /**
+             * Format: date-time
+             * @description When the accuracy data was last rebuilt; null before the first refresh
+             */
+            refreshedAt: string | null;
+            /** @description Whether a rebuild is currently running */
+            refreshing: boolean;
+            /** @description One row per CSP */
+            summary: components["schemas"]["RealtimeAccuracySummaryRow"][] | null;
+            /** @description All CSPs in the window combined; csp is empty */
+            total: components["schemas"]["RealtimeAccuracySummaryRow"];
+        };
+        RealtimeAccuracySummaryRow: {
+            /** @description Cloud service provider */
+            csp: string;
+            /**
+             * Format: double
+             * @description Sum of estimates
+             */
+            estimated: number;
+            /**
+             * Format: double
+             * @description Sum of invoice amounts, prorated to the estimated hours
+             */
+            invoiced: number;
+            /**
+             * Format: int64
+             * @description Deployment-day-category keys with a frozen estimate
+             */
+            keys: number;
+            /**
+             * Format: int64
+             * @description Keys estimated by the running loop
+             */
+            liveKeys: number;
+            /**
+             * Format: int64
+             * @description Keys with an estimate but no invoice line
+             */
+            noInvoiceLine: number;
+            /**
+             * Format: double
+             * @description Estimated divided by invoiced; null without a measurable invoice
+             */
+            ratio: number | null;
+            /**
+             * Format: int64
+             * @description Keys regenerated by a reprocess after the fact
+             */
+            reprocessedKeys: number;
+            /**
+             * Format: double
+             * @description Tagged invoice amount for deployments the estimator never covered
+             */
+            unestimatedInvoiced: number;
+            /**
+             * Format: double
+             * @description Weighted absolute percentage error over keys with an invoice line
+             */
+            wape: number | null;
+            /**
+             * Format: double
+             * @description Percentage of measurable keys whose ratio is within 0.9 to 1.1
+             */
+            withinTenPct: number | null;
+        };
+        RealtimeAccuracyTrendPoint: {
+            /** @description Cloud service provider */
+            csp: string;
+            /** @description Calendar day, YYYY-MM-DD */
+            day: string;
+            /**
+             * Format: double
+             * @description Sum of estimates
+             */
+            estimated: number;
+            /**
+             * Format: double
+             * @description Sum of prorated invoice amounts
+             */
+            invoiced: number;
+            /**
+             * Format: int64
+             * @description Keys contributing to the point
+             */
+            keys: number;
+            /**
+             * Format: double
+             * @description Estimated divided by invoiced; null without a measurable invoice
+             */
+            ratio: number | null;
+            /** @description Every key that day came from a reprocess */
+            reprocessed: boolean;
+        };
         RecommendedResource: {
             /** @description Cloud provider (aws, google, azure) */
             csp?: string;
@@ -29682,6 +30036,12 @@ export interface components {
              */
             timeoutSec?: number;
         };
+        RunStep: {
+            /** @description Step name. */
+            name?: string;
+            /** @description Step status. */
+            status?: string;
+        };
         RunSummary: {
             /**
              * Format: int64
@@ -30122,7 +30482,7 @@ export interface components {
             /** @description Workflow run information. */
             readonly workflowRun?: components["schemas"]["WorkflowRunInfo"];
             /** @description Workflow running steps. */
-            readonly workflowRunningSteps?: components["schemas"]["StepStruct"][] | null;
+            readonly workflowRunningSteps?: components["schemas"]["RunStep"][] | null;
         };
         SessionAlert: {
             /** @description Indicates if the storage will be automatically terminated when the cost limit is reached. */
@@ -30466,12 +30826,6 @@ export interface components {
             /** @description Reconnect an existing Codex provider in place */
             reconnect?: boolean;
         };
-        StepStruct: {
-            /** @description Step name. */
-            name?: string;
-            /** @description Step status. */
-            status?: string;
-        };
         StopClusterOptions: {
             /** @description Stop the controller through the cloud provider instead of waiting for the cluster agent to shut it down from inside the guest. */
             force?: boolean;
@@ -32301,9 +32655,13 @@ export interface components {
             inputs?: {
                 [key: string]: unknown;
             };
+            links?: {
+                [key: string]: components["schemas"]["WorkflowRunLink"];
+            };
             marketplace: boolean;
             /** Format: int64 */
             number?: number;
+            redirect?: components["schemas"]["WorkflowRunRedirect"];
             resolvedYaml?: {
                 [key: string]: unknown;
             };
@@ -32332,6 +32690,16 @@ export interface components {
             /** @description Workflow type. */
             readonly type?: string;
         };
+        WorkflowRunLink: {
+            detach?: boolean;
+            endpoint?: string;
+            url?: string;
+        };
+        WorkflowRunRedirect: {
+            /** @enum {string} */
+            kind: "session" | "link";
+            name: string;
+        };
         WorkflowRunResponse: {
             /** Format: date-time */
             completedAt?: string;
@@ -32350,6 +32718,9 @@ export interface components {
             user: string;
             workflowName?: string;
         };
+        WorkflowRunRunningStepsResponse: {
+            runningSteps: components["schemas"]["RunStep"][] | null;
+        };
         WorkflowRunsCleanupPreviewBody: {
             /**
              * Format: int64
@@ -32758,6 +33129,217 @@ export interface operations {
             };
         };
     };
+    "get-realtime-accuracy-summary": {
+        parameters: {
+            query?: {
+                /** @description Days to include, counted back from today */
+                window?: 14 | 30 | 60 | 90;
+                /** @description Restrict to one cloud service provider */
+                csp?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RealtimeAccuracySummary"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-realtime-accuracy-categories": {
+        parameters: {
+            query?: {
+                /** @description Days to include, counted back from today */
+                window?: 14 | 30 | 60 | 90;
+                /** @description Restrict to one cloud service provider */
+                csp?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RealtimeAccuracyCategoryRow"][] | null;
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "export-realtime-accuracy": {
+        parameters: {
+            query?: {
+                /** @description Days to include, counted back from today */
+                window?: 14 | 30 | 60 | 90;
+                /** @description Restrict to one cloud service provider */
+                csp?: string;
+                /** @description Restrict to one cost type, e.g. Compute */
+                type?: string;
+                /** @description Restrict to one cost subtype, e.g. Instance */
+                subtype?: string;
+                /** @description md = self-describing Markdown report, json = the same data as an object */
+                format?: "md" | "json";
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-realtime-accuracy-outliers": {
+        parameters: {
+            query?: {
+                /** @description Days to include, counted back from today */
+                window?: 14 | 30 | 60 | 90;
+                /** @description Restrict to one cloud service provider */
+                csp?: string;
+                /** @description Restrict to one cost type, e.g. Compute */
+                type?: string;
+                /** @description Restrict to one cost subtype, e.g. Instance */
+                subtype?: string;
+                /** @description Maximum rows to return */
+                limit?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RealtimeAccuracyOutlier"][] | null;
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "refresh-realtime-accuracy": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-realtime-accuracy-trend": {
+        parameters: {
+            query?: {
+                /** @description Days to include, counted back from today */
+                window?: 14 | 30 | 60 | 90;
+                /** @description Restrict to one cloud service provider */
+                csp?: string;
+                /** @description Restrict to one cost type, e.g. Compute */
+                type?: string;
+                /** @description Restrict to one cost subtype, e.g. Instance */
+                subtype?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RealtimeAccuracyTrendPoint"][] | null;
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "list-billing-runs": {
         parameters: {
             query?: {
@@ -35058,8 +35640,10 @@ export interface operations {
             query?: {
                 /** @description Max attachments to return */
                 limit?: number;
-                /** @description Pagination offset */
+                /** @description Pagination offset, ignored when a cursor is given */
                 offset?: number;
+                /** @description Cursor from a previous page */
+                cursor?: string;
                 /** @description Filter by content type prefix (e.g. image/) */
                 contentType?: string;
             };
@@ -35267,6 +35851,10 @@ export interface operations {
             query?: {
                 /** @description Filter by message ID (optional) */
                 messageId?: string;
+                /** @description Page size */
+                limit?: number;
+                /** @description Cursor from a previous page */
+                cursor?: string;
             };
             header?: never;
             path: {
@@ -62740,6 +63328,38 @@ export interface operations {
             };
         };
     };
+    "get-workflow-run-running-steps": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The slug identifier of the workflow run */
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkflowRunRunningStepsResponse"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "list-user-variables": {
         parameters: {
             query?: never;

package/package.json

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