@cosmotech/api-ts 5.0.0-beta3 → 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 (46) 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 -0
  4. package/README.md +2 -0
  5. package/api.ts +366 -220
  6. package/dist/api.d.ts +416 -322
  7. package/dist/api.js +338 -217
  8. package/docs/Connector.md +41 -0
  9. package/docs/ConnectorApi.md +218 -0
  10. package/docs/ConnectorParameter.md +31 -0
  11. package/docs/ConnectorParameterGroup.md +25 -0
  12. package/docs/DatasetApi.md +83 -16
  13. package/docs/DatasetCompatibility.md +25 -0
  14. package/docs/DatasetConnector.md +27 -0
  15. package/docs/DatasetCopyParameters.md +25 -0
  16. package/docs/DatasetPartTypeEnum.md +1 -1
  17. package/docs/DatasetPartUpdateRequest.md +2 -0
  18. package/docs/DatasetSearch.md +21 -0
  19. package/docs/DatasetSourceType.md +19 -0
  20. package/docs/DatasetTwinGraphHash.md +21 -0
  21. package/docs/DatasetTwinGraphInfo.md +25 -0
  22. package/docs/DatasetTwinGraphQuery.md +21 -0
  23. package/docs/DeleteHistoricalData.md +25 -0
  24. package/docs/FileUploadMetadata.md +22 -0
  25. package/docs/FileUploadValidation.md +23 -0
  26. package/docs/GraphProperties.md +28 -0
  27. package/docs/IngestionStatusEnum.md +15 -0
  28. package/docs/IoTypesEnum.md +11 -0
  29. package/docs/RunLogs.md +23 -0
  30. package/docs/RunLogsEntry.md +21 -0
  31. package/docs/RunTemplateOrchestrator.md +11 -0
  32. package/docs/RunTemplateStepSource.md +15 -0
  33. package/docs/Runner.md +2 -2
  34. package/docs/RunnerApi.md +4 -4
  35. package/docs/RunnerCreateRequest.md +4 -4
  36. package/docs/RunnerDatasets.md +24 -0
  37. package/docs/RunnerRunTemplateParameterValue.md +1 -1
  38. package/docs/RunnerUpdateRequest.md +2 -2
  39. package/docs/SolutionApi.md +104 -104
  40. package/docs/SolutionFile.md +21 -0
  41. package/docs/SourceInfo.md +27 -0
  42. package/docs/SubDatasetGraphQuery.md +27 -0
  43. package/docs/TwinGraphBatchResult.md +25 -0
  44. package/docs/TwincacheStatusEnum.md +11 -0
  45. package/docs/WorkspaceSolution.md +4 -0
  46. package/package.json +1 -1
