@cosmotech/api-ts 2.4.2 → 2.4.5-private

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Cosmo Tech Platform API
  * Cosmo Tech Platform API
  *
- * The version of the OpenAPI document: 2.4.2-dev
+ * The version of the OpenAPI document: 2.4.5-private
  * Contact: platform@cosmotech.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -6178,8 +6178,8 @@ export declare class SolutionApi extends BaseAPI {
  */
 export declare const TwingraphApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Launch a mass delete job
-     * @summary Launch a mass delete job
+     * Delete all versions of a graph and his metadatas
+     * @summary Delete all versions of a graph and his metadatas
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
      * @param {*} [options] Override http request option.
@@ -6212,14 +6212,14 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
      * @summary Create new entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to create
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createEntities: (organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Create a new graph
+     * To create a new graph from flat files,  you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes.  .zip hierarchy: *main_folder/Nodes *main_folder/Edges  In each folder you can place one or multiple csv files containing your Nodes or Edges data.  Your csv files must follow the following header (column name) requirements:  The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string  The Edges CSVs require three columns named, in order, * source * target * Id  those colomns represent * The source of the edge * The target of the edge * The Id of the edge  All following columns content are up to you.
      * @summary Create a new graph
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
@@ -6233,12 +6233,12 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
      * @summary Delete entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to delete
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteEntities: (organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    deleteEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Download a graph compressed in a zip file
      * @summary Download a graph compressed in a zip file
@@ -6261,12 +6261,12 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
      * @summary Get entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to get
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEntities: (organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Return the metaData of the specified graph
      * @summary Return the metaData of the specified graph
@@ -6309,12 +6309,12 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
      * @summary Update entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to update
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateEntities: (organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    updateEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update the metaData of the specified graph
      * @summary Update the metaData of the specified graph
@@ -6334,8 +6334,8 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
  */
 export declare const TwingraphApiFp: (configuration?: Configuration) => {
     /**
-     * Launch a mass delete job
-     * @summary Launch a mass delete job
+     * Delete all versions of a graph and his metadatas
+     * @summary Delete all versions of a graph and his metadatas
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
      * @param {*} [options] Override http request option.
@@ -6368,14 +6368,14 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
      * @summary Create new entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to create
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<object>>>;
+    createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
-     * Create a new graph
+     * To create a new graph from flat files,  you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes.  .zip hierarchy: *main_folder/Nodes *main_folder/Edges  In each folder you can place one or multiple csv files containing your Nodes or Edges data.  Your csv files must follow the following header (column name) requirements:  The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string  The Edges CSVs require three columns named, in order, * source * target * Id  those colomns represent * The source of the edge * The target of the edge * The Id of the edge  All following columns content are up to you.
      * @summary Create a new graph
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
@@ -6389,12 +6389,12 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
      * @summary Delete entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to delete
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Download a graph compressed in a zip file
      * @summary Download a graph compressed in a zip file
@@ -6417,12 +6417,12 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
      * @summary Get entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to get
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<object>>>;
+    getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
      * Return the metaData of the specified graph
      * @summary Return the metaData of the specified graph
@@ -6465,12 +6465,12 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
      * @summary Update entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to update
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<object>>>;
+    updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
      * Update the metaData of the specified graph
      * @summary Update the metaData of the specified graph
@@ -6490,8 +6490,8 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
  */
 export declare const TwingraphApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Launch a mass delete job
-     * @summary Launch a mass delete job
+     * Delete all versions of a graph and his metadatas
+     * @summary Delete all versions of a graph and his metadatas
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
      * @param {*} [options] Override http request option.
@@ -6524,14 +6524,14 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
      * @summary Create new entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to create
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<Array<object>>;
+    createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
     /**
-     * Create a new graph
+     * To create a new graph from flat files,  you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes.  .zip hierarchy: *main_folder/Nodes *main_folder/Edges  In each folder you can place one or multiple csv files containing your Nodes or Edges data.  Your csv files must follow the following header (column name) requirements:  The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string  The Edges CSVs require three columns named, in order, * source * target * Id  those colomns represent * The source of the edge * The target of the edge * The Id of the edge  All following columns content are up to you.
      * @summary Create a new graph
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
@@ -6545,12 +6545,12 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
      * @summary Delete entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to delete
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
+    deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
     /**
      * Download a graph compressed in a zip file
      * @summary Download a graph compressed in a zip file
@@ -6573,12 +6573,12 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
      * @summary Get entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to get
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<Array<object>>;
+    getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
     /**
      * Return the metaData of the specified graph
      * @summary Return the metaData of the specified graph
@@ -6621,12 +6621,12 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
      * @summary Update entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to update
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<Array<object>>;
+    updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
     /**
      * Update the metaData of the specified graph
      * @summary Update the metaData of the specified graph
@@ -6648,8 +6648,8 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
  */
 export declare class TwingraphApi extends BaseAPI {
     /**
-     * Launch a mass delete job
-     * @summary Launch a mass delete job
+     * Delete all versions of a graph and his metadatas
+     * @summary Delete all versions of a graph and his metadatas
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
      * @param {*} [options] Override http request option.
@@ -6685,15 +6685,15 @@ export declare class TwingraphApi extends BaseAPI {
      * @summary Create new entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to create
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TwingraphApi
      */
-    createEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object[]>>;
+    createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
     /**
-     * Create a new graph
+     * To create a new graph from flat files,  you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes.  .zip hierarchy: *main_folder/Nodes *main_folder/Edges  In each folder you can place one or multiple csv files containing your Nodes or Edges data.  Your csv files must follow the following header (column name) requirements:  The Nodes CSVs requires at least one column (the 1st).Column name = \'Id\'. It will represent the nodes ID Ids must be populated with string  The Edges CSVs require three columns named, in order, * source * target * Id  those colomns represent * The source of the edge * The target of the edge * The Id of the edge  All following columns content are up to you.
      * @summary Create a new graph
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
@@ -6708,13 +6708,13 @@ export declare class TwingraphApi extends BaseAPI {
      * @summary Delete entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to delete
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TwingraphApi
      */
-    deleteEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
+    deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
     /**
      * Download a graph compressed in a zip file
      * @summary Download a graph compressed in a zip file
@@ -6739,13 +6739,13 @@ export declare class TwingraphApi extends BaseAPI {
      * @summary Get entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<string>} ids the entities to get
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TwingraphApi
      */
-    getEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object[]>>;
+    getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
     /**
      * Return the metaData of the specified graph
      * @summary Return the metaData of the specified graph
@@ -6792,13 +6792,13 @@ export declare class TwingraphApi extends BaseAPI {
      * @summary Update entities in a graph instance
      * @param {string} organizationId the Organization identifier
      * @param {string} graphId the Graph Identifier
-     * @param {'node' | 'relationship'} modelType the entity model type
+     * @param {'node' | 'relationship'} type the entity model type
      * @param {Array<GraphProperties>} graphProperties the entities to update
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TwingraphApi
      */
-    updateEntities(organizationId: string, graphId: string, modelType: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object[]>>;
+    updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
     /**
      * Update the metaData of the specified graph
      * @summary Update the metaData of the specified graph