@cosmotech/api-ts 5.0.0-beta4 → 5.0.0-beta6

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 (60) hide show
  1. package/.github/workflows/publish.yaml +13 -12
  2. package/.github/workflows/track_dependencies.yml +31 -0
  3. package/.openapi-generator/FILES +1 -5
  4. package/README.md +5 -15
  5. package/api.ts +218 -777
  6. package/base.ts +1 -1
  7. package/common.ts +1 -1
  8. package/configuration.ts +1 -1
  9. package/dist/api.d.ts +240 -524
  10. package/dist/api.js +194 -819
  11. package/dist/base.d.ts +1 -1
  12. package/dist/base.js +1 -1
  13. package/dist/common.d.ts +1 -1
  14. package/dist/common.js +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +1 -1
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/docs/Connector.md +41 -0
  20. package/docs/ConnectorApi.md +218 -0
  21. package/docs/ConnectorParameter.md +31 -0
  22. package/docs/ConnectorParameterGroup.md +25 -0
  23. package/docs/DatasetApi.md +110 -28
  24. package/docs/DatasetCompatibility.md +25 -0
  25. package/docs/DatasetConnector.md +27 -0
  26. package/docs/DatasetCopyParameters.md +25 -0
  27. package/docs/DatasetPartTypeEnum.md +1 -1
  28. package/docs/DatasetSearch.md +21 -0
  29. package/docs/DatasetSourceType.md +19 -0
  30. package/docs/DatasetTwinGraphHash.md +21 -0
  31. package/docs/DatasetTwinGraphInfo.md +25 -0
  32. package/docs/DatasetTwinGraphQuery.md +21 -0
  33. package/docs/DeleteHistoricalData.md +25 -0
  34. package/docs/FileUploadMetadata.md +22 -0
  35. package/docs/FileUploadValidation.md +23 -0
  36. package/docs/GraphProperties.md +28 -0
  37. package/docs/IngestionStatusEnum.md +15 -0
  38. package/docs/IoTypesEnum.md +11 -0
  39. package/docs/RunApi.md +0 -129
  40. package/docs/RunData.md +1 -1
  41. package/docs/RunLogs.md +23 -0
  42. package/docs/RunLogsEntry.md +21 -0
  43. package/docs/RunTemplateOrchestrator.md +11 -0
  44. package/docs/RunTemplateStepSource.md +15 -0
  45. package/docs/Runner.md +2 -2
  46. package/docs/RunnerApi.md +4 -4
  47. package/docs/RunnerCreateRequest.md +4 -4
  48. package/docs/RunnerDatasets.md +24 -0
  49. package/docs/RunnerRunTemplateParameterValue.md +1 -1
  50. package/docs/RunnerUpdateRequest.md +2 -2
  51. package/docs/SendRunDataRequest.md +2 -3
  52. package/docs/SolutionApi.md +0 -290
  53. package/docs/SourceInfo.md +27 -0
  54. package/docs/SubDatasetGraphQuery.md +27 -0
  55. package/docs/TwinGraphBatchResult.md +25 -0
  56. package/docs/TwincacheStatusEnum.md +11 -0
  57. package/docs/WorkspaceSolution.md +4 -0
  58. package/git_push.sh +2 -2
  59. package/index.ts +1 -1
  60. package/package.json +2 -2
@@ -1,23 +1,24 @@
1
1
  name: Node.js Package on npm
2
+
2
3
  on:
3
4
  release:
4
5
  types: [created]
6
+
7
+ permissions:
8
+ contents: read
9
+ id-token: write
10
+
5
11
  jobs:
6
12
  build:
7
13
  name: Build & Publish
8
14
  runs-on: ubuntu-latest
9
15
  steps:
10
- - uses: actions/checkout@v2
11
- - uses: actions/setup-node@v1
16
+ - uses: actions/checkout@v5
17
+ - uses: actions/setup-node@v6
12
18
  with:
13
- node-version: '14.x'
19
+ node-version: '24'
14
20
  registry-url: 'https://registry.npmjs.org'
