basyx-typescript-sdk 2.2.4 → 2.2.5

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 (58) hide show
  1. package/README.md +115 -0
  2. package/bundle/index.cjs +2479 -1814
  3. package/bundle/index.cjs.map +1 -1
  4. package/bundle/index.mjs +2479 -1814
  5. package/bundle/index.mjs.map +1 -1
  6. package/dist/clients/AasDiscoveryClient.d.ts +3 -2
  7. package/dist/clients/AasDiscoveryClient.js +78 -20
  8. package/dist/clients/AasRegistryClient.d.ts +4 -2
  9. package/dist/clients/AasRegistryClient.js +153 -45
  10. package/dist/clients/AasRepositoryClient.d.ts +73 -16
  11. package/dist/clients/AasRepositoryClient.js +682 -263
  12. package/dist/clients/AasxFileClient.d.ts +18 -0
  13. package/dist/clients/AasxFileClient.js +100 -25
  14. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +3 -1
  15. package/dist/clients/ConceptDescriptionRepositoryClient.js +93 -29
  16. package/dist/clients/SubmodelRegistryClient.d.ts +3 -1
  17. package/dist/clients/SubmodelRegistryClient.js +91 -21
  18. package/dist/clients/SubmodelRepositoryClient.d.ts +229 -22
  19. package/dist/clients/SubmodelRepositoryClient.js +689 -201
  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/errorHandler.js +13 -2
  49. package/dist/models/api.d.ts +4 -2
  50. package/dist/services/AasService.d.ts +21 -1
  51. package/dist/services/AasService.js +114 -26
  52. package/dist/services/SubmodelService.d.ts +21 -1
  53. package/dist/services/SubmodelService.js +119 -21
  54. package/package.json +14 -3
  55. package/dist/generated/AasRegistryService/runtime.d.ts +0 -181
  56. package/dist/generated/AasRegistryService/runtime.js +0 -326
  57. package/dist/generated/AasRepositoryService/runtime.d.ts +0 -181
  58. package/dist/generated/AasRepositoryService/runtime.js +0 -326
@@ -1,16 +1,38 @@
1
1
  import { SubmodelRegistryService } from '../generated';
2
+ import { RequiredError } from '../generated/runtime';
2
3
  import { applyDefaults } from '../lib/apiConfig';
3
4
  import { base64Encode } from '../lib/base64Url';
4
5
  import { convertApiSubmodelDescriptorToCoreSubmodelDescriptor, convertCoreSubmodelDescriptorToApiSubmodelDescriptor, } from '../lib/convertAasDescriptorTypes';
5
6
  import { handleApiError } from '../lib/errorHandler';
