@cube-dev/platform-client 0.15.0 → 0.16.0

package/dist/schema.d.ts

@@ -1046,6 +1046,78 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/deployments/{deploymentId}/report-deliveries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List report deliveries
+         * @description In preview: ask Cube support to enable it. Newest first. Filter by `reportId`, `ownerUserId` or `spreadsheet`. Admins see every delivery; others only their own.
+         */
+        get: operations["ReportDeliveriesPublicController.getReportDeliveries"];
+        put?: never;
+        /**
+         * Create a report delivery
+         * @description In preview: ask Cube support to enable it. Writes a report’s results into a Google Sheets tab from `destination.anchorCell`. The caller owns it: their Google account writes, with their data access. Needs read access to the report.
+         */
+        post: operations["ReportDeliveriesPublicController.createReportDelivery"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/report-deliveries/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a report delivery
+         * @description In preview: ask Cube support to enable it. `404` if the caller cannot see it. Admins see every delivery; others only their own.
+         */
+        get: operations["ReportDeliveriesPublicController.getReportDelivery"];
+        /**
+         * Update a report delivery
+         * @description In preview: ask Cube support to enable it. Omitted fields stay unchanged; `destination` and `schedule` are replaced whole, and `schedule: null` removes it. A new `reportId` needs read access to that report.
+         */
+        put: operations["ReportDeliveriesPublicController.updateReportDelivery"];
+        post?: never;
+        /**
+         * Delete a report delivery
+         * @description In preview: ask Cube support to enable it. Also deletes its run history. Cells it already wrote stay in the spreadsheet.
+         */
+        delete: operations["ReportDeliveriesPublicController.deleteReportDelivery"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Run a report delivery now
+         * @description In preview: ask Cube support to enable it. Starts a run in the background and returns its id. The run writes the report’s current results into the destination, whether or not the delivery is paused. `409` while another run of it is still going.
+         */
+        post: operations["ReportDeliveriesPublicController.startReportDeliveryRun"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/deployments/{deploymentId}/report-folders": {
         parameters: {
             query?: never;
@@ -1365,6 +1437,126 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Pull Snowflake Semantic Views into Cube
+         * @description Pulls Snowflake Semantic Views into a Cube branch and returns a job ID to poll. Generated files are committed to the branch. Requires an API key or OAuth deployment.write token, SQL runner access, and preview enablement.
+         */
+        post: operations["SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPull"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls/{syncJobId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Snowflake Semantic View pull status
+         * @description Poll the syncJobId returned by the pull start request. COMPLETED and FAILED are terminal; a 404 means the job is not visible to this deployment.
+         */
+        get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullStatus"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls/{syncJobId}/result": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the result of a completed Snowflake Semantic View pull
+         * @description Returns the generated file paths committed to the Cube branch, view count, and duration. Poll status first; this endpoint returns 404 until the pull completes.
+         */
+        get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullResult"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Push Cube views to Snowflake Semantic Views
+         * @description Queues a push of selected Cube views to Snowflake and returns a syncJobId for polling. Requires an API key or OAuth deployment.write token, Semantic View sync, SQL DDL access, and preview enablement.
+         */
+        post: operations["SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPush"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs/{syncJobId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Snowflake Semantic View push status
+         * @description Poll the syncJobId returned by the push start request. COMPLETED and FAILED are terminal; a 404 means the job is not visible to this deployment.
+         */
+        get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushStatus"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs/{syncJobId}/result": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the result of a completed Snowflake Semantic View push
+         * @description Returns the number of Snowflake Semantic Views published and the duration. Poll status first; this endpoint returns 404 until the push completes.
+         */
+        get: operations["SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushResult"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/deployments/{deploymentId}/token": {
         parameters: {
             query?: never;
@@ -1658,7 +1850,10 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Publish dashboard */
+        /**
+         * Publish a dashboard
+         * @description Publishes the saved dashboard draft when config is omitted. Save layout or app changes to the workbook draft before publishing; the request only needs workbookId. An explicit config remains supported for existing clients.
+         */
         post: operations["WorkbooksPublicController.publishDashboard"];
         delete?: never;
         options?: never;
@@ -3771,6 +3966,14 @@ export interface components {
             subFormat?: string | null;
             targetEnvVar?: string | null;
         };
+        CreateReportDeliveryInput: {
+            destination: components["schemas"]["ReportDeliveryDestinationInput"];
+            name: string;
+            /** @description Id of the report whose results are delivered. It must belong to this deployment, and the caller must be able to read it. */
+            reportId: number;
+            schedule?: components["schemas"]["ReportDeliveryScheduleInput"] | null;
+            shape?: components["schemas"]["ReportDeliveryShapeInput"] | null;
+        };
         CreateReportInput: {
             endResultCell?: string | null;
             externalWorkbookId?: string | null;
@@ -5359,6 +5562,7 @@ export interface components {
         };
         PythonAnalysisFilteredRun: {
             at: string;
+            dataRefreshedAt?: string | null;
             executionError?: string | null;
             inputRowCount: number;
             outputData?: any | null;
@@ -5517,6 +5721,68 @@ export interface components {
             version?: number | null;
             workbookId?: number | null;
         };
+        ReportDeliveriesListResponse: {
+            items: components["schemas"]["ReportDeliveryResponse"][];
+            pageInfo?: components["schemas"]["PageInfo"] | null;
+        };
+        ReportDeliveryColumn: {
+            column?: string | null;
+            header?: string | null;
+            placeholder?: boolean | null;
+        };
+        ReportDeliveryColumnInput: {
+            column?: string | null;
+            header?: string | null;
+            placeholder?: components["schemas"]["ReportDeliveryColumnInputPlaceholder"] | null;
+        };
+        /** @enum {boolean} */
+        ReportDeliveryColumnInputPlaceholder: true;
+        ReportDeliveryDestination: {
+            /** @description Top-left cell of the delivered block, in A1 notation. */
+            anchorCell: string;
+            sheetId?: number | null;
+            sheetName?: string | null;
+            spreadsheetId: string;
+        };
+        ReportDeliveryDestinationInput: {
+            anchorCell?: string | null;
+            sheetId?: number | null;
+            sheetName?: string | null;
+            /** @description The Google Sheets spreadsheet: its URL or its id. */
+            spreadsheet: string;
+        };
+        ReportDeliveryResponse: {
+            deploymentId: number;
+            destination: components["schemas"]["ReportDeliveryDestination"];
+            id: number;
+            name: string;
+            nextRunAt?: any | null;
+            ownerUserId?: number | null;
+            pausedAt?: any | null;
+            reportId?: number | null;
+            runAsUserId?: number | null;
+            schedule?: components["schemas"]["ReportDeliverySchedule"] | null;
+            shape?: components["schemas"]["ReportDeliveryShape"] | null;
+            status: components["schemas"]["ReportDeliveryResponseStatus"];
+        };
+        /** @enum {string} */
+        ReportDeliveryResponseStatus: "active" | "failing" | "needs_reconnect" | "orphaned";
+        ReportDeliverySchedule: {
+            cronExpressions: string[];
+            timezone: string;
+        };
+        ReportDeliveryScheduleInput: {
+            /** @description Five-field cron expressions; the delivery runs whenever any matches. The minute field must be a single number (at most one run an hour): `0 9,13,17 * * 1-5` is 09:00, 13:00 and 17:00 on weekdays. */
+            cronExpressions: string[];
+            timezone?: string | null;
+        };
+        ReportDeliveryShape: {
+            columns: components["schemas"]["ReportDeliveryColumn"][];
+        };
+        ReportDeliveryShapeInput: {
+            /** @description The delivered columns, left to right. A column the query stops returning fails the run rather than shifting the ones after it. */
+            columns: components["schemas"]["ReportDeliveryColumnInput"][];
+        };
         /** @enum {string} */
         ReportDtoSource: "GOOGLE_SHEETS" | "EXCEL" | "PLAYGROUND" | "D3";
         /** @enum {string} */
@@ -5734,6 +6000,41 @@ export interface components {
             showAppliedFilters?: boolean | null;
             suppressDuplicateValues?: boolean | null;
         };
+        SnowflakeSemanticViewGeneratedFileResponse: {
+            hash?: string | null;
+            path: string;
+        };
+        SnowflakeSemanticViewPullResultResponse: {
+            completedAt: string;
+            durationMs: number;
+            generatedFiles: components["schemas"]["SnowflakeSemanticViewGeneratedFileResponse"][];
+            syncJobId: string;
+            viewCount: number;
+        };
+        SnowflakeSemanticViewPushResultResponse: {
+            completedAt: string;
+            durationMs: number;
+            syncJobId: string;
+            viewCount: number;
+        };
+        SnowflakeSemanticViewSyncProgressResponse: {
+            message?: string | null;
+            percentComplete: number;
+            stage: string;
+        };
+        SnowflakeSemanticViewSyncStartResponse: {
+            /** Format: uuid */
+            syncJobId: string;
+            workflowId: string;
+        };
+        SnowflakeSemanticViewSyncStatusResponse: {
+            error?: string | null;
+            progress: components["schemas"]["SnowflakeSemanticViewSyncProgressResponse"];
+            /** @description COMPLETED and FAILED are terminal. Treat other values as in progress. */
+            status: string;
+            syncJobId: string;
+            updatedAt: string;
+        };
         SourceTreeResponse: {
             /**
              * @deprecated
@@ -5784,6 +6085,30 @@ export interface components {
             branchName: string;
             questionFile?: string | null;
         };
+        StartReportDeliveryRunResponse: {
+            /** @description Id of the run, which writes the sheet in the background. */
+            runId: number;
+        };
+        StartSnowflakeSemanticViewPullInput: {
+            branchName?: string | null;
+            commitMessage?: string | null;
+            dataSource?: string | null;
+            idempotencyKey?: string | null;
+            namePrefix?: string | null;
+            outputPath: string;
+            schema: string;
+            titlePrefix?: string | null;
+            viewNames?: string[] | null;
+        };
+        StartSnowflakeSemanticViewSyncInput: {
+            branchName?: string | null;
+            dataSource?: string | null;
+            idempotencyKey?: string | null;
+            prefix: string;
+            schema: string;
+            schemaPath?: string | null;
+            viewNames: string[];
+        };
         StartUploadResponse: {
             deploymentName: string;
             transaction: components["schemas"]["UploadTransaction"];
@@ -5937,6 +6262,13 @@ export interface components {
             threadId: string;
             widgetId: string;
         };
+        UpdateReportDeliveryInput: {
+            destination?: components["schemas"]["ReportDeliveryDestinationInput"] | null;
+            name?: string | null;
+            reportId?: number | null;
+            schedule?: components["schemas"]["ReportDeliveryScheduleInput"] | null;
+            shape?: components["schemas"]["ReportDeliveryShapeInput"] | null;
+        };
         UpdateReportInput: {
             endResultCell?: string | null;
             externalWorkbookId?: string | null;
@@ -8229,6 +8561,170 @@ export interface operations {
             };
         };
     };
+    "ReportDeliveriesPublicController.getReportDeliveries": {
+        parameters: {
+            query?: {
+                reportId?: number | null;
+                ownerUserId?: number | null;
+                spreadsheet?: string | null;
+                after?: string;
+                first?: number;
+            };
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the delivery. */
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReportDeliveriesListResponse"];
+                };
+            };
+        };
+    };
+    "ReportDeliveriesPublicController.createReportDelivery": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the delivery. */
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        /** @description CreateReportDeliveryInput */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["CreateReportDeliveryInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReportDeliveryResponse"];
+                };
+            };
+        };
+    };
+    "ReportDeliveriesPublicController.getReportDelivery": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the delivery. */
+                deploymentId: number;
+                /** @description Numeric id of the report delivery. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReportDeliveryResponse"];
+                };
+            };
+        };
+    };
+    "ReportDeliveriesPublicController.updateReportDelivery": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the delivery. */
+                deploymentId: number;
+                /** @description Numeric id of the report delivery. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        /** @description UpdateReportDeliveryInput */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdateReportDeliveryInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReportDeliveryResponse"];
+                };
+            };
+        };
+    };
+    "ReportDeliveriesPublicController.deleteReportDelivery": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the delivery. */
+                deploymentId: number;
+                /** @description Numeric id of the report delivery. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": any;
+                };
+            };
+            /** @description Report delivery deleted. */
+            204: {
+                headers: {
+                    [name: string]: any;
+                };
+                content?: never;
+            };
+        };
+    };
+    "ReportDeliveriesPublicController.startReportDeliveryRun": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the delivery. */
+                deploymentId: number;
+                /** @description Numeric id of the report delivery. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["StartReportDeliveryRunResponse"];
+                };
+            };
+        };
+    };
     "ReportsPublicController.getReportFolders": {
         parameters: {
             query?: {
@@ -8710,6 +9206,146 @@ export interface operations {
             };
         };
     };
+    "SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPull": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        /** @description StartSnowflakeSemanticViewPullInput */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StartSnowflakeSemanticViewPullInput"];
+            };
+        };
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnowflakeSemanticViewSyncStartResponse"];
+                };
+            };
+        };
+    };
+    "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullStatus": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                syncJobId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnowflakeSemanticViewSyncStatusResponse"];
+                };
+            };
+        };
+    };
+    "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPullResult": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                syncJobId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnowflakeSemanticViewPullResultResponse"];
+                };
+            };
+        };
+    };
+    "SnowflakeSemanticViewSyncPublicController.startSnowflakeSemanticViewPush": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        /** @description StartSnowflakeSemanticViewSyncInput */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StartSnowflakeSemanticViewSyncInput"];
+            };
+        };
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnowflakeSemanticViewSyncStartResponse"];
+                };
+            };
+        };
+    };
+    "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushStatus": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                syncJobId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnowflakeSemanticViewSyncStatusResponse"];
+                };
+            };
+        };
+    };
+    "SnowflakeSemanticViewSyncPublicController.getSnowflakeSemanticViewPushResult": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                syncJobId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnowflakeSemanticViewPushResultResponse"];
+                };
+            };
+        };
+    };
     "DeploymentsPublicController.deploymentToken": {
         parameters: {
             query?: never;