@cosmotech/api-ts 3.0.13-dev → 3.0.15-dev

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 3.0.13-dev
+ * The version of the OpenAPI document: 3.0.16-SNAPSHOT
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -259,6 +259,12 @@ export interface Dataset {
      * @memberof Dataset
      */
     'ownerId'?: string;
+    /**
+     * the name of the owner
+     * @type {string}
+     * @memberof Dataset
+     */
+    'ownerName'?: string;
     /**
      * the Organization Id related to this Dataset
      * @type {string}
@@ -308,11 +314,17 @@ export interface Dataset {
      */
     'source'?: SourceInfo;
     /**
-     * the Dataset status
+     * the Dataset ingestion status
      * @type {string}
      * @memberof Dataset
      */
-    'status'?: DatasetStatusEnum;
+    'ingestionStatus'?: DatasetIngestionStatusEnum;
+    /**
+     * the twincache data status
+     * @type {string}
+     * @memberof Dataset
+     */
+    'twincacheStatus'?: DatasetTwincacheStatusEnum;
     /**
      * the list of queries
      * @type {Array<string>}
@@ -356,13 +368,18 @@ export interface Dataset {
      */
     'security'?: DatasetSecurity;
 }
-export declare const DatasetStatusEnum: {
-    readonly Draft: "DRAFT";
+export declare const DatasetIngestionStatusEnum: {
+    readonly None: "NONE";
     readonly Pending: "PENDING";
     readonly Error: "ERROR";
-    readonly Ready: "READY";
+    readonly Success: "SUCCESS";
+};
+export declare type DatasetIngestionStatusEnum = typeof DatasetIngestionStatusEnum[keyof typeof DatasetIngestionStatusEnum];
+export declare const DatasetTwincacheStatusEnum: {
+    readonly Empty: "EMPTY";
+    readonly Full: "FULL";
 };
-export declare type DatasetStatusEnum = typeof DatasetStatusEnum[keyof typeof DatasetStatusEnum];
+export declare type DatasetTwincacheStatusEnum = typeof DatasetTwincacheStatusEnum[keyof typeof DatasetTwincacheStatusEnum];
 /**
  * a Dataset access control item
  * @export
@@ -601,6 +618,44 @@ export interface DeleteHistoricalData {
      */
     'timeOut'?: number;
 }
+/**
+ *
+ * @export
+ * @interface FileUploadMetadata
+ */
+export interface FileUploadMetadata {
+    /**
+     *
+     * @type {string}
+     * @memberof FileUploadMetadata
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof FileUploadMetadata
+     */
+    'size'?: number;
+}
+/**
+ * files read on upload
+ * @export
+ * @interface FileUploadValidation
+ */
+export interface FileUploadValidation {
+    /**
+     * list of filename found on nodes folder
+     * @type {Array<FileUploadMetadata>}
+     * @memberof FileUploadValidation
+     */
+    'nodes'?: Array<FileUploadMetadata>;
+    /**
+     * list of filename found on edges folder
+     * @type {Array<FileUploadMetadata>}
+     * @memberof FileUploadValidation
+     */
+    'edges'?: Array<FileUploadMetadata>;
+}
 /**
  *
  * @export
@@ -827,8 +882,17 @@ export interface RunTemplate {
      * the Run Template name
      * @type {string}
      * @memberof RunTemplate
+     * @deprecated
      */
     'name'?: string;
+    /**
+     * a translated label with key as ISO 639-1 code
+     * @type {{ [key: string]: string; }}
+     * @memberof RunTemplate
+     */
+    'labels'?: {
+        [key: string]: string;
+    };
     /**
      * the Run Template description
      * @type {string}
@@ -3190,7 +3254,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
      */
     getDatasetSecurityUsers: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get the status of the import workflow lauch on the dataset\'s refresh.
+     * Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
      * @summary Get the dataset\'s refresh job status
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the dataset identifier
@@ -3210,7 +3274,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
      */
     getTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Lauch a import from source (ADT or Azure Storage). This replace currently stored data with just extracted data from source.
