@cosmotech/api-ts 3.0.10-private → 3.0.14-dev

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Cosmo Tech Platform API
5
5
  * Cosmo Tech Platform API
6
6
  *
7
- * The version of the OpenAPI document: 3.0.10-private
7
+ * The version of the OpenAPI document: 3.0.14-dev
8
8
  * Contact: platform@cosmotech.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -269,6 +269,12 @@ export interface Dataset {
269
269
  * @memberof Dataset
270
270
  */
271
271
  'ownerId'?: string;
272
+ /**
273
+ * the name of the owner
274
+ * @type {string}
275
+ * @memberof Dataset
276
+ */
277
+ 'ownerName'?: string;
272
278
  /**
273
279
  * the Organization Id related to this Dataset
274
280
  * @type {string}
@@ -836,8 +842,15 @@ export interface RunTemplate {
836
842
  * the Run Template name
837
843
  * @type {string}
838
844
  * @memberof RunTemplate
845
+ * @deprecated
839
846
  */
840
847
  'name'?: string;
848
+ /**
849
+ * a translated label with key as ISO 639-1 code
850
+ * @type {{ [key: string]: string; }}
851
+ * @memberof RunTemplate
852
+ */
853
+ 'labels'?: { [key: string]: string; };
841
854
  /**
842
855
  * the Run Template description
843
856
  * @type {string}
@@ -2419,6 +2432,12 @@ export interface SourceInfo {
2419
2432
  * @memberof SourceInfo
2420
2433
  */
2421
2434
  'path'?: string;
2435
+ /**
2436
+ * indicate the last import jobId
2437
+ * @type {string}
2438
+ * @memberof SourceInfo
2439
+ */
2440
+ 'jobId'?: string;
2422
2441
  }
2423
2442
  /**
2424
2443
  * a twin graph query in cypher language
@@ -3371,8 +3390,8 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
3371
3390
  };
3372
3391
  },
3373
3392
  /**
3374
- *
3375
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
3393
+ * Not implemented!
3394
+ * @summary Copy a Dataset to another Dataset.
3376
3395
  * @param {string} organizationId the Organization identifier
3377
3396
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
3378
3397
  * @param {*} [options] Override http request option.
@@ -3459,11 +3478,11 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
3459
3478
  };
3460
3479
  },
3461
3480
  /**
3462
- * Run a query on a dataset
3463
- * @summary Run a query on a dataset
3481
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
3482
+ * @summary Create a sub-dataset from the dataset in parameter
3464
3483
  * @param {string} organizationId the Organization identifier
3465
3484
  * @param {string} datasetId the Dataset identifier
3466
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
3485
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
3467
3486
  * @param {*} [options] Override http request option.
3468
3487
  * @throws {RequiredError}
3469
3488
  */
@@ -3654,8 +3673,8 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
3654
3673
  };
3655
3674
  },
3656
3675
  /**
3657
- * Download a graph compressed in a zip file
3658
- * @summary Download a graph compressed in a zip file
3676
+ * Download the compressed graph reference by the hash in a zip file
3677
+ * @summary Download a graph as a zip file
3659
3678
  * @param {string} organizationId the Organization identifier
3660
3679
  * @param {string} hash the Graph download identifier
3661
3680
  * @param {*} [options] Override http request option.
@@ -3822,6 +3841,48 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
3822
3841
 
3823
3842
 
3824
3843
 
3844
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3845
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3846
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3847
+
3848
+ return {
3849
+ url: toPathString(localVarUrlObj),
3850
+ options: localVarRequestOptions,
3851
+ };
3852
+ },
3853
+ /**
3854
+ *
3855
+ * @summary Get the Dataset security information
3856
+ * @param {string} organizationId the Organization identifier
3857
+ * @param {string} datasetId the Dataset identifier
3858
+ * @param {*} [options] Override http request option.
3859
+ * @throws {RequiredError}
3860
+ */
3861
+ getDatasetSecurity: async (organizationId: string, datasetId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
3862
+ // verify required parameter 'organizationId' is not null or undefined
3863
+ assertParamExists('getDatasetSecurity', 'organizationId', organizationId)
3864
+ // verify required parameter 'datasetId' is not null or undefined
3865
+ assertParamExists('getDatasetSecurity', 'datasetId', datasetId)
3866
+ const localVarPath = `/organizations/{organization_id}/datasets/{dataset_id}/security`
3867
+ .replace(`{${"organization_id"}}`, encodeURIComponent(String(organizationId)))
3868
+ .replace(`{${"dataset_id"}}`, encodeURIComponent(String(datasetId)));
3869
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3870
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3871
+ let baseOptions;
3872
+ if (configuration) {
3873
+ baseOptions = configuration.baseOptions;
3874
+ }
3875
+
3876
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3877
+ const localVarHeaderParameter = {} as any;
3878
+ const localVarQueryParameter = {} as any;
3879
+
3880
+ // authentication oAuth2AuthCode required
3881
+ // oauth required
3882
+ await setOAuthToObject(localVarHeaderParameter, "oAuth2AuthCode", [], configuration)
3883
+
3884
+
3885
+
3825
3886
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3826
3887
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3827
3888
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -3874,25 +3935,21 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
3874
3935
  };
3875
3936
  },
3876
3937
  /**
3877
- * Get the status of a twingraph import
3878
- * @summary Get the status of twingraph import
3938
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
3939
+ * @summary Get the dataset\'s refresh job status
3879
3940
  * @param {string} organizationId the Organization identifier
3880
3941
  * @param {string} datasetId the dataset identifier
3881
- * @param {string} jobId the job identifier
3882
3942
  * @param {*} [options] Override http request option.
3883
3943
  * @throws {RequiredError}
3884
3944
  */
3885
- getDatasetTwingraphStatus: async (organizationId: string, datasetId: string, jobId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
3945
+ getDatasetTwingraphStatus: async (organizationId: string, datasetId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
3886
3946
  // verify required parameter 'organizationId' is not null or undefined
3887
3947
  assertParamExists('getDatasetTwingraphStatus', 'organizationId', organizationId)
3888
3948
  // verify required parameter 'datasetId' is not null or undefined
3889
3949
  assertParamExists('getDatasetTwingraphStatus', 'datasetId', datasetId)
3890
- // verify required parameter 'jobId' is not null or undefined
3891
- assertParamExists('getDatasetTwingraphStatus', 'jobId', jobId)
3892
- const localVarPath = `/organizations/{organization_id}/datasets/{dataset_id}/job/{job_id}/status`
3950
+ const localVarPath = `/organizations/{organization_id}/datasets/{dataset_id}/status`
3893
3951
  .replace(`{${"organization_id"}}`, encodeURIComponent(String(organizationId)))
3894
- .replace(`{${"dataset_id"}}`, encodeURIComponent(String(datasetId)))
3895
- .replace(`{${"job_id"}}`, encodeURIComponent(String(jobId)));
3952
+ .replace(`{${"dataset_id"}}`, encodeURIComponent(String(datasetId)));
3896
3953
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3897
3954
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3898
3955
  let baseOptions;
@@ -3973,8 +4030,8 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
3973
4030
  };
3974
4031
  },
3975
4032
  /**
3976
- * Refresh ADT, Storage dataset
3977
- * @summary Refresh dataset
4033
+ * 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
4034
+ * @summary Refresh data on dataset from dataset\'s source
3978
4035
  * @param {string} organizationId the Organization identifier
3979
4036
  * @param {string} datasetId the Dataset identifier
3980
4037
  * @param {*} [options] Override http request option.
@@ -4104,7 +4161,7 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
4104
4161
  },
4105
4162
  /**
4106
4163
  *
4107
- * @summary Search Datasets
4164
+ * @summary Search Datasets by tags
4108
4165
  * @param {string} organizationId the Organization identifier
4109
4166
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
4110
4167
  * @param {number} [page] page number to query
@@ -4156,6 +4213,54 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
4156
4213
  options: localVarRequestOptions,
4157
4214
  };
4158
4215
  },
4216
+ /**
4217
+ *
4218
+ * @summary Set the Dataset default security
4219
+ * @param {string} organizationId the Organization identifier
4220
+ * @param {string} datasetId the Dataset identifier
4221
+ * @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
4222
+ * @param {*} [options] Override http request option.
4223
+ * @throws {RequiredError}
4224
+ */
4225
+ setDatasetDefaultSecurity: async (organizationId: string, datasetId: string, datasetRole: DatasetRole, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
4226
+ // verify required parameter 'organizationId' is not null or undefined
4227
+ assertParamExists('setDatasetDefaultSecurity', 'organizationId', organizationId)
4228
+ // verify required parameter 'datasetId' is not null or undefined
4229
+ assertParamExists('setDatasetDefaultSecurity', 'datasetId', datasetId)
4230
+ // verify required parameter 'datasetRole' is not null or undefined
4231
+ assertParamExists('setDatasetDefaultSecurity', 'datasetRole', datasetRole)
4232
+ const localVarPath = `/organizations/{organization_id}/datasets/{dataset_id}/security/default`
4233
+ .replace(`{${"organization_id"}}`, encodeURIComponent(String(organizationId)))
4234
+ .replace(`{${"dataset_id"}}`, encodeURIComponent(String(datasetId)));
4235
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4236
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4237
+ let baseOptions;
4238
+ if (configuration) {
4239
+ baseOptions = configuration.baseOptions;
4240
+ }
4241
+
4242
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
4243
+ const localVarHeaderParameter = {} as any;
4244
+ const localVarQueryParameter = {} as any;
4245
+
4246
+ // authentication oAuth2AuthCode required
4247
+ // oauth required
4248
+ await setOAuthToObject(localVarHeaderParameter, "oAuth2AuthCode", [], configuration)
4249
+
4250
+
4251
+
4252
+ localVarHeaderParameter['Content-Type'] = 'application/json';
4253
+
4254
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4255
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4256
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4257
+ localVarRequestOptions.data = serializeDataIfNeeded(datasetRole, localVarRequestOptions, configuration)
4258
+
4259
+ return {
4260
+ url: toPathString(localVarUrlObj),
4261
+ options: localVarRequestOptions,
4262
+ };
4263
+ },
4159
4264
  /**
4160
4265
  * Run a query on a graph instance and return the result as a zip file in async mode
4161
4266
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -4261,7 +4366,7 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
4261
4366
  },
4262
4367
  /**
4263
4368
  * Run a query on a graph instance and return the result as a json
4264
- * @summary Run a query on a graph instance and return the result as a json
4369
+ * @summary Return the result of a query made on the graph instance as a json
4265
4370
  * @param {string} organizationId the Organization identifier
4266
4371
  * @param {string} datasetId the Dataset identifier
4267
4372
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -4312,7 +4417,7 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
4312
4417
  * @summary Update a dataset
4313
4418
  * @param {string} organizationId the Organization identifier
4314
4419
  * @param {string} datasetId the Dataset identifier
4315
- * @param {Dataset} dataset the new Dataset details.
4420
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
4316
4421
  * @param {*} [options] Override http request option.
4317
4422
  * @throws {RequiredError}
4318
4423
  */
