basyx-typescript-sdk 2.1.2 → 2.2.2

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 (43) hide show
  1. package/bundle/index.cjs +18256 -4707
  2. package/bundle/index.cjs.map +1 -1
  3. package/bundle/index.mjs +18238 -4692
  4. package/bundle/index.mjs.map +1 -1
  5. package/dist/clients/AasDiscoveryClient.d.ts +31 -0
  6. package/dist/clients/AasDiscoveryClient.js +51 -0
  7. package/dist/clients/AasRegistryClient.d.ts +11 -0
  8. package/dist/clients/AasRegistryClient.js +20 -0
  9. package/dist/clients/AasRepositoryClient.d.ts +50 -0
  10. package/dist/clients/AasRepositoryClient.js +81 -0
  11. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +28 -0
  12. package/dist/clients/ConceptDescriptionRepositoryClient.js +47 -0
  13. package/dist/clients/SubmodelRegistryClient.d.ts +11 -0
  14. package/dist/clients/SubmodelRegistryClient.js +20 -0
  15. package/dist/clients/SubmodelRepositoryClient.d.ts +229 -0
  16. package/dist/clients/SubmodelRepositoryClient.js +501 -0
  17. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +2 -2
  18. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +2 -2
  19. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +2 -2
  20. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +2 -2
  21. package/dist/generated/AasRegistryService/index.d.ts +1 -0
  22. package/dist/generated/AasRegistryService/index.js +1 -0
  23. package/dist/generated/AasRegistryService/models/index.d.ts +10 -10
  24. package/dist/generated/AasRegistryService/models/index.js +1 -1
  25. package/dist/generated/AasRegistryService/runtime.d.ts +181 -0
  26. package/dist/generated/AasRegistryService/runtime.js +326 -0
  27. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +2 -2
  28. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +2 -2
  29. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +2 -2
  30. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +2 -2
  31. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +2 -2
  32. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +2 -2
  33. package/dist/generated/AasRepositoryService/index.d.ts +1 -0
  34. package/dist/generated/AasRepositoryService/index.js +1 -0
  35. package/dist/generated/AasRepositoryService/runtime.d.ts +181 -0
  36. package/dist/generated/AasRepositoryService/runtime.js +326 -0
  37. package/dist/lib/apiConfig.d.ts +1 -2
  38. package/dist/lib/apiConfig.js +2 -3
  39. package/dist/lib/index.d.ts +1 -0
  40. package/dist/lib/index.js +2 -0
  41. package/dist/models/index.d.ts +1 -0
  42. package/dist/models/index.js +1 -0
  43. package/package.json +2 -2
@@ -29,6 +29,50 @@ export declare class SubmodelRepositoryClient {
29
29
  pagedResult: SubmodelRepositoryService.PagedResultPagingMetadata | undefined;
30
30
  result: Submodel[];
31
31
  }, SubmodelRepositoryService.Result>>;
