basyx-typescript-sdk 0.2.2 → 0.9.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.
Files changed (155) hide show
  1. package/README.md +5 -3
  2. package/bundle/index.js +17534 -857
  3. package/bundle/index.js.map +1 -1
  4. package/dist/clients/AasDiscoveryClient.d.ts +67 -0
  5. package/dist/clients/AasDiscoveryClient.js +115 -0
  6. package/dist/clients/AasRegistryClient.d.ts +163 -0
  7. package/dist/clients/AasRegistryClient.js +287 -0
  8. package/dist/clients/AasRepositoryClient.d.ts +790 -103
  9. package/dist/clients/AasRepositoryClient.js +1323 -215
  10. package/dist/clients/AasxFileClient.d.ts +81 -0
  11. package/dist/clients/AasxFileClient.js +148 -0
  12. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +83 -0
  13. package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
  14. package/dist/clients/SubmodelRegistryClient.d.ts +77 -0
  15. package/dist/clients/SubmodelRegistryClient.js +138 -0
  16. package/dist/clients/SubmodelRepositoryClient.d.ts +354 -0
  17. package/dist/clients/SubmodelRepositoryClient.js +585 -0
  18. package/dist/clients/index.d.ts +6 -0
  19. package/dist/clients/index.js +6 -0
  20. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +80 -0
  21. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +156 -0
  22. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +26 -0
  23. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +40 -0
  24. package/dist/generated/AasDiscoveryService/apis/index.d.ts +2 -0
  25. package/dist/generated/AasDiscoveryService/apis/index.js +4 -0
  26. package/dist/generated/AasDiscoveryService/index.d.ts +3 -0
  27. package/dist/generated/AasDiscoveryService/index.js +5 -0
  28. package/dist/generated/AasDiscoveryService/models/index.d.ts +297 -0
  29. package/dist/generated/AasDiscoveryService/models/index.js +48 -0
  30. package/dist/generated/AasDiscoveryService/runtime.d.ts +181 -0
  31. package/dist/generated/AasDiscoveryService/runtime.js +326 -0
  32. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
  33. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
  34. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  35. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
  36. package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
  37. package/dist/generated/AasRegistryService/apis/index.js +4 -0
  38. package/dist/generated/AasRegistryService/index.d.ts +3 -0
  39. package/dist/generated/AasRegistryService/index.js +5 -0
  40. package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
  41. package/dist/generated/AasRegistryService/models/index.js +151 -0
  42. package/dist/generated/AasRegistryService/runtime.d.ts +181 -0
  43. package/dist/generated/AasRegistryService/runtime.js +326 -0
  44. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +870 -0
  45. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
  46. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  47. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
  48. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  49. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
  50. package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
  51. package/dist/generated/AasRepositoryService/apis/index.js +5 -0
  52. package/dist/generated/AasRepositoryService/index.d.ts +3 -0
  53. package/dist/generated/AasRepositoryService/index.js +5 -0
  54. package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
  55. package/dist/generated/AasRepositoryService/models/index.js +221 -0
  56. package/dist/generated/AasRepositoryService/runtime.d.ts +181 -0
  57. package/dist/generated/AasRepositoryService/runtime.js +326 -0
  58. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
  59. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
  60. package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
  61. package/dist/generated/AasxFileService/apis/index.js +3 -0
  62. package/dist/generated/AasxFileService/index.d.ts +3 -0
  63. package/dist/generated/AasxFileService/index.js +5 -0
  64. package/dist/generated/AasxFileService/models/index.d.ts +80 -0
  65. package/dist/generated/AasxFileService/models/index.js +10 -0
  66. package/dist/generated/AasxFileService/runtime.d.ts +181 -0
  67. package/dist/generated/AasxFileService/runtime.js +326 -0
  68. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
  69. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
  70. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  71. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
  72. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  73. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
  74. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
  75. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
  76. package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +3 -0
  77. package/dist/generated/ConceptDescriptionRepositoryService/index.js +5 -0
  78. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
  79. package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
  80. package/dist/generated/ConceptDescriptionRepositoryService/runtime.d.ts +181 -0
  81. package/dist/generated/ConceptDescriptionRepositoryService/runtime.js +326 -0
  82. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  83. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
  84. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
  85. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
  86. package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
  87. package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
  88. package/dist/generated/SubmodelRegistryService/index.d.ts +3 -0
  89. package/dist/generated/SubmodelRegistryService/index.js +5 -0
  90. package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
  91. package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
  92. package/dist/generated/SubmodelRegistryService/runtime.d.ts +181 -0
  93. package/dist/generated/SubmodelRegistryService/runtime.js +326 -0
  94. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  95. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
  96. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  97. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
  98. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
  99. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
  100. package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
  101. package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
  102. package/dist/generated/SubmodelRepositoryService/index.d.ts +3 -0
  103. package/dist/generated/SubmodelRepositoryService/index.js +5 -0
  104. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
  105. package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
  106. package/dist/generated/SubmodelRepositoryService/runtime.d.ts +181 -0
  107. package/dist/generated/SubmodelRepositoryService/runtime.js +326 -0
  108. package/dist/generated/index.d.ts +8 -2
  109. package/dist/generated/index.js +8 -3
  110. package/dist/index.d.ts +1 -1
  111. package/dist/index.js +1 -1
  112. package/dist/lib/apiConfig.d.ts +2 -0
  113. package/dist/lib/apiConfig.js +41 -0
  114. package/dist/lib/base64Url.js +4 -0
  115. package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
  116. package/dist/lib/convertAasDescriptorTypes.js +76 -0
  117. package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
  118. package/dist/lib/convertAasDiscoveryTypes.js +39 -0
  119. package/dist/lib/convertAasTypes.d.ts +7 -7
  120. package/dist/lib/convertAasTypes.js +5 -0
  121. package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
  122. package/dist/lib/convertConceptDescriptionTypes.js +39 -0
  123. package/dist/lib/convertSubmodelTypes.d.ts +34 -0
  124. package/dist/lib/convertSubmodelTypes.js +69 -0
  125. package/dist/lib/descriptorJsonization.d.ts +12 -0
  126. package/dist/lib/descriptorJsonization.js +172 -0
  127. package/dist/lib/errorHandler.d.ts +9 -0
  128. package/dist/lib/errorHandler.js +113 -0
  129. package/dist/models/Descriptors.d.ts +51 -0
  130. package/dist/models/Descriptors.js +56 -0
  131. package/dist/models/index.d.ts +0 -1
  132. package/dist/models/index.js +0 -1
  133. package/dist/utils/DescriptorUtils.d.ts +9 -0
  134. package/dist/utils/DescriptorUtils.js +37 -0
  135. package/dist/utils/KeyTypesUtil.d.ts +24 -0
  136. package/dist/utils/KeyTypesUtil.js +55 -0
  137. package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
  138. package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
  139. package/dist/utils/ReferableUtils.d.ts +69 -0
  140. package/dist/utils/ReferableUtils.js +220 -0
  141. package/dist/utils/ReferenceUtil.d.ts +9 -0
  142. package/dist/utils/ReferenceUtil.js +22 -0
  143. package/dist/utils/SemanticIdUtils.d.ts +119 -0
  144. package/dist/utils/SemanticIdUtils.js +363 -0
  145. package/package.json +14 -11
  146. package/dist/generated/schemas.gen.d.ts +0 -2357
  147. package/dist/generated/schemas.gen.js +0 -2789
  148. package/dist/generated/sdk.gen.d.ts +0 -822
  149. package/dist/generated/sdk.gen.js +0 -2225
  150. package/dist/generated/types.gen.d.ts +0 -10829
  151. package/dist/generated/types.gen.js +0 -2
  152. package/dist/lib/createAasRepoClient.d.ts +0 -9
  153. package/dist/lib/createAasRepoClient.js +0 -15
  154. package/dist/models/aas-repository.d.ts +0 -65
  155. package/dist/models/aas-repository.js +0 -1
