basyx-typescript-sdk 2.2.5 → 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.
- package/README.md +54 -0
- package/bundle/index.cjs +1181 -511
- package/bundle/index.cjs.map +1 -1
- package/bundle/index.mjs +1181 -511
- package/bundle/index.mjs.map +1 -1
- package/dist/clients/AasDiscoveryClient.d.ts +9 -3
- package/dist/clients/AasDiscoveryClient.js +28 -9
- package/dist/clients/AasRegistryClient.d.ts +28 -8
- package/dist/clients/AasRegistryClient.js +63 -21
- package/dist/clients/AasRepositoryClient.d.ts +170 -56
- package/dist/clients/AasRepositoryClient.js +385 -136
- package/dist/clients/AasxFileClient.d.ts +11 -3
- package/dist/clients/AasxFileClient.js +27 -11
- package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +11 -3
- package/dist/clients/ConceptDescriptionRepositoryClient.js +40 -12
- package/dist/clients/SubmodelRegistryClient.d.ts +11 -3
- package/dist/clients/SubmodelRegistryClient.js +28 -8
- package/dist/clients/SubmodelRepositoryClient.d.ts +108 -34
- package/dist/clients/SubmodelRepositoryClient.js +262 -106
- package/dist/lib/apiConfig.d.ts +2 -1
- package/dist/lib/apiConfig.js +27 -2
- package/dist/lib/conditionalRequests.d.ts +28 -0
- package/dist/lib/conditionalRequests.js +55 -0
- package/dist/models/api.d.ts +38 -2
- package/dist/services/AasService.d.ts +13 -3
- package/dist/services/AasService.js +45 -7
- package/dist/services/SubmodelService.d.ts +13 -3
- package/dist/services/SubmodelService.js +49 -7
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
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 {
|
|
@@ -134,12 +134,14 @@ export declare class SubmodelRepositoryClient {
|
|
|
134
134
|
* @param options Object containing:
|
|
135
135
|
* - configuration: The http request options
|
|
136
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
|
|
137
138
|
*
|
|
138
139
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
139
140
|
*/
|
|
140
141
|
deleteSubmodelById(options: {
|
|
141
142
|
configuration: Configuration;
|
|
142
143
|
submodelIdentifier: string;
|
|
144
|
+
ifMatch?: string;
|
|
143
145
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
144
146
|
/**
|
|
145
147
|
* Returns a specific Submodel
|
|
@@ -149,28 +151,32 @@ export declare class SubmodelRepositoryClient {
|
|
|
149
151
|
* - submodelIdentifier: The Submodel’s unique id
|
|
150
152
|
* - level?: Determines the structural depth of the respective resource content
|
|
151
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`
|
|
152
155
|
*
|
|
153
156
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
154
157
|
*/
|
|
155
|
-
getSubmodelById(options: {
|
|
158
|
+
getSubmodelById<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
156
159
|
configuration: Configuration;
|
|
157
160
|
submodelIdentifier: string;
|
|
158
161
|
level?: SubmodelRepositoryService.GetSubmodelByIdLevelEnum;
|
|
159
162
|
extent?: SubmodelRepositoryService.GetSubmodelByIdExtentEnum;
|
|
160
|
-
|
|
163
|
+
ifNoneMatch?: IfNoneMatch;
|
|
164
|
+
}): Promise<ConditionalApiResult<Submodel, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
161
165
|
/**
|
|
162
166
|
* Returns a specific Submodel in reference representation
|
|
163
167
|
*
|
|
164
168
|
* @param options Object containing:
|
|
165
169
|
* - configuration: The http request options
|
|
166
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`
|
|
167
172
|
*
|
|
168
173
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
169
174
|
*/
|
|
170
|
-
getSubmodelByIdReference(options: {
|
|
175
|
+
getSubmodelByIdReference<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
171
176
|
configuration: Configuration;
|
|
172
177
|
submodelIdentifier: string;
|
|
173
|
-
|
|
178
|
+
ifNoneMatch?: IfNoneMatch;
|
|
179
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
174
180
|
/**
|
|
175
181
|
* Returns a specific Submodel in path representation
|
|
176
182
|
*
|
|
@@ -178,14 +184,16 @@ export declare class SubmodelRepositoryClient {
|
|
|
178
184
|
* - configuration: The http request options
|
|
179
185
|
* - submodelIdentifier: The Submodel's unique id
|
|
180
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`
|
|
181
188
|
*
|
|
182
189
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
183
190
|
*/
|
|
184
|
-
getSubmodelByIdPath(options: {
|
|
191
|
+
getSubmodelByIdPath<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
185
192
|
configuration: Configuration;
|
|
186
193
|
submodelIdentifier: string;
|
|
187
194
|
level?: SubmodelRepositoryService.GetSubmodelByIdPathLevelEnum;
|
|
188
|
-
|
|
195
|
+
ifNoneMatch?: IfNoneMatch;
|
|
196
|
+
}): Promise<ConditionalApiResult<string[], SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
189
197
|
/**
|
|
190
198
|
* Updates an existing Submodel
|
|
191
199
|
*
|
|
@@ -193,6 +201,8 @@ export declare class SubmodelRepositoryClient {
|
|
|
193
201
|
* - configuration: The http request options
|
|
194
202
|
* - submodelIdentifier: The Submodel’s unique id
|
|
195
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)
|
|
196
206
|
*
|
|
197
207
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
198
208
|
*/
|
|
@@ -200,6 +210,8 @@ export declare class SubmodelRepositoryClient {
|
|
|
200
210
|
configuration: Configuration;
|
|
201
211
|
submodelIdentifier: string;
|
|
202
212
|
submodel: Submodel;
|
|
213
|
+
ifMatch?: string;
|
|
214
|
+
ifNoneMatch?: string;
|
|
203
215
|
}): Promise<ApiResult<Submodel | void, SubmodelRepositoryService.Result>>;
|
|
204
216
|
/**
|
|
205
217
|
* Updates an existing Submodel partially
|
|
@@ -209,6 +221,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
209
221
|
* - submodelIdentifier: The Submodel's unique id
|
|
210
222
|
* - submodel: Submodel object
|
|
211
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
|
|
212
225
|
*
|
|
213
226
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
214
227
|
*/
|
|
@@ -217,6 +230,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
217
230
|
submodelIdentifier: string;
|
|
218
231
|
submodel: Submodel;
|
|
219
232
|
level?: SubmodelRepositoryService.PatchSubmodelByIdLevelEnum;
|
|
233
|
+
ifMatch?: string;
|
|
220
234
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
221
235
|
/**
|
|
222
236
|
* Returns all submodel elements including their hierarchy
|
|
@@ -228,20 +242,22 @@ export declare class SubmodelRepositoryClient {
|
|
|
228
242
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
229
243
|
* - level?: Determines the structural depth of the respective resource content
|
|
230
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`
|
|
231
246
|
*
|
|
232
247
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
233
248
|
*/
|
|
234
|
-
getAllSubmodelElements(options: {
|
|
249
|
+
getAllSubmodelElements<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
235
250
|
configuration: Configuration;
|
|
236
251
|
submodelIdentifier: string;
|
|
237
252
|
limit?: number;
|
|
238
253
|
cursor?: string;
|
|
239
254
|
level?: SubmodelRepositoryService.GetAllSubmodelElementsLevelEnum;
|
|
240
255
|
extent?: SubmodelRepositoryService.GetAllSubmodelElementsExtentEnum;
|
|
241
|
-
|
|
256
|
+
ifNoneMatch?: IfNoneMatch;
|
|
257
|
+
}): Promise<ConditionalApiResult<{
|
|
242
258
|
pagedResult: SubmodelRepositoryService.PagedResultPagingMetadata | undefined;
|
|
243
259
|
result: ISubmodelElement[];
|
|
244
|
-
}, SubmodelRepositoryService.Result>>;
|
|
260
|
+
}, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
245
261
|
/**
|
|
246
262
|
* Returns all submodel elements in metadata representation
|
|
247
263
|
*
|
|
@@ -250,15 +266,17 @@ export declare class SubmodelRepositoryClient {
|
|
|
250
266
|
* - submodelIdentifier: The Submodel's unique id
|
|
251
267
|
* - limit?: The maximum number of elements in the response array
|
|
252
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`
|
|
253
270
|
*
|
|
254
271
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
255
272
|
*/
|
|
256
|
-
getAllSubmodelElementsMetadata(options: {
|
|
273
|
+
getAllSubmodelElementsMetadata<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
257
274
|
configuration: Configuration;
|
|
258
275
|
submodelIdentifier: string;
|
|
259
276
|
limit?: number;
|
|
260
277
|
cursor?: string;
|
|
261
|
-
|
|
278
|
+
ifNoneMatch?: IfNoneMatch;
|
|
279
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.GetSubmodelElementsMetadataResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
262
280
|
/**
|
|
263
281
|
* Returns all submodel elements in value-only representation
|
|
264
282
|
*
|
|
@@ -269,17 +287,19 @@ export declare class SubmodelRepositoryClient {
|
|
|
269
287
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
270
288
|
* - level?: Determines the structural depth of the respective resource content
|
|
271
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`
|
|
272
291
|
*
|
|
273
292
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
274
293
|
*/
|
|
275
|
-
getAllSubmodelElementsValueOnly(options: {
|
|
294
|
+
getAllSubmodelElementsValueOnly<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
276
295
|
configuration: Configuration;
|
|
277
296
|
submodelIdentifier: string;
|
|
278
297
|
limit?: number;
|
|
279
298
|
cursor?: string;
|
|
280
299
|
level?: SubmodelRepositoryService.GetAllSubmodelElementsValueOnlySubmodelRepoLevelEnum;
|
|
281
300
|
extent?: SubmodelRepositoryService.GetAllSubmodelElementsValueOnlySubmodelRepoExtentEnum;
|
|
282
|
-
|
|
301
|
+
ifNoneMatch?: IfNoneMatch;
|
|
302
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.GetSubmodelElementsValueResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
283
303
|
/**
|
|
284
304
|
* Returns references to all submodel elements
|
|
285
305
|
*
|
|
@@ -289,16 +309,18 @@ export declare class SubmodelRepositoryClient {
|
|
|
289
309
|
* - limit?: The maximum number of elements in the response array
|
|
290
310
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
291
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`
|
|
292
313
|
*
|
|
293
314
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
294
315
|
*/
|
|
295
|
-
getAllSubmodelElementsReference(options: {
|
|
316
|
+
getAllSubmodelElementsReference<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
296
317
|
configuration: Configuration;
|
|
297
318
|
submodelIdentifier: string;
|
|
298
319
|
limit?: number;
|
|
299
320
|
cursor?: string;
|
|
300
321
|
level?: SubmodelRepositoryService.GetAllSubmodelElementsReferenceSubmodelRepoLevelEnum;
|
|
301
|
-
|
|
322
|
+
ifNoneMatch?: IfNoneMatch;
|
|
323
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.GetReferencesResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
302
324
|
/**
|
|
303
325
|
* Returns paths of all submodel elements
|
|
304
326
|
*
|
|
@@ -308,22 +330,25 @@ export declare class SubmodelRepositoryClient {
|
|
|
308
330
|
* - limit?: The maximum number of elements in the response array
|
|
309
331
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
310
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`
|
|
311
334
|
*
|
|
312
335
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
313
336
|
*/
|
|
314
|
-
getAllSubmodelElementsPath(options: {
|
|
337
|
+
getAllSubmodelElementsPath<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
315
338
|
configuration: Configuration;
|
|
316
339
|
submodelIdentifier: string;
|
|
317
340
|
limit?: number;
|
|
318
341
|
cursor?: string;
|
|
319
342
|
level?: SubmodelRepositoryService.GetAllSubmodelElementsPathSubmodelRepoLevelEnum;
|
|
320
|
-
|
|
343
|
+
ifNoneMatch?: IfNoneMatch;
|
|
344
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.GetPathItemsResult, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
321
345
|
/**
|
|
322
346
|
* Creates a new submodel element
|
|
323
347
|
*
|
|
324
348
|
* @param options Object containing:
|
|
325
349
|
* - configuration: The http request options
|
|
326
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
|
|
327
352
|
*
|
|
328
353
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
329
354
|
*/
|
|
@@ -331,6 +356,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
331
356
|
configuration: Configuration;
|
|
332
357
|
submodelIdentifier: string;
|
|
333
358
|
submodelElement: ISubmodelElement;
|
|
359
|
+
ifMatch?: string;
|
|
334
360
|
}): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
|
|
335
361
|
/**
|
|
336
362
|
* Returns a specific submodel element from the Submodel at a specified path
|
|
@@ -341,16 +367,18 @@ export declare class SubmodelRepositoryClient {
|
|
|
341
367
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
342
368
|
* - level?: Determines the structural depth of the respective resource content
|
|
343
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`
|
|
344
371
|
*
|
|
345
372
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
346
373
|
*/
|
|
347
|
-
getSubmodelElementByPath(options: {
|
|
374
|
+
getSubmodelElementByPath<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
348
375
|
configuration: Configuration;
|
|
349
376
|
submodelIdentifier: string;
|
|
350
377
|
idShortPath: string;
|
|
351
378
|
level?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoLevelEnum;
|
|
352
379
|
extent?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoExtentEnum;
|
|
353
|
-
|
|
380
|
+
ifNoneMatch?: IfNoneMatch;
|
|
381
|
+
}): Promise<ConditionalApiResult<ISubmodelElement, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
354
382
|
/**
|
|
355
383
|
* Returns metadata attributes of a specific submodel element
|
|
356
384
|
*
|
|
@@ -358,14 +386,16 @@ export declare class SubmodelRepositoryClient {
|
|
|
358
386
|
* - configuration: The http request options
|
|
359
387
|
* - submodelIdentifier: The Submodel's unique id
|
|
360
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`
|
|
361
390
|
*
|
|
362
391
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
363
392
|
*/
|
|
364
|
-
getSubmodelElementByPathMetadata(options: {
|
|
393
|
+
getSubmodelElementByPathMetadata<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
365
394
|
configuration: Configuration;
|
|
366
395
|
submodelIdentifier: string;
|
|
367
396
|
idShortPath: string;
|
|
368
|
-
|
|
397
|
+
ifNoneMatch?: IfNoneMatch;
|
|
398
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.SubmodelElementMetadata, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
369
399
|
/**
|
|
370
400
|
* Returns a specific submodel element in reference representation
|
|
371
401
|
*
|
|
@@ -373,14 +403,16 @@ export declare class SubmodelRepositoryClient {
|
|
|
373
403
|
* - configuration: The http request options
|
|
374
404
|
* - submodelIdentifier: The Submodel's unique id
|
|
375
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`
|
|
376
407
|
*
|
|
377
408
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
378
409
|
*/
|
|
379
|
-
getSubmodelElementByPathReference(options: {
|
|
410
|
+
getSubmodelElementByPathReference<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
380
411
|
configuration: Configuration;
|
|
381
412
|
submodelIdentifier: string;
|
|
382
413
|
idShortPath: string;
|
|
383
|
-
|
|
414
|
+
ifNoneMatch?: IfNoneMatch;
|
|
415
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
384
416
|
/**
|
|
385
417
|
* Returns a specific submodel element in path representation
|
|
386
418
|
*
|
|
@@ -389,15 +421,17 @@ export declare class SubmodelRepositoryClient {
|
|
|
389
421
|
* - submodelIdentifier: The Submodel's unique id
|
|
390
422
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
391
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`
|
|
392
425
|
*
|
|
393
426
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
394
427
|
*/
|
|
395
|
-
getSubmodelElementByPathPath(options: {
|
|
428
|
+
getSubmodelElementByPathPath<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
396
429
|
configuration: Configuration;
|
|
397
430
|
submodelIdentifier: string;
|
|
398
431
|
idShortPath: string;
|
|
399
432
|
level?: SubmodelRepositoryService.GetSubmodelElementByPathPathSubmodelRepoLevelEnum;
|
|
400
|
-
|
|
433
|
+
ifNoneMatch?: IfNoneMatch;
|
|
434
|
+
}): Promise<ConditionalApiResult<string[], SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
401
435
|
/**
|
|
402
436
|
* Creates a new submodel element at a specified path within submodel elements hierarchy
|
|
403
437
|
*
|
|
@@ -406,6 +440,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
406
440
|
* - submodelIdentifier: The Submodel’s unique id
|
|
407
441
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
408
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
|
|
409
444
|
*
|
|
410
445
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
411
446
|
*/
|
|
@@ -414,6 +449,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
414
449
|
submodelIdentifier: string;
|
|
415
450
|
idShortPath: string;
|
|
416
451
|
submodelElement: ISubmodelElement;
|
|
452
|
+
ifMatch?: string;
|
|
417
453
|
}): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
|
|
418
454
|
/**
|
|
419
455
|
* Deletes a submodel element at a specified path within the submodel elements hierarchy
|
|
@@ -422,6 +458,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
422
458
|
* - configuration: The http request options.
|
|
423
459
|
* - submodelIdentifier: The Submodel’s unique id
|
|
424
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
|
|
425
462
|
*
|
|
426
463
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
427
464
|
*/
|
|
@@ -429,6 +466,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
429
466
|
configuration: Configuration;
|
|
430
467
|
submodelIdentifier: string;
|
|
431
468
|
idShortPath: string;
|
|
469
|
+
ifMatch?: string;
|
|
432
470
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
433
471
|
/**
|
|
434
472
|
* Updates an existing submodel element at a specified path within submodel elements hierarchy
|
|
@@ -439,6 +477,8 @@ export declare class SubmodelRepositoryClient {
|
|
|
439
477
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
440
478
|
* - submodelElement: SubmodelElement object
|
|
441
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)
|
|
442
482
|
*
|
|
443
483
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
444
484
|
*/
|
|
@@ -448,6 +488,8 @@ export declare class SubmodelRepositoryClient {
|
|
|
448
488
|
idShortPath: string;
|
|
449
489
|
submodelElement: ISubmodelElement;
|
|
450
490
|
level?: SubmodelRepositoryService.PutSubmodelElementByPathSubmodelRepoLevelEnum;
|
|
491
|
+
ifMatch?: string;
|
|
492
|
+
ifNoneMatch?: string;
|
|
451
493
|
}): Promise<ApiResult<ISubmodelElement | void, SubmodelRepositoryService.Result>>;
|
|
452
494
|
/**
|
|
453
495
|
* Updates values of an existing submodel element at a specified path
|
|
@@ -458,6 +500,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
458
500
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
459
501
|
* - submodelElement: SubmodelElement object
|
|
460
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
|
|
461
504
|
*
|
|
462
505
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
463
506
|
*/
|
|
@@ -467,6 +510,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
467
510
|
idShortPath: string;
|
|
468
511
|
submodelElement: ISubmodelElement;
|
|
469
512
|
level?: SubmodelRepositoryService.PatchSubmodelElementByPathSubmodelRepoLevelEnum;
|
|
513
|
+
ifMatch?: string;
|
|
470
514
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
471
515
|
/**
|
|
472
516
|
* Returns the metadata attributes of a specific Submodel
|
|
@@ -474,13 +518,15 @@ export declare class SubmodelRepositoryClient {
|
|
|
474
518
|
* @param options Object containing:
|
|
475
519
|
* - configuration: The http request options
|
|
476
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`
|
|
477
522
|
*
|
|
478
523
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
479
524
|
*/
|
|
480
|
-
getSubmodelByIdMetadata(options: {
|
|
525
|
+
getSubmodelByIdMetadata<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
481
526
|
configuration: Configuration;
|
|
482
527
|
submodelIdentifier: string;
|
|
483
|
-
|
|
528
|
+
ifNoneMatch?: IfNoneMatch;
|
|
529
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.SubmodelMetadata, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
484
530
|
/**
|
|
485
531
|
* Updates metadata attributes of an existing Submodel
|
|
486
532
|
*
|
|
@@ -489,6 +535,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
489
535
|
* - submodelIdentifier: The Submodel's unique id
|
|
490
536
|
* - submodelMetadata: SubmodelMetadata object
|
|
491
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
|
|
492
539
|
*
|
|
493
540
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
494
541
|
*/
|
|
@@ -497,6 +544,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
497
544
|
submodelIdentifier: string;
|
|
498
545
|
submodelMetadata: SubmodelRepositoryService.SubmodelMetadata;
|
|
499
546
|
level?: SubmodelRepositoryService.PatchSubmodelByIdMetadataLevelEnum;
|
|
547
|
+
ifMatch?: string;
|
|
500
548
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
501
549
|
/**
|
|
502
550
|
* Returns a specific Submodel in the ValueOnly representation
|
|
@@ -506,15 +554,17 @@ export declare class SubmodelRepositoryClient {
|
|
|
506
554
|
* - submodelIdentifier: The Submodel’s unique id
|
|
507
555
|
* - level?: Determines the structural depth of the respective resource content
|
|
508
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`
|
|
509
558
|
*
|
|
510
559
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
511
560
|
*/
|
|
512
|
-
getSubmodelByIdValueOnly(options: {
|
|
561
|
+
getSubmodelByIdValueOnly<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
513
562
|
configuration: Configuration;
|
|
514
563
|
submodelIdentifier: string;
|
|
515
564
|
level?: SubmodelRepositoryService.GetSubmodelByIdValueOnlyLevelEnum;
|
|
516
565
|
extent?: SubmodelRepositoryService.GetSubmodelByIdValueOnlyExtentEnum;
|
|
517
|
-
|
|
566
|
+
ifNoneMatch?: IfNoneMatch;
|
|
567
|
+
}): Promise<ConditionalApiResult<object, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
518
568
|
/**
|
|
519
569
|
* Updates the values of an existing Submodel
|
|
520
570
|
*
|
|
@@ -523,6 +573,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
523
573
|
* - submodelIdentifier: The Submodel's unique id
|
|
524
574
|
* - body: Value-only payload object
|
|
525
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
|
|
526
577
|
*
|
|
527
578
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
528
579
|
*/
|
|
@@ -531,6 +582,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
531
582
|
submodelIdentifier: string;
|
|
532
583
|
body: object;
|
|
533
584
|
level?: SubmodelRepositoryService.PatchSubmodelByIdValueOnlyLevelEnum;
|
|
585
|
+
ifMatch?: string;
|
|
534
586
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
535
587
|
/**
|
|
536
588
|
* Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
|
|
@@ -541,16 +593,18 @@ export declare class SubmodelRepositoryClient {
|
|
|
541
593
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
542
594
|
* - level?: Determines the structural depth of the respective resource content
|
|
543
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`
|
|
544
597
|
*
|
|
545
598
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
546
599
|
*/
|
|
547
|
-
getSubmodelElementByPathValueOnly(options: {
|
|
600
|
+
getSubmodelElementByPathValueOnly<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
548
601
|
configuration: Configuration;
|
|
549
602
|
submodelIdentifier: string;
|
|
550
603
|
idShortPath: string;
|
|
551
604
|
level?: SubmodelRepositoryService.GetSubmodelElementByPathValueOnlySubmodelRepoLevelEnum;
|
|
552
605
|
extent?: SubmodelRepositoryService.GetSubmodelElementByPathValueOnlySubmodelRepoExtentEnum;
|
|
553
|
-
|
|
606
|
+
ifNoneMatch?: IfNoneMatch;
|
|
607
|
+
}): Promise<ConditionalApiResult<SubmodelRepositoryService.SubmodelElementValue, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
554
608
|
/**
|
|
555
609
|
* Updates the value of an existing SubmodelElement
|
|
556
610
|
*
|
|
@@ -560,6 +614,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
560
614
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
561
615
|
* - submodelElementValue: SubmodelElementValue object
|
|
562
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
|
|
563
618
|
*
|
|
564
619
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
565
620
|
*/
|
|
@@ -569,6 +624,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
569
624
|
idShortPath: string;
|
|
570
625
|
submodelElementValue: SubmodelRepositoryService.SubmodelElementValue;
|
|
571
626
|
level?: SubmodelRepositoryService.PatchSubmodelElementByPathValueOnlySubmodelRepoLevelEnum;
|
|
627
|
+
ifMatch?: string;
|
|
572
628
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
573
629
|
/**
|
|
574
630
|
* Updates metadata attributes of an existing SubmodelElement
|
|
@@ -578,6 +634,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
578
634
|
* - submodelIdentifier: The Submodel's unique id
|
|
579
635
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
580
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
|
|
581
638
|
*
|
|
582
639
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
583
640
|
*/
|
|
@@ -586,6 +643,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
586
643
|
submodelIdentifier: string;
|
|
587
644
|
idShortPath: string;
|
|
588
645
|
submodelElementMetadata: SubmodelRepositoryService.SubmodelElementMetadata;
|
|
646
|
+
ifMatch?: string;
|
|
589
647
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
590
648
|
/**
|
|
591
649
|
* Returns file content for a submodel element at a specified path
|
|
@@ -594,14 +652,16 @@ export declare class SubmodelRepositoryClient {
|
|
|
594
652
|
* - configuration: The http request options
|
|
595
653
|
* - submodelIdentifier: The Submodel's unique id
|
|
596
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`
|
|
597
656
|
*
|
|
598
657
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
599
658
|
*/
|
|
600
|
-
getFileByPath(options: {
|
|
659
|
+
getFileByPath<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
601
660
|
configuration: Configuration;
|
|
602
661
|
submodelIdentifier: string;
|
|
603
662
|
idShortPath: string;
|
|
604
|
-
|
|
663
|
+
ifNoneMatch?: IfNoneMatch;
|
|
664
|
+
}): Promise<ConditionalApiResult<Blob, SubmodelRepositoryService.Result, IfNoneMatch>>;
|
|
605
665
|
/**
|
|
606
666
|
* Updates file content for a submodel element at a specified path
|
|
607
667
|
*
|
|
@@ -611,6 +671,8 @@ export declare class SubmodelRepositoryClient {
|
|
|
611
671
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
612
672
|
* - fileName?: Name of the uploaded file
|
|
613
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)
|
|
614
676
|
*
|
|
615
677
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
616
678
|
*/
|
|
@@ -620,6 +682,8 @@ export declare class SubmodelRepositoryClient {
|
|
|
620
682
|
idShortPath: string;
|
|
621
683
|
fileName?: string;
|
|
622
684
|
file?: Blob;
|
|
685
|
+
ifMatch?: string;
|
|
686
|
+
ifNoneMatch?: string;
|
|
623
687
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
624
688
|
/**
|
|
625
689
|
* Deletes file content of an existing submodel element at a specified path
|
|
@@ -628,6 +692,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
628
692
|
* - configuration: The http request options
|
|
629
693
|
* - submodelIdentifier: The Submodel's unique id
|
|
630
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
|
|
631
696
|
*
|
|
632
697
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
633
698
|
*/
|
|
@@ -635,6 +700,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
635
700
|
configuration: Configuration;
|
|
636
701
|
submodelIdentifier: string;
|
|
637
702
|
idShortPath: string;
|
|
703
|
+
ifMatch?: string;
|
|
638
704
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
639
705
|
/**
|
|
640
706
|
* Synchronously invokes an Operation at a specified path
|
|
@@ -645,6 +711,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
645
711
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
646
712
|
* - operationRequest: Operation request object
|
|
647
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
|
|
648
715
|
*
|
|
649
716
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
650
717
|
*/
|
|
@@ -653,6 +720,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
653
720
|
submodelIdentifier: string;
|
|
654
721
|
idShortPath: string;
|
|
655
722
|
operationRequest: SubmodelRepositoryService.OperationRequest;
|
|
723
|
+
ifMatch?: string;
|
|
656
724
|
}): Promise<ApiResult<SubmodelRepositoryService.OperationResult, SubmodelRepositoryService.Result>>;
|
|
657
725
|
/**
|
|
658
726
|
* Synchronously invokes an Operation at a specified path
|
|
@@ -663,6 +731,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
663
731
|
* - submodelIdentifier: The Submodel’s unique id
|
|
664
732
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
665
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
|
|
666
735
|
*
|
|
667
736
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
668
737
|
*/
|
|
@@ -672,6 +741,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
672
741
|
submodelIdentifier: string;
|
|
673
742
|
idShortPath: string;
|
|
674
743
|
operationRequestValueOnly: SubmodelRepositoryService.OperationRequestValueOnly;
|
|
744
|
+
ifMatch?: string;
|
|
675
745
|
}): Promise<ApiResult<SubmodelRepositoryService.OperationResultValueOnly, SubmodelRepositoryService.Result>>;
|
|
676
746
|
/**
|
|
677
747
|
* Asynchronously invokes an Operation at a specified path
|
|
@@ -681,6 +751,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
681
751
|
* - submodelIdentifier: The Submodel’s unique id
|
|
682
752
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
683
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
|
|
684
755
|
*
|
|
685
756
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
686
757
|
*/
|
|
@@ -689,6 +760,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
689
760
|
submodelIdentifier: string;
|
|
690
761
|
idShortPath: string;
|
|
691
762
|
operationRequest: SubmodelRepositoryService.OperationRequest;
|
|
763
|
+
ifMatch?: string;
|
|
692
764
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
693
765
|
/**
|
|
694
766
|
* Asynchronously invokes an Operation at a specified path
|
|
@@ -699,6 +771,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
699
771
|
* - submodelIdentifier: The Submodel’s unique id
|
|
700
772
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
701
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
|
|
702
775
|
*
|
|
703
776
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
704
777
|
*/
|
|
@@ -708,6 +781,7 @@ export declare class SubmodelRepositoryClient {
|
|
|
708
781
|
submodelIdentifier: string;
|
|
709
782
|
idShortPath: string;
|
|
710
783
|
operationRequestValueOnly: SubmodelRepositoryService.OperationRequestValueOnly;
|
|
784
|
+
ifMatch?: string;
|
|
711
785
|
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
712
786
|
/**
|
|
713
787
|
* Returns status of an asynchronously invoked operation
|