15
- scope: '@cosmotech'
16
- - run: yarn
17
- - run: git config --global user.email "vincent.carluer@cosmotech.com" && git config --global user.name "Vincent Carluer"
18
- - run: npm version ${{ github.event.release.tag_name }} --allow-same-version
19
- - run: npm publish
20
- env:
21
- NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
22
- NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
23
- NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
21
+ scope: '@cosmotech'
22
+ - run: npm version ${{ github.event.release.tag_name }} --allow-same-version --no-git-tag-version
23
+ - run: npm install
24
+ - run: npm publish --tag ${{ github.event.release.prerelease && 'prerelease' || 'latest' }}
@@ -0,0 +1,31 @@
1
+ name: Track Dependencies
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ push:
6
+ branches:
7
+ - master
8
+
9
+ permissions:
10
+ contents: read
11
+
12
+ jobs:
13
+ dependency_track:
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - name: Checkout Repository
17
+ uses: actions/checkout@v5
18
+ - name: Install generator
19
+ run: |
20
+ npm install --global @cyclonedx/cyclonedx-npm
21
+ - name: Install project dependencies
22
+ run: npm install
23
+ - name: Generate BOM
24
+ run: cyclonedx-npm --mc-type library -o sbom.json
25
+ - name: Upload BOM to Dependency Track
26
+ uses: DependencyTrack/gh-upload-sbom@v3
27
+ with:
28
+ serverhostname: ${{ secrets.DEPENDENCY_TRACK_SERVER_HOSTNAME }}
29
+ apikey: ${{ secrets.DEPENDENCY_TRACK_API_KEY }}
30
+ project: 'd15fd01c-3d8b-42d4-a83a-ce9a5d95d72e'
31
+ bomfilename: 'sbom.json'
@@ -35,13 +35,10 @@ docs/OrganizationEditInfo.md
35
35
  docs/OrganizationRole.md
36
36
  docs/OrganizationSecurity.md
37
37
  docs/OrganizationUpdateRequest.md
38
- docs/QueryResult.md
39
38
  docs/ResourceSizeInfo.md
40
39
  docs/Run.md
41
40
  docs/RunApi.md
42
41
  docs/RunContainer.md
43
- docs/RunData.md
44
- docs/RunDataQuery.md
45
42
  docs/RunEditInfo.md
46
43
  docs/RunResourceRequested.md
47
44
  docs/RunState.md
@@ -62,6 +59,7 @@ docs/Runner.md
62
59
  docs/RunnerAccessControl.md
63
60
  docs/RunnerApi.md
64
61
  docs/RunnerCreateRequest.md
62
+ docs/RunnerDatasets.md
65
63
  docs/RunnerEditInfo.md
66
64
  docs/RunnerResourceSizing.md
67
65
  docs/RunnerRole.md
@@ -69,13 +67,11 @@ docs/RunnerRunTemplateParameterValue.md
69
67
  docs/RunnerSecurity.md
70
68
  docs/RunnerUpdateRequest.md
71
69
  docs/RunnerValidationStatus.md
72
- docs/SendRunDataRequest.md
73
70
  docs/Solution.md
74
71
  docs/SolutionAccessControl.md
75
72
  docs/SolutionApi.md
76
73
  docs/SolutionCreateRequest.md
77
74
  docs/SolutionEditInfo.md
78
- docs/SolutionFile.md
79
75
  docs/SolutionRole.md
80
76
  docs/SolutionSecurity.md
81
77
  docs/SolutionUpdateRequest.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @cosmotech/api-ts@5.0.0-beta4
