@cosmotech/api-ts 4.0.0-dev9 → 4.2.5-onprem

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.
Files changed (155) hide show
  1. package/.github/workflows/publish.yaml +13 -12
  2. package/.github/workflows/track_dependencies.yml +31 -0
  3. package/.openapi-generator/FILES +110 -0
  4. package/.openapi-generator/VERSION +1 -0
  5. package/.openapi-generator-ignore +23 -0
  6. package/README.md +210 -2
  7. package/api.ts +50 -50
  8. package/base.ts +1 -1
  9. package/common.ts +22 -44
  10. package/configuration.ts +7 -2
  11. package/dist/api.d.ts +161 -161
  12. package/dist/api.js +49 -49
  13. package/dist/base.d.ts +1 -1
  14. package/dist/base.js +1 -1
  15. package/dist/common.d.ts +6 -37
  16. package/dist/common.js +17 -39
  17. package/dist/configuration.d.ts +1 -1
  18. package/dist/configuration.js +14 -2
  19. package/dist/index.d.ts +1 -1
  20. package/dist/index.js +1 -1
  21. package/docs/AboutInfo.md +21 -0
  22. package/docs/AboutInfoVersion.md +33 -0
  23. package/docs/ComponentRolePermissions.md +23 -0
  24. package/docs/Connector.md +41 -0
  25. package/docs/ConnectorApi.md +218 -0
  26. package/docs/ConnectorParameter.md +31 -0
  27. package/docs/ConnectorParameterGroup.md +25 -0
  28. package/docs/ContainerResourceSizeInfo.md +23 -0
  29. package/docs/ContainerResourceSizing.md +23 -0
  30. package/docs/CreateInfo.md +24 -0
  31. package/docs/CreatedRun.md +21 -0
  32. package/docs/Dataset.md +65 -0
  33. package/docs/DatasetAccessControl.md +23 -0
  34. package/docs/DatasetApi.md +1809 -0
  35. package/docs/DatasetCompatibility.md +25 -0
  36. package/docs/DatasetConnector.md +27 -0
  37. package/docs/DatasetCopyParameters.md +25 -0
  38. package/docs/DatasetCreateInfo.md +24 -0
  39. package/docs/DatasetCreateRequest.md +31 -0
  40. package/docs/DatasetEditInfo.md +22 -0
  41. package/docs/DatasetMemberGroup.md +25 -0
  42. package/docs/DatasetMemberUser.md +23 -0
  43. package/docs/DatasetMembers.md +23 -0
  44. package/docs/DatasetPart.md +43 -0
  45. package/docs/DatasetPartCreateRequest.md +31 -0
  46. package/docs/DatasetPartTypeEnum.md +11 -0
  47. package/docs/DatasetPartUpdateRequest.md +27 -0
  48. package/docs/DatasetRole.md +21 -0
  49. package/docs/DatasetSearch.md +21 -0
  50. package/docs/DatasetSecurity.md +23 -0
  51. package/docs/DatasetSourceType.md +19 -0
  52. package/docs/DatasetTwinGraphHash.md +21 -0
  53. package/docs/DatasetTwinGraphInfo.md +25 -0
  54. package/docs/DatasetTwinGraphQuery.md +21 -0
  55. package/docs/DatasetUpdateRequest.md +29 -0
  56. package/docs/DeleteHistoricalData.md +25 -0
  57. package/docs/EditInfo.md +22 -0
  58. package/docs/FileUploadMetadata.md +22 -0
  59. package/docs/FileUploadValidation.md +23 -0
  60. package/docs/GraphProperties.md +28 -0
  61. package/docs/IAMInfoApi.md +95 -0
  62. package/docs/IngestionStatusEnum.md +15 -0
  63. package/docs/IoTypesEnum.md +11 -0
  64. package/docs/LastRunInfo.md +23 -0
  65. package/docs/MemberGroup.md +25 -0
  66. package/docs/MemberUser.md +23 -0
  67. package/docs/Members.md +23 -0
  68. package/docs/MetaApi.md +52 -0
  69. package/docs/Organization.md +27 -0
  70. package/docs/OrganizationAccessControl.md +23 -0
  71. package/docs/OrganizationApi.md +758 -0
  72. package/docs/OrganizationCreateRequest.md +23 -0
  73. package/docs/OrganizationEditInfo.md +22 -0
  74. package/docs/OrganizationMemberGroup.md +25 -0
  75. package/docs/OrganizationMemberUser.md +23 -0
  76. package/docs/OrganizationMembers.md +23 -0
  77. package/docs/OrganizationRole.md +21 -0
  78. package/docs/OrganizationSecurity.md +23 -0
  79. package/docs/OrganizationUpdateRequest.md +21 -0
  80. package/docs/QueryResult.md +21 -0
  81. package/docs/ResourceSizeInfo.md +23 -0
  82. package/docs/Run.md +57 -0
  83. package/docs/RunApi.md +442 -0
  84. package/docs/RunContainer.md +41 -0
  85. package/docs/RunData.md +25 -0
  86. package/docs/RunDataQuery.md +21 -0
  87. package/docs/RunEditInfo.md +22 -0
  88. package/docs/RunLogs.md +23 -0
  89. package/docs/RunLogsEntry.md +21 -0
  90. package/docs/RunResourceRequested.md +23 -0
  91. package/docs/RunState.md +15 -0
  92. package/docs/RunStatus.md +47 -0
  93. package/docs/RunStatusNode.md +43 -0
  94. package/docs/RunTemplate.md +87 -0
  95. package/docs/RunTemplateCreateRequest.md +37 -0
  96. package/docs/RunTemplateOrchestrator.md +11 -0
  97. package/docs/RunTemplateParameter.md +35 -0
  98. package/docs/RunTemplateParameterCreateRequest.md +35 -0
  99. package/docs/RunTemplateParameterGroup.md +31 -0
  100. package/docs/RunTemplateParameterGroupCreateRequest.md +29 -0
  101. package/docs/RunTemplateParameterGroupUpdateRequest.md +27 -0
  102. package/docs/RunTemplateParameterUpdateRequest.md +33 -0
  103. package/docs/RunTemplateParameterValue.md +25 -0
  104. package/docs/RunTemplateResourceSizing.md +23 -0
  105. package/docs/RunTemplateStepSource.md +15 -0
  106. package/docs/RunTemplateUpdateRequest.md +35 -0
  107. package/docs/Runner.md +63 -0
  108. package/docs/RunnerAccessControl.md +23 -0
  109. package/docs/RunnerApi.md +908 -0
  110. package/docs/RunnerCreateRequest.md +45 -0
  111. package/docs/RunnerDatasets.md +24 -0
  112. package/docs/RunnerEditInfo.md +22 -0
  113. package/docs/RunnerMemberGroup.md +25 -0
  114. package/docs/RunnerMemberUser.md +23 -0
  115. package/docs/RunnerMembers.md +23 -0
  116. package/docs/RunnerResourceSizing.md +23 -0
  117. package/docs/RunnerRole.md +21 -0
  118. package/docs/RunnerRunTemplateParameterValue.md +27 -0
  119. package/docs/RunnerSecurity.md +23 -0
  120. package/docs/RunnerStatus.md +11 -0
  121. package/docs/RunnerUpdateRequest.md +41 -0
  122. package/docs/RunnerValidationStatus.md +15 -0
  123. package/docs/SendRunDataRequest.md +22 -0
  124. package/docs/Solution.md +53 -0
  125. package/docs/SolutionAccessControl.md +23 -0
  126. package/docs/SolutionApi.md +1159 -0
  127. package/docs/SolutionCreateRequest.md +43 -0
  128. package/docs/SolutionEditInfo.md +22 -0
  129. package/docs/SolutionFile.md +21 -0
  130. package/docs/SolutionMemberGroup.md +25 -0
  131. package/docs/SolutionMemberUser.md +23 -0
  132. package/docs/SolutionMembers.md +23 -0
  133. package/docs/SolutionRole.md +21 -0
  134. package/docs/SolutionSecurity.md +23 -0
  135. package/docs/SolutionUpdateRequest.md +41 -0
  136. package/docs/SourceInfo.md +27 -0
  137. package/docs/SubDatasetGraphQuery.md +27 -0
  138. package/docs/TwinGraphBatchResult.md +25 -0
  139. package/docs/TwincacheStatusEnum.md +11 -0
  140. package/docs/Workspace.md +57 -0
  141. package/docs/WorkspaceAccessControl.md +23 -0
  142. package/docs/WorkspaceApi.md +1162 -0
  143. package/docs/WorkspaceCreateRequest.md +35 -0
  144. package/docs/WorkspaceEditInfo.md +22 -0
  145. package/docs/WorkspaceFile.md +21 -0
  146. package/docs/WorkspaceMemberGroup.md +25 -0
  147. package/docs/WorkspaceMemberUser.md +23 -0
  148. package/docs/WorkspaceMembers.md +23 -0
  149. package/docs/WorkspaceRole.md +21 -0
  150. package/docs/WorkspaceSecurity.md +23 -0
  151. package/docs/WorkspaceSolution.md +25 -0
  152. package/docs/WorkspaceUpdateRequest.md +31 -0
  153. package/docs/WorkspaceWebApp.md +25 -0
  154. package/index.ts +1 -1
  155. package/package.json +2 -2
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Cosmo Tech Platform API
6
6
  * Cosmo Tech Platform API
