basyx-typescript-sdk 0.2.2 → 1.0.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 (143) hide show
  1. package/README.md +19 -12
  2. package/bundle/index.js +15444 -866
  3. package/bundle/index.js.map +1 -1
  4. package/dist/clients/AasDiscoveryClient.d.ts +68 -0
  5. package/dist/clients/AasDiscoveryClient.js +115 -0
  6. package/dist/clients/AasRegistryClient.d.ts +164 -0
  7. package/dist/clients/AasRegistryClient.js +287 -0
  8. package/dist/clients/AasRepositoryClient.d.ts +791 -103
  9. package/dist/clients/AasRepositoryClient.js +1323 -215
  10. package/dist/clients/AasxFileClient.d.ts +82 -0
  11. package/dist/clients/AasxFileClient.js +148 -0
  12. package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +84 -0
  13. package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
  14. package/dist/clients/SubmodelRegistryClient.d.ts +78 -0
  15. package/dist/clients/SubmodelRegistryClient.js +138 -0
  16. package/dist/clients/SubmodelRepositoryClient.d.ts +355 -0
  17. package/dist/clients/SubmodelRepositoryClient.js +585 -0
  18. package/dist/clients/index.d.ts +6 -0
  19. package/dist/clients/index.js +6 -0
  20. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +80 -0
  21. package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +156 -0
  22. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +26 -0
  23. package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +40 -0
  24. package/dist/generated/AasDiscoveryService/apis/index.d.ts +2 -0
  25. package/dist/generated/AasDiscoveryService/apis/index.js +4 -0
  26. package/dist/generated/AasDiscoveryService/index.d.ts +2 -0
  27. package/dist/generated/AasDiscoveryService/index.js +4 -0
  28. package/dist/generated/AasDiscoveryService/models/index.d.ts +297 -0
  29. package/dist/generated/AasDiscoveryService/models/index.js +48 -0
  30. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
  31. package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
  32. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  33. package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
  34. package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
  35. package/dist/generated/AasRegistryService/apis/index.js +4 -0
  36. package/dist/generated/AasRegistryService/index.d.ts +2 -0
  37. package/dist/generated/AasRegistryService/index.js +4 -0
  38. package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
  39. package/dist/generated/AasRegistryService/models/index.js +151 -0
  40. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +870 -0
  41. package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
  42. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  43. package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
  44. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  45. package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
  46. package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
  47. package/dist/generated/AasRepositoryService/apis/index.js +5 -0
  48. package/dist/generated/AasRepositoryService/index.d.ts +2 -0
  49. package/dist/generated/AasRepositoryService/index.js +4 -0
  50. package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
  51. package/dist/generated/AasRepositoryService/models/index.js +221 -0
  52. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
  53. package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
  54. package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
  55. package/dist/generated/AasxFileService/apis/index.js +3 -0
  56. package/dist/generated/AasxFileService/index.d.ts +2 -0
  57. package/dist/generated/AasxFileService/index.js +4 -0
  58. package/dist/generated/AasxFileService/models/index.d.ts +80 -0
  59. package/dist/generated/AasxFileService/models/index.js +10 -0
  60. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
  61. package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
  62. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  63. package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
  64. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  65. package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
  66. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
  67. package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
  68. package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +2 -0
  69. package/dist/generated/ConceptDescriptionRepositoryService/index.js +3 -0
  70. package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
  71. package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
  72. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
  73. package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
  74. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
  75. package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
  76. package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
  77. package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
  78. package/dist/generated/SubmodelRegistryService/index.d.ts +2 -0
  79. package/dist/generated/SubmodelRegistryService/index.js +4 -0
  80. package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
  81. package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
  82. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
  83. package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
  84. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
  85. package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
  86. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
  87. package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
  88. package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
  89. package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
  90. package/dist/generated/SubmodelRepositoryService/index.d.ts +2 -0
  91. package/dist/generated/SubmodelRepositoryService/index.js +4 -0
  92. package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
  93. package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
  94. package/dist/generated/index.d.ts +9 -2
  95. package/dist/generated/index.js +9 -3
  96. package/dist/generated/runtime.d.ts +181 -0
  97. package/dist/generated/runtime.js +326 -0
  98. package/dist/index.d.ts +1 -1
  99. package/dist/index.js +1 -1
  100. package/dist/lib/apiConfig.d.ts +2 -0
  101. package/dist/lib/apiConfig.js +23 -0
  102. package/dist/lib/base64Url.js +4 -0
  103. package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
  104. package/dist/lib/convertAasDescriptorTypes.js +76 -0
  105. package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
  106. package/dist/lib/convertAasDiscoveryTypes.js +39 -0
  107. package/dist/lib/convertAasTypes.d.ts +7 -7
  108. package/dist/lib/convertAasTypes.js +5 -0
  109. package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
  110. package/dist/lib/convertConceptDescriptionTypes.js +39 -0
  111. package/dist/lib/convertSubmodelTypes.d.ts +34 -0
  112. package/dist/lib/convertSubmodelTypes.js +69 -0
  113. package/dist/lib/descriptorJsonization.d.ts +12 -0
  114. package/dist/lib/descriptorJsonization.js +172 -0
  115. package/dist/lib/errorHandler.d.ts +9 -0
  116. package/dist/lib/errorHandler.js +94 -0
  117. package/dist/models/Descriptors.d.ts +51 -0
  118. package/dist/models/Descriptors.js +56 -0
  119. package/dist/models/index.d.ts +0 -1
  120. package/dist/models/index.js +0 -1
  121. package/dist/utils/DescriptorUtils.d.ts +9 -0
  122. package/dist/utils/DescriptorUtils.js +37 -0
  123. package/dist/utils/KeyTypesUtil.d.ts +24 -0
  124. package/dist/utils/KeyTypesUtil.js +55 -0
  125. package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
  126. package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
  127. package/dist/utils/ReferableUtils.d.ts +69 -0
  128. package/dist/utils/ReferableUtils.js +220 -0
  129. package/dist/utils/ReferenceUtil.d.ts +9 -0
  130. package/dist/utils/ReferenceUtil.js +22 -0
  131. package/dist/utils/SemanticIdUtils.d.ts +119 -0
  132. package/dist/utils/SemanticIdUtils.js +363 -0
  133. package/package.json +14 -11
  134. package/dist/generated/schemas.gen.d.ts +0 -2357
  135. package/dist/generated/schemas.gen.js +0 -2789
  136. package/dist/generated/sdk.gen.d.ts +0 -822
  137. package/dist/generated/sdk.gen.js +0 -2225
  138. package/dist/generated/types.gen.d.ts +0 -10829
  139. package/dist/generated/types.gen.js +0 -2
  140. package/dist/lib/createAasRepoClient.d.ts +0 -9
  141. package/dist/lib/createAasRepoClient.js +0 -15
  142. package/dist/models/aas-repository.d.ts +0 -65
  143. package/dist/models/aas-repository.js +0 -1