@@ -4460,8 +4565,8 @@ export const DatasetApiAxiosParamCreator = function (configuration?: Configurati
4460
4565
  };
4461
4566
  },
4462
4567
  /**
4463
- * Upload Twingraph ZIP
4464
- * @summary Upload Twingraph with ZIP File
4568
+ * 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.
4569
+ * @summary Upload data from zip file to dataset\'s twingraph
4465
4570
  * @param {string} organizationId the Organization identifier
4466
4571
  * @param {string} datasetId the Dataset identifier
4467
4572
  * @param {any} body
@@ -4544,8 +4649,8 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4544
4649
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4545
4650
  },
4546
4651
  /**
4547
- *
4548
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
4652
+ * Not implemented!
4653
+ * @summary Copy a Dataset to another Dataset.
4549
4654
  * @param {string} organizationId the Organization identifier
4550
4655
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
4551
4656
  * @param {*} [options] Override http request option.
@@ -4568,11 +4673,11 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4568
4673
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4569
4674
  },
4570
4675
  /**
4571
- * Run a query on a dataset
4572
- * @summary Run a query on a dataset
4676
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
4677
+ * @summary Create a sub-dataset from the dataset in parameter
4573
4678
  * @param {string} organizationId the Organization identifier
4574
4679
  * @param {string} datasetId the Dataset identifier
4575
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
4680
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
4576
4681
  * @param {*} [options] Override http request option.
4577
4682
  * @throws {RequiredError}
4578
4683
  */
@@ -4621,8 +4726,8 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4621
4726
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4622
4727
  },
4623
4728
  /**
4624
- * Download a graph compressed in a zip file
4625
- * @summary Download a graph compressed in a zip file
4729
+ * Download the compressed graph reference by the hash in a zip file
4730
+ * @summary Download a graph as a zip file
4626
4731
  * @param {string} organizationId the Organization identifier
4627
4732
  * @param {string} hash the Graph download identifier
4628
4733
  * @param {*} [options] Override http request option.
@@ -4670,6 +4775,18 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4670
4775
  const localVarAxiosArgs = await localVarAxiosParamCreator.getDatasetAccessControl(organizationId, datasetId, identityId, options);
4671
4776
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4672
4777
  },
4778
+ /**
4779
+ *
4780
+ * @summary Get the Dataset security information
4781
+ * @param {string} organizationId the Organization identifier
4782
+ * @param {string} datasetId the Dataset identifier
4783
+ * @param {*} [options] Override http request option.
4784
+ * @throws {RequiredError}
4785
+ */
4786
+ async getDatasetSecurity(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetSecurity>> {
4787
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDatasetSecurity(organizationId, datasetId, options);
4788
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4789
+ },
4673
4790
  /**
4674
4791
  *
4675
4792
  * @summary Get the Dataset security users list
@@ -4683,16 +4800,15 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4683
4800
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4684
4801
  },
4685
4802
  /**
4686
- * Get the status of a twingraph import
4687
- * @summary Get the status of twingraph import
4803
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
4804
+ * @summary Get the dataset\'s refresh job status
4688
4805
  * @param {string} organizationId the Organization identifier
4689
4806
  * @param {string} datasetId the dataset identifier
4690
- * @param {string} jobId the job identifier
4691
4807
  * @param {*} [options] Override http request option.
4692
4808
  * @throws {RequiredError}
4693
4809
  */
4694
- async getDatasetTwingraphStatus(organizationId: string, datasetId: string, jobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
4695
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDatasetTwingraphStatus(organizationId, datasetId, jobId, options);
4810
+ async getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
4811
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDatasetTwingraphStatus(organizationId, datasetId, options);
4696
4812
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4697
4813
  },
4698
4814
  /**
@@ -4710,8 +4826,8 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4710
4826
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4711
4827
  },
4712
4828
  /**
4713
- * Refresh ADT, Storage dataset
4714
- * @summary Refresh dataset
4829
+ * 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
4830
+ * @summary Refresh data on dataset from dataset\'s source
4715
4831
  * @param {string} organizationId the Organization identifier
4716
4832
  * @param {string} datasetId the Dataset identifier
4717
4833
  * @param {*} [options] Override http request option.
@@ -4748,7 +4864,7 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4748
4864
  },
4749
4865
  /**
4750
4866
  *
4751
- * @summary Search Datasets
4867
+ * @summary Search Datasets by tags
4752
4868
  * @param {string} organizationId the Organization identifier
4753
4869
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
4754
4870
  * @param {number} [page] page number to query
@@ -4760,6 +4876,19 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4760
4876
  const localVarAxiosArgs = await localVarAxiosParamCreator.searchDatasets(organizationId, datasetSearch, page, size, options);
4761
4877
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4762
4878
  },
4879
+ /**
4880
+ *
4881
+ * @summary Set the Dataset default security
4882
+ * @param {string} organizationId the Organization identifier
4883
+ * @param {string} datasetId the Dataset identifier
4884
+ * @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
4885
+ * @param {*} [options] Override http request option.
4886
+ * @throws {RequiredError}
4887
+ */
4888
+ async setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetSecurity>> {
4889
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setDatasetDefaultSecurity(organizationId, datasetId, datasetRole, options);
4890
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4891
+ },
4763
4892
  /**
4764
4893
  * Run a query on a graph instance and return the result as a zip file in async mode
4765
4894
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -4789,7 +4918,7 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4789
4918
  },
4790
4919
  /**
4791
4920
  * Run a query on a graph instance and return the result as a json
4792
- * @summary Run a query on a graph instance and return the result as a json
4921
+ * @summary Return the result of a query made on the graph instance as a json
4793
4922
  * @param {string} organizationId the Organization identifier
4794
4923
  * @param {string} datasetId the Dataset identifier
4795
4924
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -4805,7 +4934,7 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4805
4934
  * @summary Update a dataset
4806
4935
  * @param {string} organizationId the Organization identifier
4807
4936
  * @param {string} datasetId the Dataset identifier
4808
- * @param {Dataset} dataset the new Dataset details.
4937
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
4809
4938
  * @param {*} [options] Override http request option.
4810
4939
  * @throws {RequiredError}
4811
4940
  */
@@ -4842,8 +4971,8 @@ export const DatasetApiFp = function(configuration?: Configuration) {
4842
4971
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4843
4972
  },
4844
4973
  /**
4845
- * Upload Twingraph ZIP
4846
- * @summary Upload Twingraph with ZIP File
4974
+ * 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.
4975
+ * @summary Upload data from zip file to dataset\'s twingraph
4847
4976
  * @param {string} organizationId the Organization identifier
4848
4977
  * @param {string} datasetId the Dataset identifier
4849
4978
  * @param {any} body
@@ -4889,8 +5018,8 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
4889
5018
  return localVarFp.addOrReplaceDatasetCompatibilityElements(organizationId, datasetId, datasetCompatibility, options).then((request) => request(axios, basePath));
4890
5019
  },
4891
5020
  /**
4892
- *
4893
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
5021
+ * Not implemented!
5022
+ * @summary Copy a Dataset to another Dataset.
4894
5023
  * @param {string} organizationId the Organization identifier
4895
5024
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
4896
5025
  * @param {*} [options] Override http request option.
@@ -4911,11 +5040,11 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
4911
5040
  return localVarFp.createDataset(organizationId, dataset, options).then((request) => request(axios, basePath));
4912
5041
  },
4913
5042
  /**
4914
- * Run a query on a dataset
4915
- * @summary Run a query on a dataset
5043
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
5044
+ * @summary Create a sub-dataset from the dataset in parameter
4916
5045
  * @param {string} organizationId the Organization identifier
4917
5046
  * @param {string} datasetId the Dataset identifier
4918
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
5047
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
4919
5048
  * @param {*} [options] Override http request option.
4920
5049
  * @throws {RequiredError}
4921
5050
  */
@@ -4960,8 +5089,8 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
4960
5089
  return localVarFp.deleteTwingraphEntities(organizationId, datasetId, type, ids, options).then((request) => request(axios, basePath));
4961
5090
  },
