basyx-typescript-sdk 2.2.4 → 2.3.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 (62) hide show
  1. package/README.md +169 -0
  2. package/bundle/index.cjs +3484 -2149
  3. package/bundle/index.cjs.map +1 -1
  4. package/bundle/index.mjs +3484 -2149
  5. package/bundle/index.mjs.map +1 -1
  6. package/dist/clients/AasDiscoveryClient.d.ts +12 -5
  7. package/dist/clients/AasDiscoveryClient.js +104 -27
  8. package/dist/clients/AasRegistryClient.d.ts +32 -10
  9. package/dist/clients/AasRegistryClient.js +211 -61
  10. package/dist/clients/AasRepositoryClient.d.ts +231 -60
  11. package/dist/clients/AasRepositoryClient.js +1021 -353
  12. package/dist/clients/AasxFileClient.d.ts +29 -3
  13. package/dist/clients/AasxFileClient.js +122 -31
  14. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +14 -4
  15. package/dist/clients/ConceptDescriptionRepositoryClient.js +127 -35
  16. package/dist/clients/SubmodelRegistryClient.d.ts +14 -4
  17. package/dist/clients/SubmodelRegistryClient.js +117 -27
  18. package/dist/clients/SubmodelRepositoryClient.d.ts +339 -58
  19. package/dist/clients/SubmodelRepositoryClient.js +913 -269
  20. package/dist/generated/AasDiscoveryService/models/index.d.ts +2 -2
  21. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +1 -1
  22. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +1 -1
  23. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +1 -1
  24. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +1 -1
  25. package/dist/generated/AasRegistryService/index.d.ts +1 -1
  26. package/dist/generated/AasRegistryService/index.js +1 -1
  27. package/dist/generated/AasRegistryService/models/index.d.ts +3 -3
  28. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +3 -3
  29. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1 -1
  30. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +1 -1
  31. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +1 -1
  32. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +1 -1
  33. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +1 -1
  34. package/dist/generated/AasRepositoryService/index.d.ts +1 -1
  35. package/dist/generated/AasRepositoryService/index.js +1 -1
  36. package/dist/generated/AasRepositoryService/models/index.d.ts +7 -7
  37. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +5 -3
  38. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +6 -0
  39. package/dist/generated/AasxFileService/apis/DescriptionAPIApi.d.ts +26 -0
  40. package/dist/generated/AasxFileService/apis/DescriptionAPIApi.js +40 -0
  41. package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
  42. package/dist/generated/AasxFileService/apis/index.js +1 -0
  43. package/dist/generated/AasxFileService/models/index.d.ts +45 -0
  44. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2 -2
  45. package/dist/generated/SubmodelRegistryService/models/index.d.ts +2 -2
  46. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +9 -9
  47. package/dist/generated/runtime.js +7 -0
  48. package/dist/lib/apiConfig.d.ts +2 -1
  49. package/dist/lib/apiConfig.js +27 -2
  50. package/dist/lib/conditionalRequests.d.ts +28 -0
  51. package/dist/lib/conditionalRequests.js +55 -0
  52. package/dist/lib/errorHandler.js +13 -2
  53. package/dist/models/api.d.ts +40 -2
  54. package/dist/services/AasService.d.ts +34 -4
  55. package/dist/services/AasService.js +159 -33
  56. package/dist/services/SubmodelService.d.ts +34 -4
  57. package/dist/services/SubmodelService.js +168 -28
  58. package/package.json +14 -3
  59. package/dist/generated/AasRegistryService/runtime.d.ts +0 -181
  60. package/dist/generated/AasRegistryService/runtime.js +0 -326
  61. package/dist/generated/AasRepositoryService/runtime.d.ts +0 -181
  62. package/dist/generated/AasRepositoryService/runtime.js +0 -326
@@ -1,9 +1,11 @@
1
1
  import type { AssetAdministrationShell, AssetInformation, ISubmodelElement, Reference, Submodel } from '@aas-core-works/aas-core3.1-typescript/types';
2
- import type { ApiResult } from '../models/api';
2
+ import type { ApiResult, ConditionalApiResult } from '../models/api';
3
3
  import type { AssetId } from '../models/AssetId';
4
4
  import { AasRepositoryService } from '../generated';
5
5
  import { Configuration } from '../generated/runtime';