@@ -1,227 +1,915 @@
1
- import type { AssetAdministrationShell, AssetInformation, Reference } from '@aas-core-works/aas-core3.0-typescript/types';
1
+ import type { AssetAdministrationShell, AssetInformation, ISubmodelElement, Reference, Submodel } from '@aas-core-works/aas-core3.0-typescript/types';
2
2
  import type { ApiResult } from '../models/api';
3
3
  import type { AssetId } from '../models/AssetId';
4
- import * as AasRepository from '../generated';
4
+ import { AasRepositoryService } from '../generated';
5
+ import { Configuration } from '../generated/runtime';
5
6
  export declare class AasRepositoryClient {
6
7
  /**
7
- * Returns all Asset Administration Shells.
8
+ * Returns all Asset Administration Shells
8
9
  *
9
10
  * @param options Object containing:
10
- * - baseUrl: The API base URL
11
- * - headers?: Optional Request headers
12
- * - assetIds?: A list of asset identifiers
13
- * - idShort?: The AAS's idShort
14
- * - limit?: Max number of elements to return
15
- * - cursor?: A paging cursor from previous responses
11
+ * - configuration: The http request options
12
+ * - assetIds?: A list of specific Asset identifiers
13
+ * - idShort?: The Asset Administration Shell’s IdShort
14
+ * - limit?: The maximum number of elements in the response array
15
+ * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
16
16
  *
17
17
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
18
18
  */
19
19
  getAllAssetAdministrationShells(options: {
20
- baseUrl: string;
21
- headers?: Headers;
20
+ configuration: Configuration;
22
21
  assetIds?: AssetId[];
23
22
  idShort?: string;
24
23
  limit?: number;
25
24
  cursor?: string;
26
25
  }): Promise<ApiResult<{
27
- pagedResult: AasRepository.PagedResultPagingMetadata | undefined;
26
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
28
27
  result: AssetAdministrationShell[];
29
- }, AasRepository.GetAllAssetAdministrationShellsError | Error>>;
28
+ }, AasRepositoryService.Result>>;
30
29
  /**
31
- * Creates a new Asset Administration Shell.
30
+ * Creates a new Asset Administration Shell
32
31
  *
33
32
  * @param options Object containing:
34
- * - baseUrl: The API base URL
35
- * - assetAdministrationShell: The AAS to create
36
- * - headers?: Optional request headers
33
+ * - configuration: The http request options.
34
+ * - assetAdministrationShell: Asset Administration Shell object
37
35
  *
38
36
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
39
37
  */
40
38
  postAssetAdministrationShell(options: {
41
- baseUrl: string;
42
- headers?: Headers;
39
+ configuration: Configuration;
43
40
  assetAdministrationShell: AssetAdministrationShell;
44
- }): Promise<ApiResult<AssetAdministrationShell, AasRepository.PostAssetAdministrationShellError | Error>>;
41
+ }): Promise<ApiResult<AssetAdministrationShell, AasRepositoryService.Result>>;
45
42
  /**
46
- * Deletes an Asset Administration Shell by its unique identifier.
43
+ * Deletes an Asset Administration Shell
47
44
  *
48
45
  * @param options Object containing:
49
- * - baseUrl: The API base URL
50
- * - aasIdentifier: The unique ID for the AAS
51
- * - headers?: Optional request headers
46
+ * - configuration: The http request options
47
+ * - aasIdentifier: The Asset Administration Shell’s unique id
52
48
  *
53
49
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
54
50
  */
55
51
  deleteAssetAdministrationShellById(options: {
56
- baseUrl: string;
52
+ configuration: Configuration;
57
53
  aasIdentifier: string;
58
- headers?: Headers;
59
- }): Promise<ApiResult<AasRepository.DeleteAssetAdministrationShellByIdResponse, AasRepository.DeleteAssetAdministrationShellByIdError | Error>>;
54
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
60
55
  /**
61
- * Returns a specific Asset Administration Shell by its unique identifier.
56
+ * Returns a specific Asset Administration Shell
62
57
  *
63
58
  * @param options Object containing:
64
- * - baseUrl: The API base URL
65
- * - aasIdentifier: The unique ID
66
- * - headers?: Optional request headers
59
+ * - configuration: The http request options
60
+ * - aasIdentifier: The Asset Administration Shell’s unique id
67
61
  *
68
62
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
69
63
  */
70
64
  getAssetAdministrationShellById(options: {
71
- baseUrl: string;
65
+ configuration: Configuration;
72
66
  aasIdentifier: string;
73
- headers?: Headers;
74
- }): Promise<ApiResult<AssetAdministrationShell, AasRepository.GetAssetAdministrationShellByIdError | Error>>;
67
+ }): Promise<ApiResult<AssetAdministrationShell, AasRepositoryService.Result>>;
75
68
  /**
76
- * Updates an existing Asset Administration Shell by ID (PUT).
69
+ * Updates an existing Asset Administration Shell
77
70
  *
78
71
  * @param options Object containing:
79
- * - baseUrl: The API base URL
80
- * - aasIdentifier: The unique ID
81
- * - assetAdministrationShell: The updated AAS object
82
- * - headers?: Optional request headers
72
+ * - configuration: The http request options
73
+ * - aasIdentifier: The Asset Administration Shell’s unique id
74
+ * - assetAdministrationShell: Asset Administration Shell object
83
75
  *
84
76
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
85
77
  */
