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,8 +1,10 @@
1
1
  import type { ISubmodelElement, 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 { SubmodelRepositoryService } from '../generated';
4
4
  import { Configuration } from '../generated/runtime';
5
5
  export declare class SubmodelRepositoryClient {
6
+ private static requireIdentifier;
7
+ private static extractStatusCode;
6
8
  /**
7
9
  * Returns all Submodels
8
10
  *
@@ -11,7 +13,7 @@ export declare class SubmodelRepositoryClient {
11
13
  * - semanticId?: The value of the semantic id reference
12
14
  * - idShort?: The Asset Administration Shell's IdShort
13
15
  * - limit?: The maximum number of elements in the response array
14
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
16
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
15
17
  * - level?: Determines the structural depth of the respective resource content
16
18
  * - extent?: Determines to which extent the resource is being serialized
17
19
  *
@@ -31,6 +33,15 @@ export declare class SubmodelRepositoryClient {
31
33
  }, SubmodelRepositoryService.Result>>;
32
34
  /**
33
35
  * Returns all Submodels in metadata representation
36
+ *
37
+ * @param options Object containing:
38
+ * - configuration: The http request options
39
+ * - semanticId?: The value of the semantic id reference
40
+ * - idShort?: The Asset Administration Shell's IdShort
41
+ * - limit?: The maximum number of elements in the response array
42
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
43
+ *
44
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
34
45
  */
35
46
  getAllSubmodelsMetadata(options: {
36
47
  configuration: Configuration;
@@ -41,6 +52,17 @@ export declare class SubmodelRepositoryClient {
41
52
  }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelsMetadataResult, SubmodelRepositoryService.Result>>;
42
53
  /**
43
54
  * Returns all Submodels in value-only representation
55
+ *
56
+ * @param options Object containing:
57
+ * - configuration: The http request options
58
+ * - semanticId?: The value of the semantic id reference
59
+ * - idShort?: The Asset Administration Shell's IdShort
60
+ * - limit?: The maximum number of elements in the response array
61
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
62
+ * - level?: Determines the structural depth of the respective resource content
63
+ * - extent?: Determines to which extent the resource is being serialized
64
+ *
65
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
44
66
  */
45
67
  getAllSubmodelsValueOnly(options: {
46
68
  configuration: Configuration;
@@ -53,6 +75,16 @@ export declare class SubmodelRepositoryClient {
53
75
  }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelsValueResult, SubmodelRepositoryService.Result>>;
54
76
  /**
55
77
  * Returns references to all Submodels
78
+ *
79
+ * @param options Object containing:
80
+ * - configuration: The http request options
81
+ * - semanticId?: The value of the semantic id reference
82
+ * - idShort?: The Asset Administration Shell's IdShort
83
+ * - limit?: The maximum number of elements in the response array
84
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
85
+ * - level?: Determines the structural depth of the respective resource content
86
+ *
87
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
56
88
  */
57
89
  getAllSubmodelsReference(options: {
58
90
  configuration: Configuration;
@@ -64,6 +96,16 @@ export declare class SubmodelRepositoryClient {
64
96
  }): Promise<ApiResult<SubmodelRepositoryService.GetReferencesResult, SubmodelRepositoryService.Result>>;
65
97
  /**
66
98
  * Returns paths of all Submodels
99
+ *
100
+ * @param options Object containing:
101
+ * - configuration: The http request options
102
+ * - semanticId?: The value of the semantic id reference
103
+ * - idShort?: The Asset Administration Shell's IdShort
104
+ * - limit?: The maximum number of elements in the response array
105
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
106
+ * - level?: Determines the structural depth of the respective resource content
107
+ *
108
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
67
109
  */
68
110
  getAllSubmodelsPath(options: {
69
111
  configuration: Configuration;
@@ -92,12 +134,14 @@ export declare class SubmodelRepositoryClient {
92
134
  * @param options Object containing:
93
135
  * - configuration: The http request options
94
136
  * - submodelIdentifier: The Submodel’s unique id
137
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
95
138
  *
96
139
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
97
140
  */
98
141
  deleteSubmodelById(options: {
99
142
  configuration: Configuration;
100
143
  submodelIdentifier: string;
144
+ ifMatch?: string;
101
145
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
102
146
  /**
103
147
  * Returns a specific Submodel
@@ -107,30 +151,49 @@ export declare class SubmodelRepositoryClient {
107
151
  * - submodelIdentifier: The Submodel’s unique id
108
152
  * - level?: Determines the structural depth of the respective resource content
109
153
  * - extent?: Determines to which extent the resource is being serialized
154
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
110
155
  *
111
156
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
112
157
  */
113
- getSubmodelById(options: {
158
+ getSubmodelById<IfNoneMatch extends string | undefined = undefined>(options: {
114
159
  configuration: Configuration;
115
160
  submodelIdentifier: string;
116
161
  level?: SubmodelRepositoryService.GetSubmodelByIdLevelEnum;
117
162
  extent?: SubmodelRepositoryService.GetSubmodelByIdExtentEnum;
118
- }): Promise<ApiResult<Submodel, SubmodelRepositoryService.Result>>;
163
+ ifNoneMatch?: IfNoneMatch;
164
+ }): Promise<ConditionalApiResult<Submodel, SubmodelRepositoryService.Result, IfNoneMatch>>;
119
165
  /**
120
166
  * Returns a specific Submodel in reference representation
167
+ *
168
+ * @param options Object containing:
169
+ * - configuration: The http request options
170
+ * - submodelIdentifier: The Submodel's unique id
171
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
172
+ *
173
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
121
174
  */
122
- getSubmodelByIdReference(options: {
175
+ getSubmodelByIdReference<IfNoneMatch extends string | undefined = undefined>(options: {
123
176
  configuration: Configuration;
124
177
  submodelIdentifier: string;
125
- }): Promise<ApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result>>;
178
+ ifNoneMatch?: IfNoneMatch;
179
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result, IfNoneMatch>>;
126
180
  /**
127
181
  * Returns a specific Submodel in path representation
182
+ *
183
+ * @param options Object containing:
184
+ * - configuration: The http request options
185
+ * - submodelIdentifier: The Submodel's unique id
186
+ * - level?: Determines the structural depth of the respective resource content
187
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
188
+ *
189
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
128
190
  */
129
- getSubmodelByIdPath(options: {
191
+ getSubmodelByIdPath<IfNoneMatch extends string | undefined = undefined>(options: {
130
192
  configuration: Configuration;
131
193
  submodelIdentifier: string;
132
194
  level?: SubmodelRepositoryService.GetSubmodelByIdPathLevelEnum;
133
- }): Promise<ApiResult<string[], SubmodelRepositoryService.Result>>;
195
+ ifNoneMatch?: IfNoneMatch;
196
+ }): Promise<ConditionalApiResult<string[], SubmodelRepositoryService.Result, IfNoneMatch>>;
134
197
  /**
135
198
  * Updates an existing Submodel
136
199
  *
@@ -138,6 +201,8 @@ export declare class SubmodelRepositoryClient {
138
201
  * - configuration: The http request options
139
202
  * - submodelIdentifier: The Submodel’s unique id
140
203
  * - submodel: Submodel object
204
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
205
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
141
206
  *
142
207
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
143
208
  */
@@ -145,15 +210,27 @@ export declare class SubmodelRepositoryClient {
145
210
  configuration: Configuration;
146
211
  submodelIdentifier: string;
147
212
  submodel: Submodel;
213
+ ifMatch?: string;
214
+ ifNoneMatch?: string;
148
215
  }): Promise<ApiResult<Submodel | void, SubmodelRepositoryService.Result>>;
149
216
  /**
150
217
  * Updates an existing Submodel partially
218
+ *
219
+ * @param options Object containing:
220
+ * - configuration: The http request options
221
+ * - submodelIdentifier: The Submodel's unique id
222
+ * - submodel: Submodel object
223
+ * - level?: Determines the structural depth of the respective resource content
224
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
225
+ *
226
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
151
227
  */
152
228
  patchSubmodelById(options: {
153
229
  configuration: Configuration;
154
230
  submodelIdentifier: string;
155
231
  submodel: Submodel;
156
232
  level?: SubmodelRepositoryService.PatchSubmodelByIdLevelEnum;
233
+ ifMatch?: string;
157
234
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
158
235
  /**
159
236
  * Returns all submodel elements including their hierarchy
@@ -162,69 +239,116 @@ export declare class SubmodelRepositoryClient {
162
239
  * - configuration: The http request options
163
240
  * - submodelIdentifier: The Submodel’s unique id
164
241
  * - limit?: The maximum number of elements in the response array
165
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
242
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
166
243
  * - level?: Determines the structural depth of the respective resource content
167
244
  * - extent?: Determines to which extent the resource is being serialized
245
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
168
246
  *
169
247
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
170
248
  */
171
- getAllSubmodelElements(options: {
249
+ getAllSubmodelElements<IfNoneMatch extends string | undefined = undefined>(options: {
172
250
  configuration: Configuration;
173
251
  submodelIdentifier: string;
174
252
  limit?: number;
175
253
  cursor?: string;
176
254
  level?: SubmodelRepositoryService.GetAllSubmodelElementsLevelEnum;
177
255
  extent?: SubmodelRepositoryService.GetAllSubmodelElementsExtentEnum;
178
- }): Promise<ApiResult<{
256
+ ifNoneMatch?: IfNoneMatch;
257
+ }): Promise<ConditionalApiResult<{
179
258
  pagedResult: SubmodelRepositoryService.PagedResultPagingMetadata | undefined;
180
259
  result: ISubmodelElement[];
181
- }, SubmodelRepositoryService.Result>>;
260
+ }, SubmodelRepositoryService.Result, IfNoneMatch>>;
182
261
  /**
183
262
  * Returns all submodel elements in metadata representation
263
+ *
264
+ * @param options Object containing:
265
+ * - configuration: The http request options
266
+ * - submodelIdentifier: The Submodel's unique id
267
+ * - limit?: The maximum number of elements in the response array
268
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
269
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
270
+ *
271
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
184
272
  */
185
- getAllSubmodelElementsMetadata(options: {
273
+ getAllSubmodelElementsMetadata<IfNoneMatch extends string | undefined = undefined>(options: {
186
274
  configuration: Configuration;
187
275
  submodelIdentifier: string;
188
276
  limit?: number;
189
277
  cursor?: string;
190
- }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelElementsMetadataResult, SubmodelRepositoryService.Result>>;
278
+ ifNoneMatch?: IfNoneMatch;
279
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.GetSubmodelElementsMetadataResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
191
280
  /**
192
281
  * Returns all submodel elements in value-only representation
282
+ *
283
+ * @param options Object containing:
284
+ * - configuration: The http request options
285
+ * - submodelIdentifier: The Submodel's unique id
286
+ * - limit?: The maximum number of elements in the response array
287
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
288
+ * - level?: Determines the structural depth of the respective resource content
289
+ * - extent?: Determines to which extent the resource is being serialized
290
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
291
+ *
292
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
193
293
  */
194
- getAllSubmodelElementsValueOnly(options: {
294
+ getAllSubmodelElementsValueOnly<IfNoneMatch extends string | undefined = undefined>(options: {
195
295
  configuration: Configuration;
196
296
  submodelIdentifier: string;
197
297
  limit?: number;
198
298
  cursor?: string;
199
299
  level?: SubmodelRepositoryService.GetAllSubmodelElementsValueOnlySubmodelRepoLevelEnum;
200
300
  extent?: SubmodelRepositoryService.GetAllSubmodelElementsValueOnlySubmodelRepoExtentEnum;
201
- }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelElementsValueResult, SubmodelRepositoryService.Result>>;
301
+ ifNoneMatch?: IfNoneMatch;
302
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.GetSubmodelElementsValueResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
202
303
  /**
203
304
  * Returns references to all submodel elements
305
+ *
306
+ * @param options Object containing:
307
+ * - configuration: The http request options
308
+ * - submodelIdentifier: The Submodel's unique id
309
+ * - limit?: The maximum number of elements in the response array
310
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
311
+ * - level?: Determines the structural depth of the respective resource content
312
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
313
+ *
314
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
204
315
  */
205
- getAllSubmodelElementsReference(options: {
316
+ getAllSubmodelElementsReference<IfNoneMatch extends string | undefined = undefined>(options: {
206
317
  configuration: Configuration;
207
318
  submodelIdentifier: string;
208
319
  limit?: number;
209
320
  cursor?: string;
210
321
  level?: SubmodelRepositoryService.GetAllSubmodelElementsReferenceSubmodelRepoLevelEnum;
211
- }): Promise<ApiResult<SubmodelRepositoryService.GetReferencesResult, SubmodelRepositoryService.Result>>;
322
+ ifNoneMatch?: IfNoneMatch;
323
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.GetReferencesResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
212
324
  /**
213
325
  * Returns paths of all submodel elements
326
+ *
327
+ * @param options Object containing:
328
+ * - configuration: The http request options
329
+ * - submodelIdentifier: The Submodel's unique id
330
+ * - limit?: The maximum number of elements in the response array
331
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
332
+ * - level?: Determines the structural depth of the respective resource content
333
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
334
+ *
335
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
214
336
  */
215
- getAllSubmodelElementsPath(options: {
337
+ getAllSubmodelElementsPath<IfNoneMatch extends string | undefined = undefined>(options: {
216
338
  configuration: Configuration;
217
339
  submodelIdentifier: string;
218
340
  limit?: number;
219
341
  cursor?: string;
220
342
  level?: SubmodelRepositoryService.GetAllSubmodelElementsPathSubmodelRepoLevelEnum;
221
- }): Promise<ApiResult<SubmodelRepositoryService.GetPathItemsResult, SubmodelRepositoryService.Result>>;
343
+ ifNoneMatch?: IfNoneMatch;
344
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.GetPathItemsResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
222
345
  /**
223
346
  * Creates a new submodel element
224
347
  *
225
348
  * @param options Object containing:
226
349
  * - configuration: The http request options
227
350
  * - submodelIdentifier: The Submodel’s unique id
351
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
228
352
  *
229
353
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
230
354
  */
@@ -232,6 +356,7 @@ export declare class SubmodelRepositoryClient {
232
356
  configuration: Configuration;
233
357
  submodelIdentifier: string;
234
358
  submodelElement: ISubmodelElement;
359
+ ifMatch?: string;
235
360
  }): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
236
361
  /**
237
362
  * Returns a specific submodel element from the Submodel at a specified path
@@ -242,41 +367,71 @@ export declare class SubmodelRepositoryClient {
242
367
  * - idShortPath: IdShort path to the submodel element (dot-separated)
243
368
  * - level?: Determines the structural depth of the respective resource content
244
369
  * - extent?: Determines to which extent the resource is being serialized
370
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
245
371
  *
246
372
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
247
373
  */
248
- getSubmodelElementByPath(options: {
374
+ getSubmodelElementByPath<IfNoneMatch extends string | undefined = undefined>(options: {
249
375
  configuration: Configuration;
250
376
  submodelIdentifier: string;
251
377
  idShortPath: string;
252
378
  level?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoLevelEnum;
253
379
  extent?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoExtentEnum;
254
- }): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
380
+ ifNoneMatch?: IfNoneMatch;
381
+ }): Promise<ConditionalApiResult<ISubmodelElement, SubmodelRepositoryService.Result, IfNoneMatch>>;
255
382
  /**
256
383
  * Returns metadata attributes of a specific submodel element
384
+ *
385
+ * @param options Object containing:
386
+ * - configuration: The http request options
387
+ * - submodelIdentifier: The Submodel's unique id
388
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
389
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
390
+ *
391
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
257
392
  */
258
- getSubmodelElementByPathMetadata(options: {
393
+ getSubmodelElementByPathMetadata<IfNoneMatch extends string | undefined = undefined>(options: {
259
394
  configuration: Configuration;
260
395
  submodelIdentifier: string;
261
396
  idShortPath: string;
262
- }): Promise<ApiResult<SubmodelRepositoryService.SubmodelElementMetadata, SubmodelRepositoryService.Result>>;
397
+ ifNoneMatch?: IfNoneMatch;
398
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.SubmodelElementMetadata, SubmodelRepositoryService.Result, IfNoneMatch>>;
263
399
  /**
264
400
  * Returns a specific submodel element in reference representation
401
+ *
402
+ * @param options Object containing:
403
+ * - configuration: The http request options
404
+ * - submodelIdentifier: The Submodel's unique id
405
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
406
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
407
+ *
408
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
265
409
  */
266
- getSubmodelElementByPathReference(options: {
410
+ getSubmodelElementByPathReference<IfNoneMatch extends string | undefined = undefined>(options: {
267
411
  configuration: Configuration;
268
412
  submodelIdentifier: string;
269
413
  idShortPath: string;
270
- }): Promise<ApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result>>;
414
+ ifNoneMatch?: IfNoneMatch;
415
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result, IfNoneMatch>>;
271
416
  /**
272
417
  * Returns a specific submodel element in path representation
418
+ *
419
+ * @param options Object containing:
420
+ * - configuration: The http request options
421
+ * - submodelIdentifier: The Submodel's unique id
422
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
423
+ * - level?: Determines the structural depth of the respective resource content
424
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
425
+ *
426
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
273
427
  */
274
- getSubmodelElementByPathPath(options: {
428
+ getSubmodelElementByPathPath<IfNoneMatch extends string | undefined = undefined>(options: {
275
429
  configuration: Configuration;
276
430
  submodelIdentifier: string;
277
431
  idShortPath: string;
278
432
  level?: SubmodelRepositoryService.GetSubmodelElementByPathPathSubmodelRepoLevelEnum;
279
- }): Promise<ApiResult<string[], SubmodelRepositoryService.Result>>;
433
+ ifNoneMatch?: IfNoneMatch;
434
+ }): Promise<ConditionalApiResult<string[], SubmodelRepositoryService.Result, IfNoneMatch>>;
280
435
  /**
281
436
  * Creates a new submodel element at a specified path within submodel elements hierarchy
282
437
  *
@@ -285,6 +440,7 @@ export declare class SubmodelRepositoryClient {
285
440
  * - submodelIdentifier: The Submodel’s unique id
286
441
  * - idShortPath: IdShort path to the submodel element (dot-separated)
287
442
  * - submodelElement: SubmodelElement object
443
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
288
444
  *
289
445
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
290
446
  */
@@ -293,6 +449,7 @@ export declare class SubmodelRepositoryClient {
293
449
  submodelIdentifier: string;
294
450
  idShortPath: string;
295
451
  submodelElement: ISubmodelElement;
452
+ ifMatch?: string;
296
453
  }): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
297
454
  /**
298
455
  * Deletes a submodel element at a specified path within the submodel elements hierarchy
@@ -301,6 +458,7 @@ export declare class SubmodelRepositoryClient {
301
458
  * - configuration: The http request options.
302
459
  * - submodelIdentifier: The Submodel’s unique id
303
460
  * - idShortPath: IdShort path to the submodel element (dot-separated)
461
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
304
462
  *
305
463
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
306
464
  */
@@ -308,6 +466,7 @@ export declare class SubmodelRepositoryClient {
308
466
  configuration: Configuration;
309
467
  submodelIdentifier: string;
310
468
  idShortPath: string;
469
+ ifMatch?: string;
311
470
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
312
471
  /**
313
472
  * Updates an existing submodel element at a specified path within submodel elements hierarchy
@@ -318,6 +477,8 @@ export declare class SubmodelRepositoryClient {
318
477
  * - idShortPath: IdShort path to the submodel element (dot-separated)
319
478
  * - submodelElement: SubmodelElement object
320
479
  * - level?: Determines the structural depth of the respective resource content
480
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
481
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
321
482
  *
322
483
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
323
484
  */
@@ -327,9 +488,21 @@ export declare class SubmodelRepositoryClient {
327
488
  idShortPath: string;
328
489
  submodelElement: ISubmodelElement;
329
490
  level?: SubmodelRepositoryService.PutSubmodelElementByPathSubmodelRepoLevelEnum;
491
+ ifMatch?: string;
492
+ ifNoneMatch?: string;
330
493
  }): Promise<ApiResult<ISubmodelElement | void, SubmodelRepositoryService.Result>>;
331
494
  /**
332
495
  * Updates values of an existing submodel element at a specified path
496
+ *
497
+ * @param options Object containing:
498
+ * - configuration: The http request options
499
+ * - submodelIdentifier: The Submodel's unique id
500
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
501
+ * - submodelElement: SubmodelElement object
502
+ * - level?: Determines the structural depth of the respective resource content
503
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
504
+ *
505
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
333
506
  */
334
507
  patchSubmodelElementByPath(options: {
335
508
  configuration: Configuration;
@@ -337,6 +510,7 @@ export declare class SubmodelRepositoryClient {
337
510
  idShortPath: string;
338
511
  submodelElement: ISubmodelElement;
339
512
  level?: SubmodelRepositoryService.PatchSubmodelElementByPathSubmodelRepoLevelEnum;
513
+ ifMatch?: string;
340
514
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
341
515
  /**
342
516
  * Returns the metadata attributes of a specific Submodel
@@ -344,21 +518,33 @@ export declare class SubmodelRepositoryClient {
344
518
  * @param options Object containing:
345
519
  * - configuration: The http request options
346
520
  * - submodelIdentifier: The Submodel’s unique id
521
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
347
522
  *
348
523
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
349
524
  */
350
- getSubmodelByIdMetadata(options: {
525
+ getSubmodelByIdMetadata<IfNoneMatch extends string | undefined = undefined>(options: {
351
526
  configuration: Configuration;
352
527
  submodelIdentifier: string;
353
- }): Promise<ApiResult<SubmodelRepositoryService.SubmodelMetadata, SubmodelRepositoryService.Result>>;
528
+ ifNoneMatch?: IfNoneMatch;
529
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.SubmodelMetadata, SubmodelRepositoryService.Result, IfNoneMatch>>;
354
530
  /**
355
531
  * Updates metadata attributes of an existing Submodel
532
+ *
533
+ * @param options Object containing:
534
+ * - configuration: The http request options
535
+ * - submodelIdentifier: The Submodel's unique id
536
+ * - submodelMetadata: SubmodelMetadata object
537
+ * - level?: Determines the structural depth of the respective resource content
538
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
539
+ *
540
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
356
541
  */
357
542
  patchSubmodelByIdMetadata(options: {
358
543
  configuration: Configuration;
359
544
  submodelIdentifier: string;
360
545
  submodelMetadata: SubmodelRepositoryService.SubmodelMetadata;
361
546
  level?: SubmodelRepositoryService.PatchSubmodelByIdMetadataLevelEnum;
547
+ ifMatch?: string;
362
548
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
363
549
  /**
364
550
  * Returns a specific Submodel in the ValueOnly representation
@@ -368,30 +554,35 @@ export declare class SubmodelRepositoryClient {
368
554
  * - submodelIdentifier: The Submodel’s unique id
369
555
  * - level?: Determines the structural depth of the respective resource content
370
556
  * - extent?: Determines to which extent the resource is being serialized
557
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
371
558
  *
372
559
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
373
560
  */
374
- getSubmodelByIdValueOnly(options: {
561
+ getSubmodelByIdValueOnly<IfNoneMatch extends string | undefined = undefined>(options: {
375
562
  configuration: Configuration;
376
563
  submodelIdentifier: string;
377
564
  level?: SubmodelRepositoryService.GetSubmodelByIdValueOnlyLevelEnum;
378
565
  extent?: SubmodelRepositoryService.GetSubmodelByIdValueOnlyExtentEnum;
379
- }): Promise<ApiResult<object, SubmodelRepositoryService.Result>>;
380
- /**
381
- // * Updates the values of an existing Submodel
382
- // *
383
- // * @param options Object containing:
384
- // * - configuration: The http request options
385
- // * - submodelIdentifier: The Submodel’s unique id
386
- // * - level?: Determines the structural depth of the respective resource content
387
- // *
388
- // * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
389
- // */
566
+ ifNoneMatch?: IfNoneMatch;
567
+ }): Promise<ConditionalApiResult<object, SubmodelRepositoryService.Result, IfNoneMatch>>;
568
+ /**
569
+ * Updates the values of an existing Submodel
570
+ *
571
+ * @param options Object containing:
572
+ * - configuration: The http request options
573
+ * - submodelIdentifier: The Submodel's unique id
574
+ * - body: Value-only payload object
575
+ * - level?: Determines the structural depth of the respective resource content
576
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
577
+ *
578
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
579
+ */
390
580
  patchSubmodelByIdValueOnly(options: {
391
581
  configuration: Configuration;
392
582
  submodelIdentifier: string;
393
583
  body: object;
394
584
  level?: SubmodelRepositoryService.PatchSubmodelByIdValueOnlyLevelEnum;
585
+ ifMatch?: string;
395
586
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
396
587
  /**
397
588
  * Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
@@ -402,54 +593,88 @@ export declare class SubmodelRepositoryClient {
402
593
  * - idShortPath: IdShort path to the submodel element (dot-separated)
403
594
  * - level?: Determines the structural depth of the respective resource content
404
595
  * - extent?: Determines to which extent the resource is being serialized
596
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
405
597
  *
406
598
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
407
599
  */
408
- getSubmodelElementByPathValueOnly(options: {
600
+ getSubmodelElementByPathValueOnly<IfNoneMatch extends string | undefined = undefined>(options: {
409
601
  configuration: Configuration;
410
602
  submodelIdentifier: string;
411
603
  idShortPath: string;
412
604
  level?: SubmodelRepositoryService.GetSubmodelElementByPathValueOnlySubmodelRepoLevelEnum;
413
605
  extent?: SubmodelRepositoryService.GetSubmodelElementByPathValueOnlySubmodelRepoExtentEnum;
414
- }): Promise<ApiResult<SubmodelRepositoryService.SubmodelElementValue, SubmodelRepositoryService.Result>>;
415
- /**
416
- // * Updates the value of an existing SubmodelElement
417
- // *
418
- // * @param options Object containing:
419
- // * - configuration: The http request options
420
- // * - submodelIdentifier: The Submodel’s unique id
421
- // * - idShortPath: IdShort path to the submodel element (dot-separated)
422
- // * - submodelElementValue: SubmodelElementValue object
423
- // * - level?: Determines the structural depth of the respective resource content
424
- // *
425
- // * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
426
- // */
606
+ ifNoneMatch?: IfNoneMatch;
607
+ }): Promise<ConditionalApiResult<SubmodelRepositoryService.SubmodelElementValue, SubmodelRepositoryService.Result, IfNoneMatch>>;
608
+ /**
609
+ * Updates the value of an existing SubmodelElement
610
+ *
611
+ * @param options Object containing:
612
+ * - configuration: The http request options
613
+ * - submodelIdentifier: The Submodel's unique id
614
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
615
+ * - submodelElementValue: SubmodelElementValue object
616
+ * - level?: Determines the structural depth of the respective resource content
617
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
618
+ *
619
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
620
+ */
427
621
  patchSubmodelElementByPathValueOnly(options: {
428
622
  configuration: Configuration;
429
623
  submodelIdentifier: string;
430
624
  idShortPath: string;
431
625
  submodelElementValue: SubmodelRepositoryService.SubmodelElementValue;
432
626
  level?: SubmodelRepositoryService.PatchSubmodelElementByPathValueOnlySubmodelRepoLevelEnum;
627
+ ifMatch?: string;
433
628
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
434
629
  /**
435
630
  * Updates metadata attributes of an existing SubmodelElement
631
+ *
632
+ * @param options Object containing:
633
+ * - configuration: The http request options
634
+ * - submodelIdentifier: The Submodel's unique id
635
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
636
+ * - submodelElementMetadata: SubmodelElementMetadata object
637
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
638
+ *
639
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
436
640
  */
437
641
  patchSubmodelElementByPathMetadata(options: {
438
642
  configuration: Configuration;
439
643
  submodelIdentifier: string;
440
644
  idShortPath: string;
441
645
  submodelElementMetadata: SubmodelRepositoryService.SubmodelElementMetadata;
646
+ ifMatch?: string;
442
647
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
443
648
  /**
444
649
  * Returns file content for a submodel element at a specified path
650
+ *
651
+ * @param options Object containing:
652
+ * - configuration: The http request options
653
+ * - submodelIdentifier: The Submodel's unique id
654
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
655
+ * - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
656
+ *
657
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
445
658
  */
446
- getFileByPath(options: {
659
+ getFileByPath<IfNoneMatch extends string | undefined = undefined>(options: {
447
660
  configuration: Configuration;
448
661
  submodelIdentifier: string;
449
662
  idShortPath: string;
450
- }): Promise<ApiResult<Blob, SubmodelRepositoryService.Result>>;
663
+ ifNoneMatch?: IfNoneMatch;
664
+ }): Promise<ConditionalApiResult<Blob, SubmodelRepositoryService.Result, IfNoneMatch>>;
451
665
  /**
452
666
  * Updates file content for a submodel element at a specified path
667
+ *
668
+ * @param options Object containing:
669
+ * - configuration: The http request options
670
+ * - submodelIdentifier: The Submodel's unique id
671
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
672
+ * - fileName?: Name of the uploaded file
673
+ * - file?: File content
674
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
675
+ * - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
676
+ *
677
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
453
678
  */
454
679
  putFileByPath(options: {
455
680
  configuration: Configuration;
@@ -457,14 +682,25 @@ export declare class SubmodelRepositoryClient {
457
682
  idShortPath: string;
458
683
  fileName?: string;
459
684
  file?: Blob;
685
+ ifMatch?: string;
686
+ ifNoneMatch?: string;
460
687
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
461
688
  /**
462
689
  * Deletes file content of an existing submodel element at a specified path
690
+ *
691
+ * @param options Object containing:
692
+ * - configuration: The http request options
693
+ * - submodelIdentifier: The Submodel's unique id
694
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
695
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
696
+ *
697
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
463
698
  */
464
699
  deleteFileByPath(options: {
465
700
  configuration: Configuration;
466
701
  submodelIdentifier: string;
467
702
  idShortPath: string;
703
+ ifMatch?: string;
468
704
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
469
705
  /**
470
706
  * Synchronously invokes an Operation at a specified path
@@ -475,6 +711,7 @@ export declare class SubmodelRepositoryClient {
475
711
  * - idShortPath: IdShort path to the submodel element (dot-separated)
476
712
  * - operationRequest: Operation request object
477
713
  * - async?: Determines whether an operation invocation is performed asynchronously or synchronously
714
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
478
715
  *
479
716
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
480
717
  */
@@ -483,6 +720,7 @@ export declare class SubmodelRepositoryClient {
483
720
  submodelIdentifier: string;
484
721
  idShortPath: string;
485
722
  operationRequest: SubmodelRepositoryService.OperationRequest;
723
+ ifMatch?: string;
486
724
  }): Promise<ApiResult<SubmodelRepositoryService.OperationResult, SubmodelRepositoryService.Result>>;
487
725
  /**
488
726
  * Synchronously invokes an Operation at a specified path
@@ -493,6 +731,7 @@ export declare class SubmodelRepositoryClient {
493
731
  * - submodelIdentifier: The Submodel’s unique id
494
732
  * - idShortPath: IdShort path to the submodel element (dot-separated)
495
733
  * - operationRequestValueOnly: Operation request object
734
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
496
735
  *
497
736
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
498
737
  */
@@ -502,6 +741,7 @@ export declare class SubmodelRepositoryClient {
502
741
  submodelIdentifier: string;
503
742
  idShortPath: string;
504
743
  operationRequestValueOnly: SubmodelRepositoryService.OperationRequestValueOnly;
744
+ ifMatch?: string;
505
745
  }): Promise<ApiResult<SubmodelRepositoryService.OperationResultValueOnly, SubmodelRepositoryService.Result>>;
506
746
  /**
507
747
  * Asynchronously invokes an Operation at a specified path
@@ -511,6 +751,7 @@ export declare class SubmodelRepositoryClient {
511
751
  * - submodelIdentifier: The Submodel’s unique id
512
752
  * - idShortPath: IdShort path to the submodel element (dot-separated)
513
753
  * - operationRequest: Operation request object
754
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
514
755
  *
515
756
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
516
757
  */
@@ -519,6 +760,7 @@ export declare class SubmodelRepositoryClient {
519
760
  submodelIdentifier: string;
520
761
  idShortPath: string;
521
762
  operationRequest: SubmodelRepositoryService.OperationRequest;
763
+ ifMatch?: string;
522
764
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
523
765
  /**
524
766
  * Asynchronously invokes an Operation at a specified path
@@ -529,6 +771,7 @@ export declare class SubmodelRepositoryClient {
529
771
  * - submodelIdentifier: The Submodel’s unique id
530
772
  * - idShortPath: IdShort path to the submodel element (dot-separated)
531
773
  * - operationRequestValueOnly: Operation request object
774
+ * - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
532
775
  *
533
776
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
534
777
  */
@@ -538,9 +781,18 @@ export declare class SubmodelRepositoryClient {
538
781
  submodelIdentifier: string;
539
782
  idShortPath: string;
540
783
  operationRequestValueOnly: SubmodelRepositoryService.OperationRequestValueOnly;
784
+ ifMatch?: string;
541
785
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
542
786
  /**
543
787
  * Returns status of an asynchronously invoked operation
788
+ *
789
+ * @param options Object containing:
790
+ * - configuration: The http request options
791
+ * - submodelIdentifier: The Submodel's unique id
792
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
793
+ * - handleId: Identifier of the asynchronous invocation handle
794
+ *
795
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
544
796
  */
545
797
  getOperationAsyncStatus(options: {
546
798
  configuration: Configuration;
@@ -550,6 +802,14 @@ export declare class SubmodelRepositoryClient {
550
802
  }): Promise<ApiResult<SubmodelRepositoryService.BaseOperationResult, SubmodelRepositoryService.Result>>;
551
803
  /**
552
804
  * Returns result of an asynchronously invoked operation
805
+ *
806
+ * @param options Object containing:
807
+ * - configuration: The http request options
808
+ * - submodelIdentifier: The Submodel's unique id
809
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
810
+ * - handleId: Identifier of the asynchronous invocation handle
811
+ *
812
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
553
813
  */
554
814
  getOperationAsyncResult(options: {
555
815
  configuration: Configuration;
@@ -559,6 +819,14 @@ export declare class SubmodelRepositoryClient {
559
819
  }): Promise<ApiResult<SubmodelRepositoryService.OperationResult, SubmodelRepositoryService.Result>>;
560
820
  /**
561
821
  * Returns result of an asynchronously invoked operation in value-only representation
822
+ *
823
+ * @param options Object containing:
824
+ * - configuration: The http request options
825
+ * - submodelIdentifier: The Submodel's unique id
826
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
827
+ * - handleId: Identifier of the asynchronous invocation handle
828
+ *
829
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
562
830
  */
563
831
  getOperationAsyncResultValueOnly(options: {
564
832
  configuration: Configuration;
@@ -568,6 +836,14 @@ export declare class SubmodelRepositoryClient {
568
836
  }): Promise<ApiResult<SubmodelRepositoryService.OperationResultValueOnly, SubmodelRepositoryService.Result>>;
569
837
  /**
570
838
  * Returns an appropriate serialization based on the specified format
839
+ *
840
+ * @param options Object containing:
841
+ * - configuration: The http request options
842
+ * - aasIds?: Asset Administration Shell IDs
843
+ * - submodelIds?: Submodel IDs
844
+ * - includeConceptDescriptions?: Whether to include referenced ConceptDescriptions in the serialization result
845
+ *
846
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
571
847
  */
572
848
  generateSerializationByIds(options: {
573
849
  configuration: Configuration;
@@ -577,6 +853,11 @@ export declare class SubmodelRepositoryClient {
577
853
  }): Promise<ApiResult<Blob, SubmodelRepositoryService.Result>>;
578
854
  /**
579
855
  * Returns the self-describing information of a network resource (ServiceDescription)
856
+ *
857
+ * @param options Object containing:
858
+ * - configuration: The http request options
859
+ *
860
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
580
861
  */
581
862
  getSelfDescription(options: {
582
863
  configuration: Configuration;