6
6
  export declare class AasRepositoryClient {
7
+ private static requireIdentifier;
8
+ private static extractStatusCode;
7
9
  /**
8
10
  * Returns all Asset Administration Shells
9
11
  *
@@ -12,7 +14,7 @@ export declare class AasRepositoryClient {
12
14
  * - assetIds?: A list of specific Asset identifiers
13
15
  * - idShort?: The Asset Administration Shell’s IdShort
14
16
  * - limit?: The maximum number of elements in the response array
15
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
17
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
16
18
  *
17
19
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
18
20
  */
@@ -34,7 +36,7 @@ export declare class AasRepositoryClient {
34
36
  * - assetIds?: A list of specific Asset identifiers
35
37
  * - idShort?: The Asset Administration Shell’s IdShort
36
38
  * - limit?: The maximum number of elements in the response array
37
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
39
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
38
40
  *
39
41
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
40
42
  */
@@ -67,12 +69,14 @@ export declare class AasRepositoryClient {
67
69
  * @param options Object containing:
68
70
  * - configuration: The http request options
69
71
  * - aasIdentifier: The Asset Administration Shell’s unique id
72
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
70
73
  *
71
74
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
72
75
  */
73
76
  deleteAssetAdministrationShellById(options: {
74
77
  configuration: Configuration;
75
78
  aasIdentifier: string;
79
+ ifMatch?: string;
76
80
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
77
81
  /**
78
82
  * Returns a specific Asset Administration Shell
@@ -80,13 +84,15 @@ export declare class AasRepositoryClient {
80
84
  * @param options Object containing:
81
85
  * - configuration: The http request options
82
86
  * - aasIdentifier: The Asset Administration Shell’s unique id
87
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
83
88
  *
84
89
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
85
90
  */
86
- getAssetAdministrationShellById(options: {
91
+ getAssetAdministrationShellById<IfNoneMatch extends string | undefined = undefined>(options: {
87
92
  configuration: Configuration;
88
93
  aasIdentifier: string;
89
- }): Promise<ApiResult<AssetAdministrationShell, AasRepositoryService.Result>>;
94
+ ifNoneMatch?: IfNoneMatch;
95
+ }): Promise<ConditionalApiResult<AssetAdministrationShell, AasRepositoryService.Result, IfNoneMatch>>;
90
96
  /**
91
97
  * Updates an existing Asset Administration Shell
92
98
  *
@@ -94,6 +100,8 @@ export declare class AasRepositoryClient {
94
100
  * - configuration: The http request options
95
101
  * - aasIdentifier: The Asset Administration Shell’s unique id
96
102
  * - assetAdministrationShell: Asset Administration Shell object
103
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
104
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
97
105
  *
98
106
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
99
107
  */
@@ -101,20 +109,39 @@ export declare class AasRepositoryClient {
101
109
  configuration: Configuration;
102
110
  aasIdentifier: string;
103
111
  assetAdministrationShell: AssetAdministrationShell;
112
+ ifMatch?: string;
113
+ ifNoneMatch?: string;
104
114
  }): Promise<ApiResult<AssetAdministrationShell | void, AasRepositoryService.Result>>;
115
+ /**
116
+ * Returns a specific Asset Administration Shell in reference representation
117
+ *
118
+ * @param options Object containing:
119
+ * - configuration: The http request options
120
+ * - aasIdentifier: The Asset Administration Shell’s unique id
121
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
122
+ *
123
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
124
+ */
125
+ getAssetAdministrationShellByIdReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
126
+ configuration: Configuration;
127
+ aasIdentifier: string;
128
+ ifNoneMatch?: IfNoneMatch;
129
+ }): Promise<ConditionalApiResult<Reference, AasRepositoryService.Result, IfNoneMatch>>;
105
130
  /**
106
131
  * Returns the Asset Information
107
132
  *
108
133
  * @param options Object containing:
109
134
  * - configuration: The http request options
110
135
  * - aasIdentifier: The Asset Administration Shell’s unique id
136
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
111
137
  *
112
138
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
113
139
  */
114
- getAssetInformation(options: {
140
+ getAssetInformationAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
115
141
  configuration: Configuration;
116
142
  aasIdentifier: string;
117
- }): Promise<ApiResult<AssetInformation, AasRepositoryService.Result>>;
143
+ ifNoneMatch?: IfNoneMatch;
144
+ }): Promise<ConditionalApiResult<AssetInformation, AasRepositoryService.Result, IfNoneMatch>>;
118
145
  /**
119
146
  * Updates the Asset Information
120
147
  *
@@ -122,13 +149,17 @@ export declare class AasRepositoryClient {
122
149
  * - configuration: The http request options
123
150
  * - aasIdentifier: The Asset Administration Shell’s unique id
124
151
  * - assetInformation: Asset Information object
152
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
153
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
125
154
  *
126
155
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
127
156
  */
