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

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 (56) hide show
  1. package/.github/workflows/publish.yaml +3 -4
  2. package/.github/workflows/track_dependencies.yml +28 -0
  3. package/.openapi-generator/FILES +1 -1
  4. package/README.md +4 -8
  5. package/api.ts +153 -476
  6. package/base.ts +1 -1
  7. package/common.ts +1 -1
  8. package/configuration.ts +1 -1
  9. package/dist/api.d.ts +203 -333
  10. package/dist/api.js +178 -596
  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 +83 -16
  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/RunLogs.md +23 -0
  40. package/docs/RunLogsEntry.md +21 -0
  41. package/docs/RunTemplateOrchestrator.md +11 -0
  42. package/docs/RunTemplateStepSource.md +15 -0
  43. package/docs/Runner.md +2 -2
  44. package/docs/RunnerApi.md +4 -4
  45. package/docs/RunnerCreateRequest.md +4 -4
  46. package/docs/RunnerDatasets.md +24 -0
  47. package/docs/RunnerRunTemplateParameterValue.md +1 -1
  48. package/docs/RunnerUpdateRequest.md +2 -2
  49. package/docs/SolutionApi.md +0 -290
  50. package/docs/SourceInfo.md +27 -0
  51. package/docs/SubDatasetGraphQuery.md +27 -0
  52. package/docs/TwinGraphBatchResult.md +25 -0
  53. package/docs/TwincacheStatusEnum.md +11 -0
  54. package/docs/WorkspaceSolution.md +4 -0
  55. package/index.ts +1 -1
  56. package/package.json +1 -1
@@ -12,10 +12,9 @@ jobs:
12
12
  with:
13
13
  node-version: '14.x'
14
14
  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
15
+ scope: '@cosmotech'
16
+ - run: npm version ${{ github.event.release.tag_name }} --allow-same-version --no-git-tag-version
17
+ - run: npm install
19
18
  - run: npm publish
20
19
  env:
21
20
  NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
@@ -0,0 +1,28 @@
1
+ name: Track Dependencies
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ push:
6
+ branches:
7
+ - master
8
+
9
+ jobs:
10
+ dependency_track:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - name: Checkout Repository
14
+ uses: actions/checkout@v5
15
+ - name: Install generator
16
+ run: |
17
+ npm install --global @cyclonedx/cyclonedx-npm
18
+ - name: Install project dependencies
19
+ run: npm install
20
+ - name: Generate BOM
21
+ run: cyclonedx-npm --mc-type library -o sbom.json
22
+ - name: Upload BOM to Dependency Track
23
+ uses: DependencyTrack/gh-upload-sbom@v3
24
+ with:
25
+ serverhostname: ${{ secrets.DEPENDENCY_TRACK_SERVER_HOSTNAME }}
26
+ apikey: ${{ secrets.DEPENDENCY_TRACK_API_KEY }}
27
+ project: 'd15fd01c-3d8b-42d4-a83a-ce9a5d95d72e'
28
+ bomfilename: 'sbom.json'
@@ -62,6 +62,7 @@ docs/Runner.md
62
62
  docs/RunnerAccessControl.md
63
63
  docs/RunnerApi.md
64
64
  docs/RunnerCreateRequest.md
65
+ docs/RunnerDatasets.md
65
66
  docs/RunnerEditInfo.md
66
67
  docs/RunnerResourceSizing.md
67
68
  docs/RunnerRole.md
@@ -75,7 +76,6 @@ docs/SolutionAccessControl.md
75
76
  docs/SolutionApi.md
76
77
  docs/SolutionCreateRequest.md
77
78
  docs/SolutionEditInfo.md
78
- docs/SolutionFile.md
79
79
  docs/SolutionRole.md
80
80
  docs/SolutionSecurity.md
81
81
  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.1-SNAPSHOT
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.1-SNAPSHOT --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -71,6 +71,7 @@ Class | Method | HTTP request | Description
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
@@ -110,26 +111,21 @@ Class | Method | HTTP request | Description
110
111
  *RunnerApi* | [**updateRunnerDefaultSecurity**](docs/RunnerApi.md#updaterunnerdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security
111
112
  *SolutionApi* | [**createSolution**](docs/SolutionApi.md#createsolution) | **POST** /organizations/{organization_id}/solutions | Create a new solution
112
113
  *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
114
  *SolutionApi* | [**createSolutionParameter**](docs/SolutionApi.md#createsolutionparameter) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution
115
115
  *SolutionApi* | [**createSolutionParameterGroup**](docs/SolutionApi.md#createsolutionparametergroup) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group
116
116
  *SolutionApi* | [**createSolutionRunTemplate**](docs/SolutionApi.md#createsolutionruntemplate) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template
117
117
  *SolutionApi* | [**deleteSolution**](docs/SolutionApi.md#deletesolution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution
118
118
  *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
119
  *SolutionApi* | [**deleteSolutionParameter**](docs/SolutionApi.md#deletesolutionparameter) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution
122
120
  *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
121
  *SolutionApi* | [**deleteSolutionRunTemplate**](docs/SolutionApi.md#deletesolutionruntemplate) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template
124
122
  *SolutionApi* | [**getRunTemplate**](docs/SolutionApi.md#getruntemplate) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates
125
123
  *SolutionApi* | [**getSolution**](docs/SolutionApi.md#getsolution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution
126
124
  *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
125
  *SolutionApi* | [**getSolutionParameter**](docs/SolutionApi.md#getsolutionparameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter
129
126
  *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
127
  *SolutionApi* | [**getSolutionSecurity**](docs/SolutionApi.md#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information
131
128
  *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
129
  *SolutionApi* | [**listSolutionParameterGroups**](docs/SolutionApi.md#listsolutionparametergroups) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups
134
130
  *SolutionApi* | [**listSolutionParameters**](docs/SolutionApi.md#listsolutionparameters) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters
135
131
  *SolutionApi* | [**listSolutionSecurityUsers**](docs/SolutionApi.md#listsolutionsecurityusers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users
@@ -213,6 +209,7 @@ Class | Method | HTTP request | Description
213
209
  - [Runner](docs/Runner.md)
214
210
  - [RunnerAccessControl](docs/RunnerAccessControl.md)
215
211
  - [RunnerCreateRequest](docs/RunnerCreateRequest.md)
212
+ - [RunnerDatasets](docs/RunnerDatasets.md)
216
213
  - [RunnerEditInfo](docs/RunnerEditInfo.md)
217
214
  - [RunnerResourceSizing](docs/RunnerResourceSizing.md)
218
215
  - [RunnerRole](docs/RunnerRole.md)
@@ -225,7 +222,6 @@ Class | Method | HTTP request | Description
225
222
  - [SolutionAccessControl](docs/SolutionAccessControl.md)
226
223
  - [SolutionCreateRequest](docs/SolutionCreateRequest.md)
227
224
  - [SolutionEditInfo](docs/SolutionEditInfo.md)
228
- - [SolutionFile](docs/SolutionFile.md)
229
225
  - [SolutionRole](docs/SolutionRole.md)
230
226
  - [SolutionSecurity](docs/SolutionSecurity.md)
231
227
  - [SolutionUpdateRequest](docs/SolutionUpdateRequest.md)