32
+ /**
33
+ * Returns all Submodels in metadata representation
34
+ */
35
+ getAllSubmodelsMetadata(options: {
36
+ configuration: Configuration;
37
+ semanticId?: string;
38
+ idShort?: string;
39
+ limit?: number;
40
+ cursor?: string;
41
+ }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelsMetadataResult, SubmodelRepositoryService.Result>>;
42
+ /**
43
+ * Returns all Submodels in value-only representation
44
+ */
45
+ getAllSubmodelsValueOnly(options: {
46
+ configuration: Configuration;
47
+ semanticId?: string;
48
+ idShort?: string;
49
+ limit?: number;
50
+ cursor?: string;
51
+ level?: SubmodelRepositoryService.GetAllSubmodelsValueOnlyLevelEnum;
52
+ extent?: SubmodelRepositoryService.GetAllSubmodelsValueOnlyExtentEnum;
53
+ }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelsValueResult, SubmodelRepositoryService.Result>>;
54
+ /**
55
+ * Returns references to all Submodels
56
+ */
57
+ getAllSubmodelsReference(options: {
58
+ configuration: Configuration;
59
+ semanticId?: string;
60
+ idShort?: string;
61
+ limit?: number;
62
+ cursor?: string;
63
+ level?: SubmodelRepositoryService.GetAllSubmodelsReferenceLevelEnum;
64
+ }): Promise<ApiResult<SubmodelRepositoryService.GetReferencesResult, SubmodelRepositoryService.Result>>;
65
+ /**
66
+ * Returns paths of all Submodels
67
+ */
68
+ getAllSubmodelsPath(options: {
69
+ configuration: Configuration;
70
+ semanticId?: string;
71
+ idShort?: string;
72
+ limit?: number;
73
+ cursor?: string;
74
+ level?: SubmodelRepositoryService.GetAllSubmodelsPathLevelEnum;
75
+ }): Promise<ApiResult<SubmodelRepositoryService.GetPathItemsResult, SubmodelRepositoryService.Result>>;
32
76
  /**
33
77
  * Creates a new Submodel
34
78
  *
@@ -72,6 +116,21 @@ export declare class SubmodelRepositoryClient {
72
116
  level?: SubmodelRepositoryService.GetSubmodelByIdLevelEnum;
73
117
  extent?: SubmodelRepositoryService.GetSubmodelByIdExtentEnum;
74
118
  }): Promise<ApiResult<Submodel, SubmodelRepositoryService.Result>>;
119
+ /**
120
+ * Returns a specific Submodel in reference representation
121
+ */
122
+ getSubmodelByIdReference(options: {
123
+ configuration: Configuration;
124
+ submodelIdentifier: string;
125
+ }): Promise<ApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result>>;
126
+ /**
127
+ * Returns a specific Submodel in path representation
128
+ */
129
+ getSubmodelByIdPath(options: {
130
+ configuration: Configuration;
131
+ submodelIdentifier: string;
132
+ level?: SubmodelRepositoryService.GetSubmodelByIdPathLevelEnum;
133
+ }): Promise<ApiResult<string[], SubmodelRepositoryService.Result>>;
75
134
  /**
76
135
  * Updates an existing Submodel
77
136
  *
@@ -87,6 +146,15 @@ export declare class SubmodelRepositoryClient {
87
146
  submodelIdentifier: string;
88
147
  submodel: Submodel;
89
148
  }): Promise<ApiResult<Submodel | void, SubmodelRepositoryService.Result>>;
149
+ /**
150
+ * Updates an existing Submodel partially
151
+ */
152
+ patchSubmodelById(options: {
153
+ configuration: Configuration;
154
+ submodelIdentifier: string;
155
+ submodel: Submodel;
156
+ level?: SubmodelRepositoryService.PatchSubmodelByIdLevelEnum;
157
+ }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
90
158
  /**
91
159
  * Returns all submodel elements including their hierarchy
92
160
  *
@@ -111,6 +179,46 @@ export declare class SubmodelRepositoryClient {
111
179
  pagedResult: SubmodelRepositoryService.PagedResultPagingMetadata | undefined;
112
180
  result: ISubmodelElement[];
113
181
  }, SubmodelRepositoryService.Result>>;
182
+ /**
183
+ * Returns all submodel elements in metadata representation
184
+ */
185
+ getAllSubmodelElementsMetadata(options: {
186
+ configuration: Configuration;
187
+ submodelIdentifier: string;
188
+ limit?: number;
189
+ cursor?: string;
190
+ }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelElementsMetadataResult, SubmodelRepositoryService.Result>>;
191
+ /**
192
+ * Returns all submodel elements in value-only representation
193
+ */
194
+ getAllSubmodelElementsValueOnly(options: {
195
+ configuration: Configuration;
196
+ submodelIdentifier: string;
197
+ limit?: number;
198
+ cursor?: string;
199
+ level?: SubmodelRepositoryService.GetAllSubmodelElementsValueOnlySubmodelRepoLevelEnum;
200
+ extent?: SubmodelRepositoryService.GetAllSubmodelElementsValueOnlySubmodelRepoExtentEnum;
201
+ }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelElementsValueResult, SubmodelRepositoryService.Result>>;
202
+ /**
203
+ * Returns references to all submodel elements
204
+ */
205
+ getAllSubmodelElementsReference(options: {
206
+ configuration: Configuration;
207
+ submodelIdentifier: string;
208
+ limit?: number;
209
+ cursor?: string;
210
+ level?: SubmodelRepositoryService.GetAllSubmodelElementsReferenceSubmodelRepoLevelEnum;
211
+ }): Promise<ApiResult<SubmodelRepositoryService.GetReferencesResult, SubmodelRepositoryService.Result>>;
212
+ /**
213
+ * Returns paths of all submodel elements
214
+ */
215
+ getAllSubmodelElementsPath(options: {
216
+ configuration: Configuration;
217
+ submodelIdentifier: string;
218
+ limit?: number;
219
+ cursor?: string;
220
+ level?: SubmodelRepositoryService.GetAllSubmodelElementsPathSubmodelRepoLevelEnum;
221
+ }): Promise<ApiResult<SubmodelRepositoryService.GetPathItemsResult, SubmodelRepositoryService.Result>>;
114
222
  /**
115
223
  * Creates a new submodel element
116
224
  *
@@ -144,6 +252,31 @@ export declare class SubmodelRepositoryClient {
144
252
  level?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoLevelEnum;
145
253
  extent?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoExtentEnum;
146
254
  }): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
255
+ /**
256
+ * Returns metadata attributes of a specific submodel element
257
+ */
258
+ getSubmodelElementByPathMetadata(options: {
259
+ configuration: Configuration;
260
+ submodelIdentifier: string;
261
+ idShortPath: string;
262
+ }): Promise<ApiResult<SubmodelRepositoryService.SubmodelElementMetadata, SubmodelRepositoryService.Result>>;
263
+ /**
264
+ * Returns a specific submodel element in reference representation
265
+ */
266
+ getSubmodelElementByPathReference(options: {
267
+ configuration: Configuration;
268
+ submodelIdentifier: string;
269
+ idShortPath: string;
270
+ }): Promise<ApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result>>;
271
+ /**
272
+ * Returns a specific submodel element in path representation
273
+ */
274
+ getSubmodelElementByPathPath(options: {
275
+ configuration: Configuration;
276
+ submodelIdentifier: string;
277
+ idShortPath: string;
278
+ level?: SubmodelRepositoryService.GetSubmodelElementByPathPathSubmodelRepoLevelEnum;
279
+ }): Promise<ApiResult<string[], SubmodelRepositoryService.Result>>;
147
280
  /**
148
281
  * Creates a new submodel element at a specified path within submodel elements hierarchy
149
282
  *
@@ -195,6 +328,16 @@ export declare class SubmodelRepositoryClient {
195
328
  submodelElement: ISubmodelElement;
196
329
  level?: SubmodelRepositoryService.PutSubmodelElementByPathSubmodelRepoLevelEnum;
197
330
  }): Promise<ApiResult<ISubmodelElement | void, SubmodelRepositoryService.Result>>;
331
+ /**
332
+ * Updates values of an existing submodel element at a specified path
333
+ */
334
+ patchSubmodelElementByPath(options: {
335
+ configuration: Configuration;
336
+ submodelIdentifier: string;
337
+ idShortPath: string;
338
+ submodelElement: ISubmodelElement;
339
+ level?: SubmodelRepositoryService.PatchSubmodelElementByPathSubmodelRepoLevelEnum;
340
+ }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
198
341
  /**
199
342
  * Returns the metadata attributes of a specific Submodel
200
343
  *
@@ -208,6 +351,15 @@ export declare class SubmodelRepositoryClient {
208
351
  configuration: Configuration;
209
352
  submodelIdentifier: string;
210
353
  }): Promise<ApiResult<SubmodelRepositoryService.SubmodelMetadata, SubmodelRepositoryService.Result>>;
354
+ /**
355
+ * Updates metadata attributes of an existing Submodel
356
+ */
357
+ patchSubmodelByIdMetadata(options: {
358
+ configuration: Configuration;
359
+ submodelIdentifier: string;
360
+ submodelMetadata: SubmodelRepositoryService.SubmodelMetadata;
361
+ level?: SubmodelRepositoryService.PatchSubmodelByIdMetadataLevelEnum;
362
+ }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
211
363
  /**
212
364
  * Returns a specific Submodel in the ValueOnly representation
213
365
  *
@@ -279,6 +431,41 @@ export declare class SubmodelRepositoryClient {
279
431
  submodelElementValue: SubmodelRepositoryService.SubmodelElementValue;
280
432
  level?: SubmodelRepositoryService.PatchSubmodelElementByPathValueOnlySubmodelRepoLevelEnum;
281
433
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
434
+ /**
435
+ * Updates metadata attributes of an existing SubmodelElement
436
+ */
437
+ patchSubmodelElementByPathMetadata(options: {
438
+ configuration: Configuration;
439
+ submodelIdentifier: string;
440
+ idShortPath: string;
441
+ submodelElementMetadata: SubmodelRepositoryService.SubmodelElementMetadata;
442
+ }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
443
+ /**
444
+ * Returns file content for a submodel element at a specified path
445
+ */
446
+ getFileByPath(options: {
447
+ configuration: Configuration;
448
+ submodelIdentifier: string;
449
+ idShortPath: string;
450
+ }): Promise<ApiResult<Blob, SubmodelRepositoryService.Result>>;
451
+ /**
452
+ * Updates file content for a submodel element at a specified path
453
+ */
454
+ putFileByPath(options: {
455
+ configuration: Configuration;
456
+ submodelIdentifier: string;
457
+ idShortPath: string;
458
+ fileName?: string;
459
+ file?: Blob;
460
+ }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
461
+ /**
462
+ * Deletes file content of an existing submodel element at a specified path
463
+ */
464
+ deleteFileByPath(options: {
465
+ configuration: Configuration;
466
+ submodelIdentifier: string;
467
+ idShortPath: string;
468
+ }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
282
469
  /**
283
470
  * Synchronously invokes an Operation at a specified path
284
471
  *
@@ -352,4 +539,46 @@ export declare class SubmodelRepositoryClient {
352
539
  idShortPath: string;
353
540
  operationRequestValueOnly: SubmodelRepositoryService.OperationRequestValueOnly;
354
541
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
542
+ /**
543
+ * Returns status of an asynchronously invoked operation
544
+ */
545
+ getOperationAsyncStatus(options: {
546
+ configuration: Configuration;
547
+ submodelIdentifier: string;
548
+ idShortPath: string;
549
+ handleId: string;
550
+ }): Promise<ApiResult<SubmodelRepositoryService.BaseOperationResult, SubmodelRepositoryService.Result>>;
551
+ /**
552
+ * Returns result of an asynchronously invoked operation
553
+ */
554
+ getOperationAsyncResult(options: {
555
+ configuration: Configuration;
556
+ submodelIdentifier: string;
557
+ idShortPath: string;
558
+ handleId: string;
559
+ }): Promise<ApiResult<SubmodelRepositoryService.OperationResult, SubmodelRepositoryService.Result>>;
560
+ /**
561
+ * Returns result of an asynchronously invoked operation in value-only representation
562
+ */
563
+ getOperationAsyncResultValueOnly(options: {
564
+ configuration: Configuration;
565
+ submodelIdentifier: string;
566
+ idShortPath: string;
567
+ handleId: string;
568
+ }): Promise<ApiResult<SubmodelRepositoryService.OperationResultValueOnly, SubmodelRepositoryService.Result>>;
569
+ /**
570
+ * Returns an appropriate serialization based on the specified format
571
+ */
572
+ generateSerializationByIds(options: {
573
+ configuration: Configuration;
574
+ aasIds?: string[];
575
+ submodelIds?: string[];
576
+ includeConceptDescriptions?: boolean;
577
+ }): Promise<ApiResult<Blob, SubmodelRepositoryService.Result>>;
578
+ /**
579
+ * Returns the self-describing information of a network resource (ServiceDescription)
580
+ */
581
+ getSelfDescription(options: {
582
+ configuration: Configuration;
583
+ }): Promise<ApiResult<SubmodelRepositoryService.ServiceDescription, SubmodelRepositoryService.Result>>;
355
584
  }