128
- putAssetInformation(options: {
157
+ putAssetInformationAasRepository(options: {
129
158
  configuration: Configuration;
130
159
  aasIdentifier: string;
131
160
  assetInformation: AssetInformation;
161
+ ifMatch?: string;
162
+ ifNoneMatch?: string;
132
163
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
133
164
  /**
134
165
  * Deletes the Thumbnail associated with the given AAS
@@ -136,12 +167,14 @@ export declare class AasRepositoryClient {
136
167
  * @param options Object containing:
137
168
  * - configuration: The http request options
138
169
  * - aasIdentifier: The Asset Administration Shell’s unique id
170
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
139
171
  *
140
172
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
141
173
  */
142
- deleteThumbnail(options: {
174
+ deleteThumbnailAasRepository(options: {
143
175
  configuration: Configuration;
144
176
  aasIdentifier: string;
177
+ ifMatch?: string;
145
178
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
146
179
  /**
147
180
  * Returns the Thumbnail associated with an AAS, if any
@@ -149,13 +182,15 @@ export declare class AasRepositoryClient {
149
182
  * @param options Object containing:
150
183
  * - configuration: The http request options
151
184
  * - aasIdentifier: The Asset Administration Shell’s unique id
185
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
152
186
  *
153
187
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
154
188
  */
155
- getThumbnail(options: {
189
+ getThumbnailAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
156
190
  configuration: Configuration;
157
191
  aasIdentifier: string;
158
- }): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
192
+ ifNoneMatch?: IfNoneMatch;
193
+ }): Promise<ConditionalApiResult<Blob, AasRepositoryService.Result, IfNoneMatch>>;
159
194
  /**
160
195
  * Updates (or creates) the Thumbnail for the given AAS
161
196
  *
@@ -164,14 +199,18 @@ export declare class AasRepositoryClient {
164
199
  * - aasIdentifier: The Asset Administration Shell’s unique id
165
200
  * - fileName: The name of the file
166
201
  * - file: The file to upload
202
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
203
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
167
204
  *
168
205
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
169
206
  */
170
- putThumbnail(options: {
207
+ putThumbnailAasRepository(options: {
171
208
  configuration: Configuration;
172
209
  aasIdentifier: string;
173
210
  fileName: string;
174
211
  file: Blob;
212
+ ifMatch?: string;
213
+ ifNoneMatch?: string;
175
214
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
176
215
  /**
177
216
  * Returns all submodel references
@@ -180,19 +219,21 @@ export declare class AasRepositoryClient {
180
219
  * - configuration: The http request options
181
220
  * - aasIdentifier: The Asset Administration Shell’s unique id
182
221
  * - limit?: The maximum number of elements in the response array
183
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
222
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
223
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
184
224
  *
185
225
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
186
226
  */
187
- getAllSubmodelReferences(options: {
227
+ getAllSubmodelReferencesAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
188
228
  configuration: Configuration;
189
229
  aasIdentifier: string;
190
230
  limit?: number;
191
231
  cursor?: string;
192
- }): Promise<ApiResult<{
232
+ ifNoneMatch?: IfNoneMatch;
233
+ }): Promise<ConditionalApiResult<{
193
234
  pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
194
235
  result: Reference[];
195
- }, AasRepositoryService.Result>>;
236
+ }, AasRepositoryService.Result, IfNoneMatch>>;
196
237
  /**
197
238
  * Creates a submodel reference at the Asset Administration Shell
198
239
  *
@@ -200,13 +241,15 @@ export declare class AasRepositoryClient {
200
241
  * - configuration: The http request options
201
242
  * - aasIdentifier: The Asset Administration Shell’s unique id
202
243
  * - submodelReference: Reference to the Submodel
244
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
203
245
  *
204
246
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
205
247
  */
206
- postSubmodelReference(options: {
248
+ postSubmodelReferenceAasRepository(options: {
207
249
  configuration: Configuration;
208
250
  aasIdentifier: string;
209
251
  submodelReference: Reference;
252
+ ifMatch?: string;
210
253
  }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
211
254
  /**
212
255
  * Deletes a submodel reference from the given AAS (does not delete the submodel itself).
@@ -215,13 +258,67 @@ export declare class AasRepositoryClient {
215
258
  * - configuration: The http request options
216
259
  * - aasIdentifier: Unique ID of the AAS
217
260
  * - submodelIdentifier: The submodel's unique ID
261
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
218
262
  *
219
263
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
220
264
  */
265
+ deleteSubmodelReferenceAasRepository(options: {
266
+ configuration: Configuration;
267
+ aasIdentifier: string;
268
+ submodelIdentifier: string;
269
+ ifMatch?: string;
270
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
271
+ getAssetInformation<IfNoneMatch extends string | undefined = undefined>(options: {
272
+ configuration: Configuration;
273
+ aasIdentifier: string;
274
+ ifNoneMatch?: IfNoneMatch;
275
+ }): Promise<ConditionalApiResult<AssetInformation, AasRepositoryService.Result, IfNoneMatch>>;
276
+ putAssetInformation(options: {
277
+ configuration: Configuration;
278
+ aasIdentifier: string;
279
+ assetInformation: AssetInformation;
280
+ ifMatch?: string;
281
+ ifNoneMatch?: string;
282
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
283
+ deleteThumbnail(options: {
284
+ configuration: Configuration;
285
+ aasIdentifier: string;
286
+ ifMatch?: string;
287
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
288
+ getThumbnail<IfNoneMatch extends string | undefined = undefined>(options: {
289
+ configuration: Configuration;
290
+ aasIdentifier: string;
291
+ ifNoneMatch?: IfNoneMatch;
292
+ }): Promise<ConditionalApiResult<Blob, AasRepositoryService.Result, IfNoneMatch>>;
293
+ putThumbnail(options: {
294
+ configuration: Configuration;
295
+ aasIdentifier: string;
296
+ fileName: string;
297
+ file: Blob;
298
+ ifMatch?: string;
299
+ ifNoneMatch?: string;
300
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
301
+ getAllSubmodelReferences<IfNoneMatch extends string | undefined = undefined>(options: {
302
+ configuration: Configuration;
303
+ aasIdentifier: string;
304
+ limit?: number;
305
+ cursor?: string;
306
+ ifNoneMatch?: IfNoneMatch;
307
+ }): Promise<ConditionalApiResult<{
308
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
309
+ result: Reference[];
310
+ }, AasRepositoryService.Result, IfNoneMatch>>;
311
+ postSubmodelReference(options: {
312
+ configuration: Configuration;
313
+ aasIdentifier: string;
314
+ submodelReference: Reference;
315
+ ifMatch?: string;
316
+ }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
221
317
  deleteSubmodelReferenceById(options: {
222
318
  configuration: Configuration;
223
319
  aasIdentifier: string;
224
320
  submodelIdentifier: string;
321
+ ifMatch?: string;
225
322
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
226
323
  /**
227
324
  * Returns the Submodel
@@ -232,16 +329,18 @@ export declare class AasRepositoryClient {
232
329
  * - submodelIdentifier: The submodel's unique ID
233
330
  * - level?: Determines the structural depth of the respective resource content
234
331
  * - extent?: Determines to which extent the resource is being serialized
332
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
235
333
  *
236
334
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
237
335
  */
238
- getSubmodelByIdAasRepository(options: {
336
+ getSubmodelByIdAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
239
337
  configuration: Configuration;
240
338
  aasIdentifier: string;
241
339
  submodelIdentifier: string;
242
340
  level?: AasRepositoryService.GetSubmodelByIdAasRepositoryLevelEnum;
243
341
  extent?: AasRepositoryService.GetSubmodelByIdAasRepositoryExtentEnum;
244
- }): Promise<ApiResult<Submodel, AasRepositoryService.Result>>;
342
+ ifNoneMatch?: IfNoneMatch;
343
+ }): Promise<ConditionalApiResult<Submodel, AasRepositoryService.Result, IfNoneMatch>>;
245
344
  /**
246
345
  * Creates or updates the Submodel
247
346
  *
@@ -250,6 +349,8 @@ export declare class AasRepositoryClient {
250
349
  * - aasIdentifier: The Asset Administration Shell’s unique id
251
350
  * - submodelIdentifier: The Submodel’s unique id
252
351
  * - submodel: Submodel object
352
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
353
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
253
354
  *
254
355
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
255
356
  */
@@ -258,7 +359,9 @@ export declare class AasRepositoryClient {
258
359
  aasIdentifier: string;
259
360
  submodelIdentifier: string;
260
361
  submodel: Submodel;
261
- }): Promise<ApiResult<Reference | void, AasRepositoryService.Result>>;
362
+ ifMatch?: string;
363
+ ifNoneMatch?: string;
364
+ }): Promise<ApiResult<Submodel | void, AasRepositoryService.Result>>;
262
365
  /**
263
366
  * Deletes the submodel from the Asset Administration Shell and the Repository.
264
367
  *
@@ -266,6 +369,7 @@ export declare class AasRepositoryClient {
266
369
  * - configuration: The http request options
267
370
  * - aasIdentifier: The Asset Administration Shell’s unique id
268
371
  * - submodelIdentifier: The Submodel’s unique id
372
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
269
373
  *
270
374
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
271
375
  */
@@ -273,6 +377,7 @@ export declare class AasRepositoryClient {
273
377
  configuration: Configuration;
274
378
  aasIdentifier: string;
275
379
  submodelIdentifier: string;
380
+ ifMatch?: string;
276
381
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
277
382
  /**
278
383
  * Updates the Submodel
@@ -283,6 +388,7 @@ export declare class AasRepositoryClient {
283
388
  * - submodelIdentifier: The Submodel’s unique id
284
389
  * - submodel: Submodel object
285
390
  * - level?: Determines the structural depth of the respective resource content
391
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
286
392
  *
287
393
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
288
394
  */
@@ -292,6 +398,7 @@ export declare class AasRepositoryClient {
292
398
  submodelIdentifier: string;
293
399
  submodel: Submodel;
294
400
  level?: AasRepositoryService.PatchSubmodelAasRepositoryLevelEnum;
401
+ ifMatch?: string;
295
402
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
296
403
  /**
297
404
  * Returns the Submodel's metadata elements
@@ -300,14 +407,16 @@ export declare class AasRepositoryClient {
300
407
  * - configuration: The http request options
301
408
  * - aasIdentifier: The Asset Administration Shell’s unique id
302
409
  * - submodelIdentifier: The Submodel’s unique id
410
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
303
411
  *
304
412
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
305
413
  */
306
- getSubmodelByIdMetadataAasRepository(options: {
414
+ getSubmodelByIdMetadataAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
307
415
  configuration: Configuration;
308
416
  aasIdentifier: string;
309
417
  submodelIdentifier: string;
310
- }): Promise<ApiResult<AasRepositoryService.SubmodelMetadata, AasRepositoryService.Result>>;
418
+ ifNoneMatch?: IfNoneMatch;
419
+ }): Promise<ConditionalApiResult<AasRepositoryService.SubmodelMetadata, AasRepositoryService.Result, IfNoneMatch>>;
311
420
  /**
312
421
  * Updates the metadata attributes of the Submodel
313
422
  *
@@ -316,6 +425,7 @@ export declare class AasRepositoryClient {
316
425
  * - aasIdentifier: The Asset Administration Shell’s unique id
317
426
  * - submodelIdentifier: The Submodel’s unique id
318
427
  * - submodelMetadata: The Submodel Metadata object
428
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
319
429
  *
320
430
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
321
431
  */
@@ -324,6 +434,7 @@ export declare class AasRepositoryClient {
324
434
  aasIdentifier: string;
325
435
  submodelIdentifier: string;
326
436
  submodelMetadata: AasRepositoryService.SubmodelMetadata;
437
+ ifMatch?: string;
327
438
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
328
439
  /**
329
440
  * Returns the Submodel's ValueOnly representation
@@ -334,16 +445,18 @@ export declare class AasRepositoryClient {
334
445
  * - submodelIdentifier: The Submodel’s unique id
335
446
  * - level?: Determines the structural depth of the respective resource content
336
447
  * - extent?: Determines to which extent the resource is being serialized
448
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
337
449
  *
338
450
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
339
451
  */
340
- getSubmodelByIdValueOnlyAasRepository(options: {
452
+ getSubmodelByIdValueOnlyAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
341
453
  configuration: Configuration;
342
454
  aasIdentifier: string;
343
455
  submodelIdentifier: string;
344
456
  level?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryLevelEnum;
345
457
  extent?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryExtentEnum;
346
- }): Promise<ApiResult<object, AasRepositoryService.Result>>;
458
+ ifNoneMatch?: IfNoneMatch;
459
+ }): Promise<ConditionalApiResult<object, AasRepositoryService.Result, IfNoneMatch>>;
347
460
  /**
348
461
  * Updates the values of the Submodel
349
462
  *
@@ -352,6 +465,7 @@ export declare class AasRepositoryClient {
352
465
  * - aasIdentifier: The Asset Administration Shell’s unique id
353
466
  * - submodelIdentifier: The Submodel’s unique id
354
467
  * - level?: Determines the structural depth of the respective resource content
468
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
355
469
  *
356
470
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
357
471
  */
@@ -361,6 +475,7 @@ export declare class AasRepositoryClient {
361
475
  submodelIdentifier: string;
362
476
  body: object;
363
477
  level?: AasRepositoryService.PatchSubmodelByIdValueOnlyAasRepositoryLevelEnum;
478
+ ifMatch?: string;
364
479
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
365
480
  /**
366
481
  * Returns the Submodel as a Reference
@@ -369,14 +484,16 @@ export declare class AasRepositoryClient {
369
484
  * - configuration: The http request options
370
485
  * - aasIdentifier: The Asset Administration Shell’s unique id
371
486
  * - submodelIdentifier: The submodel's unique ID
487
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
372
488
  *
373
489
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
374
490
  */
375
- getSubmodelByIdReferenceAasRepository(options: {
491
+ getSubmodelByIdReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
376
492
  configuration: Configuration;
377
493
  aasIdentifier: string;
378
494
  submodelIdentifier: string;
379
- }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
495
+ ifNoneMatch?: IfNoneMatch;
496
+ }): Promise<ConditionalApiResult<Reference, AasRepositoryService.Result, IfNoneMatch>>;
380
497
  /**
381
498
  * Returns the elements of this submodel in path notation.
382
499
  *
@@ -385,15 +502,17 @@ export declare class AasRepositoryClient {
385
502
  * - aasIdentifier: The Asset Administration Shell’s unique id
386
503
  * - submodelIdentifier: The submodel's unique ID
387
504
  * - level?: Determines the structural depth of the respective resource content
505
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
388
506
  *
389
507
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
390
508
  */
391
- getSubmodelByIdPathAasRepository(options: {
509
+ getSubmodelByIdPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
392
510
  configuration: Configuration;
393
511
  aasIdentifier: string;
394
512
  submodelIdentifier: string;
395
513
  level?: AasRepositoryService.GetSubmodelByIdPathAasRepositoryLevelEnum;
396
- }): Promise<ApiResult<Array<string>, AasRepositoryService.Result>>;
514
+ ifNoneMatch?: IfNoneMatch;
515
+ }): Promise<ConditionalApiResult<Array<string>, AasRepositoryService.Result, IfNoneMatch>>;
397
516
  /**
398
517
  * Returns all submodel elements including their hierarchy
399
518
  *
@@ -402,13 +521,14 @@ export declare class AasRepositoryClient {
402
521
  * - aasIdentifier: The Asset Administration Shell’s unique id
403
522
  * - submodelIdentifier: The Submodel’s unique id
404
523
  * - limit?: The maximum number of elements in the response array
405
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
524
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
406
525
  * - level?: Determines the structural depth of the respective resource content
407
526
  * - extent?: Determines to which extent the resource is being serialized
527
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
408
528
  *
409
529
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
410
530
  */
411
- getAllSubmodelElementsAasRepository(options: {
531
+ getAllSubmodelElementsAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
412
532
  configuration: Configuration;
413
533
  aasIdentifier: string;
414
534
  submodelIdentifier: string;
@@ -416,10 +536,11 @@ export declare class AasRepositoryClient {
416
536
  cursor?: string;
417
537
  level?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryLevelEnum;
418
538
  extent?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryExtentEnum;
419
- }): Promise<ApiResult<{
539
+ ifNoneMatch?: IfNoneMatch;
540
+ }): Promise<ConditionalApiResult<{
420
541
  pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
421
542
  result: ISubmodelElement[];
422
- }, AasRepositoryService.Result>>;
543
+ }, AasRepositoryService.Result, IfNoneMatch>>;
423
544
  /**
424
545
  * Creates a new submodel element
425
546
  *
@@ -428,6 +549,7 @@ export declare class AasRepositoryClient {
428
549
  * - aasIdentifier: The Asset Administration Shell’s unique id
429
550
  * - submodelIdentifier: The Submodel’s unique id
430
551
  * - submodelElement: The Submodel Element object
552
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
431
553
  *
432
554
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
433
555
  */
@@ -436,6 +558,7 @@ export declare class AasRepositoryClient {
436
558
  aasIdentifier: string;
437
559
  submodelIdentifier: string;
438
560
  submodelElement: ISubmodelElement;
561
+ ifMatch?: string;
439
562
  }): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
440
563
  /**
441
564
  * Returns all submodel elements including their hierarchy
@@ -445,20 +568,22 @@ export declare class AasRepositoryClient {
445
568
  * - aasIdentifier: The Asset Administration Shell’s unique id
446
569
  * - submodelIdentifier: The Submodel’s unique id
447
570
  * - limit?: The maximum number of elements in the response array
448
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
571
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
572
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
449
573
  *
450
574
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
451
575
  */
452
- getAllSubmodelElementsMetadataAasRepository(options: {
576
+ getAllSubmodelElementsMetadataAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
453
577
  configuration: Configuration;
454
578
  aasIdentifier: string;
455
579
  submodelIdentifier: string;
456
580
  limit?: number;
457
581
  cursor?: string;
458
- }): Promise<ApiResult<{
582
+ ifNoneMatch?: IfNoneMatch;
583
+ }): Promise<ConditionalApiResult<{
459
584
  pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
460
585
  result: AasRepositoryService.SubmodelElementMetadata[];
461
- }, AasRepositoryService.Result>>;
586
+ }, AasRepositoryService.Result, IfNoneMatch>>;
462
587
  /**
463
588
  * Returns all submodel elements including their hierarchy in the ValueOnly representation
464
589
  *
@@ -467,22 +592,24 @@ export declare class AasRepositoryClient {
467
592
  * - aasIdentifier: The Asset Administration Shell’s unique id
468
593
  * - submodelIdentifier: The Submodel’s unique id
469
594
  * - limit?: The maximum number of elements in the response array
470
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
595
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
471
596
  * - level?: Determines the structural depth of the respective resource content
597
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
472
598
  *
473
599
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
474
600
  */
475
- getAllSubmodelElementsValueOnlyAasRepository(options: {
601
+ getAllSubmodelElementsValueOnlyAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
476
602
  configuration: Configuration;
477
603
  aasIdentifier: string;
478
604
  submodelIdentifier: string;
479
605
  limit?: number;
480
606
  cursor?: string;
481
607
  level?: AasRepositoryService.GetAllSubmodelElementsValueOnlyAasRepositoryLevelEnum;
482
- }): Promise<ApiResult<{
608
+ ifNoneMatch?: IfNoneMatch;
609
+ }): Promise<ConditionalApiResult<{
483
610
  pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
484
611
  result: object;
485
- }, AasRepositoryService.Result>>;
612
+ }, AasRepositoryService.Result, IfNoneMatch>>;
486
613
  /**
487
614
  * Returns all submodel elements as a list of References
488
615
  *
@@ -491,22 +618,24 @@ export declare class AasRepositoryClient {
491
618
  * - aasIdentifier: The Asset Administration Shell’s unique id
492
619
  * - submodelIdentifier: The Submodel’s unique id
493
620
  * - limit?: The maximum number of elements in the response array
494
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
621
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
495
622
  * - level?: Determines the structural depth of the respective resource content
623
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
496
624
  *
497
625
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
498
626
  */
499
- getAllSubmodelElementsReferenceAasRepository(options: {
627
+ getAllSubmodelElementsReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
500
628
  configuration: Configuration;
501
629
  aasIdentifier: string;
502
630
  submodelIdentifier: string;
503
631
  limit?: number;
504
632
  cursor?: string;
505
633
  level?: AasRepositoryService.GetAllSubmodelElementsReferenceAasRepositoryLevelEnum;
506
- }): Promise<ApiResult<{
634
+ ifNoneMatch?: IfNoneMatch;
635
+ }): Promise<ConditionalApiResult<{
507
636
  pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
508
637
  result: Reference[];
509
- }, AasRepositoryService.Result>>;
638
+ }, AasRepositoryService.Result, IfNoneMatch>>;
510
639
  /**
511
640
  * Returns all submodel elements including their hierarchy
512
641
  *
@@ -515,13 +644,14 @@ export declare class AasRepositoryClient {
515
644
  * - aasIdentifier: The Asset Administration Shell’s unique id
516
645
  * - submodelIdentifier: The Submodel’s unique id
517
646
  * - limit?: The maximum number of elements in the response array
518
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
647
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
519
648
  * - level?: Determines the structural depth of the respective resource content
520
649
  * - extent?: Determines to which extent the resource is being serialized
650
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
521
651
  *
522
652
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
523
653
  */
524
- getAllSubmodelElementsPathAasRepository(options: {
654
+ getAllSubmodelElementsPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
525
655
  configuration: Configuration;
526
656
  aasIdentifier: string;
527
657
  submodelIdentifier: string;
@@ -529,10 +659,11 @@ export declare class AasRepositoryClient {
529
659
  cursor?: string;
530
660
  level?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryLevelEnum;
531
661
  extent?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryExtentEnum;
532
- }): Promise<ApiResult<{
662
+ ifNoneMatch?: IfNoneMatch;
663
+ }): Promise<ConditionalApiResult<{
533
664
  pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
534
665
  result: string[];
535
- }, AasRepositoryService.Result>>;
666
+ }, AasRepositoryService.Result, IfNoneMatch>>;
536
667
  /**
537
668
  * Returns a specific submodel element from the Submodel at a specified path
538
669
  *
@@ -543,17 +674,19 @@ export declare class AasRepositoryClient {
543
674
  * - idShortPath: IdShort path to the submodel element (dot-separated)
544
675
  * - level?: Determines the structural depth of the respective resource content
545
676
  * - extent?: Determines to which extent the resource is being serialized
677
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
546
678
  *
547
679
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
548
680
  */
549
- getSubmodelElementByPathAasRepository(options: {
681
+ getSubmodelElementByPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
550
682
  configuration: Configuration;
551
683
  aasIdentifier: string;
552
684
  submodelIdentifier: string;
553
685
  idShortPath: string;
554
686
  level?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryLevelEnum;
555
687
  extent?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryExtentEnum;
556
- }): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
688
+ ifNoneMatch?: IfNoneMatch;
689
+ }): Promise<ConditionalApiResult<ISubmodelElement, AasRepositoryService.Result, IfNoneMatch>>;
557
690
  /**
558
691
  * Creates a new submodel element at a specified path within submodel elements hierarchy
559
692
  *
@@ -563,6 +696,7 @@ export declare class AasRepositoryClient {
563
696
  * - submodelIdentifier: The Submodel’s unique id
564
697
  * - idShortPath: IdShort path to the submodel element (dot-separated)
565
698
  * - submodelElement: SubmodelElement object
699
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
566
700
  *
567
701
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
568
702
  */
@@ -572,6 +706,7 @@ export declare class AasRepositoryClient {
572
706
  submodelIdentifier: string;
573
707
  idShortPath: string;
574
708
  submodelElement: ISubmodelElement;
709
+ ifMatch?: string;
575
710
  }): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
576
711
  /**
577
712
  * Deletes a submodel element at a specified path within the submodel elements hierarchy
@@ -581,6 +716,7 @@ export declare class AasRepositoryClient {
581
716
  * - aasIdentifier: The Asset Administration Shell’s unique id
582
717
  * - submodelIdentifier: The Submodel’s unique id
583
718
  * - idShortPath: IdShort path to the submodel element (dot-separated)
719
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
584
720
  *
585
721
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
586
722
  */
@@ -589,6 +725,7 @@ export declare class AasRepositoryClient {
589
725
  aasIdentifier: string;
590
726
  submodelIdentifier: string;
591
727
  idShortPath: string;
728
+ ifMatch?: string;
592
729
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
593
730
  /**
594
731
  * Updates an existing submodel element at a specified path within submodel elements hierarchy
@@ -599,6 +736,8 @@ export declare class AasRepositoryClient {
599
736
  * - submodelIdentifier: The Submodel’s unique id
600
737
  * - idShortPath: IdShort path to the submodel element (dot-separated)
601
738
  * - submodelElement: SubmodelElement object
739
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
740
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
602
741
  *
603
742
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
604
743
  */
@@ -608,6 +747,8 @@ export declare class AasRepositoryClient {
608
747
  submodelIdentifier: string;
609
748
  idShortPath: string;
610
749
  submodelElement: ISubmodelElement;
750
+ ifMatch?: string;
751
+ ifNoneMatch?: string;
611
752
  }): Promise<ApiResult<ISubmodelElement | void, AasRepositoryService.Result>>;
612
753
  /**
613
754
  * Updates an existing submodel element value at a specified path within submodel elements hierarchy
@@ -619,6 +760,7 @@ export declare class AasRepositoryClient {
619
760
  * - idShortPath: IdShort path to the submodel element (dot-separated)
620
761
  * - submodelElement: SubmodelElement object
621
762
  * - level?: Determines the structural depth of the respective resource content
763
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
622
764
  *
623
765
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
624
766
  */
@@ -629,6 +771,7 @@ export declare class AasRepositoryClient {
629
771
  idShortPath: string;
630
772
  submodelElement: ISubmodelElement;
631
773
  level?: AasRepositoryService.PatchSubmodelElementValueByPathAasRepositoryLevelEnum;
774
+ ifMatch?: string;
632
775
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
633
776
  /**
634
777
  * Returns the metadata attributes of a specific submodel element from the Submodel at a specified path
@@ -638,15 +781,17 @@ export declare class AasRepositoryClient {
638
781
  * - aasIdentifier: The Asset Administration Shell’s unique id
639
782
  * - submodelIdentifier: The Submodel’s unique id
640
783
  * - idShortPath: IdShort path to the submodel element (dot-separated)
784
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
641
785
  *
642
786
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
643
787
  */
644
- getSubmodelElementByPathMetadataAasRepository(options: {
788
+ getSubmodelElementByPathMetadataAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
645
789
  configuration: Configuration;
646
790
  aasIdentifier: string;
647
791
  submodelIdentifier: string;
648
792
  idShortPath: string;
649
- }): Promise<ApiResult<AasRepositoryService.SubmodelElementMetadata, AasRepositoryService.Result>>;
793
+ ifNoneMatch?: IfNoneMatch;
794
+ }): Promise<ConditionalApiResult<AasRepositoryService.SubmodelElementMetadata, AasRepositoryService.Result, IfNoneMatch>>;
650
795
  /**
651
796
  * Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy
652
797
  *
@@ -656,6 +801,7 @@ export declare class AasRepositoryClient {
656
801
  * - submodelIdentifier: The Submodel’s unique id
657
802
  * - idShortPath: IdShort path to the submodel element (dot-separated)
658
803
  * - submodelElementMetadata: The Submodel Element Metadata object
804
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
659
805
  *
660
806
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
661
807
  */
@@ -665,6 +811,7 @@ export declare class AasRepositoryClient {
665
811
  submodelIdentifier: string;
666
812
  idShortPath: string;
667
813
  submodelElementMetadata: AasRepositoryService.SubmodelElementMetadata;
814
+ ifMatch?: string;
668
815
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
669
816
  /**
670
817
  * Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
@@ -676,17 +823,19 @@ export declare class AasRepositoryClient {
676
823
  * - idShortPath: IdShort path to the submodel element (dot-separated)
677
824
  * - level?: Determines the structural depth of the respective resource content
678
825
  * - extent?: Determines to which extent the resource is being serialized
826
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
679
827
  *
680
828
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
681
829
  */
682
- getSubmodelElementByPathValueOnlyAasRepository(options: {
830
+ getSubmodelElementByPathValueOnlyAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
683
831
  configuration: Configuration;
684
832
  aasIdentifier: string;
685
833
  submodelIdentifier: string;
686
834
  idShortPath: string;
687
835
  level?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryLevelEnum;
688
836
  extent?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryExtentEnum;
689
- }): Promise<ApiResult<AasRepositoryService.SubmodelElementValue, AasRepositoryService.Result>>;
837
+ ifNoneMatch?: IfNoneMatch;
838
+ }): Promise<ConditionalApiResult<AasRepositoryService.SubmodelElementValue, AasRepositoryService.Result, IfNoneMatch>>;
690
839
  /**
691
840
  * Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy
692
841
  *
@@ -697,6 +846,7 @@ export declare class AasRepositoryClient {
697
846
  * - idShortPath: IdShort path to the submodel element (dot-separated)
698
847
  * - SubmodelElementValue: SubmodelElementValue object
699
848
  * - level?: Determines the structural depth of the respective resource content
849
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
700
850
  *
701
851
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
702
852
  */