86
78
  putAssetAdministrationShellById(options: {
87
- baseUrl: string;
79
+ configuration: Configuration;
88
80
  aasIdentifier: string;
89
81
  assetAdministrationShell: AssetAdministrationShell;
90
- headers?: Headers;
91
- }): Promise<ApiResult<AasRepository.PutAssetAdministrationShellByIdResponse, AasRepository.PutAssetAdministrationShellByIdError | Error>>;
82
+ }): Promise<ApiResult<AssetAdministrationShell | void, AasRepositoryService.Result>>;
92
83
  /**
93
- * Returns the AssetInformation for the given AAS.
84
+ * Returns the Asset Information
94
85
  *
95
86
  * @param options Object containing:
96
- * - baseUrl: The API base URL
97
- * - aasIdentifier: The unique ID
98
- * - headers?: Optional request headers
87
+ * - configuration: The http request options
88
+ * - aasIdentifier: The Asset Administration Shell’s unique id
99
89
  *
100
90
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
101
91
  */
102
92
  getAssetInformation(options: {
103
- baseUrl: string;
93
+ configuration: Configuration;
104
94
  aasIdentifier: string;
105
- headers?: Headers;
106
- }): Promise<ApiResult<AssetInformation, AasRepository.GetAssetInformationAasRepositoryError | Error>>;
95
+ }): Promise<ApiResult<AssetInformation, AasRepositoryService.Result>>;
107
96
  /**
108
- * Updates the AssetInformation for the given AAS.
97
+ * Updates the Asset Information
109
98
  *
110
99
  * @param options Object containing:
111
- * - baseUrl: The API base URL
112
- * - aasIdentifier: The unique ID
113
- * - assetInformation: The updated AssetInformation object
114
- * - headers?: Optional request headers
100
+ * - configuration: The http request options
101
+ * - aasIdentifier: The Asset Administration Shell’s unique id
102
+ * - assetInformation: Asset Information object
115
103
  *
116
104
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
117
105
  */
118
106
  putAssetInformation(options: {
119
- baseUrl: string;
107
+ configuration: Configuration;
120
108
  aasIdentifier: string;
121
109
  assetInformation: AssetInformation;
122
- headers?: Headers;
123
- }): Promise<ApiResult<AasRepository.PutAssetInformationAasRepositoryResponse, AasRepository.PutAssetInformationAasRepositoryError | Error>>;
110
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
124
111
  /**
125
- * Deletes the Thumbnail associated with the given AAS.
112
+ * Deletes the Thumbnail associated with the given AAS
126
113
  *
127
114
  * @param options Object containing:
128
- * - baseUrl: The API base URL
129
- * - aasIdentifier: The unique ID
130
- * - headers?: Optional request headers
115
+ * - configuration: The http request options
116
+ * - aasIdentifier: The Asset Administration Shell’s unique id
131
117
  *
132
118
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
133
119
  */
134
120
  deleteThumbnail(options: {
135
- baseUrl: string;
121
+ configuration: Configuration;
136
122
  aasIdentifier: string;
137
- headers?: Headers;
138
- }): Promise<ApiResult<AasRepository.DeleteThumbnailAasRepositoryResponses, AasRepository.DeleteThumbnailAasRepositoryError | Error>>;
123
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
139
124
  /**
140
- * Returns the Thumbnail associated with an AAS, if any.
125
+ * Returns the Thumbnail associated with an AAS, if any
141
126
  *
142
127
  * @param options Object containing:
143
- * - baseUrl: The API base URL
144
- * - aasIdentifier: The unique ID
145
- * - headers?: Optional request headers
128
+ * - configuration: The http request options
129
+ * - aasIdentifier: The Asset Administration Shell’s unique id
146
130
  *
147
131
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
148
132
  */
149
133
  getThumbnail(options: {
150
- baseUrl: string;
134
+ configuration: Configuration;
151
135
  aasIdentifier: string;
152
- headers?: Headers;
153
- }): Promise<ApiResult<Blob | File, AasRepository.GetThumbnailAasRepositoryError | Error>>;
136
+ }): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
154
137
  /**
155
- * Updates (or creates) the Thumbnail for the given AAS.
138
+ * Updates (or creates) the Thumbnail for the given AAS
156
139
  *
157
140
  * @param options Object containing:
158
- * - baseUrl: The API base URL
159
- * - aasIdentifier: The unique ID
160
- * - thumbnail: The thumbnail data to upload
161
- * - headers?: Optional request headers
141
+ * - configuration: The http request options
142
+ * - aasIdentifier: The Asset Administration Shell’s unique id
143
+ * - fileName: The name of the file
144
+ * - file: The file to upload
162
145
  *
163
146
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
164
147
  */
165
148
  putThumbnail(options: {
166
- baseUrl: string;
149
+ configuration: Configuration;
167
150
  aasIdentifier: string;
168
- thumbnail: AasRepository.AssetinformationThumbnailBody;
169
- headers?: Headers;
170
- }): Promise<ApiResult<AasRepository.PutThumbnailAasRepositoryResponse, AasRepository.PutThumbnailAasRepositoryError | Error>>;
151
+ fileName: string;
152
+ file: Blob;
153
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
171
154
  /**
172
- * Returns all submodel references for the given AAS.
155
+ * Returns all submodel references
173
156
  *
174
157
  * @param options Object containing:
175
- * - baseUrl: The API base URL
176
- * - aasIdentifier: The unique ID
177
- * - headers?: Optional request headers
178
- * - limit?: Max number of elements
179
- * - cursor?: Paging cursor
158
+ * - configuration: The http request options
159
+ * - aasIdentifier: The Asset Administration Shell’s unique id
160
+ * - limit?: The maximum number of elements in the response array
161
+ * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
180
162
  *
181
163
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
182
164
  */