4962
5091
  /**
4963
- * Download a graph compressed in a zip file
4964
- * @summary Download a graph compressed in a zip file
5092
+ * Download the compressed graph reference by the hash in a zip file
5093
+ * @summary Download a graph as a zip file
4965
5094
  * @param {string} organizationId the Organization identifier
4966
5095
  * @param {string} hash the Graph download identifier
4967
5096
  * @param {*} [options] Override http request option.
@@ -5005,6 +5134,17 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5005
5134
  getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<DatasetAccessControl> {
5006
5135
  return localVarFp.getDatasetAccessControl(organizationId, datasetId, identityId, options).then((request) => request(axios, basePath));
5007
5136
  },
5137
+ /**
5138
+ *
5139
+ * @summary Get the Dataset security information
5140
+ * @param {string} organizationId the Organization identifier
5141
+ * @param {string} datasetId the Dataset identifier
5142
+ * @param {*} [options] Override http request option.
5143
+ * @throws {RequiredError}
5144
+ */
5145
+ getDatasetSecurity(organizationId: string, datasetId: string, options?: any): AxiosPromise<DatasetSecurity> {
5146
+ return localVarFp.getDatasetSecurity(organizationId, datasetId, options).then((request) => request(axios, basePath));
5147
+ },
5008
5148
  /**
5009
5149
  *
5010
5150
  * @summary Get the Dataset security users list
@@ -5017,16 +5157,15 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5017
5157
  return localVarFp.getDatasetSecurityUsers(organizationId, datasetId, options).then((request) => request(axios, basePath));
5018
5158
  },
5019
5159
  /**
5020
- * Get the status of a twingraph import
5021
- * @summary Get the status of twingraph import
5160
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
5161
+ * @summary Get the dataset\'s refresh job status
5022
5162
  * @param {string} organizationId the Organization identifier
5023
5163
  * @param {string} datasetId the dataset identifier
5024
- * @param {string} jobId the job identifier
5025
5164
  * @param {*} [options] Override http request option.
5026
5165
  * @throws {RequiredError}
5027
5166
  */
5028
- getDatasetTwingraphStatus(organizationId: string, datasetId: string, jobId: string, options?: any): AxiosPromise<string> {
5029
- return localVarFp.getDatasetTwingraphStatus(organizationId, datasetId, jobId, options).then((request) => request(axios, basePath));
5167
+ getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: any): AxiosPromise<string> {
5168
+ return localVarFp.getDatasetTwingraphStatus(organizationId, datasetId, options).then((request) => request(axios, basePath));
5030
5169
  },
5031
5170
  /**
5032
5171
  * get entities in a graph instance
@@ -5042,8 +5181,8 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5042
5181
  return localVarFp.getTwingraphEntities(organizationId, datasetId, type, ids, options).then((request) => request(axios, basePath));
5043
5182
  },
5044
5183
  /**
5045
- * Refresh ADT, Storage dataset
5046
- * @summary Refresh dataset
5184
+ * 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
5185
+ * @summary Refresh data on dataset from dataset\'s source
5047
5186
  * @param {string} organizationId the Organization identifier
5048
5187
  * @param {string} datasetId the Dataset identifier
5049
5188
  * @param {*} [options] Override http request option.
@@ -5077,7 +5216,7 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5077
5216
  },
5078
5217
  /**
5079
5218
  *
5080
- * @summary Search Datasets
5219
+ * @summary Search Datasets by tags
5081
5220
  * @param {string} organizationId the Organization identifier
5082
5221
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
5083
5222
  * @param {number} [page] page number to query
@@ -5088,6 +5227,18 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5088
5227
  searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>> {
5089
5228
  return localVarFp.searchDatasets(organizationId, datasetSearch, page, size, options).then((request) => request(axios, basePath));
5090
5229
  },
5230
+ /**
5231
+ *
5232
+ * @summary Set the Dataset default security
5233
+ * @param {string} organizationId the Organization identifier
5234
+ * @param {string} datasetId the Dataset identifier
5235
+ * @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
5236
+ * @param {*} [options] Override http request option.
5237
+ * @throws {RequiredError}
5238
+ */
5239
+ setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: any): AxiosPromise<DatasetSecurity> {
5240
+ return localVarFp.setDatasetDefaultSecurity(organizationId, datasetId, datasetRole, options).then((request) => request(axios, basePath));
5241
+ },
5091
5242
  /**
5092
5243
  * Run a query on a graph instance and return the result as a zip file in async mode
5093
5244
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -5115,7 +5266,7 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5115
5266
  },
5116
5267
  /**
5117
5268
  * Run a query on a graph instance and return the result as a json
5118
- * @summary Run a query on a graph instance and return the result as a json
5269
+ * @summary Return the result of a query made on the graph instance as a json
5119
5270
  * @param {string} organizationId the Organization identifier
5120
5271
  * @param {string} datasetId the Dataset identifier
5121
5272
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -5130,7 +5281,7 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5130
5281
  * @summary Update a dataset
5131
5282
  * @param {string} organizationId the Organization identifier
5132
5283
  * @param {string} datasetId the Dataset identifier
5133
- * @param {Dataset} dataset the new Dataset details.
5284
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
5134
5285
  * @param {*} [options] Override http request option.
5135
5286
  * @throws {RequiredError}
5136
5287
  */
@@ -5164,8 +5315,8 @@ export const DatasetApiFactory = function (configuration?: Configuration, basePa
5164
5315
  return localVarFp.updateTwingraphEntities(organizationId, datasetId, type, graphProperties, options).then((request) => request(axios, basePath));
5165
5316
  },
5166
5317
  /**
5167
- * Upload Twingraph ZIP
5168
- * @summary Upload Twingraph with ZIP File
5318
+ * 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.
5319
+ * @summary Upload data from zip file to dataset\'s twingraph
5169
5320
  * @param {string} organizationId the Organization identifier
5170
5321
  * @param {string} datasetId the Dataset identifier
5171
5322
  * @param {any} body
@@ -5214,8 +5365,8 @@ export class DatasetApi extends BaseAPI {
5214
5365
  }
5215
5366
 
5216
5367
  /**
5217
- *
5218
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
5368
+ * Not implemented!
5369
+ * @summary Copy a Dataset to another Dataset.
5219
5370
  * @param {string} organizationId the Organization identifier
5220
5371
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
5221
5372
  * @param {*} [options] Override http request option.
@@ -5240,11 +5391,11 @@ export class DatasetApi extends BaseAPI {
5240
5391
  }
5241
5392
 
5242
5393
  /**
5243
- * Run a query on a dataset
5244
- * @summary Run a query on a dataset
5394
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
5395
+ * @summary Create a sub-dataset from the dataset in parameter
5245
5396
  * @param {string} organizationId the Organization identifier
5246
5397
  * @param {string} datasetId the Dataset identifier
5247
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
5398
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
5248
5399
  * @param {*} [options] Override http request option.
5249
5400
  * @throws {RequiredError}
5250
5401
  * @memberof DatasetApi
@@ -5297,8 +5448,8 @@ export class DatasetApi extends BaseAPI {
5297
5448
  }
5298
5449
 
5299
5450
  /**
5300
- * Download a graph compressed in a zip file
5301
- * @summary Download a graph compressed in a zip file
5451
+ * Download the compressed graph reference by the hash in a zip file
5452
+ * @summary Download a graph as a zip file
5302
5453
  * @param {string} organizationId the Organization identifier
5303
5454
  * @param {string} hash the Graph download identifier
5304
5455
  * @param {*} [options] Override http request option.
@@ -5350,6 +5501,19 @@ export class DatasetApi extends BaseAPI {
5350
5501
  return DatasetApiFp(this.configuration).getDatasetAccessControl(organizationId, datasetId, identityId, options).then((request) => request(this.axios, this.basePath));
5351
5502
  }
5352
5503
 
5504
+ /**
5505
+ *
5506
+ * @summary Get the Dataset security information
5507
+ * @param {string} organizationId the Organization identifier
5508
+ * @param {string} datasetId the Dataset identifier
5509
+ * @param {*} [options] Override http request option.
5510
+ * @throws {RequiredError}
5511
+ * @memberof DatasetApi
5512
+ */
5513
+ public getDatasetSecurity(organizationId: string, datasetId: string, options?: AxiosRequestConfig) {
5514
+ return DatasetApiFp(this.configuration).getDatasetSecurity(organizationId, datasetId, options).then((request) => request(this.axios, this.basePath));
5515
+ }
5516
+
5353
5517
  /**
5354
5518
  *
5355
5519
  * @summary Get the Dataset security users list
@@ -5364,17 +5528,16 @@ export class DatasetApi extends BaseAPI {
5364
5528
  }
5365
5529
 
5366
5530
  /**
5367
- * Get the status of a twingraph import
5368
- * @summary Get the status of twingraph import
5531
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
5532
+ * @summary Get the dataset\'s refresh job status
5369
5533
  * @param {string} organizationId the Organization identifier
5370
5534
  * @param {string} datasetId the dataset identifier
5371
- * @param {string} jobId the job identifier
5372
5535
  * @param {*} [options] Override http request option.
5373
5536
  * @throws {RequiredError}
5374
5537
  * @memberof DatasetApi
5375
5538
  */
5376
- public getDatasetTwingraphStatus(organizationId: string, datasetId: string, jobId: string, options?: AxiosRequestConfig) {
5377
- return DatasetApiFp(this.configuration).getDatasetTwingraphStatus(organizationId, datasetId, jobId, options).then((request) => request(this.axios, this.basePath));
5539
+ public getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig) {
5540
+ return DatasetApiFp(this.configuration).getDatasetTwingraphStatus(organizationId, datasetId, options).then((request) => request(this.axios, this.basePath));
5378
5541
  }
5379
5542
 
