@cosmotech/api-ts 5.0.0-beta5 → 5.0.0-beta6

package/common.ts

@@ -4,7 +4,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.1-SNAPSHOT
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.1-SNAPSHOT
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 5.0.1-SNAPSHOT
+ * The version of the OpenAPI document: 5.0.0-beta6
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -700,21 +700,6 @@ export interface OrganizationUpdateRequest {
      */
     'name'?: string;
 }
-/**
- * the result of a SQL Query
- * @export
- * @interface QueryResult
- */
-export interface QueryResult {
-    /**
-     * the list of results
-     * @type {Array<{ [key: string]: any; }>}
-     * @memberof QueryResult
-     */
-    'result'?: Array<{
-        [key: string]: any;
-    }>;
-}
 /**
  * define cpus and memory needs
  * @export
@@ -926,46 +911,6 @@ export interface RunContainer {
      */
     'runSizing'?: ContainerResourceSizing;
 }
-/**
- * Run Data stored
- * @export
- * @interface RunData
- */
-export interface RunData {
-    /**
-     * Database name
-     * @type {string}
-     * @memberof RunData
-     */
-    'database_name'?: string;
-    /**
-     * Table name
-     * @type {string}
-     * @memberof RunData
-     */
-    'table_name'?: string;
-    /**
-     *
-     * @type {Array<{ [key: string]: any; }>}
-     * @memberof RunData
-     */
-    'data'?: Array<{
-        [key: string]: any;
-    }>;
-}
-/**
- * a data result query in SQL
- * @export
- * @interface RunDataQuery
- */
-export interface RunDataQuery {
-    /**
-     * the query in SQL
-     * @type {string}
-     * @memberof RunDataQuery
-     */
-    'query': string;
-}
 /**
  *
  * @export
@@ -2204,27 +2149,6 @@ export declare const RunnerValidationStatus: {
     readonly Validated: "Validated";
 };
 export type RunnerValidationStatus = typeof RunnerValidationStatus[keyof typeof RunnerValidationStatus];
-/**
- * Run Data to send
- * @export
- * @interface SendRunDataRequest
- */
-export interface SendRunDataRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof SendRunDataRequest
-     */
-    'id': string;
-    /**
-     *
-     * @type {Array<{ [key: string]: any; }>}
-     * @memberof SendRunDataRequest
-     */
-    'data': Array<{
-        [key: string]: any;
-    }>;
-}
 /**
  * A version of a Solution
  * @export
@@ -3053,20 +2977,25 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
     listDatasets: (organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Get data of a Dataset
+     * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} datasetId the Dataset identifier
      * @param {string} datasetPartId the Dataset part identifier
-     * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like:  - id  - stock  - quantity  - ...
-     * @param {Array<string>} [sums] Property names to sum by
-     * @param {Array<string>} [counts] Property names to count by
+     * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like:  - id  - stock  - quantity  - ... If you want to select only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
      * @param {number} [offset] The query offset
      * @param {number} [limit] The query limit
+     * @param {Array<string>} [groupBys] Column names to group by
+     * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    queryData: (organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    queryData: (organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Replace existing dataset parts of a Dataset
@@ -3302,20 +3231,25 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
     listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
     /**
      *
-     * @summary Get data of a Dataset
+     * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} datasetId the Dataset identifier
      * @param {string} datasetPartId the Dataset part identifier
-     * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like:  - id  - stock  - quantity  - ...
-     * @param {Array<string>} [sums] Property names to sum by
-     * @param {Array<string>} [counts] Property names to count by
+     * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like:  - id  - stock  - quantity  - ... If you want to select only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
      * @param {number} [offset] The query offset
      * @param {number} [limit] The query limit
+     * @param {Array<string>} [groupBys] Column names to group by
+     * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<object>>>;
+    queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Replace existing dataset parts of a Dataset
@@ -3551,20 +3485,25 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
     listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Dataset>>;
     /**
      *
-     * @summary Get data of a Dataset
+     * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} datasetId the Dataset identifier
      * @param {string} datasetPartId the Dataset part identifier
-     * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like:  - id  - stock  - quantity  - ...
-     * @param {Array<string>} [sums] Property names to sum by
-     * @param {Array<string>} [counts] Property names to count by
+     * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like:  - id  - stock  - quantity  - ... If you want to select only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
      * @param {number} [offset] The query offset
      * @param {number} [limit] The query limit
+     * @param {Array<string>} [groupBys] Column names to group by
+     * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<object>>;
+    queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      *
      * @summary Replace existing dataset parts of a Dataset
@@ -3815,21 +3754,26 @@ export declare class DatasetApi extends BaseAPI {
     listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[], any, {}>>;
     /**
      *
-     * @summary Get data of a Dataset
+     * @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} datasetId the Dataset identifier
      * @param {string} datasetPartId the Dataset part identifier
-     * @param {Array<string>} [filters] Property names that should be part of the response data. You can specify a property name like:  - id  - stock  - quantity  - ...
-     * @param {Array<string>} [sums] Property names to sum by
-     * @param {Array<string>} [counts] Property names to count by
+     * @param {Array<string>} [selects] Column names that should be part of the response data. You can specify a column name like:  - id  - stock  - quantity  - ... If you want to select only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [sums] Column names to sum by. If you want to sum only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [avgs] Column names to average by. If you want to apply \&#39;average\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [counts] Column names to count by. If you want to count only distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [mins] Column names to min by. If you want to apply \&#39;min\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
+     * @param {Array<string>} [maxs] Column names to max by. If you want to apply \&#39;max\&#39; only on distinct columns, add a \&#39;*\&#39; at the end of the column name (e.g. stock*).
      * @param {number} [offset] The query offset
      * @param {number} [limit] The query limit
+     * @param {Array<string>} [groupBys] Column names to group by
+     * @param {Array<string>} [orderBys] Column names to order by. Default order is ascending. If you want to specify \&#39;descending\&#39; order, add a \&#39;!\&#39; at the beginning of the column name (e.g. !stock).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DatasetApi
      */