1
+ ## @cosmotech/api-ts@5.0.0-beta6
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @cosmotech/api-ts@5.0.0-beta4 --save
39
+ npm install @cosmotech/api-ts@5.0.0-beta6 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -64,13 +64,14 @@ Class | Method | HTTP request | Description
64
64
  *DatasetApi* | [**listDatasetParts**](docs/DatasetApi.md#listdatasetparts) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset
65
65
  *DatasetApi* | [**listDatasetSecurityUsers**](docs/DatasetApi.md#listdatasetsecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list
66
66
  *DatasetApi* | [**listDatasets**](docs/DatasetApi.md#listdatasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Retrieve a list of defined Dataset
67
- *DatasetApi* | [**queryData**](docs/DatasetApi.md#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Get data of a Dataset
67
+ *DatasetApi* | [**queryData**](docs/DatasetApi.md#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
68
68
  *DatasetApi* | [**replaceDatasetPart**](docs/DatasetApi.md#replacedatasetpart) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Replace existing dataset parts of a Dataset
69
69
  *DatasetApi* | [**searchDatasetParts**](docs/DatasetApi.md#searchdatasetparts) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/search | Search Dataset parts by tags
70
70
  *DatasetApi* | [**searchDatasets**](docs/DatasetApi.md#searchdatasets) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/search | Search Datasets by tags
71
71
  *DatasetApi* | [**updateDataset**](docs/DatasetApi.md#updatedataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a Dataset
72
72
  *DatasetApi* | [**updateDatasetAccessControl**](docs/DatasetApi.md#updatedatasetaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset
73
73
  *DatasetApi* | [**updateDatasetDefaultSecurity**](docs/DatasetApi.md#updatedatasetdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/default | Set the Dataset default security
74
+ *DatasetApi* | [**updateDatasetPart**](docs/DatasetApi.md#updatedatasetpart) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Update existing dataset parts information of a Dataset
74
75
  *MetaApi* | [**about**](docs/MetaApi.md#about) | **GET** /about | Get various information about the API
75
76
  *OrganizationApi* | [**createOrganization**](docs/OrganizationApi.md#createorganization) | **POST** /organizations | Create a new organization
76
77
  *OrganizationApi* | [**createOrganizationAccessControl**](docs/OrganizationApi.md#createorganizationaccesscontrol) | **POST** /organizations/{organization_id}/security/access | Add a control access to the Organization
@@ -91,8 +92,6 @@ Class | Method | HTTP request | Description
91
92
  *RunApi* | [**getRunLogs**](docs/RunApi.md#getrunlogs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run
92
93
  *RunApi* | [**getRunStatus**](docs/RunApi.md#getrunstatus) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run
93
94
  *RunApi* | [**listRuns**](docs/RunApi.md#listruns) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner
94
- *RunApi* | [**queryRunData**](docs/RunApi.md#queryrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data
95
- *RunApi* | [**sendRunData**](docs/RunApi.md#sendrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run
96
95
  *RunnerApi* | [**createRunner**](docs/RunnerApi.md#createrunner) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner
97
96
  *RunnerApi* | [**createRunnerAccessControl**](docs/RunnerApi.md#createrunneraccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner
98
97
  *RunnerApi* | [**deleteRunner**](docs/RunnerApi.md#deleterunner) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner
@@ -110,26 +109,21 @@ Class | Method | HTTP request | Description
110
109
  *RunnerApi* | [**updateRunnerDefaultSecurity**](docs/RunnerApi.md#updaterunnerdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security
111
110
  *SolutionApi* | [**createSolution**](docs/SolutionApi.md#createsolution) | **POST** /organizations/{organization_id}/solutions | Create a new solution
112
111
  *SolutionApi* | [**createSolutionAccessControl**](docs/SolutionApi.md#createsolutionaccesscontrol) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/access | Create solution access control
113
- *SolutionApi* | [**createSolutionFile**](docs/SolutionApi.md#createsolutionfile) | **POST** /organizations/{organization_id}/solutions/{solution_id}/files | Upload a file for the Solution
114
112
  *SolutionApi* | [**createSolutionParameter**](docs/SolutionApi.md#createsolutionparameter) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution
115
113
  *SolutionApi* | [**createSolutionParameterGroup**](docs/SolutionApi.md#createsolutionparametergroup) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group
116
114
  *SolutionApi* | [**createSolutionRunTemplate**](docs/SolutionApi.md#createsolutionruntemplate) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template
117
115
  *SolutionApi* | [**deleteSolution**](docs/SolutionApi.md#deletesolution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution
118
116
  *SolutionApi* | [**deleteSolutionAccessControl**](docs/SolutionApi.md#deletesolutionaccesscontrol) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Delete solution access control
119
- *SolutionApi* | [**deleteSolutionFile**](docs/SolutionApi.md#deletesolutionfile) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/files/delete | Delete a solution file
120
- *SolutionApi* | [**deleteSolutionFiles**](docs/SolutionApi.md#deletesolutionfiles) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/files | Delete all Solution files
121
117
  *SolutionApi* | [**deleteSolutionParameter**](docs/SolutionApi.md#deletesolutionparameter) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution
122
118
  *SolutionApi* | [**deleteSolutionParameterGroup**](docs/SolutionApi.md#deletesolutionparametergroup) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Delete a parameter group from the solution
123
119
  *SolutionApi* | [**deleteSolutionRunTemplate**](docs/SolutionApi.md#deletesolutionruntemplate) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template
124
120
  *SolutionApi* | [**getRunTemplate**](docs/SolutionApi.md#getruntemplate) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates
125
121
  *SolutionApi* | [**getSolution**](docs/SolutionApi.md#getsolution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution
126
122
  *SolutionApi* | [**getSolutionAccessControl**](docs/SolutionApi.md#getsolutionaccesscontrol) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control
127
- *SolutionApi* | [**getSolutionFile**](docs/SolutionApi.md#getsolutionfile) | **GET** /organizations/{organization_id}/solutions/{solution_id}/files/download | Download the Solution File specified
128
123
  *SolutionApi* | [**getSolutionParameter**](docs/SolutionApi.md#getsolutionparameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter
129
124
  *SolutionApi* | [**getSolutionParameterGroup**](docs/SolutionApi.md#getsolutionparametergroup) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group
130
125
  *SolutionApi* | [**getSolutionSecurity**](docs/SolutionApi.md#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information
131
126
  *SolutionApi* | [**listRunTemplates**](docs/SolutionApi.md#listruntemplates) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | List all solution run templates
132
- *SolutionApi* | [**listSolutionFiles**](docs/SolutionApi.md#listsolutionfiles) | **GET** /organizations/{organization_id}/solutions/{solution_id}/files | List all Solution files
133
127
  *SolutionApi* | [**listSolutionParameterGroups**](docs/SolutionApi.md#listsolutionparametergroups) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups
134
128
  *SolutionApi* | [**listSolutionParameters**](docs/SolutionApi.md#listsolutionparameters) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters
135
129
  *SolutionApi* | [**listSolutionSecurityUsers**](docs/SolutionApi.md#listsolutionsecurityusers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users
@@ -188,12 +182,9 @@ Class | Method | HTTP request | Description
188
182
  - [OrganizationRole](docs/OrganizationRole.md)
189
183
  - [OrganizationSecurity](docs/OrganizationSecurity.md)
190
184
  - [OrganizationUpdateRequest](docs/OrganizationUpdateRequest.md)
191
- - [QueryResult](docs/QueryResult.md)
192
185
  - [ResourceSizeInfo](docs/ResourceSizeInfo.md)
193
186
  - [Run](docs/Run.md)
194
187
  - [RunContainer](docs/RunContainer.md)
195
- - [RunData](docs/RunData.md)
196
- - [RunDataQuery](docs/RunDataQuery.md)
197
188
  - [RunEditInfo](docs/RunEditInfo.md)
198
189
  - [RunResourceRequested](docs/RunResourceRequested.md)
199
190
  - [RunState](docs/RunState.md)
@@ -213,6 +204,7 @@ Class | Method | HTTP request | Description
213
204
  - [Runner](docs/Runner.md)
214
205
  - [RunnerAccessControl](docs/RunnerAccessControl.md)
215
206
  - [RunnerCreateRequest](docs/RunnerCreateRequest.md)
207
+ - [RunnerDatasets](docs/RunnerDatasets.md)
216
208
  - [RunnerEditInfo](docs/RunnerEditInfo.md)
217
209
  - [RunnerResourceSizing](docs/RunnerResourceSizing.md)
218
210
  - [RunnerRole](docs/RunnerRole.md)
@@ -220,12 +212,10 @@ Class | Method | HTTP request | Description
220
212
  - [RunnerSecurity](docs/RunnerSecurity.md)
221
213
  - [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
222
214
  - [RunnerValidationStatus](docs/RunnerValidationStatus.md)
223
- - [SendRunDataRequest](docs/SendRunDataRequest.md)
224
215
  - [Solution](docs/Solution.md)
225
216
  - [SolutionAccessControl](docs/SolutionAccessControl.md)
226
217
  - [SolutionCreateRequest](docs/SolutionCreateRequest.md)
227
218
  - [SolutionEditInfo](docs/SolutionEditInfo.md)
228
- - [SolutionFile](docs/SolutionFile.md)
229
219
  - [SolutionRole](docs/SolutionRole.md)
230
220
  - [SolutionSecurity](docs/SolutionSecurity.md)
231
221
  - [SolutionUpdateRequest](docs/SolutionUpdateRequest.md)