5380
5543
  /**
@@ -5393,8 +5556,8 @@ export class DatasetApi extends BaseAPI {
5393
5556
  }
5394
5557
 
5395
5558
  /**
5396
- * Refresh ADT, Storage dataset
5397
- * @summary Refresh dataset
5559
+ * 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
5560
+ * @summary Refresh data on dataset from dataset\'s source
5398
5561
  * @param {string} organizationId the Organization identifier
5399
5562
  * @param {string} datasetId the Dataset identifier
5400
5563
  * @param {*} [options] Override http request option.
@@ -5434,7 +5597,7 @@ export class DatasetApi extends BaseAPI {
5434
5597
 
5435
5598
  /**
5436
5599
  *
5437
- * @summary Search Datasets
5600
+ * @summary Search Datasets by tags
5438
5601
  * @param {string} organizationId the Organization identifier
5439
5602
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
5440
5603
  * @param {number} [page] page number to query
@@ -5447,6 +5610,20 @@ export class DatasetApi extends BaseAPI {
5447
5610
  return DatasetApiFp(this.configuration).searchDatasets(organizationId, datasetSearch, page, size, options).then((request) => request(this.axios, this.basePath));
5448
5611
  }
5449
5612
 
5613
+ /**
5614
+ *
5615
+ * @summary Set the Dataset default security
5616
+ * @param {string} organizationId the Organization identifier
5617
+ * @param {string} datasetId the Dataset identifier
5618
+ * @param {DatasetRole} datasetRole This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset.
5619
+ * @param {*} [options] Override http request option.
5620
+ * @throws {RequiredError}
5621
+ * @memberof DatasetApi
5622
+ */
5623
+ public setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig) {
5624
+ return DatasetApiFp(this.configuration).setDatasetDefaultSecurity(organizationId, datasetId, datasetRole, options).then((request) => request(this.axios, this.basePath));
5625
+ }
5626
+
5450
5627
  /**
5451
5628
  * Run a query on a graph instance and return the result as a zip file in async mode
5452
5629
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -5478,7 +5655,7 @@ export class DatasetApi extends BaseAPI {
5478
5655
 
5479
5656
  /**
5480
5657
  * Run a query on a graph instance and return the result as a json
5481
- * @summary Run a query on a graph instance and return the result as a json
5658
+ * @summary Return the result of a query made on the graph instance as a json
5482
5659
  * @param {string} organizationId the Organization identifier
5483
5660
  * @param {string} datasetId the Dataset identifier
5484
5661
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -5495,7 +5672,7 @@ export class DatasetApi extends BaseAPI {
5495
5672
  * @summary Update a dataset
5496
5673
  * @param {string} organizationId the Organization identifier
5497
5674
  * @param {string} datasetId the Dataset identifier
5498
- * @param {Dataset} dataset the new Dataset details.
5675
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
5499
5676
  * @param {*} [options] Override http request option.
5500
5677
  * @throws {RequiredError}
5501
5678
  * @memberof DatasetApi
@@ -5535,8 +5712,8 @@ export class DatasetApi extends BaseAPI {
5535
5712
  }
5536
5713
 
5537
5714
  /**
5538
- * Upload Twingraph ZIP
5539
- * @summary Upload Twingraph with ZIP File
5715
+ * 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.
5716
+ * @summary Upload data from zip file to dataset\'s twingraph
5540
5717
  * @param {string} organizationId the Organization identifier
5541
5718
  * @param {string} datasetId the Dataset identifier
5542
5719
  * @param {any} body
@@ -5962,7 +6139,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config
5962
6139
  *
5963
6140
  * @summary Set the Organization default security
5964
6141
  * @param {string} organizationId the Organization identifier
5965
- * @param {OrganizationRole} organizationRole the new Organization default security.
6142
+ * @param {OrganizationRole} organizationRole This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization.
5966
6143
  * @param {*} [options] Override http request option.
5967
6144
  * @throws {RequiredError}
5968
6145
  */
@@ -6044,7 +6221,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config
6044
6221
  *
6045
6222
  * @summary Update an Organization
6046
6223
  * @param {string} organizationId the Organization identifier
6047
- * @param {Organization} organization the new Organization details
6224
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
6048
6225
  * @param {*} [options] Override http request option.
6049
6226
  * @throws {RequiredError}
6050
6227
  */
@@ -6392,7 +6569,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
6392
6569
  *
6393
6570
  * @summary Set the Organization default security
6394
6571
  * @param {string} organizationId the Organization identifier
6395
- * @param {OrganizationRole} organizationRole the new Organization default security.
6572
+ * @param {OrganizationRole} organizationRole This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization.
6396
6573
  * @param {*} [options] Override http request option.
6397
6574
  * @throws {RequiredError}
6398
6575
  */
@@ -6415,7 +6592,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
6415
6592
  *
6416
6593
  * @summary Update an Organization
6417
6594
  * @param {string} organizationId the Organization identifier
6418
- * @param {Organization} organization the new Organization details
6595
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
6419
6596
  * @param {*} [options] Override http request option.
6420
6597
  * @throws {RequiredError}
6421
6598
  */
@@ -6590,7 +6767,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
6590
6767
  *
6591
6768
  * @summary Set the Organization default security
6592
6769
  * @param {string} organizationId the Organization identifier
6593
- * @param {OrganizationRole} organizationRole the new Organization default security.
6770
+ * @param {OrganizationRole} organizationRole This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization.
6594
6771
  * @param {*} [options] Override http request option.
6595
6772
  * @throws {RequiredError}
6596
6773
  */
@@ -6611,7 +6788,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
6611
6788
  *
6612
6789
  * @summary Update an Organization
6613
6790
  * @param {string} organizationId the Organization identifier
6614
- * @param {Organization} organization the new Organization details
6791
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
6615
6792
  * @param {*} [options] Override http request option.
6616
6793
  * @throws {RequiredError}
6617
6794
  */