7
7
  *
8
- * The version of the OpenAPI document: 4.0.0-onprem.9
8
+ * The version of the OpenAPI document: 4.2.5-onprem
9
9
  * Contact: platform@cosmotech.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -819,7 +819,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
819
819
  });
820
820
  },
821
821
  /**
822
- * Create a copy of the dataset using the results of the list of queries given in parameter.
822
+ * Create a copy of the dataset using the results of the list of queries given in parameter. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
823
823
  * @summary Create a sub-dataset from the dataset in parameter
824
824
  * @param {string} organizationId the Organization identifier
825
825
  * @param {string} datasetId the Dataset identifier
@@ -875,7 +875,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
875
875
  });
876
876
  },
877
877
  /**
878
- * create new entities in a graph instance
878
+ * Create new entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
879
879
  * @summary Create new entities in a graph instance
880
880
  * @param {string} organizationId the Organization identifier
881
881
  * @param {string} datasetId the Dataset Identifier
@@ -986,7 +986,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
986
986
  });
987
987
  },
988
988
  /**
989
- * delete entities in a graph instance
989
+ * Delete entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
990
990
  * @summary Delete entities in a graph instance
991
991
  * @param {string} organizationId the Organization identifier
992
992
  * @param {string} datasetId the Dataset Identifier
@@ -1047,7 +1047,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
1047
1047
  });
1048
1048
  },
1049
1049
  /**
1050
- * Download the compressed graph reference by the hash in a zip file
1050
+ * Download the compressed graph reference by the hash in a zip file Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
1051
1051
  * @summary Download a graph as a zip file
1052
1052
  * @param {string} organizationId the Organization identifier
1053
1053
  * @param {string} hash the Graph download identifier
@@ -1412,7 +1412,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
1412
1412
  });
1413
1413
  },
1414
1414
  /**
1415
- * get entities in a graph instance
1415
+ * Get entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
1416
1416
  * @summary Get entities in a graph instance
1417
1417
  * @param {string} organizationId the Organization identifier
1418
1418
  * @param {string} datasetId the Dataset Identifier
@@ -1529,7 +1529,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
1529
1529
  });
1530
1530
  },
1531
1531
  /**
1532
- * 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
1532
+ * 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 Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
1533
1533
  * @summary Refresh data on dataset from dataset\'s source
1534
1534
  * @param {string} organizationId the Organization identifier
1535
1535
  * @param {string} datasetId the Dataset identifier
@@ -1686,7 +1686,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
1686
1686
  });
1687
1687
  },
1688
1688
  /**
1689
- * Rollback the twingraph on a dataset after a failed refresh
1689
+ * Rollback the twingraph on a dataset after a failed refresh Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
1690
1690
  * @summary Rollback the dataset after a failed refresh
1691
1691
  * @param {string} organizationId the Organization identifier
1692
1692
  * @param {string} datasetId the Dataset identifier
@@ -1853,7 +1853,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
1853
1853
  });
1854
1854
  },
1855
1855
  /**
1856
- * Run a query on a graph instance and return the result as a zip file in async mode
1856
+ * Run a query on a graph instance and return the result as a zip file in async mode Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
1857
1857
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
1858
1858
  * @param {string} organizationId the Organization identifier
1859
1859
  * @param {string} datasetId the Graph Identifier
@@ -1909,7 +1909,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
1909
1909
  });
1910
1910
  },
1911
1911
  /**
1912
- * Async batch update by loading a CSV file on a graph instance
1912
+ * Async batch update by loading a CSV file on a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
1913
1913
  * @summary Async batch update by loading a CSV file on a graph instance
1914
1914
  * @param {string} organizationId the Organization identifier
1915
1915
  * @param {string} datasetId the Dataset Identifier
@@ -1974,7 +1974,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
1974
1974
  });
1975
1975
  },
1976
1976
  /**
1977
- * Run a query on a graph instance and return the result as a json
1977
+ * Run a query on a graph instance and return the result as a json Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
1978
1978
  * @summary Return the result of a query made on the graph instance as a json
1979
1979
  * @param {string} organizationId the Organization identifier
1980
1980
  * @param {string} datasetId the Dataset identifier
@@ -2207,7 +2207,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
2207
2207
  * @param {string} organizationId the Organization identifier
2208
2208
  * @param {string} datasetId the Dataset Identifier
2209
2209
  * @param {UpdateTwingraphEntitiesTypeEnum} type the entity model type
2210
- * @param {Array<GraphProperties>} graphProperties the entities to update
2210
+ * @param {Array<GraphProperties>} graphProperties The entities to update Note: This endpoint is activated only if &#x60;csm.platform.twincache.useGraphModule&#x60; property is set to true
2211
2211
  * @param {*} [options] Override http request option.
2212
2212
  * @throws {RequiredError}
2213
2213
  */