@@ -0,0 +1,1070 @@
1
+ /**
2
+ *
3
+ * @export
4
+ * @interface AbstractLangString
5
+ */
6
+ export interface AbstractLangString {
7
+ /**
8
+ *
9
+ * @type {string}
10
+ * @memberof AbstractLangString
11
+ */
12
+ language: string;
13
+ /**
14
+ *
15
+ * @type {string}
16
+ * @memberof AbstractLangString
17
+ */
18
+ text: string;
19
+ }
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface AdministrativeInformation
24
+ */
25
+ export interface AdministrativeInformation {
26
+ /**
27
+ *
28
+ * @type {Array<EmbeddedDataSpecification>}
29
+ * @memberof AdministrativeInformation
30
+ */
31
+ embeddedDataSpecifications?: Array<EmbeddedDataSpecification>;
32
+ /**
33
+ *
34
+ * @type {AdministrativeInformationAllOfVersion}
35
+ * @memberof AdministrativeInformation
36
+ */
37
+ version?: AdministrativeInformationAllOfVersion;
38
+ /**
39
+ *
40
+ * @type {AdministrativeInformationAllOfRevision}
41
+ * @memberof AdministrativeInformation
42
+ */
43
+ revision?: AdministrativeInformationAllOfRevision;
44
+ /**
45
+ *
46
+ * @type {Reference}
47
+ * @memberof AdministrativeInformation
48
+ */
49
+ creator?: Reference;
50
+ /**
51
+ *
52
+ * @type {string}
53
+ * @memberof AdministrativeInformation
54
+ */
55
+ templateId?: string;
56
+ }
57
+ /**
58
+ *
59
+ * @export
60
+ * @interface AdministrativeInformationAllOfRevision
61
+ */
62
+ export interface AdministrativeInformationAllOfRevision {
63
+ }
64
+ /**
65
+ *
66
+ * @export
67
+ * @interface AdministrativeInformationAllOfVersion
68
+ */
69
+ export interface AdministrativeInformationAllOfVersion {
70
+ }
71
+ /**
72
+ *
73
+ * @export
74
+ * @interface AssetAdministrationShellDescriptor
75
+ */
76
+ export interface AssetAdministrationShellDescriptor {
77
+ /**
78
+ *
79
+ * @type {Array<LangStringTextType>}
80
+ * @memberof AssetAdministrationShellDescriptor
81
+ */
82
+ description?: Array<LangStringTextType>;
83
+ /**
84
+ *
85
+ * @type {Array<LangStringNameType>}
86
+ * @memberof AssetAdministrationShellDescriptor
87
+ */
88
+ displayName?: Array<LangStringNameType>;
89
+ /**
90
+ *
91
+ * @type {Array<Extension>}
92
+ * @memberof AssetAdministrationShellDescriptor
93
+ */
94
+ extensions?: Array<Extension>;
95
+ /**
96
+ *
97
+ * @type {AdministrativeInformation}
98
+ * @memberof AssetAdministrationShellDescriptor
99
+ */
100
+ administration?: AdministrativeInformation;
101
+ /**
102
+ *
103
+ * @type {AssetKind}
104
+ * @memberof AssetAdministrationShellDescriptor
105
+ */
106
+ assetKind?: AssetKind;
107
+ /**
108
+ *
109
+ * @type {string}
110
+ * @memberof AssetAdministrationShellDescriptor
111
+ */
112
+ assetType?: string;
113
+ /**
114
+ *
115
+ * @type {Array<Endpoint>}
116
+ * @memberof AssetAdministrationShellDescriptor
117
+ */
118
+ endpoints?: Array<Endpoint>;
119
+ /**
120
+ *
121
+ * @type {string}
122
+ * @memberof AssetAdministrationShellDescriptor
123
+ */
124
+ globalAssetId?: string;
125
+ /**
126
+ *
127
+ * @type {string}
128
+ * @memberof AssetAdministrationShellDescriptor
129
+ */
130
+ idShort?: string;
131
+ /**
132
+ *
133
+ * @type {string}
134
+ * @memberof AssetAdministrationShellDescriptor
135
+ */
136
+ id: string;
137
+ /**
138
+ *
139
+ * @type {Array<SpecificAssetId>}
140
+ * @memberof AssetAdministrationShellDescriptor
141
+ */
142
+ specificAssetIds?: Array<SpecificAssetId>;
143
+ /**
144
+ *
145
+ * @type {Array<SubmodelDescriptor>}
146
+ * @memberof AssetAdministrationShellDescriptor
147
+ */
148
+ submodelDescriptors?: Array<SubmodelDescriptor>;
149
+ }
150
+ /**
151
+ *
152
+ * @export
153
+ */
154
+ export declare const AssetKind: {
155
+ readonly Instance: "Instance";
156
+ readonly NotApplicable: "NotApplicable";
157
+ readonly Role: "Role";
158
+ readonly Type: "Type";
159
+ };
160
+ export type AssetKind = typeof AssetKind[keyof typeof AssetKind];
161
+ /**
162
+ *
163
+ * @export
164
+ * @interface DataSpecificationContent
165
+ */
166
+ export interface DataSpecificationContent {
167
+ /**
168
+ *
169
+ * @type {ModelType}
170
+ * @memberof DataSpecificationContent
171
+ */
172
+ modelType: ModelType;
173
+ }
174
+ /**
175
+ * @type DataSpecificationContentChoice
176
+ *
177
+ * @export
178
+ */
179
+ export type DataSpecificationContentChoice = DataSpecificationIec61360;
180
+ /**
181
+ *
182
+ * @export
183
+ * @interface DataSpecificationIec61360
184
+ */
185
+ export interface DataSpecificationIec61360 {
186
+ /**
187
+ *
188
+ * @type {any}
189
+ * @memberof DataSpecificationIec61360
190
+ */
191
+ modelType: any | null;
192
+ /**
193
+ *
194
+ * @type {Array<LangStringPreferredNameTypeIec61360>}
195
+ * @memberof DataSpecificationIec61360
196
+ */
197
+ preferredName: Array<LangStringPreferredNameTypeIec61360>;
198
+ /**
199
+ *
200
+ * @type {Array<LangStringShortNameTypeIec61360>}
201
+ * @memberof DataSpecificationIec61360
202
+ */
203
+ shortName?: Array<LangStringShortNameTypeIec61360>;
204
+ /**
205
+ *
206
+ * @type {string}
207
+ * @memberof DataSpecificationIec61360
208
+ */
209
+ unit?: string;
210
+ /**
211
+ *
212
+ * @type {Reference}
213
+ * @memberof DataSpecificationIec61360
214
+ */
215
+ unitId?: Reference;
216
+ /**
217
+ *
218
+ * @type {string}
219
+ * @memberof DataSpecificationIec61360
220
+ */
221
+ sourceOfDefinition?: string;
222
+ /**
223
+ *
224
+ * @type {string}
225
+ * @memberof DataSpecificationIec61360
226
+ */
227
+ symbol?: string;
228
+ /**
229
+ *
230
+ * @type {DataTypeIec61360}
231
+ * @memberof DataSpecificationIec61360
232
+ */
233
+ dataType?: DataTypeIec61360;
234
+ /**
235
+ *
236
+ * @type {Array<LangStringDefinitionTypeIec61360>}
237
+ * @memberof DataSpecificationIec61360
238
+ */
239
+ definition?: Array<LangStringDefinitionTypeIec61360>;
240
+ /**
241
+ *
242
+ * @type {string}
243
+ * @memberof DataSpecificationIec61360
244
+ */
245
+ valueFormat?: string;
246
+ /**
247
+ *
248
+ * @type {ValueList}
249
+ * @memberof DataSpecificationIec61360
250
+ */
251
+ valueList?: ValueList;
252
+ /**
253
+ *
254
+ * @type {string}
255
+ * @memberof DataSpecificationIec61360
256
+ */
257
+ value?: string;
258
+ /**
259
+ *
260
+ * @type {LevelType}
261
+ * @memberof DataSpecificationIec61360
262
+ */
263
+ levelType?: LevelType;
264
+ }
265
+ /**
266
+ *
267
+ * @export
268
+ */
269
+ export declare const DataTypeDefXsd: {
270
+ readonly XsAnyUri: "xs:anyURI";
271
+ readonly XsBase64Binary: "xs:base64Binary";
272
+ readonly XsBoolean: "xs:boolean";
273
+ readonly XsByte: "xs:byte";
274
+ readonly XsDate: "xs:date";
275
+ readonly XsDateTime: "xs:dateTime";
276
+ readonly XsDecimal: "xs:decimal";
277
+ readonly XsDouble: "xs:double";
278
+ readonly XsDuration: "xs:duration";
279
+ readonly XsFloat: "xs:float";
280
+ readonly XsGDay: "xs:gDay";
281
+ readonly XsGMonth: "xs:gMonth";
282
+ readonly XsGMonthDay: "xs:gMonthDay";
283
+ readonly XsGYear: "xs:gYear";
284
+ readonly XsGYearMonth: "xs:gYearMonth";
285
+ readonly XsHexBinary: "xs:hexBinary";
286
+ readonly XsInt: "xs:int";
287
+ readonly XsInteger: "xs:integer";
288
+ readonly XsLong: "xs:long";
289
+ readonly XsNegativeInteger: "xs:negativeInteger";
290
+ readonly XsNonNegativeInteger: "xs:nonNegativeInteger";
291
+ readonly XsNonPositiveInteger: "xs:nonPositiveInteger";
292
+ readonly XsPositiveInteger: "xs:positiveInteger";
293
+ readonly XsShort: "xs:short";
294
+ readonly XsString: "xs:string";
295
+ readonly XsTime: "xs:time";
296
+ readonly XsUnsignedByte: "xs:unsignedByte";
297
+ readonly XsUnsignedInt: "xs:unsignedInt";
298
+ readonly XsUnsignedLong: "xs:unsignedLong";
299
+ readonly XsUnsignedShort: "xs:unsignedShort";
300
+ };
301
+ export type DataTypeDefXsd = typeof DataTypeDefXsd[keyof typeof DataTypeDefXsd];
302
+ /**
303
+ *
304
+ * @export
305
+ */
306
+ export declare const DataTypeIec61360: {
307
+ readonly Blob: "BLOB";
308
+ readonly Boolean: "BOOLEAN";
309
+ readonly Date: "DATE";
310
+ readonly File: "FILE";
311
+ readonly Html: "HTML";
312
+ readonly IntegerCount: "INTEGER_COUNT";
313
+ readonly IntegerCurrency: "INTEGER_CURRENCY";
314
+ readonly IntegerMeasure: "INTEGER_MEASURE";
315
+ readonly Irdi: "IRDI";
316
+ readonly Iri: "IRI";
317
+ readonly Rational: "RATIONAL";
318
+ readonly RationalMeasure: "RATIONAL_MEASURE";
319
+ readonly RealCount: "REAL_COUNT";
320
+ readonly RealCurrency: "REAL_CURRENCY";
321
+ readonly RealMeasure: "REAL_MEASURE";
322
+ readonly String: "STRING";
323
+ readonly StringTranslatable: "STRING_TRANSLATABLE";
324
+ readonly Time: "TIME";
325
+ readonly Timestamp: "TIMESTAMP";
326
+ };
327
+ export type DataTypeIec61360 = typeof DataTypeIec61360[keyof typeof DataTypeIec61360];
328
+ /**
329
+ *
330
+ * @export
331
+ * @interface Descriptor
332
+ */
333
+ export interface Descriptor {
334
+ /**
335
+ *
336
+ * @type {Array<LangStringTextType>}
337
+ * @memberof Descriptor
338
+ */
339
+ description?: Array<LangStringTextType>;
340
+ /**
341
+ *
342
+ * @type {Array<LangStringNameType>}
343
+ * @memberof Descriptor
344
+ */
345
+ displayName?: Array<LangStringNameType>;
346
+ /**
347
+ *
348
+ * @type {Array<Extension>}
349
+ * @memberof Descriptor
350
+ */
351
+ extensions?: Array<Extension>;
352
+ }
353
+ /**
354
+ *
355
+ * @export
356
+ * @interface EmbeddedDataSpecification
357
+ */
358
+ export interface EmbeddedDataSpecification {
359
+ /**
360
+ *
361
+ * @type {DataSpecificationContentChoice}
362
+ * @memberof EmbeddedDataSpecification
363
+ */
364
+ dataSpecificationContent: DataSpecificationContentChoice;
365
+ /**
366
+ *
367
+ * @type {Reference}
368
+ * @memberof EmbeddedDataSpecification
369
+ */
370
+ dataSpecification: Reference;
371
+ }
372
+ /**
373
+ *
374
+ * @export
375
+ * @interface Endpoint
376
+ */
377
+ export interface Endpoint {
378
+ /**
379
+ *
380
+ * @type {string}
381
+ * @memberof Endpoint
382
+ */
383
+ _interface: string;
384
+ /**
385
+ *
386
+ * @type {ProtocolInformation}
387
+ * @memberof Endpoint
388
+ */
389
+ protocolInformation: ProtocolInformation;
390
+ }
391
+ /**
392
+ *
393
+ * @export
394
+ * @interface Extension
395
+ */
396
+ export interface Extension {
397
+ /**
398
+ *
399
+ * @type {Reference}
400
+ * @memberof Extension
401
+ */
402
+ semanticId?: Reference;
403
+ /**
404
+ *
405
+ * @type {Array<Reference>}
406
+ * @memberof Extension
407
+ */
408
+ supplementalSemanticIds?: Array<Reference>;
409
+ /**
410
+ *
411
+ * @type {string}
412
+ * @memberof Extension
413
+ */
414
+ name: string;
415
+ /**
416
+ *
417
+ * @type {DataTypeDefXsd}
418
+ * @memberof Extension
419
+ */
420
+ valueType?: DataTypeDefXsd;
421
+ /**
422
+ *
423
+ * @type {string}
424
+ * @memberof Extension
425
+ */
426
+ value?: string;
427
+ /**
428
+ *
429
+ * @type {Array<Reference>}
430
+ * @memberof Extension
431
+ */
432
+ refersTo?: Array<Reference>;
433
+ }
434
+ /**
435
+ *
436
+ * @export
437
+ * @interface GetAssetAdministrationShellDescriptorsResult
438
+ */
439
+ export interface GetAssetAdministrationShellDescriptorsResult {
440
+ /**
441
+ *
442
+ * @type {PagedResultPagingMetadata}
443
+ * @memberof GetAssetAdministrationShellDescriptorsResult
444
+ */
445
+ pagingMetadata: PagedResultPagingMetadata;
446
+ /**
447
+ *
448
+ * @type {Array<AssetAdministrationShellDescriptor>}
449
+ * @memberof GetAssetAdministrationShellDescriptorsResult
450
+ */
451
+ result?: Array<AssetAdministrationShellDescriptor>;
452
+ }
453
+ /**
454
+ *
455
+ * @export
456
+ * @interface GetSubmodelDescriptorsResult
457
+ */
458
+ export interface GetSubmodelDescriptorsResult {
459
+ /**
460
+ *
461
+ * @type {PagedResultPagingMetadata}
462
+ * @memberof GetSubmodelDescriptorsResult
463
+ */
464
+ pagingMetadata: PagedResultPagingMetadata;
465
+ /**
466
+ *
467
+ * @type {Array<SubmodelDescriptor>}
468
+ * @memberof GetSubmodelDescriptorsResult
469
+ */
470
+ result?: Array<SubmodelDescriptor>;
471
+ }
472
+ /**
473
+ *
474
+ * @export
475
+ * @interface HasDataSpecification
476
+ */
477
+ export interface HasDataSpecification {
478
+ /**
479
+ *
480
+ * @type {Array<EmbeddedDataSpecification>}
481
+ * @memberof HasDataSpecification
482
+ */
483
+ embeddedDataSpecifications?: Array<EmbeddedDataSpecification>;
484
+ }
485
+ /**
486
+ *
487
+ * @export
488
+ * @interface HasSemantics
489
+ */
490
+ export interface HasSemantics {
491
+ /**
492
+ *
493
+ * @type {Reference}
494
+ * @memberof HasSemantics
495
+ */
496
+ semanticId?: Reference;
497
+ /**
498
+ *
499
+ * @type {Array<Reference>}
500
+ * @memberof HasSemantics
501
+ */
502
+ supplementalSemanticIds?: Array<Reference>;
503
+ }
504
+ /**
505
+ *
506
+ * @export
507
+ * @interface Key
508
+ */
509
+ export interface Key {
510
+ /**
511
+ *
512
+ * @type {KeyTypes}
513
+ * @memberof Key
514
+ */
515
+ type: KeyTypes;
516
+ /**
517
+ *
518
+ * @type {string}
519
+ * @memberof Key
520
+ */
521
+ value: string;
522
+ }
523
+ /**
524
+ *
525
+ * @export
526
+ */
527
+ export declare const KeyTypes: {
528
+ readonly AnnotatedRelationshipElement: "AnnotatedRelationshipElement";
529
+ readonly AssetAdministrationShell: "AssetAdministrationShell";
530
+ readonly BasicEventElement: "BasicEventElement";
531
+ readonly Blob: "Blob";
532
+ readonly Capability: "Capability";
533
+ readonly ConceptDescription: "ConceptDescription";
534
+ readonly DataElement: "DataElement";
535
+ readonly Entity: "Entity";
536
+ readonly EventElement: "EventElement";
537
+ readonly File: "File";
538
+ readonly FragmentReference: "FragmentReference";
539
+ readonly GlobalReference: "GlobalReference";
540
+ readonly Identifiable: "Identifiable";
541
+ readonly MultiLanguageProperty: "MultiLanguageProperty";
542
+ readonly Operation: "Operation";
543
+ readonly Property: "Property";
544
+ readonly Range: "Range";
545
+ readonly Referable: "Referable";
546
+ readonly ReferenceElement: "ReferenceElement";
547
+ readonly RelationshipElement: "RelationshipElement";
548
+ readonly Submodel: "Submodel";
549
+ readonly SubmodelElement: "SubmodelElement";
550
+ readonly SubmodelElementCollection: "SubmodelElementCollection";
551
+ readonly SubmodelElementList: "SubmodelElementList";
552
+ };
553
+ export type KeyTypes = typeof KeyTypes[keyof typeof KeyTypes];
554
+ /**
555
+ *
556
+ * @export
557
+ * @interface LangStringDefinitionTypeIec61360
558
+ */
559
+ export interface LangStringDefinitionTypeIec61360 {
560
+ /**
561
+ *
562
+ * @type {string}
563
+ * @memberof LangStringDefinitionTypeIec61360
564
+ */
565
+ language: string;
566
+ /**
567
+ *
568
+ * @type {any}
569
+ * @memberof LangStringDefinitionTypeIec61360
570
+ */
571
+ text: any | null;
572
+ }
573
+ /**
574
+ *
575
+ * @export
576
+ * @interface LangStringNameType
577
+ */
578
+ export interface LangStringNameType {
579
+ /**
580
+ *
581
+ * @type {string}
582
+ * @memberof LangStringNameType
583
+ */
584
+ language: string;
585
+ /**
586
+ *
587
+ * @type {any}
588
+ * @memberof LangStringNameType
589
+ */
590
+ text: any | null;
591
+ }
592
+ /**
593
+ *
594
+ * @export
595
+ * @interface LangStringPreferredNameTypeIec61360
596
+ */
597
+ export interface LangStringPreferredNameTypeIec61360 {
598
+ /**
599
+ *
600
+ * @type {string}
601
+ * @memberof LangStringPreferredNameTypeIec61360
602
+ */
603
+ language: string;
604
+ /**
605
+ *
606
+ * @type {any}
607
+ * @memberof LangStringPreferredNameTypeIec61360
608
+ */
609
+ text: any | null;
610
+ }
611
+ /**
612
+ *
613
+ * @export
614
+ * @interface LangStringShortNameTypeIec61360
615
+ */
616
+ export interface LangStringShortNameTypeIec61360 {
617
+ /**
618
+ *
619
+ * @type {string}
620
+ * @memberof LangStringShortNameTypeIec61360
621
+ */
622
+ language: string;
623
+ /**
624
+ *
625
+ * @type {any}
626
+ * @memberof LangStringShortNameTypeIec61360
627
+ */
628
+ text: any | null;
629
+ }
630
+ /**
631
+ *
632
+ * @export
633
+ * @interface LangStringTextType
634
+ */
635
+ export interface LangStringTextType {
636
+ /**
637
+ *
638
+ * @type {string}
639
+ * @memberof LangStringTextType
640
+ */
641
+ language: string;
642
+ /**
643
+ *
644
+ * @type {any}
645
+ * @memberof LangStringTextType
646
+ */
647
+ text: any | null;
648
+ }
649
+ /**
650
+ *
651
+ * @export
652
+ * @interface LevelType
653
+ */
654
+ export interface LevelType {
655
+ /**
656
+ *
657
+ * @type {boolean}
658
+ * @memberof LevelType
659
+ */
660
+ min: boolean;
661
+ /**
662
+ *
663
+ * @type {boolean}
664
+ * @memberof LevelType
665
+ */
666
+ nom: boolean;
667
+ /**
668
+ *
669
+ * @type {boolean}
670
+ * @memberof LevelType
671
+ */
672
+ typ: boolean;
673
+ /**
674
+ *
675
+ * @type {boolean}
676
+ * @memberof LevelType
677
+ */
678
+ max: boolean;
679
+ }
680
+ /**
681
+ *
682
+ * @export
683
+ * @interface Message
684
+ */
685
+ export interface Message {
686
+ /**
687
+ *
688
+ * @type {string}
689
+ * @memberof Message
690
+ */
691
+ code?: string;
692
+ /**
693
+ *
694
+ * @type {string}
695
+ * @memberof Message
696
+ */
697
+ correlationId?: string;
698
+ /**
699
+ *
700
+ * @type {string}
701
+ * @memberof Message
702
+ */
703
+ messageType?: MessageMessageTypeEnum;
704
+ /**
705
+ *
706
+ * @type {string}
707
+ * @memberof Message
708
+ */
709
+ text?: string;
710
+ /**
711
+ *
712
+ * @type {string}
713
+ * @memberof Message
714
+ */
715
+ timestamp?: string;
716
+ }
717
+ /**
718
+ * @export
719
+ */
720
+ export declare const MessageMessageTypeEnum: {
721
+ readonly Undefined: "Undefined";
722
+ readonly Info: "Info";
723
+ readonly Warning: "Warning";
724
+ readonly Error: "Error";
725
+ readonly Exception: "Exception";
726
+ };
727
+ export type MessageMessageTypeEnum = typeof MessageMessageTypeEnum[keyof typeof MessageMessageTypeEnum];
728
+ /**
729
+ *
730
+ * @export
731
+ */
732
+ export declare const ModelType: {
733
+ readonly AnnotatedRelationshipElement: "AnnotatedRelationshipElement";
734
+ readonly AssetAdministrationShell: "AssetAdministrationShell";
735
+ readonly BasicEventElement: "BasicEventElement";
736
+ readonly Blob: "Blob";
737
+ readonly Capability: "Capability";
738
+ readonly ConceptDescription: "ConceptDescription";
739
+ readonly DataSpecificationIec61360: "DataSpecificationIec61360";
740
+ readonly Entity: "Entity";
741
+ readonly File: "File";
742
+ readonly MultiLanguageProperty: "MultiLanguageProperty";
743
+ readonly Operation: "Operation";
744
+ readonly Property: "Property";
745
+ readonly Range: "Range";
746
+ readonly ReferenceElement: "ReferenceElement";
747
+ readonly RelationshipElement: "RelationshipElement";
748
+ readonly Submodel: "Submodel";
749
+ readonly SubmodelElementCollection: "SubmodelElementCollection";
750
+ readonly SubmodelElementList: "SubmodelElementList";
751
+ };
752
+ export type ModelType = typeof ModelType[keyof typeof ModelType];
753
+ /**
754
+ *
755
+ * @export
756
+ * @interface PagedResult
757
+ */
758
+ export interface PagedResult {
759
+ /**
760
+ *
761
+ * @type {PagedResultPagingMetadata}
762
+ * @memberof PagedResult
763
+ */
764
+ pagingMetadata: PagedResultPagingMetadata;
765
+ }
766
+ /**
767
+ *
768
+ * @export
769
+ * @interface PagedResultPagingMetadata
770
+ */
771
+ export interface PagedResultPagingMetadata {
772
+ /**
773
+ *
774
+ * @type {string}
775
+ * @memberof PagedResultPagingMetadata
776
+ */
777
+ cursor?: string;
778
+ }
779
+ /**
780
+ *
781
+ * @export
782
+ * @interface ProtocolInformation
783
+ */
784
+ export interface ProtocolInformation {
785
+ /**
786
+ *
787
+ * @type {string}
788
+ * @memberof ProtocolInformation
789
+ */
790
+ href: string;
791
+ /**
792
+ *
793
+ * @type {string}
794
+ * @memberof ProtocolInformation
795
+ */
796
+ endpointProtocol?: string;
797
+ /**
798
+ *
799
+ * @type {Array<string>}
800
+ * @memberof ProtocolInformation
801
+ */
802
+ endpointProtocolVersion?: Array<string>;
803
+ /**
804
+ *
805
+ * @type {string}
806
+ * @memberof ProtocolInformation
807
+ */
808
+ subprotocol?: string;
809
+ /**
810
+ *
811
+ * @type {string}
812
+ * @memberof ProtocolInformation
813
+ */
814
+ subprotocolBody?: string;
815
+ /**
816
+ *
817
+ * @type {string}
818
+ * @memberof ProtocolInformation
819
+ */
820
+ subprotocolBodyEncoding?: string;
821
+ /**
822
+ *
823
+ * @type {Array<ProtocolInformationSecurityAttributes>}
824
+ * @memberof ProtocolInformation
825
+ */
826
+ securityAttributes?: Array<ProtocolInformationSecurityAttributes>;
827
+ }
828
+ /**
829
+ *
830
+ * @export
831
+ * @interface ProtocolInformationSecurityAttributes
832
+ */
833
+ export interface ProtocolInformationSecurityAttributes {
834
+ /**
835
+ *
836
+ * @type {string}
837
+ * @memberof ProtocolInformationSecurityAttributes
838
+ */
839
+ type: ProtocolInformationSecurityAttributesTypeEnum;
840
+ /**
841
+ *
842
+ * @type {string}
843
+ * @memberof ProtocolInformationSecurityAttributes
844
+ */
845
+ key: string;
846
+ /**
847
+ *
848
+ * @type {string}
849
+ * @memberof ProtocolInformationSecurityAttributes
850
+ */
851
+ value: string;
852
+ }
853
+ /**
854
+ * @export
855
+ */
856
+ export declare const ProtocolInformationSecurityAttributesTypeEnum: {
857
+ readonly None: "NONE";
858
+ readonly RfcTlsa: "RFC_TLSA";
859
+ readonly W3CDid: "W3C_DID";
860
+ };
861
+ export type ProtocolInformationSecurityAttributesTypeEnum = typeof ProtocolInformationSecurityAttributesTypeEnum[keyof typeof ProtocolInformationSecurityAttributesTypeEnum];
862
+ /**
863
+ *
864
+ * @export
865
+ * @interface Reference
866
+ */
867
+ export interface Reference {
868
+ /**
869
+ *
870
+ * @type {ReferenceTypes}
871
+ * @memberof Reference
872
+ */
873
+ type: ReferenceTypes;
874
+ /**
875
+ *
876
+ * @type {Array<Key>}
877
+ * @memberof Reference
878
+ */
879
+ keys: Array<Key>;
880
+ /**
881
+ *
882
+ * @type {ReferenceParent}
883
+ * @memberof Reference
884
+ */
885
+ referredSemanticId?: ReferenceParent;
886
+ }
887
+ /**
888
+ *
889
+ * @export
890
+ * @interface ReferenceParent
891
+ */
892
+ export interface ReferenceParent {
893
+ /**
894
+ *
895
+ * @type {ReferenceTypes}
896
+ * @memberof ReferenceParent
897
+ */
898
+ type: ReferenceTypes;
899
+ /**
900
+ *
901
+ * @type {Array<Key>}
902
+ * @memberof ReferenceParent
903
+ */
904
+ keys: Array<Key>;
905
+ }
906
+ /**
907
+ *
908
+ * @export
909
+ */
910
+ export declare const ReferenceTypes: {
911
+ readonly ExternalReference: "ExternalReference";
912
+ readonly ModelReference: "ModelReference";
913
+ };
914
+ export type ReferenceTypes = typeof ReferenceTypes[keyof typeof ReferenceTypes];
915
+ /**
916
+ *
917
+ * @export
918
+ * @interface Result
919
+ */
920
+ export interface Result {
921
+ /**
922
+ *
923
+ * @type {Array<Message>}
924
+ * @memberof Result
925
+ */
926
+ messages?: Array<Message>;
927
+ }
928
+ /**
929
+ * The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.
930
+ * @export
931
+ * @interface ServiceDescription
932
+ */
933
+ export interface ServiceDescription {
934
+ /**
935
+ *
936
+ * @type {Array<string>}
937
+ * @memberof ServiceDescription
938
+ */
939
+ profiles?: Array<string>;
940
+ }
941
+ /**
942
+ *
943
+ * @export
944
+ * @interface SpecificAssetId
945
+ */
946
+ export interface SpecificAssetId {
947
+ /**
948
+ *
949
+ * @type {Reference}
950
+ * @memberof SpecificAssetId
951
+ */
952
+ semanticId?: Reference;
953
+ /**
954
+ *
955
+ * @type {Array<Reference>}
956
+ * @memberof SpecificAssetId
957
+ */
958
+ supplementalSemanticIds?: Array<Reference>;
959
+ /**
960
+ *
961
+ * @type {string}
962
+ * @memberof SpecificAssetId
963
+ */
964
+ name: string;
965
+ /**
966
+ *
967
+ * @type {string}
968
+ * @memberof SpecificAssetId
969
+ */
970
+ value: string;
971
+ /**
972
+ *
973
+ * @type {Reference}
974
+ * @memberof SpecificAssetId
975
+ */
976
+ externalSubjectId?: Reference;
977
+ }
978
+ /**
979
+ *
980
+ * @export
981
+ * @interface SubmodelDescriptor
982
+ */
983
+ export interface SubmodelDescriptor {
984
+ /**
985
+ *
986
+ * @type {AdministrativeInformation}
987
+ * @memberof SubmodelDescriptor
988
+ */
989
+ administration?: AdministrativeInformation;
990
+ /**
991
+ *
992
+ * @type {Array<Endpoint>}
993
+ * @memberof SubmodelDescriptor
994
+ */
995
+ endpoints: Array<Endpoint>;
996
+ /**
997
+ *
998
+ * @type {string}
999
+ * @memberof SubmodelDescriptor
1000
+ */
1001
+ idShort?: string;
1002
+ /**
1003
+ *
1004
+ * @type {string}
1005
+ * @memberof SubmodelDescriptor
1006
+ */
1007
+ id: string;
1008
+ /**
1009
+ *
1010
+ * @type {Reference}
1011
+ * @memberof SubmodelDescriptor
1012
+ */
1013
+ semanticId?: Reference;
1014
+ /**
1015
+ *
1016
+ * @type {Array<Reference>}
1017
+ * @memberof SubmodelDescriptor
1018
+ */
1019
+ supplementalSemanticId?: Array<Reference>;
1020
+ /**
1021
+ *
1022
+ * @type {Array<LangStringTextType>}
1023
+ * @memberof SubmodelDescriptor
1024
+ */
1025
+ description?: Array<LangStringTextType>;
1026
+ /**
1027
+ *
1028
+ * @type {Array<LangStringNameType>}
1029
+ * @memberof SubmodelDescriptor
1030
+ */
1031
+ displayName?: Array<LangStringNameType>;
1032
+ /**
1033
+ *
1034
+ * @type {Array<Extension>}
1035
+ * @memberof SubmodelDescriptor
1036
+ */
1037
+ extensions?: Array<Extension>;
1038
+ }
1039
+ /**
1040
+ *
1041
+ * @export
1042
+ * @interface ValueList
1043
+ */
1044
+ export interface ValueList {
1045
+ /**
1046
+ *
1047
+ * @type {Array<ValueReferencePair>}
1048
+ * @memberof ValueList
1049
+ */
1050
+ valueReferencePairs: Array<ValueReferencePair>;
1051
+ }
1052
+ /**
1053
+ *
1054
+ * @export
1055
+ * @interface ValueReferencePair
1056
+ */
1057
+ export interface ValueReferencePair {
1058
+ /**
1059
+ *
1060
+ * @type {string}
1061
+ * @memberof ValueReferencePair
1062
+ */
1063
+ value: string;
1064
+ /**
1065
+ *
1066
+ * @type {Reference}
1067
+ * @memberof ValueReferencePair
1068
+ */
1069
+ valueId?: Reference;
1070
+ }