-    queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, filters?: Array<string>, sums?: Array<string>, counts?: Array<string>, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object[], any, {}>>;
+    queryData(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, selects?: Array<string>, sums?: Array<string>, avgs?: Array<string>, counts?: Array<string>, mins?: Array<string>, maxs?: Array<string>, offset?: number, limit?: number, groupBys?: Array<string>, orderBys?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
     /**
      *
      * @summary Replace existing dataset parts of a Dataset
@@ -4559,30 +4503,6 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     listRuns: (organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary query the run data
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {RunDataQuery} runDataQuery the query to run
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    queryRunData: (organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Send data associated to a run
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    sendRunData: (organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * RunApi - functional programming interface
@@ -4645,30 +4565,6 @@ export declare const RunApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listRuns(organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Run>>>;
-    /**
-     *
-     * @summary query the run data
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {RunDataQuery} runDataQuery the query to run
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    queryRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>>;
-    /**
-     *
-     * @summary Send data associated to a run
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    sendRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunData>>;
 };
 /**
  * RunApi - factory interface
@@ -4731,30 +4627,6 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
      * @throws {RequiredError}
      */
     listRuns(organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Run>>;
-    /**
-     *
-     * @summary query the run data
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {RunDataQuery} runDataQuery the query to run
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    queryRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult>;
-    /**
-     *
-     * @summary Send data associated to a run
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    sendRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunData>;
 };
 /**
  * RunApi - object-oriented interface
@@ -4824,32 +4696,6 @@ export declare class RunApi extends BaseAPI {
      * @memberof RunApi
      */
     listRuns(organizationId: string, workspaceId: string, runnerId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Run[], any, {}>>;
-    /**
-     *
-     * @summary query the run data
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {RunDataQuery} runDataQuery the query to run
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof RunApi
-     */
-    queryRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, runDataQuery: RunDataQuery, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryResult, any, {}>>;
-    /**
-     *
-     * @summary Send data associated to a run
-     * @param {string} organizationId the Organization identifier
-     * @param {string} workspaceId the Workspace identifier
-     * @param {string} runnerId the Runner identifier
-     * @param {string} runId the Run identifier
-     * @param {SendRunDataRequest} sendRunDataRequest Custom data to register
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof RunApi
-     */
-    sendRunData(organizationId: string, workspaceId: string, runnerId: string, runId: string, sendRunDataRequest: SendRunDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunData, any, {}>>;
 }
 /**
  * RunnerApi - axios parameter creator