@@ -707,6 +857,7 @@ export declare class AasRepositoryClient {
707
857
  idShortPath: string;
708
858
  submodelElementValue: AasRepositoryService.SubmodelElementValue;
709
859
  level?: AasRepositoryService.PatchSubmodelElementValueByPathValueOnlyLevelEnum;
860
+ ifMatch?: string;
710
861
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
711
862
  /**
712
863
  * Returns the Reference of a specific submodel element from the Submodel at a specified path
@@ -717,16 +868,18 @@ export declare class AasRepositoryClient {
717
868
  * - submodelIdentifier: The Submodel’s unique id
718
869
  * - idShortPath: IdShort path to the submodel element (dot-separated)
719
870
  * - level?: Determines the structural depth of the respective resource content
871
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
720
872
  *
721
873
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
722
874
  */
723
- getSubmodelElementByPathReferenceAasRepository(options: {
875
+ getSubmodelElementByPathReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
724
876
  configuration: Configuration;
725
877
  aasIdentifier: string;
726
878
  submodelIdentifier: string;
727
879
  idShortPath: string;
728
880
  level?: AasRepositoryService.GetSubmodelElementByPathReferenceAasRepositoryLevelEnum;
729
- }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
881
+ ifNoneMatch?: IfNoneMatch;
882
+ }): Promise<ConditionalApiResult<Reference, AasRepositoryService.Result, IfNoneMatch>>;
730
883
  /**
731
884
  * Returns a specific submodel element from the Submodel at a specified path in the Path notation
732
885
  *
@@ -736,16 +889,18 @@ export declare class AasRepositoryClient {
736
889
  * - submodelIdentifier: The Submodel’s unique id
737
890
  * - idShortPath: IdShort path to the submodel element (dot-separated)
738
891
  * - level?: Determines the structural depth of the respective resource content
892
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
739
893
  *
740
894
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
741
895
  */