@@ -6801,7 +6978,7 @@ export class OrganizationApi extends BaseAPI {
6801
6978
  *
6802
6979
  * @summary Set the Organization default security
6803
6980
  * @param {string} organizationId the Organization identifier
6804
- * @param {OrganizationRole} organizationRole the new Organization default security.
6981
+ * @param {OrganizationRole} organizationRole This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization.
6805
6982
  * @param {*} [options] Override http request option.
6806
6983
  * @throws {RequiredError}
6807
6984
  * @memberof OrganizationApi
@@ -6826,7 +7003,7 @@ export class OrganizationApi extends BaseAPI {
6826
7003
  *
6827
7004
  * @summary Update an Organization
6828
7005
  * @param {string} organizationId the Organization identifier
6829
- * @param {Organization} organization the new Organization details
7006
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
6830
7007
  * @param {*} [options] Override http request option.
6831
7008
  * @throws {RequiredError}
6832
7009
  * @memberof OrganizationApi
@@ -7818,7 +7995,7 @@ export const ScenarioApiAxiosParamCreator = function (configuration?: Configurat
7818
7995
  * @param {string} organizationId the Organization identifier
7819
7996
  * @param {string} workspaceId the Workspace identifier
7820
7997
  * @param {string} scenarioId the Scenario identifier
7821
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
7998
+ * @param {ScenarioRole} scenarioRole This change the scenario default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the scenario.
7822
7999
  * @param {*} [options] Override http request option.
7823
8000
  * @throws {RequiredError}
7824
8001
  */
@@ -7870,7 +8047,7 @@ export const ScenarioApiAxiosParamCreator = function (configuration?: Configurat
7870
8047
  * @param {string} organizationId the Organization identifier
7871
8048
  * @param {string} workspaceId the Workspace identifier
7872
8049
  * @param {string} scenarioId the Scenario identifier
7873
- * @param {Scenario} scenario the new Scenario details.
8050
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
7874
8051
  * @param {*} [options] Override http request option.
7875
8052
  * @throws {RequiredError}
7876
8053
  */
@@ -8243,7 +8420,7 @@ export const ScenarioApiFp = function(configuration?: Configuration) {
8243
8420
  * @param {string} organizationId the Organization identifier
8244
8421
  * @param {string} workspaceId the Workspace identifier
8245
8422
  * @param {string} scenarioId the Scenario identifier
8246
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
8423
+ * @param {ScenarioRole} scenarioRole This change the scenario default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the scenario.
8247
8424
  * @param {*} [options] Override http request option.
8248
8425
  * @throws {RequiredError}
8249
8426
  */
@@ -8257,7 +8434,7 @@ export const ScenarioApiFp = function(configuration?: Configuration) {
8257
8434
  * @param {string} organizationId the Organization identifier
8258
8435
  * @param {string} workspaceId the Workspace identifier
8259
8436
  * @param {string} scenarioId the Scenario identifier
8260
- * @param {Scenario} scenario the new Scenario details.
8437
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
8261
8438
  * @param {*} [options] Override http request option.
8262
8439
  * @throws {RequiredError}
8263
8440
  */
@@ -8532,7 +8709,7 @@ export const ScenarioApiFactory = function (configuration?: Configuration, baseP
8532
8709
  * @param {string} organizationId the Organization identifier
8533
8710
  * @param {string} workspaceId the Workspace identifier
8534
8711
  * @param {string} scenarioId the Scenario identifier
8535
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
8712
+ * @param {ScenarioRole} scenarioRole This change the scenario default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the scenario.
8536
8713
  * @param {*} [options] Override http request option.
8537
8714
  * @throws {RequiredError}
8538
8715
  */
@@ -8545,7 +8722,7 @@ export const ScenarioApiFactory = function (configuration?: Configuration, baseP
8545
8722
  * @param {string} organizationId the Organization identifier
8546
8723
  * @param {string} workspaceId the Workspace identifier
8547
8724
  * @param {string} scenarioId the Scenario identifier
8548
- * @param {Scenario} scenario the new Scenario details.
8725
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
8549
8726
  * @param {*} [options] Override http request option.
8550
8727
  * @throws {RequiredError}
8551
8728
  */
@@ -8856,7 +9033,7 @@ export class ScenarioApi extends BaseAPI {
8856
9033
  * @param {string} organizationId the Organization identifier
8857
9034
  * @param {string} workspaceId the Workspace identifier
8858
9035
  * @param {string} scenarioId the Scenario identifier
8859
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
9036
+ * @param {ScenarioRole} scenarioRole This change the scenario default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the scenario.
8860
9037
  * @param {*} [options] Override http request option.
8861
9038
  * @throws {RequiredError}
8862
9039
  * @memberof ScenarioApi
@@ -8871,7 +9048,7 @@ export class ScenarioApi extends BaseAPI {
8871
9048
  * @param {string} organizationId the Organization identifier
8872
9049
  * @param {string} workspaceId the Workspace identifier
8873
9050
  * @param {string} scenarioId the Scenario identifier
8874
- * @param {Scenario} scenario the new Scenario details.
9051
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
8875
9052
  * @param {*} [options] Override http request option.
8876
9053
  * @throws {RequiredError}
8877
9054
  * @memberof ScenarioApi
@@ -10870,6 +11047,48 @@ export const SolutionApiAxiosParamCreator = function (configuration?: Configurat
10870
11047
 
10871
11048
 
10872
11049
 
11050
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11051
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11052
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11053
+
11054
+ return {
11055
+ url: toPathString(localVarUrlObj),
11056
+ options: localVarRequestOptions,
11057
+ };
11058
+ },
11059
+ /**
11060
+ *
11061
+ * @summary Get the Solution security information
11062
+ * @param {string} organizationId the Organization identifier
11063
+ * @param {string} solutionId the Solution identifier
11064
+ * @param {*} [options] Override http request option.
11065
+ * @throws {RequiredError}
11066
+ */
11067
+ getSolutionSecurity: async (organizationId: string, solutionId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
11068
+ // verify required parameter 'organizationId' is not null or undefined
11069
+ assertParamExists('getSolutionSecurity', 'organizationId', organizationId)
11070
+ // verify required parameter 'solutionId' is not null or undefined
11071
+ assertParamExists('getSolutionSecurity', 'solutionId', solutionId)
11072
+ const localVarPath = `/organizations/{organization_id}/solutions/{solution_id}/security`
11073
+ .replace(`{${"organization_id"}}`, encodeURIComponent(String(organizationId)))
11074
+ .replace(`{${"solution_id"}}`, encodeURIComponent(String(solutionId)));
11075
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11076
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11077
+ let baseOptions;
11078
+ if (configuration) {
11079
+ baseOptions = configuration.baseOptions;
11080
+ }
11081
+
11082
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11083
+ const localVarHeaderParameter = {} as any;
11084
+ const localVarQueryParameter = {} as any;
11085
+
11086
+ // authentication oAuth2AuthCode required
11087
+ // oauth required
11088
+ await setOAuthToObject(localVarHeaderParameter, "oAuth2AuthCode", [], configuration)
11089
+
11090
+
11091
+
10873
11092
  setSearchParams(localVarUrlObj, localVarQueryParameter);
10874
11093
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10875
11094
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -11093,12 +11312,60 @@ export const SolutionApiAxiosParamCreator = function (configuration?: Configurat
11093
11312
  options: localVarRequestOptions,
11094
11313
  };
11095
11314
  },
11315
+ /**
11316
+ *
11317
+ * @summary Set the Solution default security
11318
+ * @param {string} organizationId the Organization identifier
11319
+ * @param {string} solutionId the Solution identifier
11320
+ * @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
11321
+ * @param {*} [options] Override http request option.
11322
+ * @throws {RequiredError}
11323
+ */
11324
+ setSolutionDefaultSecurity: async (organizationId: string, solutionId: string, solutionRole: SolutionRole, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
11325
+ // verify required parameter 'organizationId' is not null or undefined
11326
+ assertParamExists('setSolutionDefaultSecurity', 'organizationId', organizationId)
11327
+ // verify required parameter 'solutionId' is not null or undefined
11328
+ assertParamExists('setSolutionDefaultSecurity', 'solutionId', solutionId)
11329
+ // verify required parameter 'solutionRole' is not null or undefined
11330
+ assertParamExists('setSolutionDefaultSecurity', 'solutionRole', solutionRole)
11331
+ const localVarPath = `/organizations/{organization_id}/solutions/{solution_id}/security/default`
11332
+ .replace(`{${"organization_id"}}`, encodeURIComponent(String(organizationId)))
11333
+ .replace(`{${"solution_id"}}`, encodeURIComponent(String(solutionId)));
11334
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
11335
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11336
+ let baseOptions;
11337
+ if (configuration) {
11338
+ baseOptions = configuration.baseOptions;
11339
+ }
11340
+
11341
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
11342
+ const localVarHeaderParameter = {} as any;
11343
+ const localVarQueryParameter = {} as any;
11344
+
11345
+ // authentication oAuth2AuthCode required
11346
+ // oauth required
11347
+ await setOAuthToObject(localVarHeaderParameter, "oAuth2AuthCode", [], configuration)
11348
+
11349
+
11350
+
11351
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11352
+
11353
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
11354
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11355
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11356
+ localVarRequestOptions.data = serializeDataIfNeeded(solutionRole, localVarRequestOptions, configuration)
11357
+
11358
+ return {
11359
+ url: toPathString(localVarUrlObj),
11360
+ options: localVarRequestOptions,
11361
+ };
11362
+ },
11096
11363
  /**
11097
11364
  *
11098
11365
  * @summary Update a solution
11099
11366
  * @param {string} organizationId the Organization identifier
11100
11367
  * @param {string} solutionId the Solution identifier
11101
- * @param {Solution} solution the new Solution details.
11368
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
11102
11369
  * @param {*} [options] Override http request option.
11103
11370
  * @throws {RequiredError}
11104
11371
  */
@@ -11457,6 +11724,18 @@ export const SolutionApiFp = function(configuration?: Configuration) {
11457
11724
  const localVarAxiosArgs = await localVarAxiosParamCreator.getSolutionAccessControl(organizationId, solutionId, identityId, options);
11458
11725
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
11459
11726
  },
11727
+ /**
11728
+ *
11729
+ * @summary Get the Solution security information
11730
+ * @param {string} organizationId the Organization identifier
11731
+ * @param {string} solutionId the Solution identifier
11732
+ * @param {*} [options] Override http request option.
11733
+ * @throws {RequiredError}
11734
+ */
11735
+ async getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>> {
11736
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSolutionSecurity(organizationId, solutionId, options);
11737
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
11738
+ },
11460
11739
  /**
11461
11740
  *
11462
11741
  * @summary Get the Solution security users list
@@ -11518,12 +11797,25 @@ export const SolutionApiFp = function(configuration?: Configuration) {
11518
11797
  const localVarAxiosArgs = await localVarAxiosParamCreator.removeSolutionAccessControl(organizationId, solutionId, identityId, options);
11519
11798
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
11520
11799
  },
11800
+ /**
11801
+ *
11802
+ * @summary Set the Solution default security
11803
+ * @param {string} organizationId the Organization identifier
11804
+ * @param {string} solutionId the Solution identifier
11805
+ * @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
11806
+ * @param {*} [options] Override http request option.
11807
+ * @throws {RequiredError}
11808
+ */
11809
+ async setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>> {
11810
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setSolutionDefaultSecurity(organizationId, solutionId, solutionRole, options);
11811
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
11812
+ },
11521
11813
  /**
11522
11814
  *
11523
11815
  * @summary Update a solution
11524
11816
  * @param {string} organizationId the Organization identifier
11525
11817
  * @param {string} solutionId the Solution identifier
11526
- * @param {Solution} solution the new Solution details.
11818
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
11527
11819
  * @param {*} [options] Override http request option.
11528
11820
  * @throws {RequiredError}
11529
11821
  */
@@ -11715,6 +12007,17 @@ export const SolutionApiFactory = function (configuration?: Configuration, baseP
11715
12007
  getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<SolutionAccessControl> {
11716
12008
  return localVarFp.getSolutionAccessControl(organizationId, solutionId, identityId, options).then((request) => request(axios, basePath));
11717
12009
  },
12010
+ /**
12011
+ *
12012
+ * @summary Get the Solution security information
12013
+ * @param {string} organizationId the Organization identifier
12014
+ * @param {string} solutionId the Solution identifier
12015
+ * @param {*} [options] Override http request option.
12016
+ * @throws {RequiredError}
12017
+ */
12018
+ getSolutionSecurity(organizationId: string, solutionId: string, options?: any): AxiosPromise<SolutionSecurity> {
12019
+ return localVarFp.getSolutionSecurity(organizationId, solutionId, options).then((request) => request(axios, basePath));
12020
+ },
11718
12021
  /**
11719
12022
  *
11720
12023
  * @summary Get the Solution security users list
@@ -11771,12 +12074,24 @@ export const SolutionApiFactory = function (configuration?: Configuration, baseP
11771
12074
  removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<void> {
11772
12075
  return localVarFp.removeSolutionAccessControl(organizationId, solutionId, identityId, options).then((request) => request(axios, basePath));
11773
12076
  },
12077
+ /**
12078
+ *
12079
+ * @summary Set the Solution default security
12080
+ * @param {string} organizationId the Organization identifier
12081
+ * @param {string} solutionId the Solution identifier
12082
+ * @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
12083
+ * @param {*} [options] Override http request option.
12084
+ * @throws {RequiredError}
12085
+ */
12086
+ setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: any): AxiosPromise<SolutionSecurity> {
12087
+ return localVarFp.setSolutionDefaultSecurity(organizationId, solutionId, solutionRole, options).then((request) => request(axios, basePath));
12088
+ },
11774
12089
  /**
11775
12090
  *
11776
12091
  * @summary Update a solution
11777
12092
  * @param {string} organizationId the Organization identifier
11778
12093
  * @param {string} solutionId the Solution identifier
11779
- * @param {Solution} solution the new Solution details.
12094
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
11780
12095
  * @param {*} [options] Override http request option.
11781
12096
  * @throws {RequiredError}
11782
12097
  */
@@ -11986,6 +12301,19 @@ export class SolutionApi extends BaseAPI {
11986
12301
  return SolutionApiFp(this.configuration).getSolutionAccessControl(organizationId, solutionId, identityId, options).then((request) => request(this.axios, this.basePath));
11987
12302
  }
11988
12303
 
12304
+ /**
12305
+ *
12306
+ * @summary Get the Solution security information
12307
+ * @param {string} organizationId the Organization identifier
12308
+ * @param {string} solutionId the Solution identifier
12309
+ * @param {*} [options] Override http request option.
12310
+ * @throws {RequiredError}
12311
+ * @memberof SolutionApi
12312
+ */
12313
+ public getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig) {
12314
+ return SolutionApiFp(this.configuration).getSolutionSecurity(organizationId, solutionId, options).then((request) => request(this.axios, this.basePath));
12315
+ }
12316
+
11989
12317
  /**
11990
12318
  *
11991
12319
  * @summary Get the Solution security users list
@@ -12052,12 +12380,26 @@ export class SolutionApi extends BaseAPI {
12052
12380
  return SolutionApiFp(this.configuration).removeSolutionAccessControl(organizationId, solutionId, identityId, options).then((request) => request(this.axios, this.basePath));
12053
12381
  }
12054
12382
 
12383
+ /**
12384
+ *
12385
+ * @summary Set the Solution default security
12386
+ * @param {string} organizationId the Organization identifier
12387
+ * @param {string} solutionId the Solution identifier
12388
+ * @param {SolutionRole} solutionRole This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
12389
+ * @param {*} [options] Override http request option.
12390
+ * @throws {RequiredError}
12391
+ * @memberof SolutionApi
12392
+ */
12393
+ public setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig) {
12394
+ return SolutionApiFp(this.configuration).setSolutionDefaultSecurity(organizationId, solutionId, solutionRole, options).then((request) => request(this.axios, this.basePath));
12395
+ }
12396
+
12055
12397
  /**
12056
12398
  *
12057
12399
  * @summary Update a solution
12058
12400
  * @param {string} organizationId the Organization identifier
12059
12401
  * @param {string} solutionId the Solution identifier
12060
- * @param {Solution} solution the new Solution details.
12402
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
12061
12403
  * @param {*} [options] Override http request option.
12062
12404
  * @throws {RequiredError}
12063
12405
  * @memberof SolutionApi
@@ -12127,6 +12469,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12127
12469
  * @param {string} organizationId the Organization identifier
12128
12470
  * @param {string} graphId the Graph Identifier
12129
12471
  * @param {*} [options] Override http request option.
12472
+ * @deprecated
12130
12473
  * @throws {RequiredError}
12131
12474
  */
12132
12475
  _delete: async (organizationId: string, graphId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12170,6 +12513,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12170
12513
  * @param {string} graphId the Graph Identifier
12171
12514
  * @param {TwinGraphQuery} twinGraphQuery the query to run
12172
12515
  * @param {*} [options] Override http request option.
12516
+ * @deprecated
12173
12517
  * @throws {RequiredError}
12174
12518
  */
12175
12519
  batchQuery: async (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12219,6 +12563,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12219
12563
  * @param {TwinGraphQuery} twinGraphQuery
12220
12564
  * @param {any} body
12221
12565
  * @param {*} [options] Override http request option.
12566
+ * @deprecated
12222
12567
  * @throws {RequiredError}
12223
12568
  */
12224
12569
  batchUploadUpdate: async (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12274,6 +12619,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12274
12619
  * @param {'node' | 'relationship'} type the entity model type
12275
12620
  * @param {Array<GraphProperties>} graphProperties the entities to create
12276
12621
  * @param {*} [options] Override http request option.
12622
+ * @deprecated
12277
12623
  * @throws {RequiredError}
12278
12624
  */
12279
12625
  createEntities: async (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12325,6 +12671,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12325
12671
  * @param {string} graphId the Graph Identifier
12326
12672
  * @param {any} [body]
12327
12673
  * @param {*} [options] Override http request option.
12674
+ * @deprecated
12328
12675
  * @throws {RequiredError}
12329
12676
  */
12330
12677
  createGraph: async (organizationId: string, graphId: string, body?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12372,6 +12719,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12372
12719
  * @param {'node' | 'relationship'} type the entity model type
12373
12720
  * @param {Array<string>} ids the entities to delete
12374
12721
  * @param {*} [options] Override http request option.
12722
+ * @deprecated
12375
12723
  * @throws {RequiredError}
12376
12724
  */
12377
12725
  deleteEntities: async (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12423,6 +12771,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12423
12771
  * @param {string} organizationId the Organization identifier
12424
12772
  * @param {string} hash the Graph download identifier
12425
12773
  * @param {*} [options] Override http request option.
12774
+ * @deprecated
12426
12775
  * @throws {RequiredError}
12427
12776
  */
12428
12777
  downloadGraph: async (organizationId: string, hash: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12464,6 +12813,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12464
12813
  * @summary Return the list of all graphs stored in the organization
12465
12814
  * @param {string} organizationId the Organization identifier
12466
12815
  * @param {*} [options] Override http request option.
12816
+ * @deprecated
12467
12817
  * @throws {RequiredError}
12468
12818
  */
12469
12819
  findAllTwingraphs: async (organizationId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12505,6 +12855,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12505
12855
  * @param {'node' | 'relationship'} type the entity model type
12506
12856
  * @param {Array<string>} ids the entities to get
12507
12857
  * @param {*} [options] Override http request option.
12858
+ * @deprecated
12508
12859
  * @throws {RequiredError}
12509
12860
  */
12510
12861
  getEntities: async (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12556,6 +12907,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12556
12907
  * @param {string} organizationId the Organization identifier
12557
12908
  * @param {string} graphId the Graph Identifier
12558
12909
  * @param {*} [options] Override http request option.
12910
+ * @deprecated
12559
12911
  * @throws {RequiredError}
12560
12912
  */
12561
12913
  getGraphMetaData: async (organizationId: string, graphId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12598,6 +12950,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12598
12950
  * @param {string} organizationId the Organization identifier
12599
12951
  * @param {string} jobId the job identifier
12600
12952
  * @param {*} [options] Override http request option.
12953
+ * @deprecated
12601
12954
  * @throws {RequiredError}
12602
12955
  */
12603
12956
  jobStatus: async (organizationId: string, jobId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12641,6 +12994,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12641
12994
  * @param {string} graphId the Graph Identifier
12642
12995
  * @param {TwinGraphQuery} twinGraphQuery the query to run
12643
12996
  * @param {*} [options] Override http request option.
12997
+ * @deprecated
12644
12998
  * @throws {RequiredError}
12645
12999
  */
12646
13000
  query: async (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12690,6 +13044,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12690
13044
  * @param {'node' | 'relationship'} type the entity model type
12691
13045
  * @param {Array<GraphProperties>} graphProperties the entities to update
12692
13046
  * @param {*} [options] Override http request option.
13047
+ * @deprecated
12693
13048
  * @throws {RequiredError}
12694
13049
  */
12695
13050
  updateEntities: async (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12741,6 +13096,7 @@ export const TwingraphApiAxiosParamCreator = function (configuration?: Configura
12741
13096
  * @param {string} graphId the Graph Identifier
12742
13097
  * @param {{ [key: string]: string; }} requestBody the metaData to update
12743
13098
  * @param {*} [options] Override http request option.
13099
+ * @deprecated
12744
13100
  * @throws {RequiredError}
12745
13101
  */
12746
13102
  updateGraphMetaData: async (organizationId: string, graphId: string, requestBody: { [key: string]: string; }, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -12798,6 +13154,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12798
13154
  * @param {string} organizationId the Organization identifier
12799
13155
  * @param {string} graphId the Graph Identifier
12800
13156
  * @param {*} [options] Override http request option.
13157
+ * @deprecated
12801
13158
  * @throws {RequiredError}
12802
13159
  */
12803
13160
  async _delete(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
@@ -12811,6 +13168,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12811
13168
  * @param {string} graphId the Graph Identifier
12812
13169
  * @param {TwinGraphQuery} twinGraphQuery the query to run
12813
13170
  * @param {*} [options] Override http request option.
13171
+ * @deprecated
12814
13172
  * @throws {RequiredError}
12815
13173
  */
12816
13174
  async batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphHash>> {
@@ -12825,6 +13183,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12825
13183
  * @param {TwinGraphQuery} twinGraphQuery
12826
13184
  * @param {any} body
12827
13185
  * @param {*} [options] Override http request option.
13186
+ * @deprecated
12828
13187
  * @throws {RequiredError}
12829
13188
  */
12830
13189
  async batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphBatchResult>> {
@@ -12839,6 +13198,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12839
13198
  * @param {'node' | 'relationship'} type the entity model type
12840
13199
  * @param {Array<GraphProperties>} graphProperties the entities to create
12841
13200
  * @param {*} [options] Override http request option.
13201
+ * @deprecated
12842
13202
  * @throws {RequiredError}
12843
13203
  */
12844
13204
  async createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
@@ -12852,6 +13212,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12852
13212
  * @param {string} graphId the Graph Identifier
12853
13213
  * @param {any} [body]
12854
13214
  * @param {*} [options] Override http request option.
13215
+ * @deprecated
12855
13216
  * @throws {RequiredError}
12856
13217
  */
12857
13218
  async createGraph(organizationId: string, graphId: string, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
@@ -12866,6 +13227,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12866
13227
  * @param {'node' | 'relationship'} type the entity model type
12867
13228
  * @param {Array<string>} ids the entities to delete
12868
13229
  * @param {*} [options] Override http request option.
13230
+ * @deprecated
12869
13231
  * @throws {RequiredError}
12870
13232
  */
12871
13233
  async deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
@@ -12878,6 +13240,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12878
13240
  * @param {string} organizationId the Organization identifier
12879
13241
  * @param {string} hash the Graph download identifier
12880
13242
  * @param {*} [options] Override http request option.
13243
+ * @deprecated
12881
13244
  * @throws {RequiredError}
12882
13245
  */
12883
13246
  async downloadGraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
@@ -12889,6 +13252,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12889
13252
  * @summary Return the list of all graphs stored in the organization
12890
13253
  * @param {string} organizationId the Organization identifier
12891
13254
  * @param {*} [options] Override http request option.
13255
+ * @deprecated
12892
13256
  * @throws {RequiredError}
12893
13257
  */
12894
13258
  async findAllTwingraphs(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
@@ -12903,6 +13267,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12903
13267
  * @param {'node' | 'relationship'} type the entity model type
12904
13268
  * @param {Array<string>} ids the entities to get
12905
13269
  * @param {*} [options] Override http request option.
13270
+ * @deprecated
12906
13271
  * @throws {RequiredError}
12907
13272
  */
12908
13273
  async getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
@@ -12915,6 +13280,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12915
13280
  * @param {string} organizationId the Organization identifier
12916
13281
  * @param {string} graphId the Graph Identifier
12917
13282
  * @param {*} [options] Override http request option.
13283
+ * @deprecated
12918
13284
  * @throws {RequiredError}
12919
13285
  */
12920
13286
  async getGraphMetaData(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
@@ -12927,6 +13293,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12927
13293
  * @param {string} organizationId the Organization identifier
12928
13294
  * @param {string} jobId the job identifier
12929
13295
  * @param {*} [options] Override http request option.
13296
+ * @deprecated
12930
13297
  * @throws {RequiredError}
12931
13298
  */
12932
13299
  async jobStatus(organizationId: string, jobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
@@ -12940,6 +13307,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12940
13307
  * @param {string} graphId the Graph Identifier
12941
13308
  * @param {TwinGraphQuery} twinGraphQuery the query to run
12942
13309
  * @param {*} [options] Override http request option.
13310
+ * @deprecated
12943
13311
  * @throws {RequiredError}
12944
13312
  */
12945
13313
  async query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
@@ -12954,6 +13322,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12954
13322
  * @param {'node' | 'relationship'} type the entity model type
12955
13323
  * @param {Array<GraphProperties>} graphProperties the entities to update
12956
13324
  * @param {*} [options] Override http request option.
13325
+ * @deprecated
12957
13326
  * @throws {RequiredError}
12958
13327
  */
12959
13328
  async updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
@@ -12967,6 +13336,7 @@ export const TwingraphApiFp = function(configuration?: Configuration) {
12967
13336
  * @param {string} graphId the Graph Identifier
12968
13337
  * @param {{ [key: string]: string; }} requestBody the metaData to update
12969
13338
  * @param {*} [options] Override http request option.
13339
+ * @deprecated
12970
13340
  * @throws {RequiredError}
12971
13341
  */
12972
13342
  async updateGraphMetaData(organizationId: string, graphId: string, requestBody: { [key: string]: string; }, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
@@ -12989,6 +13359,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
12989
13359
  * @param {string} organizationId the Organization identifier
12990
13360
  * @param {string} graphId the Graph Identifier
12991
13361
  * @param {*} [options] Override http request option.
13362
+ * @deprecated
12992
13363
  * @throws {RequiredError}
12993
13364
  */
12994
13365
  _delete(organizationId: string, graphId: string, options?: any): AxiosPromise<void> {
@@ -13001,6 +13372,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13001
13372
  * @param {string} graphId the Graph Identifier
13002
13373
  * @param {TwinGraphQuery} twinGraphQuery the query to run
13003
13374
  * @param {*} [options] Override http request option.
13375
+ * @deprecated
13004
13376
  * @throws {RequiredError}
13005
13377
  */
13006
13378
  batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<TwinGraphHash> {
@@ -13014,6 +13386,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13014
13386
  * @param {TwinGraphQuery} twinGraphQuery
13015
13387
  * @param {any} body
13016
13388
  * @param {*} [options] Override http request option.
13389
+ * @deprecated
13017
13390
  * @throws {RequiredError}
13018
13391
  */
13019
13392
  batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: any): AxiosPromise<TwinGraphBatchResult> {
@@ -13027,6 +13400,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13027
13400
  * @param {'node' | 'relationship'} type the entity model type
13028
13401
  * @param {Array<GraphProperties>} graphProperties the entities to create
13029
13402
  * @param {*} [options] Override http request option.
13403
+ * @deprecated
13030
13404
  * @throws {RequiredError}
13031
13405
  */
13032
13406
  createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string> {
@@ -13039,6 +13413,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13039
13413
  * @param {string} graphId the Graph Identifier
13040
13414
  * @param {any} [body]
13041
13415
  * @param {*} [options] Override http request option.
13416
+ * @deprecated
13042
13417
  * @throws {RequiredError}
13043
13418
  */
13044
13419
  createGraph(organizationId: string, graphId: string, body?: any, options?: any): AxiosPromise<void> {
@@ -13052,6 +13427,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13052
13427
  * @param {'node' | 'relationship'} type the entity model type
13053
13428
  * @param {Array<string>} ids the entities to delete
13054
13429
  * @param {*} [options] Override http request option.
13430
+ * @deprecated
13055
13431
  * @throws {RequiredError}
13056
13432
  */
13057
13433
  deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void> {
@@ -13063,6 +13439,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13063
13439
  * @param {string} organizationId the Organization identifier
13064
13440
  * @param {string} hash the Graph download identifier
13065
13441
  * @param {*} [options] Override http request option.
13442
+ * @deprecated
13066
13443
  * @throws {RequiredError}
13067
13444
  */
13068
13445
  downloadGraph(organizationId: string, hash: string, options?: any): AxiosPromise<any> {
@@ -13073,6 +13450,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13073
13450
  * @summary Return the list of all graphs stored in the organization
13074
13451
  * @param {string} organizationId the Organization identifier
13075
13452
  * @param {*} [options] Override http request option.
13453
+ * @deprecated
13076
13454
  * @throws {RequiredError}
13077
13455
  */
13078
13456
  findAllTwingraphs(organizationId: string, options?: any): AxiosPromise<Array<string>> {
@@ -13086,6 +13464,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13086
13464
  * @param {'node' | 'relationship'} type the entity model type
13087
13465
  * @param {Array<string>} ids the entities to get
13088
13466
  * @param {*} [options] Override http request option.
13467
+ * @deprecated
13089
13468
  * @throws {RequiredError}
13090
13469
  */
13091
13470
  getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string> {
@@ -13097,6 +13476,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13097
13476
  * @param {string} organizationId the Organization identifier
13098
13477
  * @param {string} graphId the Graph Identifier
13099
13478
  * @param {*} [options] Override http request option.
13479
+ * @deprecated
13100
13480
  * @throws {RequiredError}
13101
13481
  */
13102
13482
  getGraphMetaData(organizationId: string, graphId: string, options?: any): AxiosPromise<object> {
@@ -13108,6 +13488,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13108
13488
  * @param {string} organizationId the Organization identifier
13109
13489
  * @param {string} jobId the job identifier
13110
13490
  * @param {*} [options] Override http request option.
13491
+ * @deprecated
13111
13492
  * @throws {RequiredError}
13112
13493
  */
13113
13494
  jobStatus(organizationId: string, jobId: string, options?: any): AxiosPromise<string> {
@@ -13120,6 +13501,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13120
13501
  * @param {string} graphId the Graph Identifier
13121
13502
  * @param {TwinGraphQuery} twinGraphQuery the query to run
13122
13503
  * @param {*} [options] Override http request option.
13504
+ * @deprecated
13123
13505
  * @throws {RequiredError}
13124
13506
  */
13125
13507
  query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<string> {
@@ -13133,6 +13515,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13133
13515
  * @param {'node' | 'relationship'} type the entity model type
13134
13516
  * @param {Array<GraphProperties>} graphProperties the entities to update
13135
13517
  * @param {*} [options] Override http request option.
13518
+ * @deprecated
13136
13519
  * @throws {RequiredError}
13137
13520
  */
13138
13521
  updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string> {
@@ -13145,6 +13528,7 @@ export const TwingraphApiFactory = function (configuration?: Configuration, base
13145
13528
  * @param {string} graphId the Graph Identifier
13146
13529
  * @param {{ [key: string]: string; }} requestBody the metaData to update
13147
13530
  * @param {*} [options] Override http request option.
13531
+ * @deprecated
13148
13532
  * @throws {RequiredError}
13149
13533
  */
13150
13534
  updateGraphMetaData(organizationId: string, graphId: string, requestBody: { [key: string]: string; }, options?: any): AxiosPromise<object> {
@@ -13166,6 +13550,7 @@ export class TwingraphApi extends BaseAPI {
13166
13550
  * @param {string} organizationId the Organization identifier
13167
13551
  * @param {string} graphId the Graph Identifier
13168
13552
  * @param {*} [options] Override http request option.
13553
+ * @deprecated
13169
13554
  * @throws {RequiredError}
13170
13555
  * @memberof TwingraphApi
13171
13556
  */
@@ -13180,6 +13565,7 @@ export class TwingraphApi extends BaseAPI {
13180
13565
  * @param {string} graphId the Graph Identifier
13181
13566
  * @param {TwinGraphQuery} twinGraphQuery the query to run
13182
13567
  * @param {*} [options] Override http request option.
13568
+ * @deprecated
13183
13569
  * @throws {RequiredError}
13184
13570
  * @memberof TwingraphApi
13185
13571
  */
@@ -13195,6 +13581,7 @@ export class TwingraphApi extends BaseAPI {
13195
13581
  * @param {TwinGraphQuery} twinGraphQuery
13196
13582
  * @param {any} body
13197
13583
  * @param {*} [options] Override http request option.
13584
+ * @deprecated
13198
13585
  * @throws {RequiredError}
13199
13586
  * @memberof TwingraphApi
13200
13587
  */
@@ -13210,6 +13597,7 @@ export class TwingraphApi extends BaseAPI {
13210
13597
  * @param {'node' | 'relationship'} type the entity model type
13211
13598
  * @param {Array<GraphProperties>} graphProperties the entities to create
13212
13599
  * @param {*} [options] Override http request option.
13600
+ * @deprecated
13213
13601
  * @throws {RequiredError}
13214
13602
  * @memberof TwingraphApi
13215
13603
  */
@@ -13224,6 +13612,7 @@ export class TwingraphApi extends BaseAPI {
13224
13612
  * @param {string} graphId the Graph Identifier
13225
13613
  * @param {any} [body]
13226
13614
  * @param {*} [options] Override http request option.
13615
+ * @deprecated
13227
13616
  * @throws {RequiredError}
13228
13617
  * @memberof TwingraphApi
13229
13618
  */
@@ -13239,6 +13628,7 @@ export class TwingraphApi extends BaseAPI {
13239
13628
  * @param {'node' | 'relationship'} type the entity model type
13240
13629
  * @param {Array<string>} ids the entities to delete
13241
13630
  * @param {*} [options] Override http request option.
13631
+ * @deprecated
13242
13632
  * @throws {RequiredError}
13243
13633
  * @memberof TwingraphApi
13244
13634
  */
@@ -13252,6 +13642,7 @@ export class TwingraphApi extends BaseAPI {
13252
13642
  * @param {string} organizationId the Organization identifier
13253
13643
  * @param {string} hash the Graph download identifier
13254
13644
  * @param {*} [options] Override http request option.
13645
+ * @deprecated
13255
13646
  * @throws {RequiredError}
13256
13647
  * @memberof TwingraphApi
13257
13648
  */
@@ -13264,6 +13655,7 @@ export class TwingraphApi extends BaseAPI {
13264
13655
  * @summary Return the list of all graphs stored in the organization
13265
13656
  * @param {string} organizationId the Organization identifier
13266
13657
  * @param {*} [options] Override http request option.
13658
+ * @deprecated
13267
13659
  * @throws {RequiredError}
13268
13660
  * @memberof TwingraphApi
13269
13661
  */
@@ -13279,6 +13671,7 @@ export class TwingraphApi extends BaseAPI {
13279
13671
  * @param {'node' | 'relationship'} type the entity model type
13280
13672
  * @param {Array<string>} ids the entities to get
13281
13673
  * @param {*} [options] Override http request option.
13674
+ * @deprecated
13282
13675
  * @throws {RequiredError}
13283
13676
  * @memberof TwingraphApi
13284
13677
  */
@@ -13292,6 +13685,7 @@ export class TwingraphApi extends BaseAPI {
13292
13685
  * @param {string} organizationId the Organization identifier
13293
13686
  * @param {string} graphId the Graph Identifier
13294
13687
  * @param {*} [options] Override http request option.
13688
+ * @deprecated
13295
13689
  * @throws {RequiredError}
13296
13690
  * @memberof TwingraphApi
13297
13691
  */
@@ -13305,6 +13699,7 @@ export class TwingraphApi extends BaseAPI {
13305
13699
  * @param {string} organizationId the Organization identifier
13306
13700
  * @param {string} jobId the job identifier
13307
13701
  * @param {*} [options] Override http request option.
13702
+ * @deprecated
13308
13703
  * @throws {RequiredError}
13309
13704
  * @memberof TwingraphApi
13310
13705
  */
@@ -13319,6 +13714,7 @@ export class TwingraphApi extends BaseAPI {
13319
13714
  * @param {string} graphId the Graph Identifier
13320
13715
  * @param {TwinGraphQuery} twinGraphQuery the query to run
13321
13716
  * @param {*} [options] Override http request option.
13717
+ * @deprecated
13322
13718
  * @throws {RequiredError}
13323
13719
  * @memberof TwingraphApi
13324
13720
  */
@@ -13334,6 +13730,7 @@ export class TwingraphApi extends BaseAPI {
13334
13730
  * @param {'node' | 'relationship'} type the entity model type
13335
13731
  * @param {Array<GraphProperties>} graphProperties the entities to update
13336
13732
  * @param {*} [options] Override http request option.
13733
+ * @deprecated
13337
13734
  * @throws {RequiredError}
13338
13735
  * @memberof TwingraphApi
13339
13736
  */
@@ -13348,6 +13745,7 @@ export class TwingraphApi extends BaseAPI {
13348
13745
  * @param {string} graphId the Graph Identifier
13349
13746
  * @param {{ [key: string]: string; }} requestBody the metaData to update
13350
13747
  * @param {*} [options] Override http request option.
13748
+ * @deprecated
13351
13749
  * @throws {RequiredError}
13352
13750
  * @memberof TwingraphApi
13353
13751
  */
@@ -14811,7 +15209,7 @@ export const WorkspaceApiAxiosParamCreator = function (configuration?: Configura
14811
15209
  * @summary Set the Workspace default security
14812
15210
  * @param {string} organizationId the Organization identifier
14813
15211
  * @param {string} workspaceId the Workspace identifier
14814
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
15212
+ * @param {WorkspaceRole} workspaceRole This change the workspace default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the workspace.
14815
15213
  * @param {*} [options] Override http request option.
14816
15214
  * @throws {RequiredError}
14817
15215
  */
@@ -14859,7 +15257,7 @@ export const WorkspaceApiAxiosParamCreator = function (configuration?: Configura
14859
15257
  * @summary Update a workspace
14860
15258
  * @param {string} organizationId the Organization identifier
14861
15259
  * @param {string} workspaceId the Workspace identifier
14862
- * @param {Workspace} workspace The new Workspace details.
15260
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
14863
15261
  * @param {*} [options] Override http request option.
14864
15262
  * @throws {RequiredError}
14865
15263
  */
@@ -15220,7 +15618,7 @@ export const WorkspaceApiFp = function(configuration?: Configuration) {
15220
15618
  * @summary Set the Workspace default security
15221
15619
  * @param {string} organizationId the Organization identifier
15222
15620
  * @param {string} workspaceId the Workspace identifier
15223
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
15621
+ * @param {WorkspaceRole} workspaceRole This change the workspace default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the workspace.
15224
15622
  * @param {*} [options] Override http request option.
15225
15623
  * @throws {RequiredError}
15226
15624
  */
@@ -15233,7 +15631,7 @@ export const WorkspaceApiFp = function(configuration?: Configuration) {
15233
15631
  * @summary Update a workspace
15234
15632
  * @param {string} organizationId the Organization identifier
15235
15633
  * @param {string} workspaceId the Workspace identifier
15236
- * @param {Workspace} workspace The new Workspace details.
15634
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
15237
15635
  * @param {*} [options] Override http request option.
15238
15636
  * @throws {RequiredError}
15239
15637
  */
@@ -15458,7 +15856,7 @@ export const WorkspaceApiFactory = function (configuration?: Configuration, base
15458
15856
  * @summary Set the Workspace default security
15459
15857
  * @param {string} organizationId the Organization identifier
15460
15858
  * @param {string} workspaceId the Workspace identifier
15461
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
15859
+ * @param {WorkspaceRole} workspaceRole This change the workspace default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the workspace.
15462
15860
  * @param {*} [options] Override http request option.
15463
15861
  * @throws {RequiredError}
15464
15862
  */
@@ -15470,7 +15868,7 @@ export const WorkspaceApiFactory = function (configuration?: Configuration, base
15470
15868
  * @summary Update a workspace
15471
15869
  * @param {string} organizationId the Organization identifier
15472
15870
  * @param {string} workspaceId the Workspace identifier
15473
- * @param {Workspace} workspace The new Workspace details.
15871
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
15474
15872
  * @param {*} [options] Override http request option.
15475
15873
  * @throws {RequiredError}
15476
15874
  */
@@ -15722,7 +16120,7 @@ export class WorkspaceApi extends BaseAPI {
15722
16120
  * @summary Set the Workspace default security
15723
16121
  * @param {string} organizationId the Organization identifier
15724
16122
  * @param {string} workspaceId the Workspace identifier
15725
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
16123
+ * @param {WorkspaceRole} workspaceRole This change the workspace default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the workspace.
15726
16124
  * @param {*} [options] Override http request option.
15727
16125
  * @throws {RequiredError}
15728
16126
  * @memberof WorkspaceApi
@@ -15736,7 +16134,7 @@ export class WorkspaceApi extends BaseAPI {
15736
16134
  * @summary Update a workspace
15737
16135
  * @param {string} organizationId the Organization identifier
15738
16136
  * @param {string} workspaceId the Workspace identifier
15739
- * @param {Workspace} workspace The new Workspace details.
16137
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
15740
16138
  * @param {*} [options] Override http request option.
15741
16139
  * @throws {RequiredError}
15742
16140
  * @memberof WorkspaceApi