@@ -2262,7 +2262,7 @@ var DatasetApiAxiosParamCreator = function (configuration) {
2262
2262
  });
2263
2263
  },
2264
2264
  /**
2265
- * 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.
2265
+ * 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. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2266
2266
  * @summary Upload data from zip file to dataset\'s twingraph
2267
2267
  * @param {string} organizationId the Organization identifier
2268
2268
  * @param {string} datasetId the Dataset identifier
@@ -2426,7 +2426,7 @@ var DatasetApiFp = function (configuration) {
2426
2426
  });
2427
2427
  },
2428
2428
  /**
2429
- * Create a copy of the dataset using the results of the list of queries given in parameter.
2429
+ * Create a copy of the dataset using the results of the list of queries given in parameter. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2430
2430
  * @summary Create a sub-dataset from the dataset in parameter
2431
2431
  * @param {string} organizationId the Organization identifier
2432
2432
  * @param {string} datasetId the Dataset identifier
@@ -2451,7 +2451,7 @@ var DatasetApiFp = function (configuration) {
2451
2451
  });
2452
2452
  },
2453
2453
  /**
2454
- * create new entities in a graph instance
2454
+ * Create new entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2455
2455
  * @summary Create new entities in a graph instance
2456
2456
  * @param {string} organizationId the Organization identifier
2457
2457
  * @param {string} datasetId the Dataset Identifier
@@ -2501,7 +2501,7 @@ var DatasetApiFp = function (configuration) {
2501
2501
  });
2502
2502
  },
2503
2503
  /**
2504
- * delete entities in a graph instance
2504
+ * Delete entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2505
2505
  * @summary Delete entities in a graph instance
2506
2506
  * @param {string} organizationId the Organization identifier
2507
2507
  * @param {string} datasetId the Dataset Identifier
@@ -2527,7 +2527,7 @@ var DatasetApiFp = function (configuration) {
2527
2527
  });
2528
2528
  },
2529
2529
  /**
2530
- * Download the compressed graph reference by the hash in a zip file
2530
+ * Download the compressed graph reference by the hash in a zip file Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2531
2531
  * @summary Download a graph as a zip file
2532
2532
  * @param {string} organizationId the Organization identifier
2533
2533
  * @param {string} hash the Graph download identifier
@@ -2697,7 +2697,7 @@ var DatasetApiFp = function (configuration) {
2697
2697
  });
2698
2698
  },
2699
2699
  /**
2700
- * get entities in a graph instance
2700
+ * Get entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2701
2701
  * @summary Get entities in a graph instance
2702
2702
  * @param {string} organizationId the Organization identifier
2703
2703
  * @param {string} datasetId the Dataset Identifier
@@ -2747,7 +2747,7 @@ var DatasetApiFp = function (configuration) {
2747
2747
  });
2748
2748
  },
2749
2749
  /**
2750
- * 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
2750
+ * 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 Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2751
2751
  * @summary Refresh data on dataset from dataset\'s source
2752
2752
  * @param {string} organizationId the Organization identifier
2753
2753
  * @param {string} datasetId the Dataset identifier
@@ -2820,7 +2820,7 @@ var DatasetApiFp = function (configuration) {
2820
2820
  });
2821
2821
  },
2822
2822
  /**
2823
- * Rollback the twingraph on a dataset after a failed refresh
2823
+ * Rollback the twingraph on a dataset after a failed refresh Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2824
2824
  * @summary Rollback the dataset after a failed refresh
2825
2825
  * @param {string} organizationId the Organization identifier
2826
2826
  * @param {string} datasetId the Dataset identifier
@@ -2895,7 +2895,7 @@ var DatasetApiFp = function (configuration) {
2895
2895
  });
2896
2896
  },
2897
2897
  /**
2898
- * Run a query on a graph instance and return the result as a zip file in async mode
2898
+ * Run a query on a graph instance and return the result as a zip file in async mode Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2899
2899
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
2900
2900
  * @param {string} organizationId the Organization identifier
2901
2901
  * @param {string} datasetId the Graph Identifier
@@ -2920,7 +2920,7 @@ var DatasetApiFp = function (configuration) {
2920
2920
  });
2921
2921
  },
2922
2922
  /**
2923
- * Async batch update by loading a CSV file on a graph instance
2923
+ * Async batch update by loading a CSV file on a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2924
2924
  * @summary Async batch update by loading a CSV file on a graph instance
2925
2925
  * @param {string} organizationId the Organization identifier
2926
2926
  * @param {string} datasetId the Dataset Identifier
@@ -2946,7 +2946,7 @@ var DatasetApiFp = function (configuration) {
2946
2946
  });
2947
2947
  },
2948
2948
  /**
2949
- * Run a query on a graph instance and return the result as a json
2949
+ * Run a query on a graph instance and return the result as a json Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
2950
2950
  * @summary Return the result of a query made on the graph instance as a json
2951
2951
  * @param {string} organizationId the Organization identifier
2952
2952
  * @param {string} datasetId the Dataset identifier
@@ -3051,7 +3051,7 @@ var DatasetApiFp = function (configuration) {
3051
3051
  * @param {string} organizationId the Organization identifier
3052
3052
  * @param {string} datasetId the Dataset Identifier
3053
3053
  * @param {UpdateTwingraphEntitiesTypeEnum} type the entity model type
3054
- * @param {Array<GraphProperties>} graphProperties the entities to update
3054
+ * @param {Array<GraphProperties>} graphProperties The entities to update Note: This endpoint is activated only if &#x60;csm.platform.twincache.useGraphModule&#x60; property is set to true
3055
3055
  * @param {*} [options] Override http request option.
3056
3056
  * @throws {RequiredError}
3057
3057
  */