742
- getSubmodelElementByPathPathAasRepository(options: {
896
+ getSubmodelElementByPathPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
743
897
  configuration: Configuration;
744
898
  aasIdentifier: string;
745
899
  submodelIdentifier: string;
746
900
  idShortPath: string;
747
901
  level?: AasRepositoryService.GetSubmodelElementByPathPathAasRepositoryLevelEnum;
748
- }): Promise<ApiResult<Array<string>, AasRepositoryService.Result>>;
902
+ ifNoneMatch?: IfNoneMatch;
903
+ }): Promise<ConditionalApiResult<Array<string>, AasRepositoryService.Result, IfNoneMatch>>;
749
904
  /**
750
905
  * Downloads file content from a specific submodel element from the Submodel at a specified path
751
906
  *
@@ -754,15 +909,17 @@ export declare class AasRepositoryClient {
754
909
  * - aasIdentifier: The Asset Administration Shell’s unique id
755
910
  * - submodelIdentifier: The Submodel’s unique id
756
911
  * - idShortPath: IdShort path to the submodel element (dot-separated)
912
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
757
913
  *
758
914
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
759
915
  */
760
- getFileByPathAasRepository(options: {
916
+ getFileByPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
761
917
  configuration: Configuration;
762
918
  aasIdentifier: string;
763
919
  submodelIdentifier: string;
764
920
  idShortPath: string;
765
- }): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
921
+ ifNoneMatch?: IfNoneMatch;
922
+ }): Promise<ConditionalApiResult<Blob, AasRepositoryService.Result, IfNoneMatch>>;
766
923
  /**
767
924
  * Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy
768
925
  *
@@ -773,6 +930,8 @@ export declare class AasRepositoryClient {
773
930
  * - idShortPath: IdShort path to the submodel element (dot-separated)
774
931
  * - fileName: The name of the file
775
932
  * - file: The file to upload
933
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
934
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
776
935
  *
777
936
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
778
937
  */