+     * Refresh dataset from parent source. At date, sources can be:      dataset (refresh from another dataset)      Azure Digital twin       Azure storage      Local File (import a new file)  During refresh, datas are overwritten
      * @summary Refresh data on dataset from dataset\'s source
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
@@ -3237,6 +3301,15 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     removeDatasetAccessControl: (organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Rollback the twingraph on a dataset after a failed refresh
+     * @summary Rollback the dataset after a failed refresh
+     * @param {string} organizationId the Organization identifier
+     * @param {string} datasetId the Dataset identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rollbackRefresh: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Search Datasets by tags
@@ -3294,7 +3367,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
      * @summary Update a dataset
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
-     * @param {Dataset} dataset the new Dataset details.
+     * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -3473,7 +3546,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
      */
     getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
     /**
-     * Get the status of the import workflow lauch on the dataset\'s refresh.
+     * Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
      * @summary Get the dataset\'s refresh job status
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the dataset identifier
@@ -3493,7 +3566,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
      */
     getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
-     * Lauch a import from source (ADT or Azure Storage). This replace currently stored data with just extracted data from source.
+     * Refresh dataset from parent source. At date, sources can be:      dataset (refresh from another dataset)      Azure Digital twin       Azure storage      Local File (import a new file)  During refresh, datas are overwritten
      * @summary Refresh data on dataset from dataset\'s source
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
@@ -3520,6 +3593,15 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Rollback the twingraph on a dataset after a failed refresh
+     * @summary Rollback the dataset after a failed refresh
+     * @param {string} organizationId the Organization identifier
+     * @param {string} datasetId the Dataset identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rollbackRefresh(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
      *
      * @summary Search Datasets by tags
@@ -3577,7 +3659,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
      * @summary Update a dataset
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
-     * @param {Dataset} dataset the new Dataset details.
+     * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -3613,7 +3695,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileUploadValidation>>;
 };
 /**
  * DatasetApi - factory interface
@@ -3756,7 +3838,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
      */
     getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: any): AxiosPromise<Array<string>>;
     /**
-     * Get the status of the import workflow lauch on the dataset\'s refresh.
+     * Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
      * @summary Get the dataset\'s refresh job status
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the dataset identifier
@@ -3776,7 +3858,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
      */
     getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
     /**
-     * Lauch a import from source (ADT or Azure Storage). This replace currently stored data with just extracted data from source.
+     * Refresh dataset from parent source. At date, sources can be:      dataset (refresh from another dataset)      Azure Digital twin       Azure storage      Local File (import a new file)  During refresh, datas are overwritten
      * @summary Refresh data on dataset from dataset\'s source
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
@@ -3803,6 +3885,15 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<void>;
+    /**
+     * Rollback the twingraph on a dataset after a failed refresh
+     * @summary Rollback the dataset after a failed refresh
+     * @param {string} organizationId the Organization identifier
+     * @param {string} datasetId the Dataset identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rollbackRefresh(organizationId: string, datasetId: string, options?: any): AxiosPromise<string>;
     /**
      *
      * @summary Search Datasets by tags
@@ -3860,7 +3951,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
      * @summary Update a dataset
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
-     * @param {Dataset} dataset the new Dataset details.
+     * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -3896,7 +3987,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: any): AxiosPromise<void>;
+    uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: any): AxiosPromise<FileUploadValidation>;
 };
 /**
  * DatasetApi - object-oriented interface
@@ -4055,7 +4146,7 @@ export declare class DatasetApi extends BaseAPI {
      */
     getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
     /**
-     * Get the status of the import workflow lauch on the dataset\'s refresh.
+     * Get the status of the import workflow lauch on the dataset\'s refresh. This endpoint needs to be called to update a dataset IngestionStatus or TwincacheStatus
      * @summary Get the dataset\'s refresh job status
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the dataset identifier
@@ -4077,7 +4168,7 @@ export declare class DatasetApi extends BaseAPI {
      */
     getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
     /**
-     * Lauch a import from source (ADT or Azure Storage). This replace currently stored data with just extracted data from source.
+     * Refresh dataset from parent source. At date, sources can be:      dataset (refresh from another dataset)      Azure Digital twin       Azure storage      Local File (import a new file)  During refresh, datas are overwritten
      * @summary Refresh data on dataset from dataset\'s source
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
@@ -4107,6 +4198,16 @@ export declare class DatasetApi extends BaseAPI {
      * @memberof DatasetApi
      */
     removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