@@ -3072,7 +3072,7 @@ var DatasetApiFp = function (configuration) {
3072
3072
  });
3073
3073
  },
3074
3074
  /**
3075
- * 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.
3075
+ * 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. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3076
3076
  * @summary Upload data from zip file to dataset\'s twingraph
3077
3077
  * @param {string} organizationId the Organization identifier
3078
3078
  * @param {string} datasetId the Dataset identifier
@@ -3153,7 +3153,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3153
3153
  return localVarFp.createDataset(organizationId, dataset, options).then(function (request) { return request(axios, basePath); });
3154
3154
  },
3155
3155
  /**
3156
- * Create a copy of the dataset using the results of the list of queries given in parameter.
3156
+ * Create a copy of the dataset using the results of the list of queries given in parameter. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3157
3157
  * @summary Create a sub-dataset from the dataset in parameter
3158
3158
  * @param {string} organizationId the Organization identifier
3159
3159
  * @param {string} datasetId the Dataset identifier
@@ -3165,7 +3165,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3165
3165
  return localVarFp.createSubDataset(organizationId, datasetId, subDatasetGraphQuery, options).then(function (request) { return request(axios, basePath); });
3166
3166
  },
3167
3167
  /**
3168
- * create new entities in a graph instance
3168
+ * Create new entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3169
3169
  * @summary Create new entities in a graph instance
3170
3170
  * @param {string} organizationId the Organization identifier
3171
3171
  * @param {string} datasetId the Dataset Identifier
@@ -3189,7 +3189,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3189
3189
  return localVarFp.deleteDataset(organizationId, datasetId, options).then(function (request) { return request(axios, basePath); });
3190
3190
  },
3191
3191
  /**
3192
- * delete entities in a graph instance
3192
+ * Delete entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3193
3193
  * @summary Delete entities in a graph instance
3194
3194
  * @param {string} organizationId the Organization identifier
3195
3195
  * @param {string} datasetId the Dataset Identifier
@@ -3202,7 +3202,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3202
3202
  return localVarFp.deleteTwingraphEntities(organizationId, datasetId, type, ids, options).then(function (request) { return request(axios, basePath); });
3203
3203
  },
3204
3204
  /**
3205
- * Download the compressed graph reference by the hash in a zip file
3205
+ * Download the compressed graph reference by the hash in a zip file Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3206
3206
  * @summary Download a graph as a zip file
3207
3207
  * @param {string} organizationId the Organization identifier
3208
3208
  * @param {string} hash the Graph download identifier
@@ -3281,7 +3281,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3281
3281
  return localVarFp.getDatasetTwingraphStatus(organizationId, datasetId, options).then(function (request) { return request(axios, basePath); });
3282
3282
  },
3283
3283
  /**
3284
- * get entities in a graph instance
3284
+ * Get entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3285
3285
  * @summary Get entities in a graph instance
3286
3286
  * @param {string} organizationId the Organization identifier
3287
3287
  * @param {string} datasetId the Dataset Identifier
@@ -3305,7 +3305,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3305
3305
  return localVarFp.linkWorkspace(organizationId, datasetId, workspaceId, options).then(function (request) { return request(axios, basePath); });
3306
3306
  },
3307
3307
  /**
3308
- * 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
3308
+ * 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 Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3309
3309
  * @summary Refresh data on dataset from dataset\'s source
3310
3310
  * @param {string} organizationId the Organization identifier
3311
3311
  * @param {string} datasetId the Dataset identifier
@@ -3339,7 +3339,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3339
3339
  return localVarFp.removeDatasetAccessControl(organizationId, datasetId, identityId, options).then(function (request) { return request(axios, basePath); });
3340
3340
  },
3341
3341
  /**
3342
- * Rollback the twingraph on a dataset after a failed refresh
3342
+ * Rollback the twingraph on a dataset after a failed refresh Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3343
3343
  * @summary Rollback the dataset after a failed refresh
3344
3344
  * @param {string} organizationId the Organization identifier
3345
3345
  * @param {string} datasetId the Dataset identifier
@@ -3375,7 +3375,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3375
3375
  return localVarFp.setDatasetDefaultSecurity(organizationId, datasetId, datasetRole, options).then(function (request) { return request(axios, basePath); });
3376
3376
  },
3377
3377
  /**
3378
- * Run a query on a graph instance and return the result as a zip file in async mode
3378
+ * Run a query on a graph instance and return the result as a zip file in async mode Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3379
3379
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
3380
3380
  * @param {string} organizationId the Organization identifier
3381
3381
  * @param {string} datasetId the Graph Identifier
@@ -3387,7 +3387,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3387
3387
  return localVarFp.twingraphBatchQuery(organizationId, datasetId, datasetTwinGraphQuery, options).then(function (request) { return request(axios, basePath); });
3388
3388
  },
3389
3389
  /**
3390
- * Async batch update by loading a CSV file on a graph instance
3390
+ * Async batch update by loading a CSV file on a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3391
3391
  * @summary Async batch update by loading a CSV file on a graph instance
3392
3392
  * @param {string} organizationId the Organization identifier
3393
3393
  * @param {string} datasetId the Dataset Identifier
@@ -3400,7 +3400,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3400
3400
  return localVarFp.twingraphBatchUpdate(organizationId, datasetId, twinGraphQuery, body, options).then(function (request) { return request(axios, basePath); });
3401
3401
  },
3402
3402
  /**
3403
- * Run a query on a graph instance and return the result as a json
3403
+ * Run a query on a graph instance and return the result as a json Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3404
3404
  * @summary Return the result of a query made on the graph instance as a json
3405
3405
  * @param {string} organizationId the Organization identifier
3406
3406
  * @param {string} datasetId the Dataset identifier
@@ -3453,7 +3453,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3453
3453
  * @param {string} organizationId the Organization identifier
3454
3454
  * @param {string} datasetId the Dataset Identifier
3455
3455
  * @param {UpdateTwingraphEntitiesTypeEnum} type the entity model type
3456
- * @param {Array<GraphProperties>} graphProperties the entities to update
3456
+ * @param {Array<GraphProperties>} graphProperties The entities to update Note: This endpoint is activated only if &#x60;csm.platform.twincache.useGraphModule&#x60; property is set to true
3457
3457
  * @param {*} [options] Override http request option.
3458
3458
  * @throws {RequiredError}
3459
3459
  */