@@ -783,6 +942,8 @@ export declare class AasRepositoryClient {
783
942
  idShortPath: string;
784
943
  fileName: string;
785
944
  file: Blob;
945
+ ifMatch?: string;
946
+ ifNoneMatch?: string;
786
947
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
787
948
  /**
788
949
  * Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy
@@ -792,6 +953,7 @@ export declare class AasRepositoryClient {
792
953
  * - aasIdentifier: The Asset Administration Shell’s unique id
793
954
  * - submodelIdentifier: The Submodel’s unique id
794
955
  * - idShortPath: IdShort path to the submodel element (dot-separated)
956
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
795
957
  *
796
958
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
797
959
  */
@@ -800,6 +962,7 @@ export declare class AasRepositoryClient {
800
962
  aasIdentifier: string;
801
963
  submodelIdentifier: string;
802
964
  idShortPath: string;
965
+ ifMatch?: string;
803
966
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
804
967
  /**
805
968
  * Synchronously invokes an Operation at a specified path
@@ -810,6 +973,7 @@ export declare class AasRepositoryClient {
810
973
  * - submodelIdentifier: The Submodel’s unique id
811
974
  * - idShortPath: IdShort path to the submodel element (dot-separated)
812
975
  * - operationRequest: Operation request object
976
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
813
977
  *
814
978
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
815
979
  */
@@ -819,6 +983,7 @@ export declare class AasRepositoryClient {
819
983
  submodelIdentifier: string;
820
984
  idShortPath: string;
821
985
  operationRequest: AasRepositoryService.OperationRequest;
986
+ ifMatch?: string;
822
987
  }): Promise<ApiResult<AasRepositoryService.OperationResult, AasRepositoryService.Result>>;
823
988
  /**
824
989
  * Synchronously invokes an Operation at a specified path
@@ -829,6 +994,7 @@ export declare class AasRepositoryClient {
829
994
  * - submodelIdentifier: The Submodel’s unique id
830
995
  * - idShortPath: IdShort path to the submodel element (dot-separated)
831
996
  * - operationRequestValueOnly: OperationRequestValueOnly object
997
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
832
998
  *
833
999
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
834
1000
  */
@@ -838,6 +1004,7 @@ export declare class AasRepositoryClient {
838
1004
  submodelIdentifier: string;
839
1005
  idShortPath: string;
840
1006
  operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
1007
+ ifMatch?: string;
841
1008
  }): Promise<ApiResult<AasRepositoryService.OperationResultValueOnly, AasRepositoryService.Result>>;