6
7
  export class SubmodelRegistryClient {
8
+ static requireIdentifier(value, field) {
9
+ if (value === null || value === undefined || value.trim() === '') {
10
+ throw new RequiredError(field, `Required parameter "${field}" was null, undefined, or empty.`);
11
+ }
12
+ return value;
13
+ }
14
+ static extractStatusCode(err, parsedError) {
15
+ const responseStatus = err?.response?.status;
16
+ if (typeof responseStatus === 'number') {
17
+ return responseStatus;
18
+ }
19
+ if (err instanceof RequiredError || err?.name === 'RequiredError') {
20
+ return 400;
21
+ }
22
+ const code = parsedError?.messages?.[0]?.code;
23
+ if (!code) {
24
+ return undefined;
25
+ }
26
+ const parsedCode = Number.parseInt(code, 10);
27
+ return Number.isNaN(parsedCode) ? undefined : parsedCode;
28
+ }
7
29
  /**
8
30
  * Returns all Submodel Descriptors
9
31
  *
10
32
  * @param options Object containing:
11
33
  * - configuration: The http request options
12
34
  * - limit?: The maximum number of elements in the response array
13
- * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
35
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
14
36
  *
15
37
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
16
38
  */
@@ -18,19 +40,26 @@ export class SubmodelRegistryClient {
18
40
  const { configuration, limit, cursor } = options;
19
41
  try {
20
42
  const apiInstance = new SubmodelRegistryService.SubmodelRegistryAPIApi(applyDefaults(configuration));
21
- const result = await apiInstance.getAllSubmodelDescriptors({
43
+ const response = await apiInstance.getAllSubmodelDescriptorsRaw({
22
44
  limit: limit,
23
45
  cursor: cursor,
24
46
  });
47
+ const result = await response.value();
25
48
  const submodelDescriptors = (result.result ?? []).map(convertApiSubmodelDescriptorToCoreSubmodelDescriptor);
49
+ const pagedResult = result.paging_metadata;
26
50
  return {
27
51
  success: true,
28
- data: { pagedResult: result.pagingMetadata, result: submodelDescriptors },
52
+ data: { pagedResult, result: submodelDescriptors },
53
+ statusCode: response.raw.status,
29
54
  };
30
55
  }
31
56
  catch (err) {
32
57
  const customError = await handleApiError(err);
33
- return { success: false, error: customError };
58
+ return {
59
+ success: false,
60
+ error: customError,
61
+ statusCode: SubmodelRegistryClient.extractStatusCode(err, customError),
62
+ };
34
63
  }
35
64
  }
36
65
  /**
@@ -46,14 +75,23 @@ export class SubmodelRegistryClient {
46
75
  const { configuration, submodelDescriptor } = options;
47
76
  try {
48
77
  const apiInstance = new SubmodelRegistryService.SubmodelRegistryAPIApi(applyDefaults(configuration));
49
- const result = await apiInstance.postSubmodelDescriptor({
78
+ const response = await apiInstance.postSubmodelDescriptorRaw({
50
79
  submodelDescriptor: convertCoreSubmodelDescriptorToApiSubmodelDescriptor(submodelDescriptor),
51
80
  });
52
- return { success: true, data: convertApiSubmodelDescriptorToCoreSubmodelDescriptor(result) };
81
+ const result = await response.value();
82
+ return {
83
+ success: true,
84
+ data: convertApiSubmodelDescriptorToCoreSubmodelDescriptor(result),
85
+ statusCode: response.raw.status,
86
+ };
53
87
  }
54
88
  catch (err) {
55
89
  const customError = await handleApiError(err);
56
- return { success: false, error: customError };
90
+ return {
91
+ success: false,
92
+ error: customError,
93
+ statusCode: SubmodelRegistryClient.extractStatusCode(err, customError),
94
+ };
57
95
  }
58
96
  }
59
97
  /**
@@ -69,15 +107,20 @@ export class SubmodelRegistryClient {
69
107
  const { configuration, submodelIdentifier } = options;
70
108
  try {
71
109
  const apiInstance = new SubmodelRegistryService.SubmodelRegistryAPIApi(applyDefaults(configuration));
72
- const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
73
- const result = await apiInstance.deleteSubmodelDescriptorById({
110
+ const encodedSubmodelIdentifier = base64Encode(SubmodelRegistryClient.requireIdentifier(submodelIdentifier, 'submodelIdentifier'));
111
+ const response = await apiInstance.deleteSubmodelDescriptorByIdRaw({
74
112
  submodelIdentifier: encodedSubmodelIdentifier,
75
113
  });
76
- return { success: true, data: result };
114
+ const result = await response.value();
115
+ return { success: true, data: result, statusCode: response.raw.status };
77
116
  }
78
117
  catch (err) {
79
118
  const customError = await handleApiError(err);
80
- return { success: false, error: customError };
119
+ return {
120
+ success: false,
121
+ error: customError,
122
+ statusCode: SubmodelRegistryClient.extractStatusCode(err, customError),
123
+ };
81
124
  }
82
125
  }
83
126
  /**
@@ -93,15 +136,24 @@ export class SubmodelRegistryClient {
93
136
  const { configuration, submodelIdentifier } = options;
94
137
  try {
95
138
  const apiInstance = new SubmodelRegistryService.SubmodelRegistryAPIApi(applyDefaults(configuration));
96
- const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
97
- const result = await apiInstance.getSubmodelDescriptorById({
139
+ const encodedSubmodelIdentifier = base64Encode(SubmodelRegistryClient.requireIdentifier(submodelIdentifier, 'submodelIdentifier'));
140
+ const response = await apiInstance.getSubmodelDescriptorByIdRaw({
98
141
  submodelIdentifier: encodedSubmodelIdentifier,
99
142
  });
100
- return { success: true, data: convertApiSubmodelDescriptorToCoreSubmodelDescriptor(result) };
143
+ const result = await response.value();
144
+ return {
145
+ success: true,
146
+ data: convertApiSubmodelDescriptorToCoreSubmodelDescriptor(result),
147
+ statusCode: response.raw.status,
148
+ };
101
149
  }
102
150
  catch (err) {
103
151
  const customError = await handleApiError(err);
104
- return { success: false, error: customError };
152
+ return {
153
+ success: false,
154
+ error: customError,
155
+ statusCode: SubmodelRegistryClient.extractStatusCode(err, customError),
156
+ };
105
157
  }
106
158
  }
107
159
  /**
@@ -118,19 +170,32 @@ export class SubmodelRegistryClient {
118
170
  const { configuration, submodelIdentifier, submodelDescriptor } = options;
119
171
  try {
120
172
  const apiInstance = new SubmodelRegistryService.SubmodelRegistryAPIApi(applyDefaults(configuration));
121
- const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
122
- const result = await apiInstance.putSubmodelDescriptorById({
173
+ const encodedSubmodelIdentifier = base64Encode(SubmodelRegistryClient.requireIdentifier(submodelIdentifier, 'submodelIdentifier'));
174
+ const response = await apiInstance.putSubmodelDescriptorByIdRaw({
123
175
  submodelIdentifier: encodedSubmodelIdentifier,
124
176
  submodelDescriptor: convertCoreSubmodelDescriptorToApiSubmodelDescriptor(submodelDescriptor),
125
177
  });
178
+ if (response.raw.status === 204) {
179
+ return {
180
+ success: true,
181
+ data: undefined,
182
+ statusCode: response.raw.status,
183
+ };
184
+ }
185
+ const result = await response.value();
126
186
  return {
127
187
  success: true,
128
188
  data: result ? convertApiSubmodelDescriptorToCoreSubmodelDescriptor(result) : undefined,
189
+ statusCode: response.raw.status,
129
190
  };
130
191
  }
131
192
  catch (err) {
132
193
  const customError = await handleApiError(err);
133
- return { success: false, error: customError };
194
+ return {
195
+ success: false,
196
+ error: customError,
197
+ statusCode: SubmodelRegistryClient.extractStatusCode(err, customError),
198
+ };
134
199
  }
135
200
  }
136
201
  /**
@@ -145,12 +210,17 @@ export class SubmodelRegistryClient {
145
210
  const { configuration } = options;
146
211
  try {
147
212
  const apiInstance = new SubmodelRegistryService.DescriptionAPIApi(applyDefaults(configuration));
148
- const result = await apiInstance.getSelfDescription();
149
- return { success: true, data: result };
213
+ const response = await apiInstance.getSelfDescriptionRaw();
214
+ const result = await response.value();
215
+ return { success: true, data: result, statusCode: response.raw.status };
150
216
  }
151
217
  catch (err) {
152
218
  const customError = await handleApiError(err);
153
- return { success: false, error: customError };
219
+ return {
220
+ success: false,
221
+ error: customError,
222
+ statusCode: SubmodelRegistryClient.extractStatusCode(err, customError),
223
+ };
154
224
  }
155
225
  }
156
226
  }
@@ -3,6 +3,8 @@ import type { ApiResult } 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;
@@ -118,6 +160,12 @@ export declare class SubmodelRepositoryClient {
118
160
  }): Promise<ApiResult<Submodel, SubmodelRepositoryService.Result>>;
119
161
  /**
120
162
  * Returns a specific Submodel in reference representation
163
+ *
164
+ * @param options Object containing:
165
+ * - configuration: The http request options
166
+ * - submodelIdentifier: The Submodel's unique id
167
+ *
168
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
121
169
  */
122
170
  getSubmodelByIdReference(options: {
123
171
  configuration: Configuration;
@@ -125,6 +173,13 @@ export declare class SubmodelRepositoryClient {
125
173
  }): Promise<ApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result>>;
126
174
  /**
127
175
  * Returns a specific Submodel in path representation
176
+ *
177
+ * @param options Object containing:
178
+ * - configuration: The http request options
179
+ * - submodelIdentifier: The Submodel's unique id
180
+ * - level?: Determines the structural depth of the respective resource content
181
+ *
182
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
128
183
  */
129
184
  getSubmodelByIdPath(options: {
130
185
  configuration: Configuration;
@@ -148,6 +203,14 @@ export declare class SubmodelRepositoryClient {
148
203
  }): Promise<ApiResult<Submodel | void, SubmodelRepositoryService.Result>>;
149
204
  /**
150
205
  * Updates an existing Submodel partially
206
+ *
207
+ * @param options Object containing:
208
+ * - configuration: The http request options
209
+ * - submodelIdentifier: The Submodel's unique id
210
+ * - submodel: Submodel object
211
+ * - level?: Determines the structural depth of the respective resource content
212
+ *
213
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
151
214
  */
152
215
  patchSubmodelById(options: {
153
216
  configuration: Configuration;
@@ -162,7 +225,7 @@ export declare class SubmodelRepositoryClient {
162
225
  * - configuration: The http request options
163
226
  * - submodelIdentifier: The Submodel’s unique id
164
227
  * - 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
228
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
166
229
  * - level?: Determines the structural depth of the respective resource content
167
230
  * - extent?: Determines to which extent the resource is being serialized
168
231
  *
@@ -181,6 +244,14 @@ export declare class SubmodelRepositoryClient {
181
244
  }, SubmodelRepositoryService.Result>>;
182
245
  /**
183
246
  * Returns all submodel elements in metadata representation
247
+ *
248
+ * @param options Object containing:
249
+ * - configuration: The http request options
250
+ * - submodelIdentifier: The Submodel's unique id
251
+ * - limit?: The maximum number of elements in the response array
252
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
253
+ *
254
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
184
255
  */
185
256
  getAllSubmodelElementsMetadata(options: {
186
257
  configuration: Configuration;
@@ -190,6 +261,16 @@ export declare class SubmodelRepositoryClient {
190
261
  }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelElementsMetadataResult, SubmodelRepositoryService.Result>>;
191
262
  /**
192
263
  * Returns all submodel elements in value-only representation
264
+ *
265
+ * @param options Object containing:
266
+ * - configuration: The http request options
267
+ * - submodelIdentifier: The Submodel's unique id
268
+ * - limit?: The maximum number of elements in the response array
269
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
270
+ * - level?: Determines the structural depth of the respective resource content
271
+ * - extent?: Determines to which extent the resource is being serialized
272
+ *
273
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
193
274
  */
194
275
  getAllSubmodelElementsValueOnly(options: {
195
276
  configuration: Configuration;
@@ -201,6 +282,15 @@ export declare class SubmodelRepositoryClient {
201
282
  }): Promise<ApiResult<SubmodelRepositoryService.GetSubmodelElementsValueResult, SubmodelRepositoryService.Result>>;
202
283
  /**
203
284
  * Returns references to all submodel elements
285
+ *
286
+ * @param options Object containing:
287
+ * - configuration: The http request options
288
+ * - submodelIdentifier: The Submodel's unique id
289
+ * - limit?: The maximum number of elements in the response array
290
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
291
+ * - level?: Determines the structural depth of the respective resource content
292
+ *
293
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
204
294
  */
205
295
  getAllSubmodelElementsReference(options: {
206
296
  configuration: Configuration;
@@ -211,6 +301,15 @@ export declare class SubmodelRepositoryClient {
211
301
  }): Promise<ApiResult<SubmodelRepositoryService.GetReferencesResult, SubmodelRepositoryService.Result>>;
212
302
  /**
213
303
  * Returns paths of all submodel elements
304
+ *
305
+ * @param options Object containing:
306
+ * - configuration: The http request options
307
+ * - submodelIdentifier: The Submodel's unique id
308
+ * - limit?: The maximum number of elements in the response array
309
+ * - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
310
+ * - level?: Determines the structural depth of the respective resource content
311
+ *
312
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
214
313
  */
215
314
  getAllSubmodelElementsPath(options: {
216
315
  configuration: Configuration;
@@ -254,6 +353,13 @@ export declare class SubmodelRepositoryClient {
254
353
  }): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
255
354
  /**
256
355
  * Returns metadata attributes of a specific submodel element
356
+ *
357
+ * @param options Object containing:
358
+ * - configuration: The http request options
359
+ * - submodelIdentifier: The Submodel's unique id
360
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
361
+ *
362
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
257
363
  */
258
364
  getSubmodelElementByPathMetadata(options: {
259
365
  configuration: Configuration;
@@ -262,6 +368,13 @@ export declare class SubmodelRepositoryClient {
262
368
  }): Promise<ApiResult<SubmodelRepositoryService.SubmodelElementMetadata, SubmodelRepositoryService.Result>>;
263
369
  /**
264
370
  * Returns a specific submodel element in reference representation
371
+ *
372
+ * @param options Object containing:
373
+ * - configuration: The http request options
374
+ * - submodelIdentifier: The Submodel's unique id
375
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
376
+ *
377
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
265
378
  */
266
379
  getSubmodelElementByPathReference(options: {
267
380
  configuration: Configuration;
@@ -270,6 +383,14 @@ export declare class SubmodelRepositoryClient {
270
383
  }): Promise<ApiResult<SubmodelRepositoryService.Reference, SubmodelRepositoryService.Result>>;
271
384
  /**
272
385
  * Returns a specific submodel element in path representation
386
+ *
387
+ * @param options Object containing:
388
+ * - configuration: The http request options
389
+ * - submodelIdentifier: The Submodel's unique id
390
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
391
+ * - level?: Determines the structural depth of the respective resource content
392
+ *
393
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
273
394
  */
274
395
  getSubmodelElementByPathPath(options: {
275
396
  configuration: Configuration;
@@ -330,6 +451,15 @@ export declare class SubmodelRepositoryClient {
330
451
  }): Promise<ApiResult<ISubmodelElement | void, SubmodelRepositoryService.Result>>;
331
452
  /**
332
453
  * Updates values of an existing submodel element at a specified path
454
+ *
455
+ * @param options Object containing:
456
+ * - configuration: The http request options
457
+ * - submodelIdentifier: The Submodel's unique id
458
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
459
+ * - submodelElement: SubmodelElement object
460
+ * - level?: Determines the structural depth of the respective resource content
461
+ *
462
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
333
463
  */
334
464
  patchSubmodelElementByPath(options: {
335
465
  configuration: Configuration;
@@ -353,6 +483,14 @@ export declare class SubmodelRepositoryClient {
353
483
  }): Promise<ApiResult<SubmodelRepositoryService.SubmodelMetadata, SubmodelRepositoryService.Result>>;
354
484
  /**
355
485
  * Updates metadata attributes of an existing Submodel
486
+ *
487
+ * @param options Object containing:
488
+ * - configuration: The http request options
489
+ * - submodelIdentifier: The Submodel's unique id
490
+ * - submodelMetadata: SubmodelMetadata object
491
+ * - level?: Determines the structural depth of the respective resource content
492
+ *
493
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
356
494
  */
357
495
  patchSubmodelByIdMetadata(options: {
358
496
  configuration: Configuration;
@@ -378,15 +516,16 @@ export declare class SubmodelRepositoryClient {
378
516
  extent?: SubmodelRepositoryService.GetSubmodelByIdValueOnlyExtentEnum;
379
517
  }): Promise<ApiResult<object, SubmodelRepositoryService.Result>>;
380
518
  /**
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
- // */
519
+ * Updates the values of an existing Submodel
520
+ *
521
+ * @param options Object containing:
522
+ * - configuration: The http request options
523
+ * - submodelIdentifier: The Submodel's unique id
524
+ * - body: Value-only payload object
525
+ * - level?: Determines the structural depth of the respective resource content
526
+ *
527
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
528
+ */
390
529
  patchSubmodelByIdValueOnly(options: {
391
530
  configuration: Configuration;
392
531
  submodelIdentifier: string;
@@ -413,17 +552,17 @@ export declare class SubmodelRepositoryClient {
413
552
  extent?: SubmodelRepositoryService.GetSubmodelElementByPathValueOnlySubmodelRepoExtentEnum;
414
553
  }): Promise<ApiResult<SubmodelRepositoryService.SubmodelElementValue, SubmodelRepositoryService.Result>>;
415
554
  /**
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
- // */
555
+ * Updates the value of an existing SubmodelElement
556
+ *
557
+ * @param options Object containing:
558
+ * - configuration: The http request options
559
+ * - submodelIdentifier: The Submodel's unique id
560
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
561
+ * - submodelElementValue: SubmodelElementValue object
562
+ * - level?: Determines the structural depth of the respective resource content
563
+ *
564
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
565
+ */
427
566
  patchSubmodelElementByPathValueOnly(options: {
428
567
  configuration: Configuration;
429
568
  submodelIdentifier: string;
@@ -433,6 +572,14 @@ export declare class SubmodelRepositoryClient {
433
572
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
434
573
  /**
435
574
  * Updates metadata attributes of an existing SubmodelElement
575
+ *
576
+ * @param options Object containing:
577
+ * - configuration: The http request options
578
+ * - submodelIdentifier: The Submodel's unique id
579
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
580
+ * - submodelElementMetadata: SubmodelElementMetadata object
581
+ *
582
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
436
583
  */
437
584
  patchSubmodelElementByPathMetadata(options: {
438
585
  configuration: Configuration;
@@ -442,6 +589,13 @@ export declare class SubmodelRepositoryClient {
442
589
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
443
590
  /**
444
591
  * Returns file content for a submodel element at a specified path
592
+ *
593
+ * @param options Object containing:
594
+ * - configuration: The http request options
595
+ * - submodelIdentifier: The Submodel's unique id
596
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
597
+ *
598
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
445
599
  */
446
600
  getFileByPath(options: {
447
601
  configuration: Configuration;
@@ -450,6 +604,15 @@ export declare class SubmodelRepositoryClient {
450
604
  }): Promise<ApiResult<Blob, SubmodelRepositoryService.Result>>;
451
605
  /**
452
606
  * Updates file content for a submodel element at a specified path
607
+ *
608
+ * @param options Object containing:
609
+ * - configuration: The http request options
610
+ * - submodelIdentifier: The Submodel's unique id
611
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
612
+ * - fileName?: Name of the uploaded file
613
+ * - file?: File content
614
+ *
615
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
453
616
  */
454
617
  putFileByPath(options: {
455
618
  configuration: Configuration;
@@ -460,6 +623,13 @@ export declare class SubmodelRepositoryClient {
460
623
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
461
624
  /**
462
625
  * Deletes file content of an existing submodel element at a specified path
626
+ *
627
+ * @param options Object containing:
628
+ * - configuration: The http request options
629
+ * - submodelIdentifier: The Submodel's unique id
630
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
631
+ *
632
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
463
633
  */
464
634
  deleteFileByPath(options: {
465
635
  configuration: Configuration;
@@ -541,6 +711,14 @@ export declare class SubmodelRepositoryClient {
541
711
  }): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
542
712
  /**
543
713
  * Returns status of an asynchronously invoked operation
714
+ *
715
+ * @param options Object containing:
716
+ * - configuration: The http request options
717
+ * - submodelIdentifier: The Submodel's unique id
718
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
719
+ * - handleId: Identifier of the asynchronous invocation handle
720
+ *
721
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
544
722
  */
545
723
  getOperationAsyncStatus(options: {
546
724
  configuration: Configuration;
@@ -550,6 +728,14 @@ export declare class SubmodelRepositoryClient {
550
728
  }): Promise<ApiResult<SubmodelRepositoryService.BaseOperationResult, SubmodelRepositoryService.Result>>;
551
729
  /**
552
730
  * Returns result of an asynchronously invoked operation
731
+ *
732
+ * @param options Object containing:
733
+ * - configuration: The http request options
734
+ * - submodelIdentifier: The Submodel's unique id
735
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
736
+ * - handleId: Identifier of the asynchronous invocation handle
737
+ *
738
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
553
739
  */
554
740
  getOperationAsyncResult(options: {
555
741
  configuration: Configuration;
@@ -559,6 +745,14 @@ export declare class SubmodelRepositoryClient {
559
745
  }): Promise<ApiResult<SubmodelRepositoryService.OperationResult, SubmodelRepositoryService.Result>>;
560
746
  /**
561
747
  * Returns result of an asynchronously invoked operation in value-only representation
748
+ *
749
+ * @param options Object containing:
750
+ * - configuration: The http request options
751
+ * - submodelIdentifier: The Submodel's unique id
752
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
753
+ * - handleId: Identifier of the asynchronous invocation handle
754
+ *
755
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
562
756
  */
563
757
  getOperationAsyncResultValueOnly(options: {
564
758
  configuration: Configuration;
@@ -568,6 +762,14 @@ export declare class SubmodelRepositoryClient {
568
762
  }): Promise<ApiResult<SubmodelRepositoryService.OperationResultValueOnly, SubmodelRepositoryService.Result>>;
569
763
  /**
570
764
  * Returns an appropriate serialization based on the specified format
765
+ *
766
+ * @param options Object containing:
767
+ * - configuration: The http request options
768
+ * - aasIds?: Asset Administration Shell IDs
769
+ * - submodelIds?: Submodel IDs
770
+ * - includeConceptDescriptions?: Whether to include referenced ConceptDescriptions in the serialization result
771
+ *
772
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
571
773
  */
572
774
  generateSerializationByIds(options: {
573
775
  configuration: Configuration;
@@ -577,6 +779,11 @@ export declare class SubmodelRepositoryClient {
577
779
  }): Promise<ApiResult<Blob, SubmodelRepositoryService.Result>>;
578
780
  /**
579
781
  * Returns the self-describing information of a network resource (ServiceDescription)
782
+ *
783
+ * @param options Object containing:
784
+ * - configuration: The http request options
785
+ *
786
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
580
787
  */
581
788
  getSelfDescription(options: {
582
789
  configuration: Configuration;