@@ -3461,7 +3461,7 @@ var DatasetApiFactory = function (configuration, basePath, axios) {
3461
3461
  return localVarFp.updateTwingraphEntities(organizationId, datasetId, type, graphProperties, options).then(function (request) { return request(axios, basePath); });
3462
3462
  },
3463
3463
  /**
3464
- * 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.
3464
+ * 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. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3465
3465
  * @summary Upload data from zip file to dataset\'s twingraph
3466
3466
  * @param {string} organizationId the Organization identifier
3467
3467
  * @param {string} datasetId the Dataset identifier
@@ -3541,7 +3541,7 @@ var DatasetApi = /** @class */ (function (_super) {
3541
3541
  return (0, exports.DatasetApiFp)(this.configuration).createDataset(organizationId, dataset, options).then(function (request) { return request(_this.axios, _this.basePath); });
3542
3542
  };
3543
3543
  /**
3544
- * Create a copy of the dataset using the results of the list of queries given in parameter.
3544
+ * Create a copy of the dataset using the results of the list of queries given in parameter. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3545
3545
  * @summary Create a sub-dataset from the dataset in parameter
3546
3546
  * @param {string} organizationId the Organization identifier
3547
3547
  * @param {string} datasetId the Dataset identifier
@@ -3555,7 +3555,7 @@ var DatasetApi = /** @class */ (function (_super) {
3555
3555
  return (0, exports.DatasetApiFp)(this.configuration).createSubDataset(organizationId, datasetId, subDatasetGraphQuery, options).then(function (request) { return request(_this.axios, _this.basePath); });
3556
3556
  };
3557
3557
  /**
3558
- * create new entities in a graph instance
3558
+ * Create new entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3559
3559
  * @summary Create new entities in a graph instance
3560
3560
  * @param {string} organizationId the Organization identifier
3561
3561
  * @param {string} datasetId the Dataset Identifier
@@ -3583,7 +3583,7 @@ var DatasetApi = /** @class */ (function (_super) {
3583
3583
  return (0, exports.DatasetApiFp)(this.configuration).deleteDataset(organizationId, datasetId, options).then(function (request) { return request(_this.axios, _this.basePath); });
3584
3584
  };
3585
3585
  /**
3586
- * delete entities in a graph instance
3586
+ * Delete entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3587
3587
  * @summary Delete entities in a graph instance
3588
3588
  * @param {string} organizationId the Organization identifier
3589
3589
  * @param {string} datasetId the Dataset Identifier
@@ -3598,7 +3598,7 @@ var DatasetApi = /** @class */ (function (_super) {
3598
3598
  return (0, exports.DatasetApiFp)(this.configuration).deleteTwingraphEntities(organizationId, datasetId, type, ids, options).then(function (request) { return request(_this.axios, _this.basePath); });
3599
3599
  };
3600
3600
  /**
3601
- * Download the compressed graph reference by the hash in a zip file
3601
+ * Download the compressed graph reference by the hash in a zip file Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3602
3602
  * @summary Download a graph as a zip file
3603
3603
  * @param {string} organizationId the Organization identifier
3604
3604
  * @param {string} hash the Graph download identifier
@@ -3691,7 +3691,7 @@ var DatasetApi = /** @class */ (function (_super) {
3691
3691
  return (0, exports.DatasetApiFp)(this.configuration).getDatasetTwingraphStatus(organizationId, datasetId, options).then(function (request) { return request(_this.axios, _this.basePath); });
3692
3692
  };
3693
3693
  /**
3694
- * get entities in a graph instance
3694
+ * Get entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3695
3695
  * @summary Get entities in a graph instance
3696
3696
  * @param {string} organizationId the Organization identifier
3697
3697
  * @param {string} datasetId the Dataset Identifier
@@ -3719,7 +3719,7 @@ var DatasetApi = /** @class */ (function (_super) {
3719
3719
  return (0, exports.DatasetApiFp)(this.configuration).linkWorkspace(organizationId, datasetId, workspaceId, options).then(function (request) { return request(_this.axios, _this.basePath); });
3720
3720
  };
3721
3721
  /**
3722
- * 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
3722
+ * 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 Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3723
3723
  * @summary Refresh data on dataset from dataset\'s source
3724
3724
  * @param {string} organizationId the Organization identifier
3725
3725
  * @param {string} datasetId the Dataset identifier
@@ -3759,7 +3759,7 @@ var DatasetApi = /** @class */ (function (_super) {
3759
3759
  return (0, exports.DatasetApiFp)(this.configuration).removeDatasetAccessControl(organizationId, datasetId, identityId, options).then(function (request) { return request(_this.axios, _this.basePath); });
3760
3760
  };
3761
3761
  /**
3762
- * Rollback the twingraph on a dataset after a failed refresh
3762
+ * Rollback the twingraph on a dataset after a failed refresh Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3763
3763
  * @summary Rollback the dataset after a failed refresh
3764
3764
  * @param {string} organizationId the Organization identifier
3765
3765
  * @param {string} datasetId the Dataset identifier
@@ -3801,7 +3801,7 @@ var DatasetApi = /** @class */ (function (_super) {
3801
3801
  return (0, exports.DatasetApiFp)(this.configuration).setDatasetDefaultSecurity(organizationId, datasetId, datasetRole, options).then(function (request) { return request(_this.axios, _this.basePath); });
3802
3802
  };
3803
3803
  /**
3804
- * Run a query on a graph instance and return the result as a zip file in async mode
3804
+ * Run a query on a graph instance and return the result as a zip file in async mode Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3805
3805
  * @summary Run a query on a graph instance and return the result as a zip file in async mode
3806
3806
  * @param {string} organizationId the Organization identifier
3807
3807
  * @param {string} datasetId the Graph Identifier
@@ -3815,7 +3815,7 @@ var DatasetApi = /** @class */ (function (_super) {
3815
3815
  return (0, exports.DatasetApiFp)(this.configuration).twingraphBatchQuery(organizationId, datasetId, datasetTwinGraphQuery, options).then(function (request) { return request(_this.axios, _this.basePath); });
3816
3816
  };
3817
3817
  /**
3818
- * Async batch update by loading a CSV file on a graph instance
3818
+ * Async batch update by loading a CSV file on a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3819
3819
  * @summary Async batch update by loading a CSV file on a graph instance
3820
3820
  * @param {string} organizationId the Organization identifier
3821
3821
  * @param {string} datasetId the Dataset Identifier
@@ -3830,7 +3830,7 @@ var DatasetApi = /** @class */ (function (_super) {
3830
3830
  return (0, exports.DatasetApiFp)(this.configuration).twingraphBatchUpdate(organizationId, datasetId, twinGraphQuery, body, options).then(function (request) { return request(_this.axios, _this.basePath); });
3831
3831
  };
3832
3832
  /**
3833
- * Run a query on a graph instance and return the result as a json
3833
+ * Run a query on a graph instance and return the result as a json Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3834
3834
  * @summary Return the result of a query made on the graph instance as a json
3835
3835
  * @param {string} organizationId the Organization identifier
3836
3836
  * @param {string} datasetId the Dataset identifier
@@ -3891,7 +3891,7 @@ var DatasetApi = /** @class */ (function (_super) {
3891
3891
  * @param {string} organizationId the Organization identifier
3892
3892
  * @param {string} datasetId the Dataset Identifier
3893
3893
  * @param {UpdateTwingraphEntitiesTypeEnum} type the entity model type
3894
- * @param {Array<GraphProperties>} graphProperties the entities to update
3894
+ * @param {Array<GraphProperties>} graphProperties The entities to update Note: This endpoint is activated only if &#x60;csm.platform.twincache.useGraphModule&#x60; property is set to true
3895
3895
  * @param {*} [options] Override http request option.
3896
3896
  * @throws {RequiredError}
3897
3897
  * @memberof DatasetApi
@@ -3901,7 +3901,7 @@ var DatasetApi = /** @class */ (function (_super) {
3901
3901
  return (0, exports.DatasetApiFp)(this.configuration).updateTwingraphEntities(organizationId, datasetId, type, graphProperties, options).then(function (request) { return request(_this.axios, _this.basePath); });
3902
3902
  };
3903
3903
  /**
3904
- * 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.
3904
+ * 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. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
3905
3905
  * @summary Upload data from zip file to dataset\'s twingraph
3906
3906
  * @param {string} organizationId the Organization identifier
3907
3907
  * @param {string} datasetId the Dataset identifier
package/dist/base.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: 4.0.0-onprem.9
5
+ * The version of the OpenAPI document: 4.2.5-onprem
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Cosmo Tech Platform API
6
6
  * Cosmo Tech Platform API
7
7
  *
8
- * The version of the OpenAPI document: 4.0.0-onprem.9
8
+ * The version of the OpenAPI document: 4.2.5-onprem
9
9
  * Contact: platform@cosmotech.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.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: 4.0.0-onprem.9
5
+ * The version of the OpenAPI document: 4.2.5-onprem
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,54 +12,23 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
26
  /**
52
- *
53
- * @export
27
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
54
30
  */
31
+ export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
55
32
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
33
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
34
+ export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;