@@ -48,7 +48,7 @@ import {
48
48
  const configuration = new Configuration();
49
49
  const apiInstance = new SolutionApi(configuration);
50
50
 
51
- let organizationId: string; //The Organization identifier (default to undefined)
51
+ let organizationId: string; //the Organization identifier (default to undefined)
52
52
  let solutionCreateRequest: SolutionCreateRequest; //The Solution to create
53
53
 
54
54
  const { status, data } = await apiInstance.createSolution(
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.createSolution(
62
62
  |Name | Type | Description | Notes|
63
63
  |------------- | ------------- | ------------- | -------------|
64
64
  | **solutionCreateRequest** | **SolutionCreateRequest**| The Solution to create | |
65
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
65
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
66
66
 
67
67
 
68
68
  ### Return type
@@ -103,8 +103,8 @@ import {
103
103
  const configuration = new Configuration();
104
104
  const apiInstance = new SolutionApi(configuration);
105
105
 
106
- let organizationId: string; //The Organization identifier (default to undefined)
107
- let solutionId: string; //The Solution identifier (default to undefined)
106
+ let organizationId: string; //the Organization identifier (default to undefined)
107
+ let solutionId: string; //the Solution identifier (default to undefined)
108
108
  let solutionAccessControl: SolutionAccessControl; //Access control to create
109
109
 
110
110
  const { status, data } = await apiInstance.createSolutionAccessControl(
@@ -119,8 +119,8 @@ const { status, data } = await apiInstance.createSolutionAccessControl(
119
119
  |Name | Type | Description | Notes|
120
120
  |------------- | ------------- | ------------- | -------------|
121
121
  | **solutionAccessControl** | **SolutionAccessControl**| Access control to create | |
122
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
123
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
122
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
123
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
124
124
 
125
125
 
126
126
  ### Return type
@@ -161,8 +161,8 @@ import {
161
161
  const configuration = new Configuration();
162
162
  const apiInstance = new SolutionApi(configuration);
163
163
 
164
- let organizationId: string; //The Organization identifier (default to undefined)
165
- let solutionId: string; //The Solution identifier (default to undefined)
164
+ let organizationId: string; //the Organization identifier (default to undefined)
165
+ let solutionId: string; //the Solution identifier (default to undefined)
166
166
  let runTemplateParameterCreateRequest: RunTemplateParameterCreateRequest; //Parameter to create
167
167
 
168
168
  const { status, data } = await apiInstance.createSolutionParameter(
@@ -177,8 +177,8 @@ const { status, data } = await apiInstance.createSolutionParameter(
177
177
  |Name | Type | Description | Notes|
178
178
  |------------- | ------------- | ------------- | -------------|
179
179
  | **runTemplateParameterCreateRequest** | **RunTemplateParameterCreateRequest**| Parameter to create | |
180
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
181
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
180
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
181
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
182
182
 
183
183
 
184
184
  ### Return type
@@ -220,8 +220,8 @@ import {
220
220
  const configuration = new Configuration();
221
221
  const apiInstance = new SolutionApi(configuration);
222
222
 
223
- let organizationId: string; //The Organization identifier (default to undefined)
224
- let solutionId: string; //The Solution identifier (default to undefined)
223
+ let organizationId: string; //the Organization identifier (default to undefined)
224
+ let solutionId: string; //the Solution identifier (default to undefined)
225
225
  let runTemplateParameterGroupCreateRequest: RunTemplateParameterGroupCreateRequest; //Parameter group to create
226
226
 
227
227
  const { status, data } = await apiInstance.createSolutionParameterGroup(
@@ -236,8 +236,8 @@ const { status, data } = await apiInstance.createSolutionParameterGroup(
236
236
  |Name | Type | Description | Notes|
237
237
  |------------- | ------------- | ------------- | -------------|
238
238
  | **runTemplateParameterGroupCreateRequest** | **RunTemplateParameterGroupCreateRequest**| Parameter group to create | |
239
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
240
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
239
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
240
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
241
241
 
242
242
 
243
243
  ### Return type
@@ -279,8 +279,8 @@ import {
279
279
  const configuration = new Configuration();
280
280
  const apiInstance = new SolutionApi(configuration);
281
281
 
282
- let organizationId: string; //The Organization identifier (default to undefined)
283
- let solutionId: string; //The Solution identifier (default to undefined)
282
+ let organizationId: string; //the Organization identifier (default to undefined)
283
+ let solutionId: string; //the Solution identifier (default to undefined)
284
284
  let runTemplateCreateRequest: RunTemplateCreateRequest; //Run template to create
285
285
 
286
286
  const { status, data } = await apiInstance.createSolutionRunTemplate(
@@ -295,8 +295,8 @@ const { status, data } = await apiInstance.createSolutionRunTemplate(
295
295
  |Name | Type | Description | Notes|
296
296
  |------------- | ------------- | ------------- | -------------|
297
297
  | **runTemplateCreateRequest** | **RunTemplateCreateRequest**| Run template to create | |
298
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
299
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
298
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
299
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
300
300
 
301
301
 
302
302
  ### Return type
@@ -337,8 +337,8 @@ import {
337
337
  const configuration = new Configuration();
338
338
  const apiInstance = new SolutionApi(configuration);
339
339
 
340
- let organizationId: string; //The Organization identifier (default to undefined)
341
- let solutionId: string; //The Solution identifier (default to undefined)
340
+ let organizationId: string; //the Organization identifier (default to undefined)
341
+ let solutionId: string; //the Solution identifier (default to undefined)
342
342
 
343
343
  const { status, data } = await apiInstance.deleteSolution(
344
344
  organizationId,
@@ -350,8 +350,8 @@ const { status, data } = await apiInstance.deleteSolution(
350
350
 
351
351
  |Name | Type | Description | Notes|
352
352
  |------------- | ------------- | ------------- | -------------|
353
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
354
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
353
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
354
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
355
355
 
356
356
 
357
357
  ### Return type
@@ -391,8 +391,8 @@ import {
391
391
  const configuration = new Configuration();
392
392
  const apiInstance = new SolutionApi(configuration);
393
393
 
394
- let organizationId: string; //The Organization identifier (default to undefined)
395
- let solutionId: string; //The Solution identifier (default to undefined)
394
+ let organizationId: string; //the Organization identifier (default to undefined)
395
+ let solutionId: string; //the Solution identifier (default to undefined)
396
396
  let identityId: string; //The User identifier (default to undefined)
397
397
 
398
398
  const { status, data } = await apiInstance.deleteSolutionAccessControl(
@@ -406,8 +406,8 @@ const { status, data } = await apiInstance.deleteSolutionAccessControl(
406
406
 
407
407
  |Name | Type | Description | Notes|
408
408
  |------------- | ------------- | ------------- | -------------|
409
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
410
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
409
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
410
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
411
411
  | **identityId** | [**string**] | The User identifier | defaults to undefined|
412
412
 
413
413
 
@@ -448,8 +448,8 @@ import {
448
448
  const configuration = new Configuration();
449
449
  const apiInstance = new SolutionApi(configuration);
450
450
 
451
- let organizationId: string; //The Organization identifier (default to undefined)
452
- let solutionId: string; //The Solution identifier (default to undefined)
451
+ let organizationId: string; //the Organization identifier (default to undefined)
452
+ let solutionId: string; //the Solution identifier (default to undefined)
453
453
  let parameterId: string; //The solution parameter identifier (default to undefined)
454
454
 
455
455
  const { status, data } = await apiInstance.deleteSolutionParameter(
@@ -463,8 +463,8 @@ const { status, data } = await apiInstance.deleteSolutionParameter(
463
463
 
464
464
  |Name | Type | Description | Notes|
465
465
  |------------- | ------------- | ------------- | -------------|
466
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
467
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
466
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
467
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
468
468
  | **parameterId** | [**string**] | The solution parameter identifier | defaults to undefined|
469
469
 
470
470
 
@@ -505,8 +505,8 @@ import {
505
505
  const configuration = new Configuration();
506
506
  const apiInstance = new SolutionApi(configuration);
507
507
 
508
- let organizationId: string; //The Organization identifier (default to undefined)
509
- let solutionId: string; //The Solution identifier (default to undefined)
508
+ let organizationId: string; //the Organization identifier (default to undefined)
509
+ let solutionId: string; //the Solution identifier (default to undefined)
510
510
  let parameterGroupId: string; //The parameter group identifier (default to undefined)
511
511
 
512
512
  const { status, data } = await apiInstance.deleteSolutionParameterGroup(
@@ -520,8 +520,8 @@ const { status, data } = await apiInstance.deleteSolutionParameterGroup(
520
520
 
521
521
  |Name | Type | Description | Notes|
522
522
  |------------- | ------------- | ------------- | -------------|
523
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
524
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
523
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
524
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
525
525
  | **parameterGroupId** | [**string**] | The parameter group identifier | defaults to undefined|
526
526
 
527
527
 
@@ -562,8 +562,8 @@ import {
562
562
  const configuration = new Configuration();
563
563
  const apiInstance = new SolutionApi(configuration);
564
564
 
565
- let organizationId: string; //The Organization identifier (default to undefined)
566
- let solutionId: string; //The Solution identifier (default to undefined)
565
+ let organizationId: string; //the Organization identifier (default to undefined)
566
+ let solutionId: string; //the Solution identifier (default to undefined)
567
567
  let runTemplateId: string; //The Run Template identifier (default to undefined)
568
568
 
569
569
  const { status, data } = await apiInstance.deleteSolutionRunTemplate(
@@ -577,8 +577,8 @@ const { status, data } = await apiInstance.deleteSolutionRunTemplate(
577
577
 
578
578
  |Name | Type | Description | Notes|
579
579
  |------------- | ------------- | ------------- | -------------|
580
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
581
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
580
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
581
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
582
582
  | **runTemplateId** | [**string**] | The Run Template identifier | defaults to undefined|
583
583
 
584
584
 
@@ -619,8 +619,8 @@ import {
619
619
  const configuration = new Configuration();
620
620
  const apiInstance = new SolutionApi(configuration);
621
621
 
622
- let organizationId: string; //The Organization identifier (default to undefined)
623
- let solutionId: string; //The Solution identifier (default to undefined)
622
+ let organizationId: string; //the Organization identifier (default to undefined)
623
+ let solutionId: string; //the Solution identifier (default to undefined)
624
624
  let runTemplateId: string; //The Run Template identifier (default to undefined)
625
625
 
626
626
  const { status, data } = await apiInstance.getRunTemplate(
@@ -634,8 +634,8 @@ const { status, data } = await apiInstance.getRunTemplate(
634
634
 
635
635
  |Name | Type | Description | Notes|
636
636
  |------------- | ------------- | ------------- | -------------|
637
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
638
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
637
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
638
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
639
639
  | **runTemplateId** | [**string**] | The Run Template identifier | defaults to undefined|
640
640
 
641
641
 
@@ -676,8 +676,8 @@ import {
676
676
  const configuration = new Configuration();
677
677
  const apiInstance = new SolutionApi(configuration);
678
678
 
679
- let organizationId: string; //The Organization identifier (default to undefined)
680
- let solutionId: string; //The Solution identifier (default to undefined)
679
+ let organizationId: string; //the Organization identifier (default to undefined)
680
+ let solutionId: string; //the Solution identifier (default to undefined)
681
681
 
682
682
  const { status, data } = await apiInstance.getSolution(
683
683
  organizationId,
@@ -689,8 +689,8 @@ const { status, data } = await apiInstance.getSolution(
689
689
 
690
690
  |Name | Type | Description | Notes|
691
691
  |------------- | ------------- | ------------- | -------------|
692
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
693
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
692
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
693
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
694
694
 
695
695
 
696
696
  ### Return type
@@ -730,8 +730,8 @@ import {
730
730
  const configuration = new Configuration();
731
731
  const apiInstance = new SolutionApi(configuration);
732
732
 
733
- let organizationId: string; //The Organization identifier (default to undefined)
734
- let solutionId: string; //The Solution identifier (default to undefined)
733
+ let organizationId: string; //the Organization identifier (default to undefined)
734
+ let solutionId: string; //the Solution identifier (default to undefined)
735
735
  let identityId: string; //The User identifier (default to undefined)
736
736
 
737
737
  const { status, data } = await apiInstance.getSolutionAccessControl(
@@ -745,8 +745,8 @@ const { status, data } = await apiInstance.getSolutionAccessControl(
745
745
 
746
746
  |Name | Type | Description | Notes|
747
747
  |------------- | ------------- | ------------- | -------------|
748
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
749
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
748
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
749
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
750
750
  | **identityId** | [**string**] | The User identifier | defaults to undefined|
751
751
 
752
752
 
@@ -787,8 +787,8 @@ import {
787
787
  const configuration = new Configuration();
788
788
  const apiInstance = new SolutionApi(configuration);
789
789
 
790
- let organizationId: string; //The Organization identifier (default to undefined)
791
- let solutionId: string; //The Solution identifier (default to undefined)
790
+ let organizationId: string; //the Organization identifier (default to undefined)
791
+ let solutionId: string; //the Solution identifier (default to undefined)
792
792
  let parameterId: string; //The solution parameter identifier (default to undefined)
793
793
 
794
794
  const { status, data } = await apiInstance.getSolutionParameter(
@@ -802,8 +802,8 @@ const { status, data } = await apiInstance.getSolutionParameter(
802
802
 
803
803
  |Name | Type | Description | Notes|
804
804
  |------------- | ------------- | ------------- | -------------|
805
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
806
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
805
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
806
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
807
807
  | **parameterId** | [**string**] | The solution parameter identifier | defaults to undefined|
808
808
 
809
809
 
@@ -845,8 +845,8 @@ import {
845
845
  const configuration = new Configuration();
846
846
  const apiInstance = new SolutionApi(configuration);
847
847
 
848
- let organizationId: string; //The Organization identifier (default to undefined)
849
- let solutionId: string; //The Solution identifier (default to undefined)
848
+ let organizationId: string; //the Organization identifier (default to undefined)
849
+ let solutionId: string; //the Solution identifier (default to undefined)
850
850
  let parameterGroupId: string; //The parameter group identifier (default to undefined)
851
851
 
852
852
  const { status, data } = await apiInstance.getSolutionParameterGroup(
@@ -860,8 +860,8 @@ const { status, data } = await apiInstance.getSolutionParameterGroup(
860
860
 
861
861
  |Name | Type | Description | Notes|
862
862
  |------------- | ------------- | ------------- | -------------|
863
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
864
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
863
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
864
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
865
865
  | **parameterGroupId** | [**string**] | The parameter group identifier | defaults to undefined|
866
866
 
867
867
 
@@ -902,8 +902,8 @@ import {
902
902
  const configuration = new Configuration();
903
903
  const apiInstance = new SolutionApi(configuration);
904
904
 
905
- let organizationId: string; //The Organization identifier (default to undefined)
906
- let solutionId: string; //The Solution identifier (default to undefined)
905
+ let organizationId: string; //the Organization identifier (default to undefined)
906
+ let solutionId: string; //the Solution identifier (default to undefined)
907
907
 
908
908
  const { status, data } = await apiInstance.getSolutionSecurity(
909
909
  organizationId,
@@ -915,8 +915,8 @@ const { status, data } = await apiInstance.getSolutionSecurity(
915
915
 
916
916
  |Name | Type | Description | Notes|
917
917
  |------------- | ------------- | ------------- | -------------|
918
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
919
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
918
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
919
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
920
920
 
921
921
 
922
922
  ### Return type
@@ -956,8 +956,8 @@ import {
956
956
  const configuration = new Configuration();
957
957
  const apiInstance = new SolutionApi(configuration);
958
958
 
959
- let organizationId: string; //The Organization identifier (default to undefined)
960
- let solutionId: string; //The Solution identifier (default to undefined)
959
+ let organizationId: string; //the Organization identifier (default to undefined)
960
+ let solutionId: string; //the Solution identifier (default to undefined)
961
961
 
962
962
  const { status, data } = await apiInstance.listRunTemplates(
963
963
  organizationId,
@@ -969,8 +969,8 @@ const { status, data } = await apiInstance.listRunTemplates(
969
969
 
970
970
  |Name | Type | Description | Notes|
971
971
  |------------- | ------------- | ------------- | -------------|
972
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
973
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
972
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
973
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
974
974
 
975
975
 
976
976
  ### Return type
@@ -1010,8 +1010,8 @@ import {
1010
1010
  const configuration = new Configuration();
1011
1011
  const apiInstance = new SolutionApi(configuration);
1012
1012
 
1013
- let organizationId: string; //The Organization identifier (default to undefined)
1014
- let solutionId: string; //The Solution identifier (default to undefined)
1013
+ let organizationId: string; //the Organization identifier (default to undefined)
1014
+ let solutionId: string; //the Solution identifier (default to undefined)
1015
1015
 
1016
1016
  const { status, data } = await apiInstance.listSolutionParameterGroups(
1017
1017
  organizationId,
@@ -1023,8 +1023,8 @@ const { status, data } = await apiInstance.listSolutionParameterGroups(
1023
1023
 
1024
1024
  |Name | Type | Description | Notes|
1025
1025
  |------------- | ------------- | ------------- | -------------|
1026
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1027
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1026
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1027
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1028
1028
 
1029
1029
 
1030
1030
  ### Return type
@@ -1064,8 +1064,8 @@ import {
1064
1064
  const configuration = new Configuration();
1065
1065
  const apiInstance = new SolutionApi(configuration);
1066
1066
 
1067
- let organizationId: string; //The Organization identifier (default to undefined)
1068
- let solutionId: string; //The Solution identifier (default to undefined)
1067
+ let organizationId: string; //the Organization identifier (default to undefined)
1068
+ let solutionId: string; //the Solution identifier (default to undefined)
1069
1069
 
1070
1070
  const { status, data } = await apiInstance.listSolutionParameters(
1071
1071
  organizationId,
@@ -1077,8 +1077,8 @@ const { status, data } = await apiInstance.listSolutionParameters(
1077
1077
 
1078
1078
  |Name | Type | Description | Notes|
1079
1079
  |------------- | ------------- | ------------- | -------------|
1080
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1081
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1080
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1081
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1082
1082
 
1083
1083
 
1084
1084
  ### Return type
@@ -1119,8 +1119,8 @@ import {
1119
1119
  const configuration = new Configuration();
1120
1120
  const apiInstance = new SolutionApi(configuration);
1121
1121
 
1122
- let organizationId: string; //The Organization identifier (default to undefined)
1123
- let solutionId: string; //The Solution identifier (default to undefined)
1122
+ let organizationId: string; //the Organization identifier (default to undefined)
1123
+ let solutionId: string; //the Solution identifier (default to undefined)
1124
1124
 
1125
1125
  const { status, data } = await apiInstance.listSolutionSecurityUsers(
1126
1126
  organizationId,
@@ -1132,8 +1132,8 @@ const { status, data } = await apiInstance.listSolutionSecurityUsers(
1132
1132
 
1133
1133
  |Name | Type | Description | Notes|
1134
1134
  |------------- | ------------- | ------------- | -------------|
1135
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1136
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1135
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1136
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1137
1137
 
1138
1138
 
1139
1139
  ### Return type
@@ -1173,9 +1173,9 @@ import {
1173
1173
  const configuration = new Configuration();
1174
1174
  const apiInstance = new SolutionApi(configuration);
1175
1175
 
1176
- let organizationId: string; //The Organization identifier (default to undefined)
1177
- let page: number; //Page number to query (zero-based indexing) (optional) (default to undefined)
1178
- let size: number; //Number of records per page (optional) (default to undefined)
1176
+ let organizationId: string; //the Organization identifier (default to undefined)
1177
+ let page: number; //Page number to query (first page is at index 0) (optional) (default to undefined)
1178
+ let size: number; //Amount of result by page (optional) (default to undefined)
1179
1179
 
1180
1180
  const { status, data } = await apiInstance.listSolutions(
1181
1181
  organizationId,
@@ -1188,9 +1188,9 @@ const { status, data } = await apiInstance.listSolutions(
1188
1188
 
1189
1189
  |Name | Type | Description | Notes|
1190
1190
  |------------- | ------------- | ------------- | -------------|
1191
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1192
- | **page** | [**number**] | Page number to query (zero-based indexing) | (optional) defaults to undefined|
1193
- | **size** | [**number**] | Number of records per page | (optional) defaults to undefined|
1191
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1192
+ | **page** | [**number**] | Page number to query (first page is at index 0) | (optional) defaults to undefined|
1193
+ | **size** | [**number**] | Amount of result by page | (optional) defaults to undefined|
1194
1194
 
1195
1195
 
1196
1196
  ### Return type
@@ -1230,8 +1230,8 @@ import {
1230
1230
  const configuration = new Configuration();
1231
1231
  const apiInstance = new SolutionApi(configuration);
1232
1232
 
1233
- let organizationId: string; //The Organization identifier (default to undefined)
1234
- let solutionId: string; //The Solution identifier (default to undefined)
1233
+ let organizationId: string; //the Organization identifier (default to undefined)
1234
+ let solutionId: string; //the Solution identifier (default to undefined)
1235
1235
  let solutionUpdateRequest: SolutionUpdateRequest; //The new Solution details. This endpoint can\'t be used to update security
1236
1236
 
1237
1237
  const { status, data } = await apiInstance.updateSolution(
@@ -1246,8 +1246,8 @@ const { status, data } = await apiInstance.updateSolution(
1246
1246
  |Name | Type | Description | Notes|
1247
1247
  |------------- | ------------- | ------------- | -------------|
1248
1248
  | **solutionUpdateRequest** | **SolutionUpdateRequest**| The new Solution details. This endpoint can\'t be used to update security | |
1249
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1250
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1249
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1250
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1251
1251
 
1252
1252
 
1253
1253
  ### Return type
@@ -1289,8 +1289,8 @@ import {
1289
1289
  const configuration = new Configuration();
1290
1290
  const apiInstance = new SolutionApi(configuration);
1291
1291
 
1292
- let organizationId: string; //The Organization identifier (default to undefined)
1293
- let solutionId: string; //The Solution identifier (default to undefined)
1292
+ let organizationId: string; //the Organization identifier (default to undefined)
1293
+ let solutionId: string; //the Solution identifier (default to undefined)
1294
1294
  let identityId: string; //The User identifier (default to undefined)
1295
1295
  let solutionRole: SolutionRole; //Access control updates
1296
1296
 
@@ -1307,8 +1307,8 @@ const { status, data } = await apiInstance.updateSolutionAccessControl(
1307
1307
  |Name | Type | Description | Notes|
1308
1308
  |------------- | ------------- | ------------- | -------------|
1309
1309
  | **solutionRole** | **SolutionRole**| Access control updates | |
1310
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1311
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1310
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1311
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1312
1312
  | **identityId** | [**string**] | The User identifier | defaults to undefined|
1313
1313
 
1314
1314
 
@@ -1408,8 +1408,8 @@ import {
1408
1408
  const configuration = new Configuration();
1409
1409
  const apiInstance = new SolutionApi(configuration);
1410
1410
 
1411
- let organizationId: string; //The Organization identifier (default to undefined)
1412
- let solutionId: string; //The Solution identifier (default to undefined)
1411
+ let organizationId: string; //the Organization identifier (default to undefined)
1412
+ let solutionId: string; //the Solution identifier (default to undefined)
1413
1413
  let parameterId: string; //The solution parameter identifier (default to undefined)
1414
1414
  let runTemplateParameterUpdateRequest: RunTemplateParameterUpdateRequest; //Parameter to update
1415
1415
 
@@ -1426,8 +1426,8 @@ const { status, data } = await apiInstance.updateSolutionParameter(
1426
1426
  |Name | Type | Description | Notes|
1427
1427
  |------------- | ------------- | ------------- | -------------|
1428
1428
  | **runTemplateParameterUpdateRequest** | **RunTemplateParameterUpdateRequest**| Parameter to update | |
1429
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1430
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1429
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1430
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1431
1431
  | **parameterId** | [**string**] | The solution parameter identifier | defaults to undefined|
1432
1432
 
1433
1433
 
@@ -1470,8 +1470,8 @@ import {
1470
1470
  const configuration = new Configuration();
1471
1471
  const apiInstance = new SolutionApi(configuration);
1472
1472
 
1473
- let organizationId: string; //The Organization identifier (default to undefined)
1474
- let solutionId: string; //The Solution identifier (default to undefined)
1473
+ let organizationId: string; //the Organization identifier (default to undefined)
1474
+ let solutionId: string; //the Solution identifier (default to undefined)
1475
1475
  let parameterGroupId: string; //The parameter group identifier (default to undefined)
1476
1476
  let runTemplateParameterGroupUpdateRequest: RunTemplateParameterGroupUpdateRequest; //Parameter groups to update
1477
1477
 
@@ -1488,8 +1488,8 @@ const { status, data } = await apiInstance.updateSolutionParameterGroup(
1488
1488
  |Name | Type | Description | Notes|
1489
1489
  |------------- | ------------- | ------------- | -------------|
1490
1490
  | **runTemplateParameterGroupUpdateRequest** | **RunTemplateParameterGroupUpdateRequest**| Parameter groups to update | |
1491
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1492
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1491
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1492
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1493
1493
  | **parameterGroupId** | [**string**] | The parameter group identifier | defaults to undefined|
1494
1494
 
1495
1495
 
@@ -1532,8 +1532,8 @@ import {
1532
1532
  const configuration = new Configuration();
1533
1533
  const apiInstance = new SolutionApi(configuration);
1534
1534
 
1535
- let organizationId: string; //The Organization identifier (default to undefined)
1536
- let solutionId: string; //The Solution identifier (default to undefined)
1535
+ let organizationId: string; //the Organization identifier (default to undefined)
1536
+ let solutionId: string; //the Solution identifier (default to undefined)
1537
1537
  let runTemplateId: string; //The Run Template identifier (default to undefined)
1538
1538
  let runTemplateUpdateRequest: RunTemplateUpdateRequest; //Run template updates
1539
1539
 
@@ -1550,8 +1550,8 @@ const { status, data } = await apiInstance.updateSolutionRunTemplate(
1550
1550
  |Name | Type | Description | Notes|
1551
1551
  |------------- | ------------- | ------------- | -------------|
1552
1552
  | **runTemplateUpdateRequest** | **RunTemplateUpdateRequest**| Run template updates | |
1553
- | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
1554
- | **solutionId** | [**string**] | The Solution identifier | defaults to undefined|
1553
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
1554
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
1555
1555
  | **runTemplateId** | [**string**] | The Run Template identifier | defaults to undefined|
1556
1556
 
1557
1557
 
@@ -0,0 +1,21 @@
1
+ # SolutionFile
2
+
3
+ A Solution File resource
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **fileName** | **string** | The Solution File name | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { SolutionFile } from '@cosmotech/api-ts';
15
+
16
+ const instance: SolutionFile = {
17
+ fileName,
18
+ };
19
+ ```
20
+
21
+ [[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
+ # 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)