@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.
- package/.github/workflows/publish.yaml +3 -4
- package/.github/workflows/track_dependencies.yml +28 -0
- package/.openapi-generator/FILES +1 -1
- package/README.md +4 -8
- package/api.ts +153 -476
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +203 -333
- package/dist/api.js +178 -596
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Connector.md +41 -0
- package/docs/ConnectorApi.md +218 -0
- package/docs/ConnectorParameter.md +31 -0
- package/docs/ConnectorParameterGroup.md +25 -0
- package/docs/DatasetApi.md +83 -16
- package/docs/DatasetCompatibility.md +25 -0
- package/docs/DatasetConnector.md +27 -0
- package/docs/DatasetCopyParameters.md +25 -0
- package/docs/DatasetPartTypeEnum.md +1 -1
- package/docs/DatasetSearch.md +21 -0
- package/docs/DatasetSourceType.md +19 -0
- package/docs/DatasetTwinGraphHash.md +21 -0
- package/docs/DatasetTwinGraphInfo.md +25 -0
- package/docs/DatasetTwinGraphQuery.md +21 -0
- package/docs/DeleteHistoricalData.md +25 -0
- package/docs/FileUploadMetadata.md +22 -0
- package/docs/FileUploadValidation.md +23 -0
- package/docs/GraphProperties.md +28 -0
- package/docs/IngestionStatusEnum.md +15 -0
- package/docs/IoTypesEnum.md +11 -0
- package/docs/RunLogs.md +23 -0
- package/docs/RunLogsEntry.md +21 -0
- package/docs/RunTemplateOrchestrator.md +11 -0
- package/docs/RunTemplateStepSource.md +15 -0
- package/docs/Runner.md +2 -2
- package/docs/RunnerApi.md +4 -4
- package/docs/RunnerCreateRequest.md +4 -4
- package/docs/RunnerDatasets.md +24 -0
- package/docs/RunnerRunTemplateParameterValue.md +1 -1
- package/docs/RunnerUpdateRequest.md +2 -2
- package/docs/SolutionApi.md +0 -290
- package/docs/SourceInfo.md +27 -0
- package/docs/SubDatasetGraphQuery.md +27 -0
- package/docs/TwinGraphBatchResult.md +25 -0
- package/docs/TwincacheStatusEnum.md +11 -0
- package/docs/WorkspaceSolution.md +4 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/SolutionApi.md
CHANGED
|
@@ -6,26 +6,21 @@ All URIs are relative to *http://localhost:8080*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createSolution**](#createsolution) | **POST** /organizations/{organization_id}/solutions | Create a new solution|
|
|
8
8
|
|[**createSolutionAccessControl**](#createsolutionaccesscontrol) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/access | Create solution access control|
|
|
9
|
-
|[**createSolutionFile**](#createsolutionfile) | **POST** /organizations/{organization_id}/solutions/{solution_id}/files | Upload a file for the Solution|
|
|
10
9
|
|[**createSolutionParameter**](#createsolutionparameter) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution|
|
|
11
10
|
|[**createSolutionParameterGroup**](#createsolutionparametergroup) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group|
|
|
12
11
|
|[**createSolutionRunTemplate**](#createsolutionruntemplate) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template|
|
|
13
12
|
|[**deleteSolution**](#deletesolution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution|
|
|
14
13
|
|[**deleteSolutionAccessControl**](#deletesolutionaccesscontrol) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Delete solution access control|
|
|
15
|
-
|[**deleteSolutionFile**](#deletesolutionfile) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/files/delete | Delete a solution file|
|
|
16
|
-
|[**deleteSolutionFiles**](#deletesolutionfiles) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/files | Delete all Solution files|
|
|
17
14
|
|[**deleteSolutionParameter**](#deletesolutionparameter) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution|
|
|
18
15
|
|[**deleteSolutionParameterGroup**](#deletesolutionparametergroup) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Delete a parameter group from the solution|
|
|
19
16
|
|[**deleteSolutionRunTemplate**](#deletesolutionruntemplate) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template|
|
|
20
17
|
|[**getRunTemplate**](#getruntemplate) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates|
|
|
21
18
|
|[**getSolution**](#getsolution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution|
|
|
22
19
|
|[**getSolutionAccessControl**](#getsolutionaccesscontrol) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control|
|
|
23
|
-
|[**getSolutionFile**](#getsolutionfile) | **GET** /organizations/{organization_id}/solutions/{solution_id}/files/download | Download the Solution File specified|
|
|
24
20
|
|[**getSolutionParameter**](#getsolutionparameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter|
|
|
25
21
|
|[**getSolutionParameterGroup**](#getsolutionparametergroup) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group|
|
|
26
22
|
|[**getSolutionSecurity**](#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information|
|
|
27
23
|
|[**listRunTemplates**](#listruntemplates) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | List all solution run templates|
|
|
28
|
-
|[**listSolutionFiles**](#listsolutionfiles) | **GET** /organizations/{organization_id}/solutions/{solution_id}/files | List all Solution files|
|
|
29
24
|
|[**listSolutionParameterGroups**](#listsolutionparametergroups) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups|
|
|
30
25
|
|[**listSolutionParameters**](#listsolutionparameters) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters|
|
|
31
26
|
|[**listSolutionSecurityUsers**](#listsolutionsecurityusers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users|
|
|
@@ -150,69 +145,6 @@ const { status, data } = await apiInstance.createSolutionAccessControl(
|
|
|
150
145
|
|
|
151
146
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
152
147
|
|
|
153
|
-
# **createSolutionFile**
|
|
154
|
-
> SolutionFile createSolutionFile()
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
### Example
|
|
158
|
-
|
|
159
|
-
```typescript
|
|
160
|
-
import {
|
|
161
|
-
SolutionApi,
|
|
162
|
-
Configuration
|
|
163
|
-
} from '@cosmotech/api-ts';
|
|
164
|
-
|
|
165
|
-
const configuration = new Configuration();
|
|
166
|
-
const apiInstance = new SolutionApi(configuration);
|
|
167
|
-
|
|
168
|
-
let organizationId: string; //the Organization identifier (default to undefined)
|
|
169
|
-
let solutionId: string; //the Solution identifier (default to undefined)
|
|
170
|
-
let file: File; //The file to upload (default to undefined)
|
|
171
|
-
let overwrite: boolean; //Whether to overwrite an existing file (optional) (default to false)
|
|
172
|
-
let destination: string; //Destination path. Must end with a \\\'/\\\' if specifying a folder. Note that paths may or may not start with a \\\'/\\\', but they are always treated as relative to the Solution root location. (optional) (default to undefined)
|
|
173
|
-
|
|
174
|
-
const { status, data } = await apiInstance.createSolutionFile(
|
|
175
|
-
organizationId,
|
|
176
|
-
solutionId,
|
|
177
|
-
file,
|
|
178
|
-
overwrite,
|
|
179
|
-
destination
|
|
180
|
-
);
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
### Parameters
|
|
184
|
-
|
|
185
|
-
|Name | Type | Description | Notes|
|
|
186
|
-
|------------- | ------------- | ------------- | -------------|
|
|
187
|
-
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
188
|
-
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
189
|
-
| **file** | [**File**] | The file to upload | defaults to undefined|
|
|
190
|
-
| **overwrite** | [**boolean**] | Whether to overwrite an existing file | (optional) defaults to false|
|
|
191
|
-
| **destination** | [**string**] | Destination path. Must end with a \\\'/\\\' if specifying a folder. Note that paths may or may not start with a \\\'/\\\', but they are always treated as relative to the Solution root location. | (optional) defaults to undefined|
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
### Return type
|
|
195
|
-
|
|
196
|
-
**SolutionFile**
|
|
197
|
-
|
|
198
|
-
### Authorization
|
|
199
|
-
|
|
200
|
-
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
201
|
-
|
|
202
|
-
### HTTP request headers
|
|
203
|
-
|
|
204
|
-
- **Content-Type**: multipart/form-data
|
|
205
|
-
- **Accept**: application/json, application/yaml
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
### HTTP response details
|
|
209
|
-
| Status code | Description | Response headers |
|
|
210
|
-
|-------------|-------------|------------------|
|
|
211
|
-
|**201** | The file resource details | - |
|
|
212
|
-
|**400** | Bad request | - |
|
|
213
|
-
|
|
214
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
215
|
-
|
|
216
148
|
# **createSolutionParameter**
|
|
217
149
|
> RunTemplateParameter createSolutionParameter(runTemplateParameterCreateRequest)
|
|
218
150
|
|
|
@@ -501,117 +433,6 @@ void (empty response body)
|
|
|
501
433
|
|
|
502
434
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
503
435
|
|
|
504
|
-
# **deleteSolutionFile**
|
|
505
|
-
> deleteSolutionFile()
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
### Example
|
|
509
|
-
|
|
510
|
-
```typescript
|
|
511
|
-
import {
|
|
512
|
-
SolutionApi,
|
|
513
|
-
Configuration
|
|
514
|
-
} from '@cosmotech/api-ts';
|
|
515
|
-
|
|
516
|
-
const configuration = new Configuration();
|
|
517
|
-
const apiInstance = new SolutionApi(configuration);
|
|
518
|
-
|
|
519
|
-
let organizationId: string; //the Organization identifier (default to undefined)
|
|
520
|
-
let solutionId: string; //the Solution identifier (default to undefined)
|
|
521
|
-
let fileName: string; //The file name (default to undefined)
|
|
522
|
-
|
|
523
|
-
const { status, data } = await apiInstance.deleteSolutionFile(
|
|
524
|
-
organizationId,
|
|
525
|
-
solutionId,
|
|
526
|
-
fileName
|
|
527
|
-
);
|
|
528
|
-
```
|
|
529
|
-
|
|
530
|
-
### Parameters
|
|
531
|
-
|
|
532
|
-
|Name | Type | Description | Notes|
|
|
533
|
-
|------------- | ------------- | ------------- | -------------|
|
|
534
|
-
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
535
|
-
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
536
|
-
| **fileName** | [**string**] | The file name | defaults to undefined|
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
### Return type
|
|
540
|
-
|
|
541
|
-
void (empty response body)
|
|
542
|
-
|
|
543
|
-
### Authorization
|
|
544
|
-
|
|
545
|
-
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
546
|
-
|
|
547
|
-
### HTTP request headers
|
|
548
|
-
|
|
549
|
-
- **Content-Type**: Not defined
|
|
550
|
-
- **Accept**: Not defined
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
### HTTP response details
|
|
554
|
-
| Status code | Description | Response headers |
|
|
555
|
-
|-------------|-------------|------------------|
|
|
556
|
-
|**204** | Request succeeded | - |
|
|
557
|
-
|**404** | The Solution or the file specified is unknown or you don\'t have access to them | - |
|
|
558
|
-
|
|
559
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
560
|
-
|
|
561
|
-
# **deleteSolutionFiles**
|
|
562
|
-
> deleteSolutionFiles()
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
### Example
|
|
566
|
-
|
|
567
|
-
```typescript
|
|
568
|
-
import {
|
|
569
|
-
SolutionApi,
|
|
570
|
-
Configuration
|
|
571
|
-
} from '@cosmotech/api-ts';
|
|
572
|
-
|
|
573
|
-
const configuration = new Configuration();
|
|
574
|
-
const apiInstance = new SolutionApi(configuration);
|
|
575
|
-
|
|
576
|
-
let organizationId: string; //the Organization identifier (default to undefined)
|
|
577
|
-
let solutionId: string; //the Solution identifier (default to undefined)
|
|
578
|
-
|
|
579
|
-
const { status, data } = await apiInstance.deleteSolutionFiles(
|
|
580
|
-
organizationId,
|
|
581
|
-
solutionId
|
|
582
|
-
);
|
|
583
|
-
```
|
|
584
|
-
|
|
585
|
-
### Parameters
|
|
586
|
-
|
|
587
|
-
|Name | Type | Description | Notes|
|
|
588
|
-
|------------- | ------------- | ------------- | -------------|
|
|
589
|
-
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
590
|
-
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
### Return type
|
|
594
|
-
|
|
595
|
-
void (empty response body)
|
|
596
|
-
|
|
597
|
-
### Authorization
|
|
598
|
-
|
|
599
|
-
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
600
|
-
|
|
601
|
-
### HTTP request headers
|
|
602
|
-
|
|
603
|
-
- **Content-Type**: Not defined
|
|
604
|
-
- **Accept**: Not defined
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
### HTTP response details
|
|
608
|
-
| Status code | Description | Response headers |
|
|
609
|
-
|-------------|-------------|------------------|
|
|
610
|
-
|**204** | Request succeeded | - |
|
|
611
|
-
|**404** | The Solution specified is unknown or you don\'t have access to them | - |
|
|
612
|
-
|
|
613
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
614
|
-
|
|
615
436
|
# **deleteSolutionParameter**
|
|
616
437
|
> deleteSolutionParameter()
|
|
617
438
|
|
|
@@ -951,63 +772,6 @@ const { status, data } = await apiInstance.getSolutionAccessControl(
|
|
|
951
772
|
|
|
952
773
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
953
774
|
|
|
954
|
-
# **getSolutionFile**
|
|
955
|
-
> File getSolutionFile()
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
### Example
|
|
959
|
-
|
|
960
|
-
```typescript
|
|
961
|
-
import {
|
|
962
|
-
SolutionApi,
|
|
963
|
-
Configuration
|
|
964
|
-
} from '@cosmotech/api-ts';
|
|
965
|
-
|
|
966
|
-
const configuration = new Configuration();
|
|
967
|
-
const apiInstance = new SolutionApi(configuration);
|
|
968
|
-
|
|
969
|
-
let organizationId: string; //the Organization identifier (default to undefined)
|
|
970
|
-
let solutionId: string; //the Solution identifier (default to undefined)
|
|
971
|
-
let fileName: string; //The file name (default to undefined)
|
|
972
|
-
|
|
973
|
-
const { status, data } = await apiInstance.getSolutionFile(
|
|
974
|
-
organizationId,
|
|
975
|
-
solutionId,
|
|
976
|
-
fileName
|
|
977
|
-
);
|
|
978
|
-
```
|
|
979
|
-
|
|
980
|
-
### Parameters
|
|
981
|
-
|
|
982
|
-
|Name | Type | Description | Notes|
|
|
983
|
-
|------------- | ------------- | ------------- | -------------|
|
|
984
|
-
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
985
|
-
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
986
|
-
| **fileName** | [**string**] | The file name | defaults to undefined|
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
### Return type
|
|
990
|
-
|
|
991
|
-
**File**
|
|
992
|
-
|
|
993
|
-
### Authorization
|
|
994
|
-
|
|
995
|
-
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
996
|
-
|
|
997
|
-
### HTTP request headers
|
|
998
|
-
|
|
999
|
-
- **Content-Type**: Not defined
|
|
1000
|
-
- **Accept**: application/octet-stream
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
### HTTP response details
|
|
1004
|
-
| Status code | Description | Response headers |
|
|
1005
|
-
|-------------|-------------|------------------|
|
|
1006
|
-
|**200** | The solution file as a resource | - |
|
|
1007
|
-
|**404** | The Solution file specified is unknown or you don\'t have access to it | - |
|
|
1008
|
-
|
|
1009
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1010
|
-
|
|
1011
775
|
# **getSolutionParameter**
|
|
1012
776
|
> RunTemplateParameter getSolutionParameter()
|
|
1013
777
|
|
|
@@ -1231,60 +995,6 @@ const { status, data } = await apiInstance.listRunTemplates(
|
|
|
1231
995
|
|
|
1232
996
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1233
997
|
|
|
1234
|
-
# **listSolutionFiles**
|
|
1235
|
-
> Array<SolutionFile> listSolutionFiles()
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
### Example
|
|
1239
|
-
|
|
1240
|
-
```typescript
|
|
1241
|
-
import {
|
|
1242
|
-
SolutionApi,
|
|
1243
|
-
Configuration
|
|
1244
|
-
} from '@cosmotech/api-ts';
|
|
1245
|
-
|
|
1246
|
-
const configuration = new Configuration();
|
|
1247
|
-
const apiInstance = new SolutionApi(configuration);
|
|
1248
|
-
|
|
1249
|
-
let organizationId: string; //the Organization identifier (default to undefined)
|
|
1250
|
-
let solutionId: string; //the Solution identifier (default to undefined)
|
|
1251
|
-
|
|
1252
|
-
const { status, data } = await apiInstance.listSolutionFiles(
|
|
1253
|
-
organizationId,
|
|
1254
|
-
solutionId
|
|
1255
|
-
);
|
|
1256
|
-
```
|
|
1257
|
-
|
|
1258
|
-
### Parameters
|
|
1259
|
-
|
|
1260
|
-
|Name | Type | Description | Notes|
|
|
1261
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1262
|
-
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
1263
|
-
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
### Return type
|
|
1267
|
-
|
|
1268
|
-
**Array<SolutionFile>**
|
|
1269
|
-
|
|
1270
|
-
### Authorization
|
|
1271
|
-
|
|
1272
|
-
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
1273
|
-
|
|
1274
|
-
### HTTP request headers
|
|
1275
|
-
|
|
1276
|
-
- **Content-Type**: Not defined
|
|
1277
|
-
- **Accept**: application/json, application/yaml
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
### HTTP response details
|
|
1281
|
-
| Status code | Description | Response headers |
|
|
1282
|
-
|-------------|-------------|------------------|
|
|
1283
|
-
|**200** | The solution files | - |
|
|
1284
|
-
|**404** | The Solution specified is unknown or you don\'t have access to it | - |
|
|
1285
|
-
|
|
1286
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1287
|
-
|
|
1288
998
|
# **listSolutionParameterGroups**
|
|
1289
999
|
> Array<RunTemplateParameterGroup> listSolutionParameterGroups()
|
|
1290
1000
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# SourceInfo
|
|
2
|
+
|
|
3
|
+
Source job import information
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | the source name containing the files to import | [optional] [default to undefined]
|
|
10
|
+
**location** | **string** | the source location containing the files to import | [default to undefined]
|
|
11
|
+
**path** | **string** | the source location containing the files to import | [optional] [default to undefined]
|
|
12
|
+
**jobId** | **string** | indicate the last import jobId | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { SourceInfo } from '@cosmotech/api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: SourceInfo = {
|
|
20
|
+
name,
|
|
21
|
+
location,
|
|
22
|
+
path,
|
|
23
|
+
jobId,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# SubDatasetGraphQuery
|
|
2
|
+
|
|
3
|
+
a twin graph query in cypher language
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | the name of the subdataset | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | the description of the subdataset | [optional] [default to undefined]
|
|
11
|
+
**queries** | **Array<string>** | the query in cypher language | [optional] [default to undefined]
|
|
12
|
+
**main** | **boolean** | is this the main dataset | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { SubDatasetGraphQuery } from '@cosmotech/api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: SubDatasetGraphQuery = {
|
|
20
|
+
name,
|
|
21
|
+
description,
|
|
22
|
+
queries,
|
|
23
|
+
main,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TwinGraphBatchResult
|
|
2
|
+
|
|
3
|
+
Processing result
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**totalLines** | **number** | | [default to undefined]
|
|
10
|
+
**processedLines** | **number** | | [default to undefined]
|
|
11
|
+
**errors** | **Array<string>** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { TwinGraphBatchResult } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: TwinGraphBatchResult = {
|
|
19
|
+
totalLines,
|
|
20
|
+
processedLines,
|
|
21
|
+
errors,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# TwincacheStatusEnum
|
|
2
|
+
|
|
3
|
+
the twincache data status
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Empty` (value: `'EMPTY'`)
|
|
8
|
+
|
|
9
|
+
* `Full` (value: `'FULL'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,6 +7,8 @@ The Workspace Solution configuration
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**solutionId** | **string** | The Solution Id attached to this workspace | [default to undefined]
|
|
10
|
+
**datasetId** | **string** | The Dataset Id attached to this workspace. This dataset will be used to store default values for Solution parameters with file\'s varType. | [optional] [default to undefined]
|
|
11
|
+
**defaultParameterValues** | **{ [key: string]: string; }** | A map of parameterId/value to set default values for Solution parameters with simple varType (int, string, ...) | [optional] [default to undefined]
|
|
10
12
|
**runTemplateFilter** | **Array<string>** | The list of Solution Run Template Id to filter | [optional] [default to undefined]
|
|
11
13
|
**defaultRunTemplateDataset** | **{ [key: string]: any; }** | A map of RunTemplateId/DatasetId to set a default dataset for a Run Template | [optional] [default to undefined]
|
|
12
14
|
|
|
@@ -17,6 +19,8 @@ import { WorkspaceSolution } from '@cosmotech/api-ts';
|
|
|
17
19
|
|
|
18
20
|
const instance: WorkspaceSolution = {
|
|
19
21
|
solutionId,
|
|
22
|
+
datasetId,
|
|
23
|
+
defaultParameterValues,
|
|
20
24
|
runTemplateFilter,
|
|
21
25
|
defaultRunTemplateDataset,
|
|
22
26
|
};
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Cosmo Tech Platform API
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.0.
|
|
7
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
8
8
|
* Contact: platform@cosmotech.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|