183
165
  getAllSubmodelReferences(options: {
184
- baseUrl: string;
166
+ configuration: Configuration;
185
167
  aasIdentifier: string;
186
- headers?: Headers;
187
168
  limit?: number;
188
169
  cursor?: string;
189
170
  }): Promise<ApiResult<{
190
- pagedResult: AasRepository.PagedResultPagingMetadata | undefined;
171
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
191
172
  result: Reference[];
192
- }, AasRepository.GetAllSubmodelReferencesAasRepositoryError | Error>>;
173
+ }, AasRepositoryService.Result>>;
193
174
  /**
194
- * Creates a submodel reference at the given AAS.
175
+ * Creates a submodel reference at the Asset Administration Shell
195
176
  *
196
177
  * @param options Object containing:
197
- * - baseUrl: The API base URL
198
- * - aasIdentifier: The unique ID of the AAS
199
- * - submodelReference: The Reference to the submodel
200
- * - headers?: Optional request headers
178
+ * - configuration: The http request options
179
+ * - aasIdentifier: The Asset Administration Shell’s unique id
180
+ * - submodelReference: Reference to the Submodel
201
181
  *
202
182
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
203
183
  */
204
184
  postSubmodelReference(options: {
205
- baseUrl: string;
185
+ configuration: Configuration;
206
186
  aasIdentifier: string;
207
187
  submodelReference: Reference;
208
- headers?: Headers;
209
- }): Promise<ApiResult<Reference, AasRepository.PostSubmodelReferenceAasRepositoryError | Error>>;
188
+ }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
210
189
  /**
211
190
  * Deletes a submodel reference from the given AAS (does not delete the submodel itself).
212
191
  *
213
192
  * @param options Object containing:
214
- * - baseUrl: The API base URL
193
+ * - configuration: The http request options
215
194
  * - aasIdentifier: Unique ID of the AAS
216
195
  * - submodelIdentifier: The submodel's unique ID
217
- * - headers?: Optional request headers
218
196
  *
219
197
  * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
220
198
  */