842
1009
  /**
843
1010
  * Asynchronously invokes an Operation at a specified path
@@ -848,6 +1015,7 @@ export declare class AasRepositoryClient {
848
1015
  * - submodelIdentifier: The Submodel’s unique id
849
1016
  * - idShortPath: IdShort path to the submodel element (dot-separated)
850
1017
  * - operationRequest: OperationRequest object
1018
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
851
1019
  *
852
1020
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
853
1021
  */
@@ -857,6 +1025,7 @@ export declare class AasRepositoryClient {
857
1025
  submodelIdentifier: string;
858
1026
  idShortPath: string;
859
1027
  operationRequest: AasRepositoryService.OperationRequest;
1028
+ ifMatch?: string;
860
1029
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
861
1030
  /**
862
1031
  * Asynchronously invokes an Operation at a specified path
@@ -867,6 +1036,7 @@ export declare class AasRepositoryClient {
867
1036
  * - submodelIdentifier: The Submodel’s unique id
868
1037
  * - idShortPath: IdShort path to the submodel element (dot-separated)
869
1038
  * - operationRequestValueOnly: Operation request object
1039
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
870
1040
  *
871
1041
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
872
1042
  */
@@ -876,6 +1046,7 @@ export declare class AasRepositoryClient {
876
1046
  submodelIdentifier: string;
877
1047
  idShortPath: string;
878
1048
  operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
1049
+ ifMatch?: string;
879
1050
  }): Promise<ApiResult<void, AasRepositoryService.Result>>;
880
1051
  /**
881
1052
  * Returns the Operation status of an asynchronous invoked Operation