@keboola/api-client 0.1.0

package/dist/types-CGMJT3JL.d.ts

@@ -0,0 +1,943 @@
+import { d as OpenapiPathType, b as OpenapiBodyType, c as OpenapiQueryType, a as OpenapiReturnType } from './types-C7mpAfq-.js';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+type paths = {
+  '/': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Service index
+     * @description Get basic service information and API documentation link
+     */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['handlers.IndexResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get query history
+     * @description Retrieve the history of query statements for the specified branch and workspace
+     */
+    get: {
+      parameters: {
+        query?: {
+          /** @description Get results after this statement ID for pagination */
+          afterId?: string;
+          /** @description Number of results per page (default: 500) */
+          pageSize?: number;
+        };
+        header?: never;
+        path: {
+          /**
+           * @description Branch ID
+           * @example main
+           */
+          branchId: string;
+          /**
+           * @description Workspace ID
+           * @example workspace-123
+           */
+          workspaceId: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['handlers.QueryHistoryResponse'];
+          };
+        };
+        /** @description Bad request - invalid parameters */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Unauthorized - project scope not found */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Internal server error */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    /**
+     * Submit query job
+     * @description Create a new query job with SQL statements in the specified branch and workspace
+     */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /**
+           * @description Branch ID
+           * @example main
+           */
+          branchId: string;
+          /**
+           * @description Workspace ID
+           * @example workspace-123
+           */
+          workspaceId: string;
+        };
+        cookie?: never;
+      };
+      /** @description Query job request */
+      requestBody: {
+        content: {
+          'application/json': components['schemas']['handlers.SubmitQueryJobRequest'];
+        };
+      };
+      responses: {
+        /** @description Created */
+        201: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['handlers.SubmitJobResponse'];
+          };
+        };
+        /** @description Bad request - invalid request body, missing parameters, or blocked SQL statement */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Unauthorized - project scope not found */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Internal server error */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/documentation': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * API Documentation
+     * @description Interactive API documentation with Swagger UI
+     */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description HTML page with Swagger UI */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'text/html': string;
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/queries/{queryJobId}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get job status
+     * @description Retrieve the current status and statements of a query job by its ID
+     */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /**
+           * @description Query job ID
+           * @example job-12345
+           */
+          queryJobId: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['handlers.JobStatusResponse'];
+          };
+        };
+        /** @description Bad request - queryJobId is required */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Internal server error */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/queries/{queryJobId}/cancel': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Cancel job
+     * @description Cancel a running query job by its ID. The job will be marked for cancellation and stopped as soon as possible.
+     */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /**
+           * @description Query job ID
+           * @example job-12345
+           */
+          queryJobId: string;
+        };
+        cookie?: never;
+      };
+      /** @description Cancellation request */
+      requestBody: {
+        content: {
+          'application/json': components['schemas']['handlers.CancelQueryJobRequest'];
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['handlers.CancelQueryJobResponse'];
+          };
+        };
+        /** @description Bad request - invalid request body, missing queryJobId, or job already in terminal state */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Unauthorized - project scope not found */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Not found - job not found */
+        404: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Internal server error */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/queries/{queryJobId}/{statementId}/export': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Export job results as CSV or Parquet
+     * @description Export the results of a specific statement within a query job as a downloadable file (CSV or Parquet). Creates a temporary table from query results, exports it to Storage API, and returns the content to the client.
+     */
+    get: {
+      parameters: {
+        query: {
+          /** @description Export format: csv or parquet */
+          fileType: 'csv' | 'parquet';
+          /** @description Enable gzip compression for the exported file */
+          gzip?: boolean;
+        };
+        header?: never;
+        path: {
+          /**
+           * @description Query job ID
+           * @example job-12345
+           */
+          queryJobId: string;
+          /**
+           * @description Statement ID
+           * @example stmt-67890
+           */
+          statementId: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description File download (CSV or Parquet) */
+        200: {
+          headers: {
+            /** @description attachment; filename=\"export_{timestamp}.{format}\ */
+            'Content-Disposition'?: string;
+            /** @description text/csv or application/x-parquet */
+            'Content-Type'?: string;
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-parquet': string;
+            'text/csv': string;
+          };
+        };
+        /** @description Bad request - invalid format, queryJobId or statementId is required, or statement not completed */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-parquet': components['schemas']['httperrors.ErrorResponse'];
+            'text/csv': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Not found - job or statement not found */
+        404: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-parquet': components['schemas']['httperrors.ErrorResponse'];
+            'text/csv': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Payload Too Large - export exceeds maximum allowed size */
+        413: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-parquet': components['schemas']['httperrors.ErrorResponse'];
+            'text/csv': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Internal server error - failed to create table, export, or download file */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-parquet': components['schemas']['httperrors.ErrorResponse'];
+            'text/csv': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/queries/{queryJobId}/{statementId}/profile': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get statement profile
+     * @description Get the profile of a specific statement within a query job.
+     */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /**
+           * @description Query job ID
+           * @example 550e8400-e29b-41d4-a716-446655440000
+           */
+          queryJobId: string;
+          /**
+           * @description Statement ID
+           * @example 6ba7b810-9dad-11d1-80b4-00c04fd430c8
+           */
+          statementId: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['handlers.Profile'];
+          };
+        };
+        /** @description Internal Server Error */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/queries/{queryJobId}/{statementId}/results': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get job results
+     * @description Retrieve the results of a specific statement within a query job. Returns data, rows affected count, and status information with pagination support.
+     */
+    get: {
+      parameters: {
+        query?: {
+          /**
+           * @description Offset for pagination
+           * @example 0
+           */
+          offset?: number;
+          /**
+           * @description Page size for pagination
+           * @example 500
+           */
+          pageSize?: number;
+        };
+        header?: never;
+        path: {
+          /**
+           * @description Query job ID
+           * @example job-12345
+           */
+          queryJobId: string;
+          /**
+           * @description Statement ID
+           * @example stmt-67890
+           */
+          statementId: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description Regular JSON response */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['handlers.ResultResponse'];
+          };
+        };
+        /** @description Bad request - queryJobId or statementId is required */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Not found - job or statement not found */
+        404: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Internal server error */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/api/v1/queries/{queryJobId}/{statementId}/results/stream': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Stream job results
+     * @description Stream the results of a specific statement within a query job using HTTP/2 chunked transfer encoding. Returns data as NDJSON format for efficient streaming of large result sets.
+     */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /**
+           * @description Query job ID
+           * @example job-12345
+           */
+          queryJobId: string;
+          /**
+           * @description Statement ID
+           * @example stmt-67890
+           */
+          statementId: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description Streaming NDJSON response */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-ndjson': string;
+          };
+        };
+        /** @description Bad request - queryJobId or statementId is required */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-ndjson': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Not found - job or statement not found */
+        404: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-ndjson': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Upgrade Required - HTTP/2 required for streaming */
+        426: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-ndjson': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+        /** @description Internal server error */
+        500: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/x-ndjson': components['schemas']['httperrors.ErrorResponse'];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/health-check': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Health check
+     * @description Get the health status of the service
+     */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': {
+              [key: string]: string;
+            };
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    'handlers.CancelQueryJobRequest': {
+      /** @example User requested cancellation */
+      reason?: string;
+    };
+    'handlers.CancelQueryJobResponse': {
+      /** @example job-12345 */
+      queryJobId: string;
+    };
+    'handlers.Column': {
+      length: number;
+      name: string;
+      nullable: boolean;
+      type: string;
+    };
+    'handlers.IndexResponse': {
+      /** @example http://localhost:8090/api/v1/documentation/swagger.json */
+      apiDocs: string;
+      /** @example query */
+      appName: string;
+      /** @example 1.0.0 */
+      appVersion: string;
+    };
+    'handlers.JobStatusResponse': {
+      /** @example user */
+      actorType: components['schemas']['models.ActorType'];
+      canceledAt?: string;
+      cancellationReason?: string;
+      changedAt: string;
+      createdAt: string;
+      expiration?: string;
+      /** @example job-12345 */
+      queryJobId: string;
+      statements: components['schemas']['handlers.Statement'][];
+      /** @example processing */
+      status: components['schemas']['models.JobState'];
+    };
+    'handlers.Operation': {
+      /** @description Breakdown of execution time for the operator, e.g., time spent in different phases of execution. */
+      executionTimeBreakdown: {
+        [key: string]: unknown;
+      };
+      /** @description Attributes of the operator, e.g., the number of rows returned by the operator. */
+      operatorAttributes: {
+        [key: string]: unknown;
+      };
+      operatorId?: number;
+      /** @description Statistics for the operator, e.g., number of rows processed, CPU time, etc. */
+      operatorStatistics: {
+        [key: string]: unknown;
+      };
+      /** @description Type of the operator, e.g., SELECT, INSERT, etc. */
+      operatorType: string;
+      /** @description IDs of the parent operators, e.g., the ID of the parent SELECT operator for a SELECT operator in a subquery. */
+      parentOperators: number[];
+      queryId: string;
+      stepId?: number;
+    };
+    'handlers.Profile': {
+      operations: components['schemas']['handlers.Operation'][];
+      queryId: string;
+    };
+    'handlers.QueryHistoryResponse': {
+      statements: components['schemas']['handlers.StatementWithWorkspaceInfo'][];
+    };
+    'handlers.ResultResponse': {
+      columns?: components['schemas']['handlers.Column'][];
+      data?: string[][];
+      /** @example 100 rows affected */
+      message?: string;
+      /** @example 100 */
+      numberOfRows?: number;
+      /** @example 100 */
+      rowsAffected?: number;
+      /** @example completed */
+      status: components['schemas']['models.StatementState'];
+    };
+    'handlers.Statement': {
+      completedAt?: string;
+      createdAt?: string;
+      error?: string;
+      executedAt?: string;
+      id: string;
+      numberOfRows?: number;
+      query: string;
+      queryId?: string;
+      rowsAffected?: number;
+      status: components['schemas']['models.StatementState'];
+    };
+    'handlers.StatementWithWorkspaceInfo': {
+      backendSize?: string;
+      completedAt?: string;
+      createdAt?: string;
+      error?: string;
+      executedAt?: string;
+      id: string;
+      numberOfRows?: number;
+      query: string;
+      queryId?: string;
+      queryJobId: string;
+      rowsAffected?: number;
+      status: components['schemas']['models.StatementState'];
+      warehouse?: string;
+    };
+    'handlers.SubmitJobResponse': {
+      /** @example job-12345 */
+      queryJobId: string;
+      /** @example 550e8400-e29b-41d4-a716-446655440000 */
+      sessionId?: string;
+    };
+    'handlers.SubmitQueryJobRequest': {
+      /** @example user */
+      actorType?: components['schemas']['models.ActorType'];
+      refreshMetadataOnSuccess?: boolean;
+      /** @example 550e8400-e29b-41d4-a716-446655440000 */
+      sessionId?: string;
+      /**
+       * @example [
+       *       "SELECT * FROM table1",
+       *       "INSERT INTO table2 SELECT * FROM table1"
+       *     ]
+       */
+      statements: string[];
+      /** @example 60s */
+      timeout?: string;
+      /** @example true */
+      transactional: boolean;
+    };
+    'httperrors.ErrorResponse': {
+      /** @description String representation of the status code */
+      code?: string;
+      /** @description Optional context information */
+      context?: {
+        [key: string]: unknown;
+      };
+      /** @description HTTP status code */
+      error?: number;
+      /** @description Error message */
+      exception?: string;
+      /** @description Unique error ID for tracking */
+      exceptionId?: string;
+      /** @description Always "error" */
+      status?: string;
+      /** @description Stack trace information if debug mode */
+      trace?: string[];
+    };
+    /** @enum {string} */
+    'models.ActorType': 'user' | 'system';
+    /** @enum {string} */
+    'models.JobState': 'created' | 'enqueued' | 'processing' | 'canceled' | 'completed' | 'failed';
+    /** @enum {string} */
+    'models.StatementState':
+      | 'waiting'
+      | 'processing'
+      | 'canceled'
+      | 'completed'
+      | 'failed'
+      | 'notExecuted';
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+
+type PostQueryPath = OpenapiPathType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['post']>;
+type GetQueriesPath = OpenapiPathType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>;
+type GetQueriesHistoryQuery = OpenapiQueryType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>;
+type PostQueryBody = OpenapiBodyType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['post']>;
+type GetQueryJobPath = OpenapiPathType<paths['/api/v1/queries/{queryJobId}']['get']>;
+type PostCancelQueryJobPath = OpenapiPathType<paths['/api/v1/queries/{queryJobId}/cancel']['post']>;
+type GetQueryResultsPath = OpenapiPathType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
+type GetQueryResutsQuery = OpenapiQueryType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
+type JobStatusResponse = OpenapiReturnType<paths['/api/v1/queries/{queryJobId}']['get']>;
+type Statements = OpenapiReturnType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>['statements'];
+type GetExportResultsQuery = OpenapiQueryType<paths['/api/v1/queries/{queryJobId}/{statementId}/export']['get']>;
+type ExportResultsResponse = {
+    content: string;
+    fileName: string;
+    mimeType: string;
+};
+
+export type { ExportResultsResponse as E, GetQueryJobPath as G, JobStatusResponse as J, PostQueryPath as P, Statements as S, PostQueryBody as a, PostCancelQueryJobPath as b, components as c, GetQueryResultsPath as d, GetQueryResutsQuery as e, GetQueriesPath as f, GetQueriesHistoryQuery as g, GetExportResultsQuery as h };