221
199
  deleteSubmodelReferenceById(options: {
222
- baseUrl: string;
200
+ configuration: Configuration;
223
201
  aasIdentifier: string;
224
202
  submodelIdentifier: string;
225
- headers?: Headers;
226
- }): Promise<ApiResult<AasRepository.DeleteSubmodelReferenceByIdAasRepositoryResponse, AasRepository.DeleteSubmodelReferenceByIdAasRepositoryError | Error>>;
203
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
204
+ /**
205
+ * Returns the Submodel
206
+ *
207
+ * @param options Object containing:
208
+ * - configuration: The http request options
209
+ * - aasIdentifier: The Asset Administration Shell’s unique id
210
+ * - submodelIdentifier: The submodel's unique ID
211
+ * - level?: Determines the structural depth of the respective resource content
212
+ * - extent?: Determines to which extent the resource is being serialized
213
+ *
214
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
215
+ */
216
+ getSubmodelByIdAasRepository(options: {
217
+ configuration: Configuration;
218
+ aasIdentifier: string;
219
+ submodelIdentifier: string;
220
+ level?: AasRepositoryService.GetSubmodelByIdAasRepositoryLevelEnum;
221
+ extent?: AasRepositoryService.GetSubmodelByIdAasRepositoryExtentEnum;
222
+ }): Promise<ApiResult<Submodel, AasRepositoryService.Result>>;
223
+ /**
224
+ * Creates or updates the Submodel
225
+ *
226
+ * @param options Object containing:
227
+ * - configuration: The http request options
228
+ * - aasIdentifier: The Asset Administration Shell’s unique id
229
+ * - submodelIdentifier: The Submodel’s unique id
230
+ * - submodel: Submodel object
231
+ *
232
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
233
+ */
234
+ putSubmodelByIdAasRepository(options: {
235
+ configuration: Configuration;
236
+ aasIdentifier: string;
237
+ submodelIdentifier: string;
238
+ submodel: Submodel;
239
+ }): Promise<ApiResult<Reference | void, AasRepositoryService.Result>>;
240
+ /**
241
+ * Deletes the submodel from the Asset Administration Shell and the Repository.
242
+ *
243
+ * @param options Object containing:
244
+ * - configuration: The http request options
245
+ * - aasIdentifier: The Asset Administration Shell’s unique id
246
+ * - submodelIdentifier: The Submodel’s unique id
247
+ *
248
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
249
+ */
250
+ deleteSubmodelByIdAasRepository(options: {
251
+ configuration: Configuration;
252
+ aasIdentifier: string;
253
+ submodelIdentifier: string;
254
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
255
+ /**
256
+ * Updates the Submodel
257
+ *
258
+ * @param options Object containing:
259
+ * - configuration: The http request options
260
+ * - aasIdentifier: The Asset Administration Shell’s unique id
261
+ * - submodelIdentifier: The Submodel’s unique id
262
+ * - submodel: Submodel object
263
+ * - level?: Determines the structural depth of the respective resource content
264
+ *
265
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
266
+ */
267
+ patchSubmodelAasRepository(options: {
268
+ configuration: Configuration;
269
+ aasIdentifier: string;
270
+ submodelIdentifier: string;
271
+ submodel: Submodel;
272
+ level?: AasRepositoryService.PatchSubmodelAasRepositoryLevelEnum;
273
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
274
+ /**
275
+ * Returns the Submodel's metadata elements
276
+ *
277
+ * @param options Object containing:
278
+ * - configuration: The http request options
279
+ * - aasIdentifier: The Asset Administration Shell’s unique id
280
+ * - submodelIdentifier: The Submodel’s unique id
281
+ *
282
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
283
+ */
284
+ getSubmodelByIdMetadataAasRepository(options: {
285
+ configuration: Configuration;
286
+ aasIdentifier: string;
287
+ submodelIdentifier: string;
288
+ }): Promise<ApiResult<AasRepositoryService.SubmodelMetadata, AasRepositoryService.Result>>;
289
+ /**
290
+ * Updates the metadata attributes of the Submodel
291
+ *
292
+ * @param options Object containing:
293
+ * - configuration: The http request options
294
+ * - aasIdentifier: The Asset Administration Shell’s unique id
295
+ * - submodelIdentifier: The Submodel’s unique id
296
+ * - submodelMetadata: The Submodel Metadata object
297
+ *
298
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
299
+ */
300
+ patchSubmodelByIdMetadataAasRepository(options: {
301
+ configuration: Configuration;
302
+ aasIdentifier: string;
303
+ submodelIdentifier: string;
304
+ submodelMetadata: AasRepositoryService.SubmodelMetadata;
305
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
306
+ /**
307
+ * Returns the Submodel's ValueOnly representation
308
+ *
309
+ * @param options Object containing:
310
+ * - configuration: The http request options
311
+ * - aasIdentifier: The Asset Administration Shell’s unique id
312
+ * - submodelIdentifier: The Submodel’s unique id
313
+ * - level?: Determines the structural depth of the respective resource content
314
+ * - extent?: Determines to which extent the resource is being serialized
315
+ *
316
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
317
+ */
318
+ getSubmodelByIdValueOnlyAasRepository(options: {
319
+ configuration: Configuration;
320
+ aasIdentifier: string;
321
+ submodelIdentifier: string;
322
+ level?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryLevelEnum;
323
+ extent?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryExtentEnum;
324
+ }): Promise<ApiResult<object, AasRepositoryService.Result>>;
325
+ /**
326
+ * Updates the values of the Submodel
327
+ *
328
+ * @param options Object containing:
329
+ * - configuration: The http request options
330
+ * - aasIdentifier: The Asset Administration Shell’s unique id
331
+ * - submodelIdentifier: The Submodel’s unique id
332
+ * - level?: Determines the structural depth of the respective resource content
333
+ *
334
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
335
+ */
336
+ patchSubmodelByIdValueOnlyAasRepository(options: {
337
+ configuration: Configuration;
338
+ aasIdentifier: string;
339
+ submodelIdentifier: string;
340
+ body: object;
341
+ level?: AasRepositoryService.PatchSubmodelByIdValueOnlyAasRepositoryLevelEnum;
342
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
343
+ /**
344
+ * Returns the Submodel as a Reference
345
+ *
346
+ * @param options Object containing:
347
+ * - configuration: The http request options
348
+ * - aasIdentifier: The Asset Administration Shell’s unique id
349
+ * - submodelIdentifier: The submodel's unique ID
350
+ *
351
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
352
+ */
353
+ getSubmodelByIdReferenceAasRepository(options: {
354
+ configuration: Configuration;
355
+ aasIdentifier: string;
356
+ submodelIdentifier: string;
357
+ }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
358
+ /**
359
+ * Returns the elements of this submodel in path notation.
360
+ *
361
+ * @param options Object containing:
362
+ * - configuration: The http request options
363
+ * - aasIdentifier: The Asset Administration Shell’s unique id
364
+ * - submodelIdentifier: The submodel's unique ID
365
+ * - level?: Determines the structural depth of the respective resource content
366
+ *
367
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
368
+ */
369
+ getSubmodelByIdPathAasRepository(options: {
370
+ configuration: Configuration;
371
+ aasIdentifier: string;
372
+ submodelIdentifier: string;
373
+ level?: AasRepositoryService.GetSubmodelByIdPathAasRepositoryLevelEnum;
374
+ }): Promise<ApiResult<Array<string>, AasRepositoryService.Result>>;
375
+ /**
376
+ * Returns all submodel elements including their hierarchy
377
+ *
378
+ * @param options Object containing:
379
+ * - configuration: The http request options
380
+ * - aasIdentifier: The Asset Administration Shell’s unique id
381
+ * - submodelIdentifier: The Submodel’s unique id
382
+ * - limit?: The maximum number of elements in the response array
383
+ * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
384
+ * - level?: Determines the structural depth of the respective resource content
385
+ * - extent?: Determines to which extent the resource is being serialized
386
+ *
387
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
388
+ */
389
+ getAllSubmodelElementsAasRepository(options: {
390
+ configuration: Configuration;
391
+ aasIdentifier: string;
392
+ submodelIdentifier: string;
393
+ limit?: number;
394
+ cursor?: string;
395
+ level?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryLevelEnum;
396
+ extent?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryExtentEnum;
397
+ }): Promise<ApiResult<{
398
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
399
+ result: ISubmodelElement[];
400
+ }, AasRepositoryService.Result>>;
401
+ /**
402
+ * Creates a new submodel element
403
+ *
404
+ * @param options Object containing:
405
+ * - configuration: The http request options
406
+ * - aasIdentifier: The Asset Administration Shell’s unique id
407
+ * - submodelIdentifier: The Submodel’s unique id
408
+ * - submodelElement: The Submodel Element object
409
+ *
410
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
411
+ */
412
+ postSubmodelElementAasRepository(options: {
413
+ configuration: Configuration;
414
+ aasIdentifier: string;
415
+ submodelIdentifier: string;
416
+ submodelElement: ISubmodelElement;
417
+ }): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
418
+ /**
419
+ * Returns all submodel elements including their hierarchy
420
+ *
421
+ * @param options Object containing:
422
+ * - configuration: The http request options
423
+ * - aasIdentifier: The Asset Administration Shell’s unique id
424
+ * - submodelIdentifier: The Submodel’s unique id
425
+ * - limit?: The maximum number of elements in the response array
426
+ * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
427
+ *
428
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
429
+ */
430
+ getAllSubmodelElementsMetadataAasRepository(options: {
431
+ configuration: Configuration;
432
+ aasIdentifier: string;
433
+ submodelIdentifier: string;
434
+ limit?: number;
435
+ cursor?: string;
436
+ }): Promise<ApiResult<{
437
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
438
+ result: AasRepositoryService.SubmodelElementMetadata[];
439
+ }, AasRepositoryService.Result>>;
440
+ /**
441
+ * Returns all submodel elements including their hierarchy in the ValueOnly representation
442
+ *
443
+ * @param options Object containing:
444
+ * - configuration: The http request options
445
+ * - aasIdentifier: The Asset Administration Shell’s unique id
446
+ * - submodelIdentifier: The Submodel’s unique id
447
+ * - limit?: The maximum number of elements in the response array
448
+ * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
449
+ * - level?: Determines the structural depth of the respective resource content
450
+ *
451
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
452
+ */
453
+ getAllSubmodelElementsValueOnlyAasRepository(options: {
454
+ configuration: Configuration;
455
+ aasIdentifier: string;
456
+ submodelIdentifier: string;
457
+ limit?: number;
458
+ cursor?: string;
459
+ level?: AasRepositoryService.GetAllSubmodelElementsValueOnlyAasRepositoryLevelEnum;
460
+ }): Promise<ApiResult<{
461
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
462
+ result: object;
463
+ }, AasRepositoryService.Result>>;
464
+ /**
465
+ * Returns all submodel elements as a list of References
466
+ *
467
+ * @param options Object containing:
468
+ * - configuration: The http request options
469
+ * - aasIdentifier: The Asset Administration Shell’s unique id
470
+ * - submodelIdentifier: The Submodel’s unique id
471
+ * - limit?: The maximum number of elements in the response array
472
+ * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
473
+ * - level?: Determines the structural depth of the respective resource content
474
+ *
475
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
476
+ */
477
+ getAllSubmodelElementsReferenceAasRepository(options: {
478
+ configuration: Configuration;
479
+ aasIdentifier: string;
480
+ submodelIdentifier: string;
481
+ limit?: number;
482
+ cursor?: string;
483
+ level?: AasRepositoryService.GetAllSubmodelElementsReferenceAasRepositoryLevelEnum;
484
+ }): Promise<ApiResult<{
485
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
486
+ result: Reference[];
487
+ }, AasRepositoryService.Result>>;
488
+ /**
489
+ * Returns all submodel elements including their hierarchy
490
+ *
491
+ * @param options Object containing:
492
+ * - configuration: The http request options
493
+ * - aasIdentifier: The Asset Administration Shell’s unique id
494
+ * - submodelIdentifier: The Submodel’s unique id
495
+ * - limit?: The maximum number of elements in the response array
496
+ * - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
497
+ * - level?: Determines the structural depth of the respective resource content
498
+ * - extent?: Determines to which extent the resource is being serialized
499
+ *
500
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
501
+ */
502
+ getAllSubmodelElementsPathAasRepository(options: {
503
+ configuration: Configuration;
504
+ aasIdentifier: string;
505
+ submodelIdentifier: string;
506
+ limit?: number;
507
+ cursor?: string;
508
+ level?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryLevelEnum;
509
+ extent?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryExtentEnum;
510
+ }): Promise<ApiResult<{
511
+ pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
512
+ result: string[];
513
+ }, AasRepositoryService.Result>>;
514
+ /**
515
+ * Returns a specific submodel element from the Submodel at a specified path
516
+ *
517
+ * @param options Object containing:
518
+ * - configuration: The http request options
519
+ * - aasIdentifier: The Asset Administration Shell’s unique id
520
+ * - submodelIdentifier: The Submodel’s unique id
521
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
522
+ * - level?: Determines the structural depth of the respective resource content
523
+ * - extent?: Determines to which extent the resource is being serialized
524
+ *
525
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
526
+ */
527
+ getSubmodelElementByPathAasRepository(options: {
528
+ configuration: Configuration;
529
+ aasIdentifier: string;
530
+ submodelIdentifier: string;
531
+ idShortPath: string;
532
+ level?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryLevelEnum;
533
+ extent?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryExtentEnum;
534
+ }): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
535
+ /**
536
+ * Creates a new submodel element at a specified path within submodel elements hierarchy
537
+ *
538
+ * @param options Object containing:
539
+ * - configuration: The http request options.
540
+ * - aasIdentifier: The Asset Administration Shell’s unique id
541
+ * - submodelIdentifier: The Submodel’s unique id
542
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
543
+ * - submodelElement: SubmodelElement object
544
+ *
545
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
546
+ */
547
+ postSubmodelElementByPathAasRepository(options: {
548
+ configuration: Configuration;
549
+ aasIdentifier: string;
550
+ submodelIdentifier: string;
551
+ idShortPath: string;
552
+ submodelElement: ISubmodelElement;
553
+ }): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
554
+ /**
555
+ * Deletes a submodel element at a specified path within the submodel elements hierarchy
556
+ *
557
+ * @param options Object containing:
558
+ * - configuration: The http request options.
559
+ * - aasIdentifier: The Asset Administration Shell’s unique id
560
+ * - submodelIdentifier: The Submodel’s unique id
561
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
562
+ *
563
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
564
+ */
565
+ deleteSubmodelElementByPathAasRepository(options: {
566
+ configuration: Configuration;
567
+ aasIdentifier: string;
568
+ submodelIdentifier: string;
569
+ idShortPath: string;
570
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
571
+ /**
572
+ * Updates an existing submodel element at a specified path within submodel elements hierarchy
573
+ *
574
+ * @param options Object containing:
575
+ * - configuration: The http request options
576
+ * - aasIdentifier: The Asset Administration Shell’s unique id
577
+ * - submodelIdentifier: The Submodel’s unique id
578
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
579
+ * - submodelElement: SubmodelElement object
580
+ *
581
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
582
+ */
583
+ putSubmodelElementByPathAasRepository(options: {
584
+ configuration: Configuration;
585
+ aasIdentifier: string;
586
+ submodelIdentifier: string;
587
+ idShortPath: string;
588
+ submodelElement: ISubmodelElement;
589
+ }): Promise<ApiResult<ISubmodelElement | void, AasRepositoryService.Result>>;
590
+ /**
591
+ * Updates an existing submodel element value at a specified path within submodel elements hierarchy
592
+ *
593
+ * @param options Object containing:
594
+ * - configuration: The http request options
595
+ * - aasIdentifier: The Asset Administration Shell’s unique id
596
+ * - submodelIdentifier: The Submodel’s unique id
597
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
598
+ * - submodelElement: SubmodelElement object
599
+ * - level?: Determines the structural depth of the respective resource content
600
+ *
601
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
602
+ */
603
+ patchSubmodelElementValueByPathAasRepository(options: {
604
+ configuration: Configuration;
605
+ aasIdentifier: string;
606
+ submodelIdentifier: string;
607
+ idShortPath: string;
608
+ submodelElement: ISubmodelElement;
609
+ level?: AasRepositoryService.PatchSubmodelElementValueByPathAasRepositoryLevelEnum;
610
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
611
+ /**
612
+ * Returns the metadata attributes of a specific submodel element from the Submodel at a specified path
613
+ *
614
+ * @param options Object containing:
615
+ * - configuration: The http request options
616
+ * - aasIdentifier: The Asset Administration Shell’s unique id
617
+ * - submodelIdentifier: The Submodel’s unique id
618
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
619
+ *
620
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
621
+ */
622
+ getSubmodelElementByPathMetadataAasRepository(options: {
623
+ configuration: Configuration;
624
+ aasIdentifier: string;
625
+ submodelIdentifier: string;
626
+ idShortPath: string;
627
+ }): Promise<ApiResult<AasRepositoryService.SubmodelElementMetadata, AasRepositoryService.Result>>;
628
+ /**
629
+ * Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy
630
+ *
631
+ * @param options Object containing:
632
+ * - configuration: The http request options
633
+ * - aasIdentifier: The Asset Administration Shell’s unique id
634
+ * - submodelIdentifier: The Submodel’s unique id
635
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
636
+ * - submodelElementMetadata: The Submodel Element Metadata object
637
+ *
638
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
639
+ */
640
+ patchSubmodelElementValueByPathMetadata(options: {
641
+ configuration: Configuration;
642
+ aasIdentifier: string;
643
+ submodelIdentifier: string;
644
+ idShortPath: string;
645
+ submodelElementMetadata: AasRepositoryService.SubmodelElementMetadata;
646
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
647
+ /**
648
+ * Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
649
+ *
650
+ * @param options Object containing:
651
+ * - configuration: The http request options
652
+ * - aasIdentifier: The Asset Administration Shell’s unique id
653
+ * - submodelIdentifier: The Submodel’s unique id
654
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
655
+ * - level?: Determines the structural depth of the respective resource content
656
+ * - extent?: Determines to which extent the resource is being serialized
657
+ *
658
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
659
+ */
660
+ getSubmodelElementByPathValueOnlyAasRepository(options: {
661
+ configuration: Configuration;
662
+ aasIdentifier: string;
663
+ submodelIdentifier: string;
664
+ idShortPath: string;
665
+ level?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryLevelEnum;
666
+ extent?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryExtentEnum;
667
+ }): Promise<ApiResult<AasRepositoryService.SubmodelElementValue, AasRepositoryService.Result>>;
668
+ /**
669
+ * Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy
670
+ *
671
+ * @param options Object containing:
672
+ * - configuration: The http request options
673
+ * - aasIdentifier: The Asset Administration Shell’s unique id
674
+ * - submodelIdentifier: The Submodel’s unique id
675
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
676
+ * - SubmodelElementValue: SubmodelElementValue object
677
+ * - level?: Determines the structural depth of the respective resource content
678
+ *
679
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
680
+ */
681
+ patchSubmodelElementValueByPathValueOnly(options: {
682
+ configuration: Configuration;
683
+ aasIdentifier: string;
684
+ submodelIdentifier: string;
685
+ idShortPath: string;
686
+ submodelElementValue: AasRepositoryService.SubmodelElementValue;
687
+ level?: AasRepositoryService.PatchSubmodelElementValueByPathValueOnlyLevelEnum;
688
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
689
+ /**
690
+ * Returns the Reference of a specific submodel element from the Submodel at a specified path
691
+ *
692
+ * @param options Object containing:
693
+ * - configuration: The http request options
694
+ * - aasIdentifier: The Asset Administration Shell’s unique id
695
+ * - submodelIdentifier: The Submodel’s unique id
696
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
697
+ * - level?: Determines the structural depth of the respective resource content
698
+ *
699
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
700
+ */
701
+ getSubmodelElementByPathReferenceAasRepository(options: {
702
+ configuration: Configuration;
703
+ aasIdentifier: string;
704
+ submodelIdentifier: string;
705
+ idShortPath: string;
706
+ level?: AasRepositoryService.GetSubmodelElementByPathReferenceAasRepositoryLevelEnum;
707
+ }): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
708
+ /**
709
+ * Returns a specific submodel element from the Submodel at a specified path in the Path notation
710
+ *
711
+ * @param options Object containing:
712
+ * - configuration: The http request options
713
+ * - aasIdentifier: The Asset Administration Shell’s unique id
714
+ * - submodelIdentifier: The Submodel’s unique id
715
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
716
+ * - level?: Determines the structural depth of the respective resource content
717
+ *
718
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
719
+ */
720
+ getSubmodelElementByPathPathAasRepository(options: {
721
+ configuration: Configuration;
722
+ aasIdentifier: string;
723
+ submodelIdentifier: string;
724
+ idShortPath: string;
725
+ level?: AasRepositoryService.GetSubmodelElementByPathPathAasRepositoryLevelEnum;
726
+ }): Promise<ApiResult<Array<string>, AasRepositoryService.Result>>;
727
+ /**
728
+ * Downloads file content from a specific submodel element from the Submodel at a specified path
729
+ *
730
+ * @param options Object containing:
731
+ * - configuration: The http request options
732
+ * - aasIdentifier: The Asset Administration Shell’s unique id
733
+ * - submodelIdentifier: The Submodel’s unique id
734
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
735
+ *
736
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
737
+ */
738
+ getFileByPathAasRepository(options: {
739
+ configuration: Configuration;
740
+ aasIdentifier: string;
741
+ submodelIdentifier: string;
742
+ idShortPath: string;
743
+ }): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
744
+ /**
745
+ * Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy
746
+ *
747
+ * @param options Object containing:
748
+ * - configuration: The http request options
749
+ * - aasIdentifier: The Asset Administration Shell’s unique id
750
+ * - submodelIdentifier: The Submodel’s unique id
751
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
752
+ * - fileName: The name of the file
753
+ * - file: The file to upload
754
+ *
755
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
756
+ */
757
+ putFileByPathAasRepository(options: {
758
+ configuration: Configuration;
759
+ aasIdentifier: string;
760
+ submodelIdentifier: string;
761
+ idShortPath: string;
762
+ fileName: string;
763
+ file: Blob;
764
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
765
+ /**
766
+ * Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy
767
+ *
768
+ * @param options Object containing:
769
+ * - configuration: The http request options.
770
+ * - aasIdentifier: The Asset Administration Shell’s unique id
771
+ * - submodelIdentifier: The Submodel’s unique id
772
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
773
+ *
774
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
775
+ */
776
+ deleteFileByPathAasRepository(options: {
777
+ configuration: Configuration;
778
+ aasIdentifier: string;
779
+ submodelIdentifier: string;
780
+ idShortPath: string;
781
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
782
+ /**
783
+ * Synchronously invokes an Operation at a specified path
784
+ *
785
+ * @param options Object containing:
786
+ * - configuration: The http request options.
787
+ * - aasIdentifier: The Asset Administration Shell’s unique id
788
+ * - submodelIdentifier: The Submodel’s unique id
789
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
790
+ * - operationRequest: Operation request object
791
+ *
792
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
793
+ */
794
+ invokeOperationAasRepository(options: {
795
+ configuration: Configuration;
796
+ aasIdentifier: string;
797
+ submodelIdentifier: string;
798
+ idShortPath: string;
799
+ operationRequest: AasRepositoryService.OperationRequest;
800
+ }): Promise<ApiResult<AasRepositoryService.OperationResult, AasRepositoryService.Result>>;
801
+ /**
802
+ * Synchronously invokes an Operation at a specified path
803
+ *
804
+ * @param options Object containing:
805
+ * - configuration: The http request options.
806
+ * - aasIdentifier: The Asset Administration Shell’s unique id
807
+ * - submodelIdentifier: The Submodel’s unique id
808
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
809
+ * - operationRequestValueOnly: OperationRequestValueOnly object
810
+ *
811
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
812
+ */
813
+ invokeOperationValueOnlyAasRepository(options: {
814
+ configuration: Configuration;
815
+ aasIdentifier: string;
816
+ submodelIdentifier: string;
817
+ idShortPath: string;
818
+ operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
819
+ }): Promise<ApiResult<AasRepositoryService.OperationResultValueOnly, AasRepositoryService.Result>>;
820
+ /**
821
+ * Asynchronously invokes an Operation at a specified path
822
+ *
823
+ * @param options Object containing:
824
+ * - configuration: The http request options.
825
+ * - aasIdentifier: The Asset Administration Shell’s unique id
826
+ * - submodelIdentifier: The Submodel’s unique id
827
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
828
+ * - operationRequest: OperationRequest object
829
+ *
830
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
831
+ */
832
+ invokeOperationAsyncAasRepository(options: {
833
+ configuration: Configuration;
834
+ aasIdentifier: string;
835
+ submodelIdentifier: string;
836
+ idShortPath: string;
837
+ operationRequest: AasRepositoryService.OperationRequest;
838
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
839
+ /**
840
+ * Asynchronously invokes an Operation at a specified path
841
+ *
842
+ * @param options Object containing:
843
+ * - configuration: The http request options.
844
+ * - aasIdentifier: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
845
+ * - submodelIdentifier: The Submodel’s unique id
846
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
847
+ * - operationRequestValueOnly: Operation request object
848
+ *
849
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
850
+ */
851
+ invokeOperationAsyncValueOnlyAasRepository(options: {
852
+ configuration: Configuration;
853
+ aasIdentifier: string;
854
+ submodelIdentifier: string;
855
+ idShortPath: string;
856
+ operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
857
+ }): Promise<ApiResult<void, AasRepositoryService.Result>>;
858
+ /**
859
+ * Returns the Operation status of an asynchronous invoked Operation
860
+ *
861
+ * @param options Object containing:
862
+ * - configuration: The http request options
863
+ * - aasIdentifier: The Asset Administration Shell’s unique id
864
+ * - submodelIdentifier: The Submodel’s unique id
865
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
866
+ * - handleId: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded)
867
+ *
868
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
869
+ */
870
+ getOperationAsyncStatusAasRepository(options: {
871
+ configuration: Configuration;
872
+ aasIdentifier: string;
873
+ submodelIdentifier: string;
874
+ idShortPath: string;
875
+ handleId: string;
876
+ }): Promise<ApiResult<AasRepositoryService.BaseOperationResult, AasRepositoryService.Result>>;
877
+ /**
878
+ * Returns the Operation result of an asynchronous invoked Operation
879
+ *
880
+ * @param options Object containing:
881
+ * - configuration: The http request options
882
+ * - aasIdentifier: The Asset Administration Shell’s unique id
883
+ * - submodelIdentifier: The Submodel’s unique id
884
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
885
+ * - handleId: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded)
886
+ *
887
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
888
+ */
889
+ getOperationAsyncResultAasRepository(options: {
890
+ configuration: Configuration;
891
+ aasIdentifier: string;
892
+ submodelIdentifier: string;
893
+ idShortPath: string;
894
+ handleId: string;
895
+ }): Promise<ApiResult<AasRepositoryService.OperationResult, AasRepositoryService.Result>>;
896
+ /**
897
+ * Returns the ValueOnly notation of the Operation result of an asynchronous invoked Operation
898
+ *
899
+ * @param options Object containing:
900
+ * - configuration: The http request options
901
+ * - aasIdentifier: The Asset Administration Shell’s unique id
902
+ * - submodelIdentifier: The Submodel’s unique id
903
+ * - idShortPath: IdShort path to the submodel element (dot-separated)
904
+ * - handleId: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded)
905
+ *
906
+ * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
907
+ */
908
+ getOperationAsyncResultValueOnlyAasRepository(options: {
909
+ configuration: Configuration;
910
+ aasIdentifier: string;
911
+ submodelIdentifier: string;
912
+ idShortPath: string;
913
+ handleId: string;
914
+ }): Promise<ApiResult<AasRepositoryService.OperationResultValueOnly, AasRepositoryService.Result>>;
227
915
  }