@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/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Cosmo Tech Platform API
3
3
  * Cosmo Tech Platform API
4
4
  *
5
- * The version of the OpenAPI document: 3.0.10-private
5
+ * The version of the OpenAPI document: 3.0.14-dev
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -259,6 +259,12 @@ export interface Dataset {
259
259
  * @memberof Dataset
260
260
  */
261
261
  'ownerId'?: string;
262
+ /**
263
+ * the name of the owner
264
+ * @type {string}
265
+ * @memberof Dataset
266
+ */
267
+ 'ownerName'?: string;
262
268
  /**
263
269
  * the Organization Id related to this Dataset
264
270
  * @type {string}
@@ -827,8 +833,17 @@ export interface RunTemplate {
827
833
  * the Run Template name
828
834
  * @type {string}
829
835
  * @memberof RunTemplate
836
+ * @deprecated
830
837
  */
831
838
  'name'?: string;
839
+ /**
840
+ * a translated label with key as ISO 639-1 code
841
+ * @type {{ [key: string]: string; }}
842
+ * @memberof RunTemplate
843
+ */
844
+ 'labels'?: {
845
+ [key: string]: string;
846
+ };
832
847
  /**
833
848
  * the Run Template description
834
849
  * @type {string}
@@ -2401,6 +2416,12 @@ export interface SourceInfo {
2401
2416
  * @memberof SourceInfo
2402
2417
  */
2403
2418
  'path'?: string;
2419
+ /**
2420
+ * indicate the last import jobId
2421
+ * @type {string}
2422
+ * @memberof SourceInfo
2423
+ */
2424
+ 'jobId'?: string;
2404
2425
  }
2405
2426
  /**
2406
2427
  * a twin graph query in cypher language
@@ -3069,8 +3090,8 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3069
3090
  */