+    /**
+     * Rollback the twingraph on a dataset after a failed refresh
+     * @summary Rollback the dataset after a failed refresh
+     * @param {string} organizationId the Organization identifier
+     * @param {string} datasetId the Dataset identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetApi
+     */
+    rollbackRefresh(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
     /**
      *
      * @summary Search Datasets by tags
@@ -4169,7 +4270,7 @@ export declare class DatasetApi extends BaseAPI {
      * @summary Update a dataset
      * @param {string} organizationId the Organization identifier
      * @param {string} datasetId the Dataset identifier
-     * @param {Dataset} dataset the new Dataset details.
+     * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DatasetApi
@@ -4209,7 +4310,7 @@ export declare class DatasetApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DatasetApi
      */
-    uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
+    uploadTwingraph(organizationId: string, datasetId: string, body: any, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileUploadValidation>>;
 }
 /**
  * OrganizationApi - axios parameter creator
@@ -4321,7 +4422,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
      *
      * @summary Update an Organization
      * @param {string} organizationId the Organization identifier
-     * @param {Organization} organization the new Organization details
+     * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -4476,7 +4577,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
      *
      * @summary Update an Organization
      * @param {string} organizationId the Organization identifier
-     * @param {Organization} organization the new Organization details
+     * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -4633,7 +4734,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
      *
      * @summary Update an Organization
      * @param {string} organizationId the Organization identifier
-     * @param {Organization} organization the new Organization details
+     * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -4804,7 +4905,7 @@ export declare class OrganizationApi extends BaseAPI {
      *
      * @summary Update an Organization
      * @param {string} organizationId the Organization identifier
-     * @param {Organization} organization the new Organization details
+     * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrganizationApi
@@ -5076,7 +5177,7 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} scenarioId the Scenario identifier
-     * @param {Scenario} scenario the new Scenario details.
+     * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -5314,7 +5415,7 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} scenarioId the Scenario identifier
-     * @param {Scenario} scenario the new Scenario details.
+     * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -5552,7 +5653,7 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} scenarioId the Scenario identifier
-     * @param {Scenario} scenario the new Scenario details.
+     * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -5760,7 +5861,7 @@ export declare class ScenarioApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ScenarioApi
      */
-    getScenarioValidationStatusById(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<"Draft" | "Unknown" | "Rejected" | "Validated">>;
+    getScenarioValidationStatusById(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<"Unknown" | "Draft" | "Rejected" | "Validated">>;
     /**
      *
      * @summary Get the Scenarios Tree
@@ -5812,7 +5913,7 @@ export declare class ScenarioApi extends BaseAPI {
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
      * @param {string} scenarioId the Scenario identifier
-     * @param {Scenario} scenario the new Scenario details.
+     * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ScenarioApi
@@ -6739,7 +6840,7 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
      * @summary Update a solution
      * @param {string} organizationId the Organization identifier
      * @param {string} solutionId the Solution identifier
-     * @param {Solution} solution the new Solution details.
+     * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -6963,7 +7064,7 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
      * @summary Update a solution
      * @param {string} organizationId the Organization identifier
      * @param {string} solutionId the Solution identifier
-     * @param {Solution} solution the new Solution details.
+     * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -7187,7 +7288,7 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
      * @summary Update a solution
      * @param {string} organizationId the Organization identifier
      * @param {string} solutionId the Solution identifier
-     * @param {Solution} solution the new Solution details.
+     * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -7431,7 +7532,7 @@ export declare class SolutionApi extends BaseAPI {
      * @summary Update a solution
      * @param {string} organizationId the Organization identifier
      * @param {string} solutionId the Solution identifier
-     * @param {Solution} solution the new Solution details.
+     * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SolutionApi
@@ -8670,7 +8771,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
      * @summary Update a workspace
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
-     * @param {Workspace} workspace The new Workspace details.
+     * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -8862,7 +8963,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
      * @summary Update a workspace
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
-     * @param {Workspace} workspace The new Workspace details.
+     * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -9054,7 +9155,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
      * @summary Update a workspace
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
-     * @param {Workspace} workspace The new Workspace details.
+     * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -9264,7 +9365,7 @@ export declare class WorkspaceApi extends BaseAPI {
      * @summary Update a workspace
      * @param {string} organizationId the Organization identifier
      * @param {string} workspaceId the Workspace identifier
-     * @param {Workspace} workspace The new Workspace details.
+     * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkspaceApi