basyx-typescript-sdk 0.2.2 → 1.0.0
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/README.md +19 -12
- package/bundle/index.js +15444 -866
- package/bundle/index.js.map +1 -1
- package/dist/clients/AasDiscoveryClient.d.ts +68 -0
- package/dist/clients/AasDiscoveryClient.js +115 -0
- package/dist/clients/AasRegistryClient.d.ts +164 -0
- package/dist/clients/AasRegistryClient.js +287 -0
- package/dist/clients/AasRepositoryClient.d.ts +791 -103
- package/dist/clients/AasRepositoryClient.js +1323 -215
- package/dist/clients/AasxFileClient.d.ts +82 -0
- package/dist/clients/AasxFileClient.js +148 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +84 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
- package/dist/clients/SubmodelRegistryClient.d.ts +78 -0
- package/dist/clients/SubmodelRegistryClient.js +138 -0
- package/dist/clients/SubmodelRepositoryClient.d.ts +355 -0
- package/dist/clients/SubmodelRepositoryClient.js +585 -0
- package/dist/clients/index.d.ts +6 -0
- package/dist/clients/index.js +6 -0
- package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +80 -0
- package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +156 -0
- package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasDiscoveryService/apis/index.d.ts +2 -0
- package/dist/generated/AasDiscoveryService/apis/index.js +4 -0
- package/dist/generated/AasDiscoveryService/index.d.ts +2 -0
- package/dist/generated/AasDiscoveryService/index.js +4 -0
- package/dist/generated/AasDiscoveryService/models/index.d.ts +297 -0
- package/dist/generated/AasDiscoveryService/models/index.js +48 -0
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
- package/dist/generated/AasRegistryService/apis/index.js +4 -0
- package/dist/generated/AasRegistryService/index.d.ts +2 -0
- package/dist/generated/AasRegistryService/index.js +4 -0
- package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
- package/dist/generated/AasRegistryService/models/index.js +151 -0
- package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +870 -0
- package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/AasRepositoryService/apis/index.js +5 -0
- package/dist/generated/AasRepositoryService/index.d.ts +2 -0
- package/dist/generated/AasRepositoryService/index.js +4 -0
- package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
- package/dist/generated/AasRepositoryService/models/index.js +221 -0
- package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
- package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
- package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
- package/dist/generated/AasxFileService/apis/index.js +3 -0
- package/dist/generated/AasxFileService/index.d.ts +2 -0
- package/dist/generated/AasxFileService/index.js +4 -0
- package/dist/generated/AasxFileService/models/index.d.ts +80 -0
- package/dist/generated/AasxFileService/models/index.js +10 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
- package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +2 -0
- package/dist/generated/ConceptDescriptionRepositoryService/index.js +3 -0
- package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
- package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
- package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
- package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
- package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
- package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
- package/dist/generated/SubmodelRegistryService/index.d.ts +2 -0
- package/dist/generated/SubmodelRegistryService/index.js +4 -0
- package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
- package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
- package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
- package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
- package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
- package/dist/generated/SubmodelRepositoryService/index.d.ts +2 -0
- package/dist/generated/SubmodelRepositoryService/index.js +4 -0
- package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
- package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
- package/dist/generated/index.d.ts +9 -2
- package/dist/generated/index.js +9 -3
- package/dist/generated/runtime.d.ts +181 -0
- package/dist/generated/runtime.js +326 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/lib/apiConfig.d.ts +2 -0
- package/dist/lib/apiConfig.js +23 -0
- package/dist/lib/base64Url.js +4 -0
- package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
- package/dist/lib/convertAasDescriptorTypes.js +76 -0
- package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
- package/dist/lib/convertAasDiscoveryTypes.js +39 -0
- package/dist/lib/convertAasTypes.d.ts +7 -7
- package/dist/lib/convertAasTypes.js +5 -0
- package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
- package/dist/lib/convertConceptDescriptionTypes.js +39 -0
- package/dist/lib/convertSubmodelTypes.d.ts +34 -0
- package/dist/lib/convertSubmodelTypes.js +69 -0
- package/dist/lib/descriptorJsonization.d.ts +12 -0
- package/dist/lib/descriptorJsonization.js +172 -0
- package/dist/lib/errorHandler.d.ts +9 -0
- package/dist/lib/errorHandler.js +94 -0
- package/dist/models/Descriptors.d.ts +51 -0
- package/dist/models/Descriptors.js +56 -0
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/utils/DescriptorUtils.d.ts +9 -0
- package/dist/utils/DescriptorUtils.js +37 -0
- package/dist/utils/KeyTypesUtil.d.ts +24 -0
- package/dist/utils/KeyTypesUtil.js +55 -0
- package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
- package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
- package/dist/utils/ReferableUtils.d.ts +69 -0
- package/dist/utils/ReferableUtils.js +220 -0
- package/dist/utils/ReferenceUtil.d.ts +9 -0
- package/dist/utils/ReferenceUtil.js +22 -0
- package/dist/utils/SemanticIdUtils.d.ts +119 -0
- package/dist/utils/SemanticIdUtils.js +363 -0
- package/package.json +14 -11
- package/dist/generated/schemas.gen.d.ts +0 -2357
- package/dist/generated/schemas.gen.js +0 -2789
- package/dist/generated/sdk.gen.d.ts +0 -822
- package/dist/generated/sdk.gen.js +0 -2225
- package/dist/generated/types.gen.d.ts +0 -10829
- package/dist/generated/types.gen.js +0 -2
- package/dist/lib/createAasRepoClient.d.ts +0 -9
- package/dist/lib/createAasRepoClient.js +0 -15
- package/dist/models/aas-repository.d.ts +0 -65
- package/dist/models/aas-repository.js +0 -1
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* @export
|
|
6
|
+
*/
|
|
7
|
+
export const AasSubmodelElements = {
|
|
8
|
+
AnnotatedRelationshipElement: 'AnnotatedRelationshipElement',
|
|
9
|
+
BasicEventElement: 'BasicEventElement',
|
|
10
|
+
Blob: 'Blob',
|
|
11
|
+
Capability: 'Capability',
|
|
12
|
+
DataElement: 'DataElement',
|
|
13
|
+
Entity: 'Entity',
|
|
14
|
+
EventElement: 'EventElement',
|
|
15
|
+
File: 'File',
|
|
16
|
+
MultiLanguageProperty: 'MultiLanguageProperty',
|
|
17
|
+
Operation: 'Operation',
|
|
18
|
+
Property: 'Property',
|
|
19
|
+
Range: 'Range',
|
|
20
|
+
ReferenceElement: 'ReferenceElement',
|
|
21
|
+
RelationshipElement: 'RelationshipElement',
|
|
22
|
+
SubmodelElement: 'SubmodelElement',
|
|
23
|
+
SubmodelElementCollection: 'SubmodelElementCollection',
|
|
24
|
+
SubmodelElementList: 'SubmodelElementList'
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export const AssetKind = {
|
|
31
|
+
Instance: 'Instance',
|
|
32
|
+
NotApplicable: 'NotApplicable',
|
|
33
|
+
Role: 'Role',
|
|
34
|
+
Type: 'Type'
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export const DataTypeDefXsd = {
|
|
41
|
+
XsAnyUri: 'xs:anyURI',
|
|
42
|
+
XsBase64Binary: 'xs:base64Binary',
|
|
43
|
+
XsBoolean: 'xs:boolean',
|
|
44
|
+
XsByte: 'xs:byte',
|
|
45
|
+
XsDate: 'xs:date',
|
|
46
|
+
XsDateTime: 'xs:dateTime',
|
|
47
|
+
XsDecimal: 'xs:decimal',
|
|
48
|
+
XsDouble: 'xs:double',
|
|
49
|
+
XsDuration: 'xs:duration',
|
|
50
|
+
XsFloat: 'xs:float',
|
|
51
|
+
XsGDay: 'xs:gDay',
|
|
52
|
+
XsGMonth: 'xs:gMonth',
|
|
53
|
+
XsGMonthDay: 'xs:gMonthDay',
|
|
54
|
+
XsGYear: 'xs:gYear',
|
|
55
|
+
XsGYearMonth: 'xs:gYearMonth',
|
|
56
|
+
XsHexBinary: 'xs:hexBinary',
|
|
57
|
+
XsInt: 'xs:int',
|
|
58
|
+
XsInteger: 'xs:integer',
|
|
59
|
+
XsLong: 'xs:long',
|
|
60
|
+
XsNegativeInteger: 'xs:negativeInteger',
|
|
61
|
+
XsNonNegativeInteger: 'xs:nonNegativeInteger',
|
|
62
|
+
XsNonPositiveInteger: 'xs:nonPositiveInteger',
|
|
63
|
+
XsPositiveInteger: 'xs:positiveInteger',
|
|
64
|
+
XsShort: 'xs:short',
|
|
65
|
+
XsString: 'xs:string',
|
|
66
|
+
XsTime: 'xs:time',
|
|
67
|
+
XsUnsignedByte: 'xs:unsignedByte',
|
|
68
|
+
XsUnsignedInt: 'xs:unsignedInt',
|
|
69
|
+
XsUnsignedLong: 'xs:unsignedLong',
|
|
70
|
+
XsUnsignedShort: 'xs:unsignedShort'
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export const DataTypeIec61360 = {
|
|
77
|
+
Blob: 'BLOB',
|
|
78
|
+
Boolean: 'BOOLEAN',
|
|
79
|
+
Date: 'DATE',
|
|
80
|
+
File: 'FILE',
|
|
81
|
+
Html: 'HTML',
|
|
82
|
+
IntegerCount: 'INTEGER_COUNT',
|
|
83
|
+
IntegerCurrency: 'INTEGER_CURRENCY',
|
|
84
|
+
IntegerMeasure: 'INTEGER_MEASURE',
|
|
85
|
+
Irdi: 'IRDI',
|
|
86
|
+
Iri: 'IRI',
|
|
87
|
+
Rational: 'RATIONAL',
|
|
88
|
+
RationalMeasure: 'RATIONAL_MEASURE',
|
|
89
|
+
RealCount: 'REAL_COUNT',
|
|
90
|
+
RealCurrency: 'REAL_CURRENCY',
|
|
91
|
+
RealMeasure: 'REAL_MEASURE',
|
|
92
|
+
String: 'STRING',
|
|
93
|
+
StringTranslatable: 'STRING_TRANSLATABLE',
|
|
94
|
+
Time: 'TIME',
|
|
95
|
+
Timestamp: 'TIMESTAMP'
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
*
|
|
99
|
+
* @export
|
|
100
|
+
*/
|
|
101
|
+
export const Direction = {
|
|
102
|
+
Input: 'input',
|
|
103
|
+
Output: 'output'
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @export
|
|
108
|
+
*/
|
|
109
|
+
export const EntityType = {
|
|
110
|
+
CoManagedEntity: 'CoManagedEntity',
|
|
111
|
+
SelfManagedEntity: 'SelfManagedEntity'
|
|
112
|
+
};
|
|
113
|
+
/**
|
|
114
|
+
*
|
|
115
|
+
* @export
|
|
116
|
+
*/
|
|
117
|
+
export const ExecutionState = {
|
|
118
|
+
Initiated: 'Initiated',
|
|
119
|
+
Running: 'Running',
|
|
120
|
+
Completed: 'Completed',
|
|
121
|
+
Canceled: 'Canceled',
|
|
122
|
+
Failed: 'Failed',
|
|
123
|
+
Timeout: 'Timeout'
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @export
|
|
128
|
+
*/
|
|
129
|
+
export const KeyTypes = {
|
|
130
|
+
AnnotatedRelationshipElement: 'AnnotatedRelationshipElement',
|
|
131
|
+
AssetAdministrationShell: 'AssetAdministrationShell',
|
|
132
|
+
BasicEventElement: 'BasicEventElement',
|
|
133
|
+
Blob: 'Blob',
|
|
134
|
+
Capability: 'Capability',
|
|
135
|
+
ConceptDescription: 'ConceptDescription',
|
|
136
|
+
DataElement: 'DataElement',
|
|
137
|
+
Entity: 'Entity',
|
|
138
|
+
EventElement: 'EventElement',
|
|
139
|
+
File: 'File',
|
|
140
|
+
FragmentReference: 'FragmentReference',
|
|
141
|
+
GlobalReference: 'GlobalReference',
|
|
142
|
+
Identifiable: 'Identifiable',
|
|
143
|
+
MultiLanguageProperty: 'MultiLanguageProperty',
|
|
144
|
+
Operation: 'Operation',
|
|
145
|
+
Property: 'Property',
|
|
146
|
+
Range: 'Range',
|
|
147
|
+
Referable: 'Referable',
|
|
148
|
+
ReferenceElement: 'ReferenceElement',
|
|
149
|
+
RelationshipElement: 'RelationshipElement',
|
|
150
|
+
Submodel: 'Submodel',
|
|
151
|
+
SubmodelElement: 'SubmodelElement',
|
|
152
|
+
SubmodelElementCollection: 'SubmodelElementCollection',
|
|
153
|
+
SubmodelElementList: 'SubmodelElementList'
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* @export
|
|
157
|
+
*/
|
|
158
|
+
export const MessageMessageTypeEnum = {
|
|
159
|
+
Undefined: 'Undefined',
|
|
160
|
+
Info: 'Info',
|
|
161
|
+
Warning: 'Warning',
|
|
162
|
+
Error: 'Error',
|
|
163
|
+
Exception: 'Exception'
|
|
164
|
+
};
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
export const ModelType = {
|
|
170
|
+
AnnotatedRelationshipElement: 'AnnotatedRelationshipElement',
|
|
171
|
+
AssetAdministrationShell: 'AssetAdministrationShell',
|
|
172
|
+
BasicEventElement: 'BasicEventElement',
|
|
173
|
+
Blob: 'Blob',
|
|
174
|
+
Capability: 'Capability',
|
|
175
|
+
ConceptDescription: 'ConceptDescription',
|
|
176
|
+
DataSpecificationIec61360: 'DataSpecificationIec61360',
|
|
177
|
+
Entity: 'Entity',
|
|
178
|
+
File: 'File',
|
|
179
|
+
MultiLanguageProperty: 'MultiLanguageProperty',
|
|
180
|
+
Operation: 'Operation',
|
|
181
|
+
Property: 'Property',
|
|
182
|
+
Range: 'Range',
|
|
183
|
+
ReferenceElement: 'ReferenceElement',
|
|
184
|
+
RelationshipElement: 'RelationshipElement',
|
|
185
|
+
Submodel: 'Submodel',
|
|
186
|
+
SubmodelElementCollection: 'SubmodelElementCollection',
|
|
187
|
+
SubmodelElementList: 'SubmodelElementList'
|
|
188
|
+
};
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @export
|
|
192
|
+
*/
|
|
193
|
+
export const ModellingKind = {
|
|
194
|
+
Instance: 'Instance',
|
|
195
|
+
Template: 'Template'
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
*
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export const QualifierKind = {
|
|
202
|
+
ConceptQualifier: 'ConceptQualifier',
|
|
203
|
+
TemplateQualifier: 'TemplateQualifier',
|
|
204
|
+
ValueQualifier: 'ValueQualifier'
|
|
205
|
+
};
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @export
|
|
209
|
+
*/
|
|
210
|
+
export const ReferenceTypes = {
|
|
211
|
+
ExternalReference: 'ExternalReference',
|
|
212
|
+
ModelReference: 'ModelReference'
|
|
213
|
+
};
|
|
214
|
+
/**
|
|
215
|
+
*
|
|
216
|
+
* @export
|
|
217
|
+
*/
|
|
218
|
+
export const StateOfEvent = {
|
|
219
|
+
Off: 'off',
|
|
220
|
+
On: 'on'
|
|
221
|
+
};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DotAAS Part 2 | HTTP/REST | AASX File Server API
|
|
3
|
+
* The AASX file server API as part of Details of the Asset Administration Shell Part 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: V1.0RC03
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../../runtime';
|
|
13
|
+
import type { PackageDescription } from '../models/index';
|
|
14
|
+
export interface DeleteAASXByPackageIdRequest {
|
|
15
|
+
packageId: string;
|
|
16
|
+
}
|
|
17
|
+
export interface GetAASXByPackageIdRequest {
|
|
18
|
+
packageId: string;
|
|
19
|
+
}
|
|
20
|
+
export interface GetAllAASXPackageIdsRequest {
|
|
21
|
+
aasId?: string;
|
|
22
|
+
}
|
|
23
|
+
export interface PostAASXPackageRequest {
|
|
24
|
+
aasIds?: Array<string>;
|
|
25
|
+
file?: Blob;
|
|
26
|
+
fileName?: string;
|
|
27
|
+
}
|
|
28
|
+
export interface PutAASXByPackageIdRequest {
|
|
29
|
+
packageId: string;
|
|
30
|
+
aasIds?: Array<string>;
|
|
31
|
+
file?: Blob;
|
|
32
|
+
fileName?: string;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
*/
|
|
37
|
+
export declare class AASXFileServerAPIApi extends runtime.BaseAPI {
|
|
38
|
+
/**
|
|
39
|
+
* Deletes a specific AASX package from the server
|
|
40
|
+
*/
|
|
41
|
+
deleteAASXByPackageIdRaw(requestParameters: DeleteAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
42
|
+
/**
|
|
43
|
+
* Deletes a specific AASX package from the server
|
|
44
|
+
*/
|
|
45
|
+
deleteAASXByPackageId(requestParameters: DeleteAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
* Returns a specific AASX package from the server
|
|
48
|
+
*/
|
|
49
|
+
getAASXByPackageIdRaw(requestParameters: GetAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
50
|
+
/**
|
|
51
|
+
* Returns a specific AASX package from the server
|
|
52
|
+
*/
|
|
53
|
+
getAASXByPackageId(requestParameters: GetAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
54
|
+
/**
|
|
55
|
+
* Returns a list of available AASX packages at the server
|
|
56
|
+
*/
|
|
57
|
+
getAllAASXPackageIdsRaw(requestParameters: GetAllAASXPackageIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PackageDescription>>>;
|
|
58
|
+
/**
|
|
59
|
+
* Returns a list of available AASX packages at the server
|
|
60
|
+
*/
|
|
61
|
+
getAllAASXPackageIds(requestParameters?: GetAllAASXPackageIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PackageDescription>>;
|
|
62
|
+
/**
|
|
63
|
+
* Stores the AASX package at the server
|
|
64
|
+
*/
|
|
65
|
+
postAASXPackageRaw(requestParameters: PostAASXPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PackageDescription>>;
|
|
66
|
+
/**
|
|
67
|
+
* Stores the AASX package at the server
|
|
68
|
+
*/
|
|
69
|
+
postAASXPackage(requestParameters?: PostAASXPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PackageDescription>;
|
|
70
|
+
/**
|
|
71
|
+
* Updates the AASX package at the server
|
|
72
|
+
*/
|
|
73
|
+
putAASXByPackageIdRaw(requestParameters: PutAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
74
|
+
/**
|
|
75
|
+
* Updates the AASX package at the server
|
|
76
|
+
*/
|
|
77
|
+
putAASXByPackageId(requestParameters: PutAASXByPackageIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
78
|
+
}
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* DotAAS Part 2 | HTTP/REST | AASX File Server API
|
|
5
|
+
* The AASX file server API as part of Details of the Asset Administration Shell Part 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: V1.0RC03
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import * as runtime from '../../runtime';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
export class AASXFileServerAPIApi extends runtime.BaseAPI {
|
|
19
|
+
/**
|
|
20
|
+
* Deletes a specific AASX package from the server
|
|
21
|
+
*/
|
|
22
|
+
async deleteAASXByPackageIdRaw(requestParameters, initOverrides) {
|
|
23
|
+
if (requestParameters['packageId'] == null) {
|
|
24
|
+
throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling deleteAASXByPackageId().');
|
|
25
|
+
}
|
|
26
|
+
const queryParameters = {};
|
|
27
|
+
const headerParameters = {};
|
|
28
|
+
const response = await this.request({
|
|
29
|
+
path: `/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
|
|
30
|
+
method: 'DELETE',
|
|
31
|
+
headers: headerParameters,
|
|
32
|
+
query: queryParameters,
|
|
33
|
+
}, initOverrides);
|
|
34
|
+
return new runtime.VoidApiResponse(response);
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Deletes a specific AASX package from the server
|
|
38
|
+
*/
|
|
39
|
+
async deleteAASXByPackageId(requestParameters, initOverrides) {
|
|
40
|
+
await this.deleteAASXByPackageIdRaw(requestParameters, initOverrides);
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Returns a specific AASX package from the server
|
|
44
|
+
*/
|
|
45
|
+
async getAASXByPackageIdRaw(requestParameters, initOverrides) {
|
|
46
|
+
if (requestParameters['packageId'] == null) {
|
|
47
|
+
throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling getAASXByPackageId().');
|
|
48
|
+
}
|
|
49
|
+
const queryParameters = {};
|
|
50
|
+
const headerParameters = {};
|
|
51
|
+
const response = await this.request({
|
|
52
|
+
path: `/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
|
|
53
|
+
method: 'GET',
|
|
54
|
+
headers: headerParameters,
|
|
55
|
+
query: queryParameters,
|
|
56
|
+
}, initOverrides);
|
|
57
|
+
return new runtime.BlobApiResponse(response);
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Returns a specific AASX package from the server
|
|
61
|
+
*/
|
|
62
|
+
async getAASXByPackageId(requestParameters, initOverrides) {
|
|
63
|
+
const response = await this.getAASXByPackageIdRaw(requestParameters, initOverrides);
|
|
64
|
+
return await response.value();
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Returns a list of available AASX packages at the server
|
|
68
|
+
*/
|
|
69
|
+
async getAllAASXPackageIdsRaw(requestParameters, initOverrides) {
|
|
70
|
+
const queryParameters = {};
|
|
71
|
+
if (requestParameters['aasId'] != null) {
|
|
72
|
+
queryParameters['aasId'] = requestParameters['aasId'];
|
|
73
|
+
}
|
|
74
|
+
const headerParameters = {};
|
|
75
|
+
const response = await this.request({
|
|
76
|
+
path: `/packages`,
|
|
77
|
+
method: 'GET',
|
|
78
|
+
headers: headerParameters,
|
|
79
|
+
query: queryParameters,
|
|
80
|
+
}, initOverrides);
|
|
81
|
+
return new runtime.JSONApiResponse(response);
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Returns a list of available AASX packages at the server
|
|
85
|
+
*/
|
|
86
|
+
async getAllAASXPackageIds(requestParameters = {}, initOverrides) {
|
|
87
|
+
const response = await this.getAllAASXPackageIdsRaw(requestParameters, initOverrides);
|
|
88
|
+
return await response.value();
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Stores the AASX package at the server
|
|
92
|
+
*/
|
|
93
|
+
async postAASXPackageRaw(requestParameters, initOverrides) {
|
|
94
|
+
const queryParameters = {};
|
|
95
|
+
const headerParameters = {};
|
|
96
|
+
const consumes = [
|
|
97
|
+
{ contentType: 'multipart/form-data' },
|
|
98
|
+
];
|
|
99
|
+
// @ts-ignore: canConsumeForm may be unused
|
|
100
|
+
const canConsumeForm = runtime.canConsumeForm(consumes);
|
|
101
|
+
let formParams;
|
|
102
|
+
let useForm = false;
|
|
103
|
+
// use FormData to transmit files using content-type "multipart/form-data"
|
|
104
|
+
useForm = canConsumeForm;
|
|
105
|
+
if (useForm) {
|
|
106
|
+
formParams = new FormData();
|
|
107
|
+
}
|
|
108
|
+
else {
|
|
109
|
+
formParams = new URLSearchParams();
|
|
110
|
+
}
|
|
111
|
+
if (requestParameters['aasIds'] != null) {
|
|
112
|
+
formParams.append('aasIds', requestParameters['aasIds'].join(runtime.COLLECTION_FORMATS["csv"]));
|
|
113
|
+
}
|
|
114
|
+
if (requestParameters['file'] != null) {
|
|
115
|
+
formParams.append('file', requestParameters['file']);
|
|
116
|
+
}
|
|
117
|
+
if (requestParameters['fileName'] != null) {
|
|
118
|
+
formParams.append('fileName', requestParameters['fileName']);
|
|
119
|
+
}
|
|
120
|
+
const response = await this.request({
|
|
121
|
+
path: `/packages`,
|
|
122
|
+
method: 'POST',
|
|
123
|
+
headers: headerParameters,
|
|
124
|
+
query: queryParameters,
|
|
125
|
+
body: formParams,
|
|
126
|
+
}, initOverrides);
|
|
127
|
+
return new runtime.JSONApiResponse(response);
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Stores the AASX package at the server
|
|
131
|
+
*/
|
|
132
|
+
async postAASXPackage(requestParameters = {}, initOverrides) {
|
|
133
|
+
const response = await this.postAASXPackageRaw(requestParameters, initOverrides);
|
|
134
|
+
return await response.value();
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Updates the AASX package at the server
|
|
138
|
+
*/
|
|
139
|
+
async putAASXByPackageIdRaw(requestParameters, initOverrides) {
|
|
140
|
+
if (requestParameters['packageId'] == null) {
|
|
141
|
+
throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling putAASXByPackageId().');
|
|
142
|
+
}
|
|
143
|
+
const queryParameters = {};
|
|
144
|
+
const headerParameters = {};
|
|
145
|
+
const consumes = [
|
|
146
|
+
{ contentType: 'multipart/form-data' },
|
|
147
|
+
];
|
|
148
|
+
// @ts-ignore: canConsumeForm may be unused
|
|
149
|
+
const canConsumeForm = runtime.canConsumeForm(consumes);
|
|
150
|
+
let formParams;
|
|
151
|
+
let useForm = false;
|
|
152
|
+
// use FormData to transmit files using content-type "multipart/form-data"
|
|
153
|
+
useForm = canConsumeForm;
|
|
154
|
+
if (useForm) {
|
|
155
|
+
formParams = new FormData();
|
|
156
|
+
}
|
|
157
|
+
else {
|
|
158
|
+
formParams = new URLSearchParams();
|
|
159
|
+
}
|
|
160
|
+
if (requestParameters['aasIds'] != null) {
|
|
161
|
+
formParams.append('aasIds', requestParameters['aasIds'].join(runtime.COLLECTION_FORMATS["csv"]));
|
|
162
|
+
}
|
|
163
|
+
if (requestParameters['file'] != null) {
|
|
164
|
+
formParams.append('file', requestParameters['file']);
|
|
165
|
+
}
|
|
166
|
+
if (requestParameters['fileName'] != null) {
|
|
167
|
+
formParams.append('fileName', requestParameters['fileName']);
|
|
168
|
+
}
|
|
169
|
+
const response = await this.request({
|
|
170
|
+
path: `/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
|
|
171
|
+
method: 'PUT',
|
|
172
|
+
headers: headerParameters,
|
|
173
|
+
query: queryParameters,
|
|
174
|
+
body: formParams,
|
|
175
|
+
}, initOverrides);
|
|
176
|
+
return new runtime.VoidApiResponse(response);
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Updates the AASX package at the server
|
|
180
|
+
*/
|
|
181
|
+
async putAASXByPackageId(requestParameters, initOverrides) {
|
|
182
|
+
await this.putAASXByPackageIdRaw(requestParameters, initOverrides);
|
|
183
|
+
}
|
|
184
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './AASXFileServerAPIApi';
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @export
|
|
4
|
+
* @interface Message
|
|
5
|
+
*/
|
|
6
|
+
export interface Message {
|
|
7
|
+
/**
|
|
8
|
+
*
|
|
9
|
+
* @type {string}
|
|
10
|
+
* @memberof Message
|
|
11
|
+
*/
|
|
12
|
+
code?: string;
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @type {string}
|
|
16
|
+
* @memberof Message
|
|
17
|
+
*/
|
|
18
|
+
messageType?: MessageMessageTypeEnum;
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof Message
|
|
23
|
+
*/
|
|
24
|
+
text?: string;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof Message
|
|
29
|
+
*/
|
|
30
|
+
timestamp?: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const MessageMessageTypeEnum: {
|
|
36
|
+
readonly Undefined: "Undefined";
|
|
37
|
+
readonly Info: "Info";
|
|
38
|
+
readonly Warning: "Warning";
|
|
39
|
+
readonly Error: "Error";
|
|
40
|
+
readonly Exception: "Exception";
|
|
41
|
+
};
|
|
42
|
+
export type MessageMessageTypeEnum = typeof MessageMessageTypeEnum[keyof typeof MessageMessageTypeEnum];
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @export
|
|
46
|
+
* @interface PackageDescription
|
|
47
|
+
*/
|
|
48
|
+
export interface PackageDescription {
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {Array<string>}
|
|
52
|
+
* @memberof PackageDescription
|
|
53
|
+
*/
|
|
54
|
+
aasIds?: Array<string>;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof PackageDescription
|
|
59
|
+
*/
|
|
60
|
+
packageId?: string;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @export
|
|
65
|
+
* @interface Result
|
|
66
|
+
*/
|
|
67
|
+
export interface Result {
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {Array<Message>}
|
|
71
|
+
* @memberof Result
|
|
72
|
+
*/
|
|
73
|
+
messages?: Array<Message>;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @type {boolean}
|
|
77
|
+
* @memberof Result
|
|
78
|
+
*/
|
|
79
|
+
success?: boolean;
|
|
80
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DotAAS Part 2 | HTTP/REST | Concept Description Repository Service Specification
|
|
3
|
+
* The ConceptDescription Repository Service Specification as part of [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) March 2023
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: V3.1.0_SSP-001
|
|
6
|
+
* Contact: info@idtwin.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../../runtime';
|
|
13
|
+
import type { ConceptDescription, GetConceptDescriptionsResult } from '../models/index';
|
|
14
|
+
export interface DeleteConceptDescriptionByIdRequest {
|
|
15
|
+
cdIdentifier: string;
|
|
16
|
+
}
|
|
17
|
+
export interface GetAllConceptDescriptionsRequest {
|
|
18
|
+
idShort?: string;
|
|
19
|
+
isCaseOf?: string;
|
|
20
|
+
dataSpecificationRef?: string;
|
|
21
|
+
limit?: number;
|
|
22
|
+
cursor?: string;
|
|
23
|
+
}
|
|
24
|
+
export interface GetConceptDescriptionByIdRequest {
|
|
25
|
+
cdIdentifier: string;
|
|
26
|
+
}
|
|
27
|
+
export interface PostConceptDescriptionRequest {
|
|
28
|
+
conceptDescription: ConceptDescription;
|
|
29
|
+
}
|
|
30
|
+
export interface PutConceptDescriptionByIdRequest {
|
|
31
|
+
cdIdentifier: string;
|
|
32
|
+
conceptDescription: ConceptDescription;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
*/
|
|
37
|
+
export declare class ConceptDescriptionRepositoryAPIApi extends runtime.BaseAPI {
|
|
38
|
+
/**
|
|
39
|
+
* Deletes a Concept Description
|
|
40
|
+
*/
|
|
41
|
+
deleteConceptDescriptionByIdRaw(requestParameters: DeleteConceptDescriptionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
42
|
+
/**
|
|
43
|
+
* Deletes a Concept Description
|
|
44
|
+
*/
|
|
45
|
+
deleteConceptDescriptionById(requestParameters: DeleteConceptDescriptionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
* Returns all Concept Descriptions
|
|
48
|
+
*/
|
|
49
|
+
getAllConceptDescriptionsRaw(requestParameters: GetAllConceptDescriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetConceptDescriptionsResult>>;
|
|
50
|
+
/**
|
|
51
|
+
* Returns all Concept Descriptions
|
|
52
|
+
*/
|
|
53
|
+
getAllConceptDescriptions(requestParameters?: GetAllConceptDescriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetConceptDescriptionsResult>;
|
|
54
|
+
/**
|
|
55
|
+
* Returns a specific Concept Description
|
|
56
|
+
*/
|
|
57
|
+
getConceptDescriptionByIdRaw(requestParameters: GetConceptDescriptionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConceptDescription>>;
|
|
58
|
+
/**
|
|
59
|
+
* Returns a specific Concept Description
|
|
60
|
+
*/
|
|
61
|
+
getConceptDescriptionById(requestParameters: GetConceptDescriptionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConceptDescription>;
|
|
62
|
+
/**
|
|
63
|
+
* Creates a new Concept Description
|
|
64
|
+
*/
|
|
65
|
+
postConceptDescriptionRaw(requestParameters: PostConceptDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConceptDescription>>;
|
|
66
|
+
/**
|
|
67
|
+
* Creates a new Concept Description
|
|
68
|
+
*/
|
|
69
|
+
postConceptDescription(requestParameters: PostConceptDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConceptDescription>;
|
|
70
|
+
/**
|
|
71
|
+
* Creates or updates an existing Concept Description
|
|
72
|
+
*/
|
|
73
|
+
putConceptDescriptionByIdRaw(requestParameters: PutConceptDescriptionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConceptDescription>>;
|
|
74
|
+
/**
|
|
75
|
+
* Creates or updates an existing Concept Description
|
|
76
|
+
*/
|
|
77
|
+
putConceptDescriptionById(requestParameters: PutConceptDescriptionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConceptDescription | null | undefined>;
|
|
78
|
+
}
|