3070
3091
  addOrReplaceDatasetCompatibilityElements: (organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3071
3092
  /**
3072
- *
3073
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
3093
+ * Not implemented!
3094
+ * @summary Copy a Dataset to another Dataset.
3074
3095
  * @param {string} organizationId the Organization identifier
3075
3096
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
3076
3097
  * @param {*} [options] Override http request option.
@@ -3087,11 +3108,11 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3087
3108
  */
3088
3109
  createDataset: (organizationId: string, dataset: Dataset, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3089
3110
  /**
3090
- * Run a query on a dataset
3091
- * @summary Run a query on a dataset
3111
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
3112
+ * @summary Create a sub-dataset from the dataset in parameter
3092
3113
  * @param {string} organizationId the Organization identifier
3093
3114
  * @param {string} datasetId the Dataset identifier
3094
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
3115
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
3095
3116
  * @param {*} [options] Override http request option.
3096
3117
  * @throws {RequiredError}
3097
3118
  */
@@ -3128,8 +3149,8 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3128
3149
  */
3129
3150
  deleteTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3130
3151
  /**
3131
- * Download a graph compressed in a zip file
3132
- * @summary Download a graph compressed in a zip file
3152
+ * Download the compressed graph reference by the hash in a zip file
3153
+ * @summary Download a graph as a zip file
3133
3154
  * @param {string} organizationId the Organization identifier
3134
3155
  * @param {string} hash the Graph download identifier
3135
3156
  * @param {*} [options] Override http request option.
@@ -3165,6 +3186,15 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3165
3186
  * @throws {RequiredError}
3166
3187
  */
3167
3188
  getDatasetAccessControl: (organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3189
+ /**
3190
+ *
3191
+ * @summary Get the Dataset security information
3192
+ * @param {string} organizationId the Organization identifier
3193
+ * @param {string} datasetId the Dataset identifier
3194
+ * @param {*} [options] Override http request option.
3195
+ * @throws {RequiredError}
3196
+ */
3197
+ getDatasetSecurity: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3168
3198
  /**
3169
3199
  *
3170
3200
  * @summary Get the Dataset security users list
@@ -3175,15 +3205,14 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3175
3205
  */
3176
3206
  getDatasetSecurityUsers: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3177
3207
  /**
3178
- * Get the status of a twingraph import
3179
- * @summary Get the status of twingraph import
3208
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
3209
+ * @summary Get the dataset\'s refresh job status
3180
3210
  * @param {string} organizationId the Organization identifier
3181
3211
  * @param {string} datasetId the dataset identifier
3182
- * @param {string} jobId the job identifier
3183
3212
  * @param {*} [options] Override http request option.
3184
3213
  * @throws {RequiredError}
3185
3214
  */
3186
- getDatasetTwingraphStatus: (organizationId: string, datasetId: string, jobId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3215
+ getDatasetTwingraphStatus: (organizationId: string, datasetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3187
3216
  /**
3188
3217
  * get entities in a graph instance
3189
3218
  * @summary Get entities in a graph instance
@@ -3196,8 +3225,8 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3196
3225
  */
3197
3226
  getTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3198
3227
  /**
3199
- * Refresh ADT, Storage dataset
3200
- * @summary Refresh dataset
3228
+ * 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
3229
+ * @summary Refresh data on dataset from dataset\'s source
3201
3230
  * @param {string} organizationId the Organization identifier
3202
3231
  * @param {string} datasetId the Dataset identifier
3203
3232
  * @param {*} [options] Override http request option.
@@ -3225,7 +3254,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3225
3254
  removeDatasetAccessControl: (organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3226
3255
  /**
3227
3256
  *
3228
- * @summary Search Datasets
3257
+ * @summary Search Datasets by tags
3229
3258
  * @param {string} organizationId the Organization identifier
3230
3259
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
3231
3260
  * @param {number} [page] page number to query
@@ -3234,6 +3263,16 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3234
3263
  * @throws {RequiredError}
3235
3264
  */
3236
3265
  searchDatasets: (organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3266
+ /**
3267
+ *
3268
+ * @summary Set the Dataset default security
3269
+ * @param {string} organizationId the Organization identifier
3270
+ * @param {string} datasetId the Dataset identifier
3271
+ * @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.
3272
+ * @param {*} [options] Override http request option.
3273
+ * @throws {RequiredError}
3274
+ */
3275
+ setDatasetDefaultSecurity: (organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3237
3276
  /**
3238
3277
  * Run a query on a graph instance and return the result as a zip file in async mode
3239
3278
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -3257,7 +3296,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3257
3296
  twingraphBatchUpdate: (organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3258
3297
  /**
3259
3298
  * Run a query on a graph instance and return the result as a json
3260
- * @summary Run a query on a graph instance and return the result as a json
3299
+ * @summary Return the result of a query made on the graph instance as a json
3261
3300
  * @param {string} organizationId the Organization identifier
3262
3301
  * @param {string} datasetId the Dataset identifier
3263
3302
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -3270,7 +3309,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3270
3309
  * @summary Update a dataset
3271
3310
  * @param {string} organizationId the Organization identifier
3272
3311
  * @param {string} datasetId the Dataset identifier
3273
- * @param {Dataset} dataset the new Dataset details.
3312
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
3274
3313
  * @param {*} [options] Override http request option.
3275
3314
  * @throws {RequiredError}
3276
3315
  */
@@ -3298,8 +3337,8 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
3298
3337
  */
3299
3338
  updateTwingraphEntities: (organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3300
3339
  /**
3301
- * Upload Twingraph ZIP
3302
- * @summary Upload Twingraph with ZIP File
3340
+ * 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.
3341
+ * @summary Upload data from zip file to dataset\'s twingraph
3303
3342
  * @param {string} organizationId the Organization identifier
3304
3343
  * @param {string} datasetId the Dataset identifier
3305
3344
  * @param {any} body
@@ -3334,8 +3373,8 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3334
3373
  */
3335
3374
  addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DatasetCompatibility>>>;
3336
3375
  /**
3337
- *
3338
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
3376
+ * Not implemented!
3377
+ * @summary Copy a Dataset to another Dataset.
3339
3378
  * @param {string} organizationId the Organization identifier
3340
3379
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
3341
3380
  * @param {*} [options] Override http request option.
@@ -3352,11 +3391,11 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3352
3391
  */
3353
3392
  createDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Dataset>>;
3354
3393
  /**
3355
- * Run a query on a dataset
3356
- * @summary Run a query on a dataset
3394
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
3395
+ * @summary Create a sub-dataset from the dataset in parameter
3357
3396
  * @param {string} organizationId the Organization identifier
3358
3397
  * @param {string} datasetId the Dataset identifier
3359
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
3398
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
3360
3399
  * @param {*} [options] Override http request option.
3361
3400
  * @throws {RequiredError}
3362
3401
  */
@@ -3393,8 +3432,8 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3393
3432
  */
3394
3433
  deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3395
3434
  /**
3396
- * Download a graph compressed in a zip file
3397
- * @summary Download a graph compressed in a zip file
3435
+ * Download the compressed graph reference by the hash in a zip file
3436
+ * @summary Download a graph as a zip file
3398
3437
  * @param {string} organizationId the Organization identifier
3399
3438
  * @param {string} hash the Graph download identifier
3400
3439
  * @param {*} [options] Override http request option.
@@ -3430,6 +3469,15 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3430
3469
  * @throws {RequiredError}
3431
3470
  */
3432
3471
  getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
3472
+ /**
3473
+ *
3474
+ * @summary Get the Dataset security information
3475
+ * @param {string} organizationId the Organization identifier
3476
+ * @param {string} datasetId the Dataset identifier
3477
+ * @param {*} [options] Override http request option.
3478
+ * @throws {RequiredError}
3479
+ */
3480
+ getDatasetSecurity(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetSecurity>>;
3433
3481
  /**
3434
3482
  *
3435
3483
  * @summary Get the Dataset security users list
@@ -3440,15 +3488,14 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3440
3488
  */
3441
3489
  getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
3442
3490
  /**
3443
- * Get the status of a twingraph import
3444
- * @summary Get the status of twingraph import
3491
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
3492
+ * @summary Get the dataset\'s refresh job status
3445
3493
  * @param {string} organizationId the Organization identifier
3446
3494
  * @param {string} datasetId the dataset identifier
3447
- * @param {string} jobId the job identifier
3448
3495
  * @param {*} [options] Override http request option.
3449
3496
  * @throws {RequiredError}
3450
3497
  */
3451
- getDatasetTwingraphStatus(organizationId: string, datasetId: string, jobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
3498
+ getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
3452
3499
  /**
3453
3500
  * get entities in a graph instance
3454
3501
  * @summary Get entities in a graph instance
@@ -3461,8 +3508,8 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3461
3508
  */
3462
3509
  getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
3463
3510
  /**
3464
- * Refresh ADT, Storage dataset
3465
- * @summary Refresh dataset
3511
+ * 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
3512
+ * @summary Refresh data on dataset from dataset\'s source
3466
3513
  * @param {string} organizationId the Organization identifier
3467
3514
  * @param {string} datasetId the Dataset identifier
3468
3515
  * @param {*} [options] Override http request option.
@@ -3490,7 +3537,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3490
3537
  removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3491
3538
  /**
3492
3539
  *
3493
- * @summary Search Datasets
3540
+ * @summary Search Datasets by tags
3494
3541
  * @param {string} organizationId the Organization identifier
3495
3542
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
3496
3543
  * @param {number} [page] page number to query
@@ -3499,6 +3546,16 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3499
3546
  * @throws {RequiredError}
3500
3547
  */
3501
3548
  searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
3549
+ /**
3550
+ *
3551
+ * @summary Set the Dataset default security
3552
+ * @param {string} organizationId the Organization identifier
3553
+ * @param {string} datasetId the Dataset identifier
3554
+ * @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.
3555
+ * @param {*} [options] Override http request option.
3556
+ * @throws {RequiredError}
3557
+ */
3558
+ setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetSecurity>>;
3502
3559
  /**
3503
3560
  * Run a query on a graph instance and return the result as a zip file in async mode
3504
3561
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -3522,7 +3579,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3522
3579
  twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphBatchResult>>;
3523
3580
  /**
3524
3581
  * Run a query on a graph instance and return the result as a json
3525
- * @summary Run a query on a graph instance and return the result as a json
3582
+ * @summary Return the result of a query made on the graph instance as a json
3526
3583
  * @param {string} organizationId the Organization identifier
3527
3584
  * @param {string} datasetId the Dataset identifier
3528
3585
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -3535,7 +3592,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3535
3592
  * @summary Update a dataset
3536
3593
  * @param {string} organizationId the Organization identifier
3537
3594
  * @param {string} datasetId the Dataset identifier
3538
- * @param {Dataset} dataset the new Dataset details.
3595
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
3539
3596
  * @param {*} [options] Override http request option.
3540
3597
  * @throws {RequiredError}
3541
3598
  */
@@ -3563,8 +3620,8 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
3563
3620
  */
3564
3621
  updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
3565
3622
  /**
3566
- * Upload Twingraph ZIP
3567
- * @summary Upload Twingraph with ZIP File
3623
+ * 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.
3624
+ * @summary Upload data from zip file to dataset\'s twingraph
3568
3625
  * @param {string} organizationId the Organization identifier
3569
3626
  * @param {string} datasetId the Dataset identifier
3570
3627
  * @param {any} body
@@ -3599,8 +3656,8 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3599
3656
  */
3600
3657
  addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: any): AxiosPromise<Array<DatasetCompatibility>>;
3601
3658
  /**
3602
- *
3603
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
3659
+ * Not implemented!
3660
+ * @summary Copy a Dataset to another Dataset.
3604
3661
  * @param {string} organizationId the Organization identifier
3605
3662
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
3606
3663
  * @param {*} [options] Override http request option.
@@ -3617,11 +3674,11 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3617
3674
  */
3618
3675
  createDataset(organizationId: string, dataset: Dataset, options?: any): AxiosPromise<Dataset>;
3619
3676
  /**
3620
- * Run a query on a dataset
3621
- * @summary Run a query on a dataset
3677
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
3678
+ * @summary Create a sub-dataset from the dataset in parameter
3622
3679
  * @param {string} organizationId the Organization identifier
3623
3680
  * @param {string} datasetId the Dataset identifier
3624
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
3681
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
3625
3682
  * @param {*} [options] Override http request option.
3626
3683
  * @throws {RequiredError}
3627
3684
  */
@@ -3658,8 +3715,8 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3658
3715
  */
3659
3716
  deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
3660
3717
  /**
3661
- * Download a graph compressed in a zip file
3662
- * @summary Download a graph compressed in a zip file
3718
+ * Download the compressed graph reference by the hash in a zip file
3719
+ * @summary Download a graph as a zip file
3663
3720
  * @param {string} organizationId the Organization identifier
3664
3721
  * @param {string} hash the Graph download identifier
3665
3722
  * @param {*} [options] Override http request option.
@@ -3695,6 +3752,15 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3695
3752
  * @throws {RequiredError}
3696
3753
  */
3697
3754
  getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<DatasetAccessControl>;
3755
+ /**
3756
+ *
3757
+ * @summary Get the Dataset security information
3758
+ * @param {string} organizationId the Organization identifier
3759
+ * @param {string} datasetId the Dataset identifier
3760
+ * @param {*} [options] Override http request option.
3761
+ * @throws {RequiredError}
3762
+ */
3763
+ getDatasetSecurity(organizationId: string, datasetId: string, options?: any): AxiosPromise<DatasetSecurity>;
3698
3764
  /**
3699
3765
  *
3700
3766
  * @summary Get the Dataset security users list
@@ -3705,15 +3771,14 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3705
3771
  */
3706
3772
  getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: any): AxiosPromise<Array<string>>;
3707
3773
  /**
3708
- * Get the status of a twingraph import
3709
- * @summary Get the status of twingraph import
3774
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
3775
+ * @summary Get the dataset\'s refresh job status
3710
3776
  * @param {string} organizationId the Organization identifier
3711
3777
  * @param {string} datasetId the dataset identifier
3712
- * @param {string} jobId the job identifier
3713
3778
  * @param {*} [options] Override http request option.
3714
3779
  * @throws {RequiredError}
3715
3780
  */
3716
- getDatasetTwingraphStatus(organizationId: string, datasetId: string, jobId: string, options?: any): AxiosPromise<string>;
3781
+ getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: any): AxiosPromise<string>;
3717
3782
  /**
3718
3783
  * get entities in a graph instance
3719
3784
  * @summary Get entities in a graph instance
@@ -3726,8 +3791,8 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3726
3791
  */
3727
3792
  getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
3728
3793
  /**
3729
- * Refresh ADT, Storage dataset
3730
- * @summary Refresh dataset
3794
+ * 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
3795
+ * @summary Refresh data on dataset from dataset\'s source
3731
3796
  * @param {string} organizationId the Organization identifier
3732
3797
  * @param {string} datasetId the Dataset identifier
3733
3798
  * @param {*} [options] Override http request option.
@@ -3755,7 +3820,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3755
3820
  removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: any): AxiosPromise<void>;
3756
3821
  /**
3757
3822
  *
3758
- * @summary Search Datasets
3823
+ * @summary Search Datasets by tags
3759
3824
  * @param {string} organizationId the Organization identifier
3760
3825
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
3761
3826
  * @param {number} [page] page number to query
@@ -3764,6 +3829,16 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3764
3829
  * @throws {RequiredError}
3765
3830
  */
3766
3831
  searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: any): AxiosPromise<Array<Dataset>>;
3832
+ /**
3833
+ *
3834
+ * @summary Set the Dataset default security
3835
+ * @param {string} organizationId the Organization identifier
3836
+ * @param {string} datasetId the Dataset identifier
3837
+ * @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.
3838
+ * @param {*} [options] Override http request option.
3839
+ * @throws {RequiredError}
3840
+ */
3841
+ setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: any): AxiosPromise<DatasetSecurity>;
3767
3842
  /**
3768
3843
  * Run a query on a graph instance and return the result as a zip file in async mode
3769
3844
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -3787,7 +3862,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3787
3862
  twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: any): AxiosPromise<TwinGraphBatchResult>;
3788
3863
  /**
3789
3864
  * Run a query on a graph instance and return the result as a json
3790
- * @summary Run a query on a graph instance and return the result as a json
3865
+ * @summary Return the result of a query made on the graph instance as a json
3791
3866
  * @param {string} organizationId the Organization identifier
3792
3867
  * @param {string} datasetId the Dataset identifier
3793
3868
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -3800,7 +3875,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3800
3875
  * @summary Update a dataset
3801
3876
  * @param {string} organizationId the Organization identifier
3802
3877
  * @param {string} datasetId the Dataset identifier
3803
- * @param {Dataset} dataset the new Dataset details.
3878
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
3804
3879
  * @param {*} [options] Override http request option.
3805
3880
  * @throws {RequiredError}
3806
3881
  */
@@ -3828,8 +3903,8 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
3828
3903
  */
3829
3904
  updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
3830
3905
  /**
3831
- * Upload Twingraph ZIP
3832
- * @summary Upload Twingraph with ZIP File
3906
+ * 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.
3907
+ * @summary Upload data from zip file to dataset\'s twingraph
3833
3908
  * @param {string} organizationId the Organization identifier
3834
3909
  * @param {string} datasetId the Dataset identifier
3835
3910
  * @param {any} body
@@ -3868,8 +3943,8 @@ export declare class DatasetApi extends BaseAPI {
3868
3943
  */
3869
3944
  addOrReplaceDatasetCompatibilityElements(organizationId: string, datasetId: string, datasetCompatibility: Array<DatasetCompatibility>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetCompatibility[]>>;
3870
3945
  /**
3871
- *
3872
- * @summary Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
3946
+ * Not implemented!
3947
+ * @summary Copy a Dataset to another Dataset.
3873
3948
  * @param {string} organizationId the Organization identifier
3874
3949
  * @param {DatasetCopyParameters} datasetCopyParameters the Dataset copy parameters
3875
3950
  * @param {*} [options] Override http request option.
@@ -3888,11 +3963,11 @@ export declare class DatasetApi extends BaseAPI {
3888
3963
  */
3889
3964
  createDataset(organizationId: string, dataset: Dataset, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset>>;
3890
3965
  /**
3891
- * Run a query on a dataset
3892
- * @summary Run a query on a dataset
3966
+ * Create a copy of the dataset using the results of the list of queries given in parameter.
3967
+ * @summary Create a sub-dataset from the dataset in parameter
3893
3968
  * @param {string} organizationId the Organization identifier
3894
3969
  * @param {string} datasetId the Dataset identifier
3895
- * @param {SubDatasetGraphQuery} subDatasetGraphQuery the query to run
3970
+ * @param {SubDatasetGraphQuery} subDatasetGraphQuery the Cypher query to filter
3896
3971
  * @param {*} [options] Override http request option.
3897
3972
  * @throws {RequiredError}
3898
3973
  * @memberof DatasetApi
@@ -3933,8 +4008,8 @@ export declare class DatasetApi extends BaseAPI {
3933
4008
  */
3934
4009
  deleteTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3935
4010
  /**
3936
- * Download a graph compressed in a zip file
3937
- * @summary Download a graph compressed in a zip file
4011
+ * Download the compressed graph reference by the hash in a zip file
4012
+ * @summary Download a graph as a zip file
3938
4013
  * @param {string} organizationId the Organization identifier
3939
4014
  * @param {string} hash the Graph download identifier
3940
4015
  * @param {*} [options] Override http request option.
@@ -3974,6 +4049,16 @@ export declare class DatasetApi extends BaseAPI {
3974
4049
  * @memberof DatasetApi
3975
4050
  */
3976
4051
  getDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl>>;
4052
+ /**
4053
+ *
4054
+ * @summary Get the Dataset security information
4055
+ * @param {string} organizationId the Organization identifier
4056
+ * @param {string} datasetId the Dataset identifier
4057
+ * @param {*} [options] Override http request option.
4058
+ * @throws {RequiredError}
4059
+ * @memberof DatasetApi
4060
+ */
4061
+ getDatasetSecurity(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetSecurity>>;
3977
4062
  /**
3978
4063
  *
3979
4064
  * @summary Get the Dataset security users list
@@ -3985,16 +4070,15 @@ export declare class DatasetApi extends BaseAPI {
3985
4070
  */
3986
4071
  getDatasetSecurityUsers(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
3987
4072
  /**
3988
- * Get the status of a twingraph import
3989
- * @summary Get the status of twingraph import
4073
+ * Get the status of the import workflow lauch on the dataset\'s refresh.
4074
+ * @summary Get the dataset\'s refresh job status
3990
4075
  * @param {string} organizationId the Organization identifier
3991
4076
  * @param {string} datasetId the dataset identifier
3992
- * @param {string} jobId the job identifier
3993
4077
  * @param {*} [options] Override http request option.
3994
4078
  * @throws {RequiredError}
3995
4079
  * @memberof DatasetApi
3996
4080
  */
3997
- getDatasetTwingraphStatus(organizationId: string, datasetId: string, jobId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
4081
+ getDatasetTwingraphStatus(organizationId: string, datasetId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
3998
4082
  /**
3999
4083
  * get entities in a graph instance
4000
4084
  * @summary Get entities in a graph instance
@@ -4008,8 +4092,8 @@ export declare class DatasetApi extends BaseAPI {
4008
4092
  */
4009
4093
  getTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
4010
4094
  /**
4011
- * Refresh ADT, Storage dataset
4012
- * @summary Refresh dataset
4095
+ * 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
4096
+ * @summary Refresh data on dataset from dataset\'s source
4013
4097
  * @param {string} organizationId the Organization identifier
4014
4098
  * @param {string} datasetId the Dataset identifier
4015
4099
  * @param {*} [options] Override http request option.
@@ -4040,7 +4124,7 @@ export declare class DatasetApi extends BaseAPI {
4040
4124
  removeDatasetAccessControl(organizationId: string, datasetId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4041
4125
  /**
4042
4126
  *
4043
- * @summary Search Datasets
4127
+ * @summary Search Datasets by tags
4044
4128
  * @param {string} organizationId the Organization identifier
4045
4129
  * @param {DatasetSearch} datasetSearch the Dataset search parameters
4046
4130
  * @param {number} [page] page number to query
@@ -4050,6 +4134,17 @@ export declare class DatasetApi extends BaseAPI {
4050
4134
  * @memberof DatasetApi
4051
4135
  */
4052
4136
  searchDatasets(organizationId: string, datasetSearch: DatasetSearch, page?: number, size?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[]>>;
4137
+ /**
4138
+ *
4139
+ * @summary Set the Dataset default security
4140
+ * @param {string} organizationId the Organization identifier
4141
+ * @param {string} datasetId the Dataset identifier
4142
+ * @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.
4143
+ * @param {*} [options] Override http request option.
4144
+ * @throws {RequiredError}
4145
+ * @memberof DatasetApi
4146
+ */
4147
+ setDatasetDefaultSecurity(organizationId: string, datasetId: string, datasetRole: DatasetRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetSecurity>>;
4053
4148
  /**
4054
4149
  * Run a query on a graph instance and return the result as a zip file in async mode
4055
4150
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
@@ -4075,7 +4170,7 @@ export declare class DatasetApi extends BaseAPI {
4075
4170
  twingraphBatchUpdate(organizationId: string, datasetId: string, twinGraphQuery: DatasetTwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TwinGraphBatchResult>>;
4076
4171
  /**
4077
4172
  * Run a query on a graph instance and return the result as a json
4078
- * @summary Run a query on a graph instance and return the result as a json
4173
+ * @summary Return the result of a query made on the graph instance as a json
4079
4174
  * @param {string} organizationId the Organization identifier
4080
4175
  * @param {string} datasetId the Dataset identifier
4081
4176
  * @param {DatasetTwinGraphQuery} datasetTwinGraphQuery the query to run
@@ -4089,7 +4184,7 @@ export declare class DatasetApi extends BaseAPI {
4089
4184
  * @summary Update a dataset
4090
4185
  * @param {string} organizationId the Organization identifier
4091
4186
  * @param {string} datasetId the Dataset identifier
4092
- * @param {Dataset} dataset the new Dataset details.
4187
+ * @param {Dataset} dataset the new Dataset details. This endpoint can\&#39;t be used to update security
4093
4188
  * @param {*} [options] Override http request option.
4094
4189
  * @throws {RequiredError}
4095
4190
  * @memberof DatasetApi
@@ -4120,8 +4215,8 @@ export declare class DatasetApi extends BaseAPI {
4120
4215
  */
4121
4216
  updateTwingraphEntities(organizationId: string, datasetId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string>>;
4122
4217
  /**
4123
- * Upload Twingraph ZIP
4124
- * @summary Upload Twingraph with ZIP File
4218
+ * 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.
4219
+ * @summary Upload data from zip file to dataset\'s twingraph
4125
4220
  * @param {string} organizationId the Organization identifier
4126
4221
  * @param {string} datasetId the Dataset identifier
4127
4222
  * @param {any} body
@@ -4224,7 +4319,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
4224
4319
  *
4225
4320
  * @summary Set the Organization default security
4226
4321
  * @param {string} organizationId the Organization identifier
4227
- * @param {OrganizationRole} organizationRole the new Organization default security.
4322
+ * @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.
4228
4323
  * @param {*} [options] Override http request option.
4229
4324
  * @throws {RequiredError}
4230
4325
  */
@@ -4241,7 +4336,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
4241
4336
  *
4242
4337
  * @summary Update an Organization
4243
4338
  * @param {string} organizationId the Organization identifier
4244
- * @param {Organization} organization the new Organization details
4339
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
4245
4340
  * @param {*} [options] Override http request option.
4246
4341
  * @throws {RequiredError}
4247
4342
  */
@@ -4379,7 +4474,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
4379
4474
  *
4380
4475
  * @summary Set the Organization default security
4381
4476
  * @param {string} organizationId the Organization identifier
4382
- * @param {OrganizationRole} organizationRole the new Organization default security.
4477
+ * @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.
4383
4478
  * @param {*} [options] Override http request option.
4384
4479
  * @throws {RequiredError}
4385
4480
  */
@@ -4396,7 +4491,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
4396
4491
  *
4397
4492
  * @summary Update an Organization
4398
4493
  * @param {string} organizationId the Organization identifier
4399
- * @param {Organization} organization the new Organization details
4494
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
4400
4495
  * @param {*} [options] Override http request option.
4401
4496
  * @throws {RequiredError}
4402
4497
  */
@@ -4536,7 +4631,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
4536
4631
  *
4537
4632
  * @summary Set the Organization default security
4538
4633
  * @param {string} organizationId the Organization identifier
4539
- * @param {OrganizationRole} organizationRole the new Organization default security.
4634
+ * @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.
4540
4635
  * @param {*} [options] Override http request option.
4541
4636
  * @throws {RequiredError}
4542
4637
  */
@@ -4553,7 +4648,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
4553
4648
  *
4554
4649
  * @summary Update an Organization
4555
4650
  * @param {string} organizationId the Organization identifier
4556
- * @param {Organization} organization the new Organization details
4651
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
4557
4652
  * @param {*} [options] Override http request option.
4558
4653
  * @throws {RequiredError}
4559
4654
  */
@@ -4705,7 +4800,7 @@ export declare class OrganizationApi extends BaseAPI {
4705
4800
  *
4706
4801
  * @summary Set the Organization default security
4707
4802
  * @param {string} organizationId the Organization identifier
4708
- * @param {OrganizationRole} organizationRole the new Organization default security.
4803
+ * @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.
4709
4804
  * @param {*} [options] Override http request option.
4710
4805
  * @throws {RequiredError}
4711
4806
  * @memberof OrganizationApi
@@ -4724,7 +4819,7 @@ export declare class OrganizationApi extends BaseAPI {
4724
4819
  *
4725
4820
  * @summary Update an Organization
4726
4821
  * @param {string} organizationId the Organization identifier
4727
- * @param {Organization} organization the new Organization details
4822
+ * @param {Organization} organization the new Organization details. This endpoint can\&#39;t be used to update security
4728
4823
  * @param {*} [options] Override http request option.
4729
4824
  * @throws {RequiredError}
4730
4825
  * @memberof OrganizationApi
@@ -4985,7 +5080,7 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
4985
5080
  * @param {string} organizationId the Organization identifier
4986
5081
  * @param {string} workspaceId the Workspace identifier
4987
5082
  * @param {string} scenarioId the Scenario identifier
4988
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
5083
+ * @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.
4989
5084
  * @param {*} [options] Override http request option.
4990
5085
  * @throws {RequiredError}
4991
5086
  */
@@ -4996,7 +5091,7 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
4996
5091
  * @param {string} organizationId the Organization identifier
4997
5092
  * @param {string} workspaceId the Workspace identifier
4998
5093
  * @param {string} scenarioId the Scenario identifier
4999
- * @param {Scenario} scenario the new Scenario details.
5094
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
5000
5095
  * @param {*} [options] Override http request option.
5001
5096
  * @throws {RequiredError}
5002
5097
  */
@@ -5223,7 +5318,7 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
5223
5318
  * @param {string} organizationId the Organization identifier
5224
5319
  * @param {string} workspaceId the Workspace identifier
5225
5320
  * @param {string} scenarioId the Scenario identifier
5226
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
5321
+ * @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.
5227
5322
  * @param {*} [options] Override http request option.
5228
5323
  * @throws {RequiredError}
5229
5324
  */
@@ -5234,7 +5329,7 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
5234
5329
  * @param {string} organizationId the Organization identifier
5235
5330
  * @param {string} workspaceId the Workspace identifier
5236
5331
  * @param {string} scenarioId the Scenario identifier
5237
- * @param {Scenario} scenario the new Scenario details.
5332
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
5238
5333
  * @param {*} [options] Override http request option.
5239
5334
  * @throws {RequiredError}
5240
5335
  */
@@ -5461,7 +5556,7 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
5461
5556
  * @param {string} organizationId the Organization identifier
5462
5557
  * @param {string} workspaceId the Workspace identifier
5463
5558
  * @param {string} scenarioId the Scenario identifier
5464
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
5559
+ * @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.
5465
5560
  * @param {*} [options] Override http request option.
5466
5561
  * @throws {RequiredError}
5467
5562
  */
@@ -5472,7 +5567,7 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
5472
5567
  * @param {string} organizationId the Organization identifier
5473
5568
  * @param {string} workspaceId the Workspace identifier
5474
5569
  * @param {string} scenarioId the Scenario identifier
5475
- * @param {Scenario} scenario the new Scenario details.
5570
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
5476
5571
  * @param {*} [options] Override http request option.
5477
5572
  * @throws {RequiredError}
5478
5573
  */
@@ -5720,7 +5815,7 @@ export declare class ScenarioApi extends BaseAPI {
5720
5815
  * @param {string} organizationId the Organization identifier
5721
5816
  * @param {string} workspaceId the Workspace identifier
5722
5817
  * @param {string} scenarioId the Scenario identifier
5723
- * @param {ScenarioRole} scenarioRole the new Scenario default security.
5818
+ * @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.
5724
5819
  * @param {*} [options] Override http request option.
5725
5820
  * @throws {RequiredError}
5726
5821
  * @memberof ScenarioApi
@@ -5732,7 +5827,7 @@ export declare class ScenarioApi extends BaseAPI {
5732
5827
  * @param {string} organizationId the Organization identifier
5733
5828
  * @param {string} workspaceId the Workspace identifier
5734
5829
  * @param {string} scenarioId the Scenario identifier
5735
- * @param {Scenario} scenario the new Scenario details.
5830
+ * @param {Scenario} scenario the new Scenario details. This endpoint can\&#39;t be used to update security
5736
5831
  * @param {*} [options] Override http request option.
5737
5832
  * @throws {RequiredError}
5738
5833
  * @memberof ScenarioApi
@@ -6589,6 +6684,15 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
6589
6684
  * @throws {RequiredError}
6590
6685
  */
6591
6686
  getSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6687
+ /**
6688
+ *
6689
+ * @summary Get the Solution security information
6690
+ * @param {string} organizationId the Organization identifier
6691
+ * @param {string} solutionId the Solution identifier
6692
+ * @param {*} [options] Override http request option.
6693
+ * @throws {RequiredError}
6694
+ */
6695
+ getSolutionSecurity: (organizationId: string, solutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6592
6696
  /**
6593
6697
  *
6594
6698
  * @summary Get the Solution security users list
@@ -6635,12 +6739,22 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
6635
6739
  * @throws {RequiredError}
6636
6740
  */
6637
6741
  removeSolutionAccessControl: (organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6742
+ /**
6743
+ *
6744
+ * @summary Set the Solution default security
6745
+ * @param {string} organizationId the Organization identifier
6746
+ * @param {string} solutionId the Solution identifier
6747
+ * @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.
6748
+ * @param {*} [options] Override http request option.
6749
+ * @throws {RequiredError}
6750
+ */
6751
+ setSolutionDefaultSecurity: (organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6638
6752
  /**
6639
6753
  *
6640
6754
  * @summary Update a solution
6641
6755
  * @param {string} organizationId the Organization identifier
6642
6756
  * @param {string} solutionId the Solution identifier
6643
- * @param {Solution} solution the new Solution details.
6757
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
6644
6758
  * @param {*} [options] Override http request option.
6645
6759
  * @throws {RequiredError}
6646
6760
  */
@@ -6794,6 +6908,15 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
6794
6908
  * @throws {RequiredError}
6795
6909
  */
6796
6910
  getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionAccessControl>>;
6911
+ /**
6912
+ *
6913
+ * @summary Get the Solution security information
6914
+ * @param {string} organizationId the Organization identifier
6915
+ * @param {string} solutionId the Solution identifier
6916
+ * @param {*} [options] Override http request option.
6917
+ * @throws {RequiredError}
6918
+ */
6919
+ getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>>;
6797
6920
  /**
6798
6921
  *
6799
6922
  * @summary Get the Solution security users list
@@ -6840,12 +6963,22 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
6840
6963
  * @throws {RequiredError}
6841
6964
  */
6842
6965
  removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6966
+ /**
6967
+ *
6968
+ * @summary Set the Solution default security
6969
+ * @param {string} organizationId the Organization identifier
6970
+ * @param {string} solutionId the Solution identifier
6971
+ * @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.
6972
+ * @param {*} [options] Override http request option.
6973
+ * @throws {RequiredError}
6974
+ */
6975
+ setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SolutionSecurity>>;
6843
6976
  /**
6844
6977
  *
6845
6978
  * @summary Update a solution
6846
6979
  * @param {string} organizationId the Organization identifier
6847
6980
  * @param {string} solutionId the Solution identifier
6848
- * @param {Solution} solution the new Solution details.
6981
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
6849
6982
  * @param {*} [options] Override http request option.
6850
6983
  * @throws {RequiredError}
6851
6984
  */
@@ -6999,6 +7132,15 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
6999
7132
  * @throws {RequiredError}
7000
7133
  */
7001
7134
  getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<SolutionAccessControl>;
7135
+ /**
7136
+ *
7137
+ * @summary Get the Solution security information
7138
+ * @param {string} organizationId the Organization identifier
7139
+ * @param {string} solutionId the Solution identifier
7140
+ * @param {*} [options] Override http request option.
7141
+ * @throws {RequiredError}
7142
+ */
7143
+ getSolutionSecurity(organizationId: string, solutionId: string, options?: any): AxiosPromise<SolutionSecurity>;
7002
7144
  /**
7003
7145
  *
7004
7146
  * @summary Get the Solution security users list
@@ -7045,12 +7187,22 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
7045
7187
  * @throws {RequiredError}
7046
7188
  */
7047
7189
  removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: any): AxiosPromise<void>;
7190
+ /**
7191
+ *
7192
+ * @summary Set the Solution default security
7193
+ * @param {string} organizationId the Organization identifier
7194
+ * @param {string} solutionId the Solution identifier
7195
+ * @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.
7196
+ * @param {*} [options] Override http request option.
7197
+ * @throws {RequiredError}
7198
+ */
7199
+ setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: any): AxiosPromise<SolutionSecurity>;
7048
7200
  /**
7049
7201
  *
7050
7202
  * @summary Update a solution
7051
7203
  * @param {string} organizationId the Organization identifier
7052
7204
  * @param {string} solutionId the Solution identifier
7053
- * @param {Solution} solution the new Solution details.
7205
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
7054
7206
  * @param {*} [options] Override http request option.
7055
7207
  * @throws {RequiredError}
7056
7208
  */
@@ -7217,6 +7369,16 @@ export declare class SolutionApi extends BaseAPI {
7217
7369
  * @memberof SolutionApi
7218
7370
  */
7219
7371
  getSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionAccessControl>>;
7372
+ /**
7373
+ *
7374
+ * @summary Get the Solution security information
7375
+ * @param {string} organizationId the Organization identifier
7376
+ * @param {string} solutionId the Solution identifier
7377
+ * @param {*} [options] Override http request option.
7378
+ * @throws {RequiredError}
7379
+ * @memberof SolutionApi
7380
+ */
7381
+ getSolutionSecurity(organizationId: string, solutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity>>;
7220
7382
  /**
7221
7383
  *
7222
7384
  * @summary Get the Solution security users list
@@ -7268,12 +7430,23 @@ export declare class SolutionApi extends BaseAPI {
7268
7430
  * @memberof SolutionApi
7269
7431
  */
7270
7432
  removeSolutionAccessControl(organizationId: string, solutionId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
7433
+ /**
7434
+ *
7435
+ * @summary Set the Solution default security
7436
+ * @param {string} organizationId the Organization identifier
7437
+ * @param {string} solutionId the Solution identifier
7438
+ * @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.
7439
+ * @param {*} [options] Override http request option.
7440
+ * @throws {RequiredError}
7441
+ * @memberof SolutionApi
7442
+ */
7443
+ setSolutionDefaultSecurity(organizationId: string, solutionId: string, solutionRole: SolutionRole, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SolutionSecurity>>;
7271
7444
  /**
7272
7445
  *
7273
7446
  * @summary Update a solution
7274
7447
  * @param {string} organizationId the Organization identifier
7275
7448
  * @param {string} solutionId the Solution identifier
7276
- * @param {Solution} solution the new Solution details.
7449
+ * @param {Solution} solution the new Solution details. This endpoint can\&#39;t be used to update security
7277
7450
  * @param {*} [options] Override http request option.
7278
7451
  * @throws {RequiredError}
7279
7452
  * @memberof SolutionApi
@@ -7329,6 +7502,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7329
7502
  * @param {string} organizationId the Organization identifier
7330
7503
  * @param {string} graphId the Graph Identifier
7331
7504
  * @param {*} [options] Override http request option.
7505
+ * @deprecated
7332
7506
  * @throws {RequiredError}
7333
7507
  */
7334
7508
  _delete: (organizationId: string, graphId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7339,6 +7513,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7339
7513
  * @param {string} graphId the Graph Identifier
7340
7514
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7341
7515
  * @param {*} [options] Override http request option.
7516
+ * @deprecated
7342
7517
  * @throws {RequiredError}
7343
7518
  */
7344
7519
  batchQuery: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7350,6 +7525,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7350
7525
  * @param {TwinGraphQuery} twinGraphQuery
7351
7526
  * @param {any} body
7352
7527
  * @param {*} [options] Override http request option.
7528
+ * @deprecated
7353
7529
  * @throws {RequiredError}
7354
7530
  */
7355
7531
  batchUploadUpdate: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7361,6 +7537,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7361
7537
  * @param {'node' | 'relationship'} type the entity model type
7362
7538
  * @param {Array<GraphProperties>} graphProperties the entities to create
7363
7539
  * @param {*} [options] Override http request option.
7540
+ * @deprecated
7364
7541
  * @throws {RequiredError}
7365
7542
  */
7366
7543
  createEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7371,6 +7548,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7371
7548
  * @param {string} graphId the Graph Identifier
7372
7549
  * @param {any} [body]
7373
7550
  * @param {*} [options] Override http request option.
7551
+ * @deprecated
7374
7552
  * @throws {RequiredError}
7375
7553
  */
7376
7554
  createGraph: (organizationId: string, graphId: string, body?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7382,6 +7560,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7382
7560
  * @param {'node' | 'relationship'} type the entity model type
7383
7561
  * @param {Array<string>} ids the entities to delete
7384
7562
  * @param {*} [options] Override http request option.
7563
+ * @deprecated
7385
7564
  * @throws {RequiredError}
7386
7565
  */
7387
7566
  deleteEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7391,6 +7570,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7391
7570
  * @param {string} organizationId the Organization identifier
7392
7571
  * @param {string} hash the Graph download identifier
7393
7572
  * @param {*} [options] Override http request option.
7573
+ * @deprecated
7394
7574
  * @throws {RequiredError}
7395
7575
  */
7396
7576
  downloadGraph: (organizationId: string, hash: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7399,6 +7579,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7399
7579
  * @summary Return the list of all graphs stored in the organization
7400
7580
  * @param {string} organizationId the Organization identifier
7401
7581
  * @param {*} [options] Override http request option.
7582
+ * @deprecated
7402
7583
  * @throws {RequiredError}
7403
7584
  */
7404
7585
  findAllTwingraphs: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7410,6 +7591,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7410
7591
  * @param {'node' | 'relationship'} type the entity model type
7411
7592
  * @param {Array<string>} ids the entities to get
7412
7593
  * @param {*} [options] Override http request option.
7594
+ * @deprecated
7413
7595
  * @throws {RequiredError}
7414
7596
  */
7415
7597
  getEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7419,6 +7601,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7419
7601
  * @param {string} organizationId the Organization identifier
7420
7602
  * @param {string} graphId the Graph Identifier
7421
7603
  * @param {*} [options] Override http request option.
7604
+ * @deprecated
7422
7605
  * @throws {RequiredError}
7423
7606
  */
7424
7607
  getGraphMetaData: (organizationId: string, graphId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7428,6 +7611,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7428
7611
  * @param {string} organizationId the Organization identifier
7429
7612
  * @param {string} jobId the job identifier
7430
7613
  * @param {*} [options] Override http request option.
7614
+ * @deprecated
7431
7615
  * @throws {RequiredError}
7432
7616
  */
7433
7617
  jobStatus: (organizationId: string, jobId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7438,6 +7622,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7438
7622
  * @param {string} graphId the Graph Identifier
7439
7623
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7440
7624
  * @param {*} [options] Override http request option.
7625
+ * @deprecated
7441
7626
  * @throws {RequiredError}
7442
7627
  */
7443
7628
  query: (organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7449,6 +7634,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7449
7634
  * @param {'node' | 'relationship'} type the entity model type
7450
7635
  * @param {Array<GraphProperties>} graphProperties the entities to update
7451
7636
  * @param {*} [options] Override http request option.
7637
+ * @deprecated
7452
7638
  * @throws {RequiredError}
7453
7639
  */
7454
7640
  updateEntities: (organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -7459,6 +7645,7 @@ export declare const TwingraphApiAxiosParamCreator: (configuration?: Configurati
7459
7645
  * @param {string} graphId the Graph Identifier
7460
7646
  * @param {{ [key: string]: string; }} requestBody the metaData to update
7461
7647
  * @param {*} [options] Override http request option.
7648
+ * @deprecated
7462
7649
  * @throws {RequiredError}
7463
7650
  */
7464
7651
  updateGraphMetaData: (organizationId: string, graphId: string, requestBody: {
@@ -7476,6 +7663,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7476
7663
  * @param {string} organizationId the Organization identifier
7477
7664
  * @param {string} graphId the Graph Identifier
7478
7665
  * @param {*} [options] Override http request option.
7666
+ * @deprecated
7479
7667
  * @throws {RequiredError}
7480
7668
  */
7481
7669
  _delete(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
@@ -7486,6 +7674,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7486
7674
  * @param {string} graphId the Graph Identifier
7487
7675
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7488
7676
  * @param {*} [options] Override http request option.
7677
+ * @deprecated
7489
7678
  * @throws {RequiredError}
7490
7679
  */
7491
7680
  batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphHash>>;
@@ -7497,6 +7686,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7497
7686
  * @param {TwinGraphQuery} twinGraphQuery
7498
7687
  * @param {any} body
7499
7688
  * @param {*} [options] Override http request option.
7689
+ * @deprecated
7500
7690
  * @throws {RequiredError}
7501
7691
  */
7502
7692
  batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TwinGraphBatchResult>>;
@@ -7508,6 +7698,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7508
7698
  * @param {'node' | 'relationship'} type the entity model type
7509
7699
  * @param {Array<GraphProperties>} graphProperties the entities to create
7510
7700
  * @param {*} [options] Override http request option.
7701
+ * @deprecated
7511
7702
  * @throws {RequiredError}
7512
7703
  */
7513
7704
  createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
@@ -7518,6 +7709,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7518
7709
  * @param {string} graphId the Graph Identifier
7519
7710
  * @param {any} [body]
7520
7711
  * @param {*} [options] Override http request option.
7712
+ * @deprecated
7521
7713
  * @throws {RequiredError}
7522
7714
  */
7523
7715
  createGraph(organizationId: string, graphId: string, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
@@ -7529,6 +7721,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7529
7721
  * @param {'node' | 'relationship'} type the entity model type
7530
7722
  * @param {Array<string>} ids the entities to delete
7531
7723
  * @param {*} [options] Override http request option.
7724
+ * @deprecated
7532
7725
  * @throws {RequiredError}
7533
7726
  */
7534
7727
  deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
@@ -7538,6 +7731,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7538
7731
  * @param {string} organizationId the Organization identifier
7539
7732
  * @param {string} hash the Graph download identifier
7540
7733
  * @param {*} [options] Override http request option.
7734
+ * @deprecated
7541
7735
  * @throws {RequiredError}
7542
7736
  */
7543
7737
  downloadGraph(organizationId: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
@@ -7546,6 +7740,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7546
7740
  * @summary Return the list of all graphs stored in the organization
7547
7741
  * @param {string} organizationId the Organization identifier
7548
7742
  * @param {*} [options] Override http request option.
7743
+ * @deprecated
7549
7744
  * @throws {RequiredError}
7550
7745
  */
7551
7746
  findAllTwingraphs(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
@@ -7557,6 +7752,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7557
7752
  * @param {'node' | 'relationship'} type the entity model type
7558
7753
  * @param {Array<string>} ids the entities to get
7559
7754
  * @param {*} [options] Override http request option.
7755
+ * @deprecated
7560
7756
  * @throws {RequiredError}
7561
7757
  */
7562
7758
  getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
@@ -7566,6 +7762,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7566
7762
  * @param {string} organizationId the Organization identifier
7567
7763
  * @param {string} graphId the Graph Identifier
7568
7764
  * @param {*} [options] Override http request option.
7765
+ * @deprecated
7569
7766
  * @throws {RequiredError}
7570
7767
  */
7571
7768
  getGraphMetaData(organizationId: string, graphId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
@@ -7575,6 +7772,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7575
7772
  * @param {string} organizationId the Organization identifier
7576
7773
  * @param {string} jobId the job identifier
7577
7774
  * @param {*} [options] Override http request option.
7775
+ * @deprecated
7578
7776
  * @throws {RequiredError}
7579
7777
  */
7580
7778
  jobStatus(organizationId: string, jobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
@@ -7585,6 +7783,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7585
7783
  * @param {string} graphId the Graph Identifier
7586
7784
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7587
7785
  * @param {*} [options] Override http request option.
7786
+ * @deprecated
7588
7787
  * @throws {RequiredError}
7589
7788
  */
7590
7789
  query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
@@ -7596,6 +7795,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7596
7795
  * @param {'node' | 'relationship'} type the entity model type
7597
7796
  * @param {Array<GraphProperties>} graphProperties the entities to update
7598
7797
  * @param {*} [options] Override http request option.
7798
+ * @deprecated
7599
7799
  * @throws {RequiredError}
7600
7800
  */
7601
7801
  updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
@@ -7606,6 +7806,7 @@ export declare const TwingraphApiFp: (configuration?: Configuration) => {
7606
7806
  * @param {string} graphId the Graph Identifier
7607
7807
  * @param {{ [key: string]: string; }} requestBody the metaData to update
7608
7808
  * @param {*} [options] Override http request option.
7809
+ * @deprecated
7609
7810
  * @throws {RequiredError}
7610
7811
  */
7611
7812
  updateGraphMetaData(organizationId: string, graphId: string, requestBody: {
@@ -7623,6 +7824,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7623
7824
  * @param {string} organizationId the Organization identifier
7624
7825
  * @param {string} graphId the Graph Identifier
7625
7826
  * @param {*} [options] Override http request option.
7827
+ * @deprecated
7626
7828
  * @throws {RequiredError}
7627
7829
  */
7628
7830
  _delete(organizationId: string, graphId: string, options?: any): AxiosPromise<void>;
@@ -7633,6 +7835,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7633
7835
  * @param {string} graphId the Graph Identifier
7634
7836
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7635
7837
  * @param {*} [options] Override http request option.
7838
+ * @deprecated
7636
7839
  * @throws {RequiredError}
7637
7840
  */
7638
7841
  batchQuery(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<TwinGraphHash>;
@@ -7644,6 +7847,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7644
7847
  * @param {TwinGraphQuery} twinGraphQuery
7645
7848
  * @param {any} body
7646
7849
  * @param {*} [options] Override http request option.
7850
+ * @deprecated
7647
7851
  * @throws {RequiredError}
7648
7852
  */
7649
7853
  batchUploadUpdate(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, body: any, options?: any): AxiosPromise<TwinGraphBatchResult>;
@@ -7655,6 +7859,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7655
7859
  * @param {'node' | 'relationship'} type the entity model type
7656
7860
  * @param {Array<GraphProperties>} graphProperties the entities to create
7657
7861
  * @param {*} [options] Override http request option.
7862
+ * @deprecated
7658
7863
  * @throws {RequiredError}
7659
7864
  */
7660
7865
  createEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
@@ -7665,6 +7870,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7665
7870
  * @param {string} graphId the Graph Identifier
7666
7871
  * @param {any} [body]
7667
7872
  * @param {*} [options] Override http request option.
7873
+ * @deprecated
7668
7874
  * @throws {RequiredError}
7669
7875
  */
7670
7876
  createGraph(organizationId: string, graphId: string, body?: any, options?: any): AxiosPromise<void>;
@@ -7676,6 +7882,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7676
7882
  * @param {'node' | 'relationship'} type the entity model type
7677
7883
  * @param {Array<string>} ids the entities to delete
7678
7884
  * @param {*} [options] Override http request option.
7885
+ * @deprecated
7679
7886
  * @throws {RequiredError}
7680
7887
  */
7681
7888
  deleteEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<void>;
@@ -7685,6 +7892,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7685
7892
  * @param {string} organizationId the Organization identifier
7686
7893
  * @param {string} hash the Graph download identifier
7687
7894
  * @param {*} [options] Override http request option.
7895
+ * @deprecated
7688
7896
  * @throws {RequiredError}
7689
7897
  */
7690
7898
  downloadGraph(organizationId: string, hash: string, options?: any): AxiosPromise<any>;
@@ -7693,6 +7901,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7693
7901
  * @summary Return the list of all graphs stored in the organization
7694
7902
  * @param {string} organizationId the Organization identifier
7695
7903
  * @param {*} [options] Override http request option.
7904
+ * @deprecated
7696
7905
  * @throws {RequiredError}
7697
7906
  */
7698
7907
  findAllTwingraphs(organizationId: string, options?: any): AxiosPromise<Array<string>>;
@@ -7704,6 +7913,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7704
7913
  * @param {'node' | 'relationship'} type the entity model type
7705
7914
  * @param {Array<string>} ids the entities to get
7706
7915
  * @param {*} [options] Override http request option.
7916
+ * @deprecated
7707
7917
  * @throws {RequiredError}
7708
7918
  */
7709
7919
  getEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', ids: Array<string>, options?: any): AxiosPromise<string>;
@@ -7713,6 +7923,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7713
7923
  * @param {string} organizationId the Organization identifier
7714
7924
  * @param {string} graphId the Graph Identifier
7715
7925
  * @param {*} [options] Override http request option.
7926
+ * @deprecated
7716
7927
  * @throws {RequiredError}
7717
7928
  */
7718
7929
  getGraphMetaData(organizationId: string, graphId: string, options?: any): AxiosPromise<object>;
@@ -7722,6 +7933,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7722
7933
  * @param {string} organizationId the Organization identifier
7723
7934
  * @param {string} jobId the job identifier
7724
7935
  * @param {*} [options] Override http request option.
7936
+ * @deprecated
7725
7937
  * @throws {RequiredError}
7726
7938
  */
7727
7939
  jobStatus(organizationId: string, jobId: string, options?: any): AxiosPromise<string>;
@@ -7732,6 +7944,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7732
7944
  * @param {string} graphId the Graph Identifier
7733
7945
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7734
7946
  * @param {*} [options] Override http request option.
7947
+ * @deprecated
7735
7948
  * @throws {RequiredError}
7736
7949
  */
7737
7950
  query(organizationId: string, graphId: string, twinGraphQuery: TwinGraphQuery, options?: any): AxiosPromise<string>;
@@ -7743,6 +7956,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7743
7956
  * @param {'node' | 'relationship'} type the entity model type
7744
7957
  * @param {Array<GraphProperties>} graphProperties the entities to update
7745
7958
  * @param {*} [options] Override http request option.
7959
+ * @deprecated
7746
7960
  * @throws {RequiredError}
7747
7961
  */
7748
7962
  updateEntities(organizationId: string, graphId: string, type: 'node' | 'relationship', graphProperties: Array<GraphProperties>, options?: any): AxiosPromise<string>;
@@ -7753,6 +7967,7 @@ export declare const TwingraphApiFactory: (configuration?: Configuration, basePa
7753
7967
  * @param {string} graphId the Graph Identifier
7754
7968
  * @param {{ [key: string]: string; }} requestBody the metaData to update
7755
7969
  * @param {*} [options] Override http request option.
7970
+ * @deprecated
7756
7971
  * @throws {RequiredError}
7757
7972
  */
7758
7973
  updateGraphMetaData(organizationId: string, graphId: string, requestBody: {
@@ -7772,6 +7987,7 @@ export declare class TwingraphApi extends BaseAPI {
7772
7987
  * @param {string} organizationId the Organization identifier
7773
7988
  * @param {string} graphId the Graph Identifier
7774
7989
  * @param {*} [options] Override http request option.
7990
+ * @deprecated
7775
7991
  * @throws {RequiredError}
7776
7992
  * @memberof TwingraphApi
7777
7993
  */
@@ -7783,6 +7999,7 @@ export declare class TwingraphApi extends BaseAPI {
7783
7999
  * @param {string} graphId the Graph Identifier
7784
8000
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7785
8001
  * @param {*} [options] Override http request option.
8002
+ * @deprecated
7786
8003
  * @throws {RequiredError}
7787
8004
  * @memberof TwingraphApi
7788
8005
  */
@@ -7795,6 +8012,7 @@ export declare class TwingraphApi extends BaseAPI {
7795
8012
  * @param {TwinGraphQuery} twinGraphQuery
7796
8013
  * @param {any} body
7797
8014
  * @param {*} [options] Override http request option.
8015
+ * @deprecated
7798
8016
  * @throws {RequiredError}
7799
8017
  * @memberof TwingraphApi
7800
8018
  */
@@ -7807,6 +8025,7 @@ export declare class TwingraphApi extends BaseAPI {
7807
8025
  * @param {'node' | 'relationship'} type the entity model type
7808
8026
  * @param {Array<GraphProperties>} graphProperties the entities to create
7809
8027
  * @param {*} [options] Override http request option.
8028
+ * @deprecated
7810
8029
  * @throws {RequiredError}
7811
8030
  * @memberof TwingraphApi
7812
8031
  */
@@ -7818,6 +8037,7 @@ export declare class TwingraphApi extends BaseAPI {
7818
8037
  * @param {string} graphId the Graph Identifier
7819
8038
  * @param {any} [body]
7820
8039
  * @param {*} [options] Override http request option.
8040
+ * @deprecated
7821
8041
  * @throws {RequiredError}
7822
8042
  * @memberof TwingraphApi
7823
8043
  */
@@ -7830,6 +8050,7 @@ export declare class TwingraphApi extends BaseAPI {
7830
8050
  * @param {'node' | 'relationship'} type the entity model type
7831
8051
  * @param {Array<string>} ids the entities to delete
7832
8052
  * @param {*} [options] Override http request option.
8053
+ * @deprecated
7833
8054
  * @throws {RequiredError}
7834
8055
  * @memberof TwingraphApi
7835
8056
  */
@@ -7840,6 +8061,7 @@ export declare class TwingraphApi extends BaseAPI {
7840
8061
  * @param {string} organizationId the Organization identifier
7841
8062
  * @param {string} hash the Graph download identifier
7842
8063
  * @param {*} [options] Override http request option.
8064
+ * @deprecated
7843
8065
  * @throws {RequiredError}
7844
8066
  * @memberof TwingraphApi
7845
8067
  */
@@ -7849,6 +8071,7 @@ export declare class TwingraphApi extends BaseAPI {
7849
8071
  * @summary Return the list of all graphs stored in the organization
7850
8072
  * @param {string} organizationId the Organization identifier
7851
8073
  * @param {*} [options] Override http request option.
8074
+ * @deprecated
7852
8075
  * @throws {RequiredError}
7853
8076
  * @memberof TwingraphApi
7854
8077
  */
@@ -7861,6 +8084,7 @@ export declare class TwingraphApi extends BaseAPI {
7861
8084
  * @param {'node' | 'relationship'} type the entity model type
7862
8085
  * @param {Array<string>} ids the entities to get
7863
8086
  * @param {*} [options] Override http request option.
8087
+ * @deprecated
7864
8088
  * @throws {RequiredError}
7865
8089
  * @memberof TwingraphApi
7866
8090
  */
@@ -7871,6 +8095,7 @@ export declare class TwingraphApi extends BaseAPI {
7871
8095
  * @param {string} organizationId the Organization identifier
7872
8096
  * @param {string} graphId the Graph Identifier
7873
8097
  * @param {*} [options] Override http request option.
8098
+ * @deprecated
7874
8099
  * @throws {RequiredError}
7875
8100
  * @memberof TwingraphApi
7876
8101
  */
@@ -7881,6 +8106,7 @@ export declare class TwingraphApi extends BaseAPI {
7881
8106
  * @param {string} organizationId the Organization identifier
7882
8107
  * @param {string} jobId the job identifier
7883
8108
  * @param {*} [options] Override http request option.
8109
+ * @deprecated
7884
8110
  * @throws {RequiredError}
7885
8111
  * @memberof TwingraphApi
7886
8112
  */
@@ -7892,6 +8118,7 @@ export declare class TwingraphApi extends BaseAPI {
7892
8118
  * @param {string} graphId the Graph Identifier
7893
8119
  * @param {TwinGraphQuery} twinGraphQuery the query to run
7894
8120
  * @param {*} [options] Override http request option.
8121
+ * @deprecated
7895
8122
  * @throws {RequiredError}
7896
8123
  * @memberof TwingraphApi
7897
8124
  */
@@ -7904,6 +8131,7 @@ export declare class TwingraphApi extends BaseAPI {
7904
8131
  * @param {'node' | 'relationship'} type the entity model type
7905
8132
  * @param {Array<GraphProperties>} graphProperties the entities to update
7906
8133
  * @param {*} [options] Override http request option.
8134
+ * @deprecated
7907
8135
  * @throws {RequiredError}
7908
8136
  * @memberof TwingraphApi
7909
8137
  */
@@ -7915,6 +8143,7 @@ export declare class TwingraphApi extends BaseAPI {
7915
8143
  * @param {string} graphId the Graph Identifier
7916
8144
  * @param {{ [key: string]: string; }} requestBody the metaData to update
7917
8145
  * @param {*} [options] Override http request option.
8146
+ * @deprecated
7918
8147
  * @throws {RequiredError}
7919
8148
  * @memberof TwingraphApi
7920
8149
  */
@@ -8446,7 +8675,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
8446
8675
  * @summary Set the Workspace default security
8447
8676
  * @param {string} organizationId the Organization identifier
8448
8677
  * @param {string} workspaceId the Workspace identifier
8449
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
8678
+ * @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.
8450
8679
  * @param {*} [options] Override http request option.
8451
8680
  * @throws {RequiredError}
8452
8681
  */
@@ -8456,7 +8685,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
8456
8685
  * @summary Update a workspace
8457
8686
  * @param {string} organizationId the Organization identifier
8458
8687
  * @param {string} workspaceId the Workspace identifier
8459
- * @param {Workspace} workspace The new Workspace details.
8688
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
8460
8689
  * @param {*} [options] Override http request option.
8461
8690
  * @throws {RequiredError}
8462
8691
  */
@@ -8638,7 +8867,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
8638
8867
  * @summary Set the Workspace default security
8639
8868
  * @param {string} organizationId the Organization identifier
8640
8869
  * @param {string} workspaceId the Workspace identifier
8641
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
8870
+ * @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.
8642
8871
  * @param {*} [options] Override http request option.
8643
8872
  * @throws {RequiredError}
8644
8873
  */
@@ -8648,7 +8877,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
8648
8877
  * @summary Update a workspace
8649
8878
  * @param {string} organizationId the Organization identifier
8650
8879
  * @param {string} workspaceId the Workspace identifier
8651
- * @param {Workspace} workspace The new Workspace details.
8880
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
8652
8881
  * @param {*} [options] Override http request option.
8653
8882
  * @throws {RequiredError}
8654
8883
  */
@@ -8830,7 +9059,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
8830
9059
  * @summary Set the Workspace default security
8831
9060
  * @param {string} organizationId the Organization identifier
8832
9061
  * @param {string} workspaceId the Workspace identifier
8833
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
9062
+ * @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.
8834
9063
  * @param {*} [options] Override http request option.
8835
9064
  * @throws {RequiredError}
8836
9065
  */
@@ -8840,7 +9069,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
8840
9069
  * @summary Update a workspace
8841
9070
  * @param {string} organizationId the Organization identifier
8842
9071
  * @param {string} workspaceId the Workspace identifier
8843
- * @param {Workspace} workspace The new Workspace details.
9072
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
8844
9073
  * @param {*} [options] Override http request option.
8845
9074
  * @throws {RequiredError}
8846
9075
  */
@@ -9039,7 +9268,7 @@ export declare class WorkspaceApi extends BaseAPI {
9039
9268
  * @summary Set the Workspace default security
9040
9269
  * @param {string} organizationId the Organization identifier
9041
9270
  * @param {string} workspaceId the Workspace identifier
9042
- * @param {WorkspaceRole} workspaceRole the new Workspace default security.
9271
+ * @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.
9043
9272
  * @param {*} [options] Override http request option.
9044
9273
  * @throws {RequiredError}
9045
9274
  * @memberof WorkspaceApi
@@ -9050,7 +9279,7 @@ export declare class WorkspaceApi extends BaseAPI {
9050
9279
  * @summary Update a workspace
9051
9280
  * @param {string} organizationId the Organization identifier
9052
9281
  * @param {string} workspaceId the Workspace identifier
9053
- * @param {Workspace} workspace The new Workspace details.
9282
+ * @param {Workspace} workspace The new Workspace details. This endpoint can\&#39;t be used to update security
9054
9283
  * @param {*} [options] Override http request option.
9055
9284
  * @throws {RequiredError}
9056
9285
  * @memberof WorkspaceApi