basyx-typescript-sdk 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/dist/clients/AasRepositoryClient.d.ts +3 -3
- package/dist/clients/AasRepositoryClient.js +6 -6
- package/dist/generated/sdk.gen.d.ts +822 -0
- package/dist/generated/sdk.gen.js +1705 -0
- package/dist/generated/types.gen.d.ts +10829 -0
- package/dist/lib/convertAasTypes.d.ts +2 -2
- package/dist/lib/convertAasTypes.js +13 -3
- package/dist/lib/createAasRepoClient.d.ts +1 -1
- package/dist/models/aas-repository.d.ts +1 -1
- package/package.json +3 -4
- package/dist/generated/aas-repository/sdk.gen.d.ts +0 -210
- package/dist/generated/aas-repository/sdk.gen.js +0 -430
- package/dist/generated/aas-repository/types.gen.d.ts +0 -3380
- package/src/clients/AasRepositoryClient.ts +0 -501
- package/src/clients/index.ts +0 -1
- package/src/generated/aas-repository/index.ts +0 -3
- package/src/generated/aas-repository/sdk.gen.ts +0 -620
- package/src/generated/aas-repository/types.gen.ts +0 -3786
- package/src/index.ts +0 -1
- package/src/lib/convertAasTypes.ts +0 -123
- package/src/lib/createAasRepoClient.ts +0 -16
- package/src/models/aas-repository.ts +0 -12
- package/src/tests/clients/AasRepositoryClient.test.ts +0 -270
- package/src/tests/lib/convertAasTypes.test.ts +0 -201
- package/src/tests/lib/createAasRepoClient.test.ts +0 -55
- package/src/tests/models/.gitkeep +0 -0
- package/src/tests/utils/.gitkeep +0 -0
- package/src/utils/.gitkeep +0 -0
- /package/dist/generated/{aas-repository/index.d.ts → index.d.ts} +0 -0
- /package/dist/generated/{aas-repository/index.js → index.js} +0 -0
- /package/dist/generated/{aas-repository/types.gen.js → types.gen.js} +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import { AssetAdministrationShell as CoreAssetAdministrationShell, AssetInformation as CoreAssetInformation, Reference as CoreReference } from '@aas-core-works/aas-core3.0-typescript/types';
|
|
2
|
+
import { AssetAdministrationShell as ApiAssetAdministrationShell, AssetInformation as ApiAssetInformation, Reference as ApiReference } from '../generated/types.gen';
|
|
3
3
|
/**
|
|
4
4
|
* Convert an API AssetAdministrationShell to a Core Works AssetAdministrationShell
|
|
5
5
|
*
|
|
@@ -7,6 +7,7 @@ exports.convertCoreAssetInformationToApiAssetInformation = convertCoreAssetInfor
|
|
|
7
7
|
exports.convertApiReferenceToCoreReference = convertApiReferenceToCoreReference;
|
|
8
8
|
exports.convertCoreReferenceToApiReference = convertCoreReferenceToApiReference;
|
|
9
9
|
const aas_core3_0_typescript_1 = require("@aas-core-works/aas-core3.0-typescript");
|
|
10
|
+
const types_1 = require("@aas-core-works/aas-core3.0-typescript/types");
|
|
10
11
|
/**
|
|
11
12
|
* Convert an API AssetAdministrationShell to a Core Works AssetAdministrationShell
|
|
12
13
|
*
|
|
@@ -24,7 +25,10 @@ function convertApiAasToCoreAas(aas) {
|
|
|
24
25
|
if (instanceOrError.error !== null) {
|
|
25
26
|
throw instanceOrError.error;
|
|
26
27
|
}
|
|
27
|
-
|
|
28
|
+
const instance = instanceOrError.mustValue();
|
|
29
|
+
// set the prototype
|
|
30
|
+
Object.setPrototypeOf(instance, types_1.AssetAdministrationShell.prototype);
|
|
31
|
+
return instance;
|
|
28
32
|
}
|
|
29
33
|
/**
|
|
30
34
|
* Convert a Core Works AssetAdministrationShell to an API AssetAdministrationShell
|
|
@@ -58,7 +62,10 @@ function convertApiAssetInformationToCoreAssetInformation(assetInformation) {
|
|
|
58
62
|
if (instanceOrError.error !== null) {
|
|
59
63
|
throw instanceOrError.error;
|
|
60
64
|
}
|
|
61
|
-
|
|
65
|
+
const instance = instanceOrError.mustValue();
|
|
66
|
+
// set the prototype
|
|
67
|
+
Object.setPrototypeOf(instance, types_1.AssetInformation.prototype);
|
|
68
|
+
return instance;
|
|
62
69
|
}
|
|
63
70
|
/**
|
|
64
71
|
* Convert a Core Works AssetInformation to an API AssetInformation
|
|
@@ -92,7 +99,10 @@ function convertApiReferenceToCoreReference(reference) {
|
|
|
92
99
|
if (instanceOrError.error !== null) {
|
|
93
100
|
throw instanceOrError.error;
|
|
94
101
|
}
|
|
95
|
-
|
|
102
|
+
const instance = instanceOrError.mustValue();
|
|
103
|
+
// set the prototype
|
|
104
|
+
Object.setPrototypeOf(instance, types_1.Reference.prototype);
|
|
105
|
+
return instance;
|
|
96
106
|
}
|
|
97
107
|
/**
|
|
98
108
|
* Convert a Core Works Reference to an API Reference
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
* @param headers The headers to be included in the request
|
|
7
7
|
* @returns {Client} The custom client
|
|
8
8
|
*/
|
|
9
|
-
export declare function createCustomClient(baseURL: string, headers?: Headers): import("@hey-api/client-fetch").Client
|
|
9
|
+
export declare function createCustomClient(baseURL: string, headers?: Headers): import("@hey-api/client-fetch").Client;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { AssetAdministrationShell, Reference } from '@aas-core-works/aas-core3.0-typescript/types';
|
|
2
|
-
import type { PagedResultPagingMetadata } from '../generated/
|
|
2
|
+
import type { PagedResultPagingMetadata } from '../generated/types.gen';
|
|
3
3
|
export interface GetAllAssetAdministrationShellsResponse {
|
|
4
4
|
pagedResult: PagedResultPagingMetadata | undefined;
|
|
5
5
|
result: AssetAdministrationShell[] | undefined;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "basyx-typescript-sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"repository": "https://github.com/eclipse-basyx/basyx-typescript-sdk.git",
|
|
@@ -8,12 +8,11 @@
|
|
|
8
8
|
"license": "MIT",
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
11
|
-
"src",
|
|
12
11
|
"README.md",
|
|
13
12
|
"LICENSE"
|
|
14
13
|
],
|
|
15
14
|
"scripts": {
|
|
16
|
-
"
|
|
15
|
+
"openapi-ts": "openapi-ts",
|
|
17
16
|
"build": "tsc",
|
|
18
17
|
"lint:check": "eslint ./",
|
|
19
18
|
"lint:fix": "eslint --fix ./",
|
|
@@ -25,7 +24,7 @@
|
|
|
25
24
|
"@hey-api/client-fetch": "^0.7.0"
|
|
26
25
|
},
|
|
27
26
|
"devDependencies": {
|
|
28
|
-
"@hey-api/openapi-ts": "^0.
|
|
27
|
+
"@hey-api/openapi-ts": "^0.64.1",
|
|
29
28
|
"@types/jest": "^29.5.14",
|
|
30
29
|
"@types/node": "^22.10.7",
|
|
31
30
|
"@typescript-eslint/eslint-plugin": "^8.21.0",
|
|
@@ -1,210 +0,0 @@
|
|
|
1
|
-
import { type Options } from '@hey-api/client-fetch';
|
|
2
|
-
import type { GetAllAssetAdministrationShellsData, PostAssetAdministrationShellData, GetAllAssetAdministrationShellsReferenceData, DeleteAssetAdministrationShellByIdData, GetAssetAdministrationShellByIdData, PutAssetAdministrationShellByIdData, GetAssetAdministrationShellByIdReferenceAasRepositoryData, GetAssetInformationAasRepositoryData, PutAssetInformationAasRepositoryData, DeleteThumbnailAasRepositoryData, GetThumbnailAasRepositoryData, PutThumbnailAasRepositoryData, GetAllSubmodelReferencesAasRepositoryData, PostSubmodelReferenceAasRepositoryData, DeleteSubmodelReferenceByIdAasRepositoryData, DeleteSubmodelByIdAasRepositoryData, GetSubmodelByIdAasRepositoryData, PatchSubmodelAasRepositoryData, PutSubmodelByIdAasRepositoryData, GetSubmodelByIdMetadataAasRepositoryData, PatchSubmodelByIdMetadataAasRepositoryData, GetSubmodelByIdValueOnlyAasRepositoryData, PatchSubmodelByIdValueOnlyAasRepositoryData, GetSubmodelByIdReferenceAasRepositoryData, GetSubmodelByIdPathAasRepositoryData, GetAllSubmodelElementsAasRepositoryData, PostSubmodelElementAasRepositoryData, GetAllSubmodelElementsMetadataAasRepositoryData, GetAllSubmodelElementsValueOnlyAasRepositoryData, GetAllSubmodelElementsReferenceAasRepositoryData, GetAllSubmodelElementsPathAasRepositoryData, DeleteSubmodelElementByPathAasRepositoryData, GetSubmodelElementByPathAasRepositoryData, PatchSubmodelElementValueByPathAasRepositoryData, PostSubmodelElementByPathAasRepositoryData, PutSubmodelElementByPathAasRepositoryData, GetSubmodelElementByPathMetadataAasRepositoryData, PatchSubmodelElementValueByPathMetadataData, GetSubmodelElementByPathValueOnlyAasRepositoryData, PatchSubmodelElementValueByPathValueOnlyData, GetSubmodelElementByPathReferenceAasRepositoryData, GetSubmodelElementByPathPathAasRepositoryData, DeleteFileByPathAasRepositoryData, GetFileByPathAasRepositoryData, PutFileByPathAasRepositoryData, InvokeOperationAasRepositoryData, InvokeOperationValueOnlyAasRepositoryData, InvokeOperationAsyncAasRepositoryData, InvokeOperationAsyncValueOnlyAasRepositoryData, GetOperationAsyncStatusAasRepositoryData, GetOperationAsyncResultAasRepositoryData, GetOperationAsyncResultValueOnlyAasRepositoryData, GenerateSerializationByIdsData, GetDescriptionData } from './types.gen';
|
|
3
|
-
export declare const client: import("@hey-api/client-fetch").Client<Request, Response, unknown, import("@hey-api/client-fetch").RequestOptions<boolean, string>>;
|
|
4
|
-
/**
|
|
5
|
-
* Returns all Asset Administration Shells
|
|
6
|
-
*/
|
|
7
|
-
export declare const getAllAssetAdministrationShells: <ThrowOnError extends boolean = false>(options?: Options<GetAllAssetAdministrationShellsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetAssetAdministrationShellsResult, import("./types.gen").Result, ThrowOnError>;
|
|
8
|
-
/**
|
|
9
|
-
* Creates a new Asset Administration Shell
|
|
10
|
-
*/
|
|
11
|
-
export declare const postAssetAdministrationShell: <ThrowOnError extends boolean = false>(options: Options<PostAssetAdministrationShellData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AssetAdministrationShell, import("./types.gen").Result, ThrowOnError>;
|
|
12
|
-
/**
|
|
13
|
-
* Returns References to all Asset Administration Shells
|
|
14
|
-
*/
|
|
15
|
-
export declare const getAllAssetAdministrationShellsReference: <ThrowOnError extends boolean = false>(options?: Options<GetAllAssetAdministrationShellsReferenceData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetReferencesResult, import("./types.gen").Result, ThrowOnError>;
|
|
16
|
-
/**
|
|
17
|
-
* Deletes an Asset Administration Shell
|
|
18
|
-
*/
|
|
19
|
-
export declare const deleteAssetAdministrationShellById: <ThrowOnError extends boolean = false>(options: Options<DeleteAssetAdministrationShellByIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
20
|
-
/**
|
|
21
|
-
* Returns a specific Asset Administration Shell
|
|
22
|
-
*/
|
|
23
|
-
export declare const getAssetAdministrationShellById: <ThrowOnError extends boolean = false>(options: Options<GetAssetAdministrationShellByIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AssetAdministrationShell, import("./types.gen").Result, ThrowOnError>;
|
|
24
|
-
/**
|
|
25
|
-
* Updates an existing Asset Administration Shell
|
|
26
|
-
*/
|
|
27
|
-
export declare const putAssetAdministrationShellById: <ThrowOnError extends boolean = false>(options: Options<PutAssetAdministrationShellByIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
28
|
-
/**
|
|
29
|
-
* Returns a specific Asset Administration Shell as a Reference
|
|
30
|
-
*/
|
|
31
|
-
export declare const getAssetAdministrationShellByIdReferenceAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAssetAdministrationShellByIdReferenceAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Reference, import("./types.gen").Result, ThrowOnError>;
|
|
32
|
-
/**
|
|
33
|
-
* Returns the Asset Information
|
|
34
|
-
*/
|
|
35
|
-
export declare const getAssetInformationAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAssetInformationAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AssetInformation, import("./types.gen").Result, ThrowOnError>;
|
|
36
|
-
/**
|
|
37
|
-
* Updates the Asset Information
|
|
38
|
-
*/
|
|
39
|
-
export declare const putAssetInformationAasRepository: <ThrowOnError extends boolean = false>(options: Options<PutAssetInformationAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
40
|
-
export declare const deleteThumbnailAasRepository: <ThrowOnError extends boolean = false>(options: Options<DeleteThumbnailAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, import("./types.gen").Result, ThrowOnError>;
|
|
41
|
-
export declare const getThumbnailAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetThumbnailAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<Blob | File, import("./types.gen").Result, ThrowOnError>;
|
|
42
|
-
export declare const putThumbnailAasRepository: <ThrowOnError extends boolean = false>(options: Options<PutThumbnailAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
43
|
-
/**
|
|
44
|
-
* Returns all submodel references
|
|
45
|
-
*/
|
|
46
|
-
export declare const getAllSubmodelReferencesAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAllSubmodelReferencesAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetReferencesResult, import("./types.gen").Result, ThrowOnError>;
|
|
47
|
-
/**
|
|
48
|
-
* Creates a submodel reference at the Asset Administration Shell
|
|
49
|
-
*/
|
|
50
|
-
export declare const postSubmodelReferenceAasRepository: <ThrowOnError extends boolean = false>(options: Options<PostSubmodelReferenceAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Reference, import("./types.gen").Result, ThrowOnError>;
|
|
51
|
-
/**
|
|
52
|
-
* Deletes the submodel reference from the Asset Administration Shell. Does not delete the submodel itself!
|
|
53
|
-
*/
|
|
54
|
-
export declare const deleteSubmodelReferenceByIdAasRepository: <ThrowOnError extends boolean = false>(options: Options<DeleteSubmodelReferenceByIdAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
55
|
-
/**
|
|
56
|
-
* Deletes the submodel from the Asset Administration Shell and the Repository.
|
|
57
|
-
*/
|
|
58
|
-
export declare const deleteSubmodelByIdAasRepository: <ThrowOnError extends boolean = false>(options: Options<DeleteSubmodelByIdAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
59
|
-
/**
|
|
60
|
-
* Returns the Submodel
|
|
61
|
-
*/
|
|
62
|
-
export declare const getSubmodelByIdAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelByIdAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Submodel, import("./types.gen").Result, ThrowOnError>;
|
|
63
|
-
/**
|
|
64
|
-
* Updates the Submodel
|
|
65
|
-
*/
|
|
66
|
-
export declare const patchSubmodelAasRepository: <ThrowOnError extends boolean = false>(options: Options<PatchSubmodelAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
67
|
-
/**
|
|
68
|
-
* Updates the Submodel
|
|
69
|
-
*/
|
|
70
|
-
export declare const putSubmodelByIdAasRepository: <ThrowOnError extends boolean = false>(options: Options<PutSubmodelByIdAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
71
|
-
/**
|
|
72
|
-
* Returns the Submodel's metadata elements
|
|
73
|
-
*/
|
|
74
|
-
export declare const getSubmodelByIdMetadataAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelByIdMetadataAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SubmodelMetadata, import("./types.gen").Result, ThrowOnError>;
|
|
75
|
-
/**
|
|
76
|
-
* Updates the metadata attributes of the Submodel
|
|
77
|
-
*/
|
|
78
|
-
export declare const patchSubmodelByIdMetadataAasRepository: <ThrowOnError extends boolean = false>(options: Options<PatchSubmodelByIdMetadataAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
79
|
-
/**
|
|
80
|
-
* Returns the Submodel's ValueOnly representation
|
|
81
|
-
*/
|
|
82
|
-
export declare const getSubmodelByIdValueOnlyAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelByIdValueOnlyAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SubmodelValue, import("./types.gen").Result, ThrowOnError>;
|
|
83
|
-
/**
|
|
84
|
-
* Updates the values of the Submodel
|
|
85
|
-
*/
|
|
86
|
-
export declare const patchSubmodelByIdValueOnlyAasRepository: <ThrowOnError extends boolean = false>(options: Options<PatchSubmodelByIdValueOnlyAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
87
|
-
/**
|
|
88
|
-
* Returns the Submodel as a Reference
|
|
89
|
-
*/
|
|
90
|
-
export declare const getSubmodelByIdReferenceAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelByIdReferenceAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Reference, import("./types.gen").Result, ThrowOnError>;
|
|
91
|
-
/**
|
|
92
|
-
* Returns the Submodel's metadata elements
|
|
93
|
-
*/
|
|
94
|
-
export declare const getSubmodelByIdPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelByIdPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<string[], import("./types.gen").Result, ThrowOnError>;
|
|
95
|
-
/**
|
|
96
|
-
* Returns all submodel elements including their hierarchy
|
|
97
|
-
*/
|
|
98
|
-
export declare const getAllSubmodelElementsAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAllSubmodelElementsAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetSubmodelElementsResult, import("./types.gen").Result, ThrowOnError>;
|
|
99
|
-
/**
|
|
100
|
-
* Creates a new submodel element
|
|
101
|
-
*/
|
|
102
|
-
export declare const postSubmodelElementAasRepository: <ThrowOnError extends boolean = false>(options: Options<PostSubmodelElementAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SubmodelElement, import("./types.gen").Result, ThrowOnError>;
|
|
103
|
-
/**
|
|
104
|
-
* Returns all submodel elements including their hierarchy
|
|
105
|
-
*/
|
|
106
|
-
export declare const getAllSubmodelElementsMetadataAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAllSubmodelElementsMetadataAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetSubmodelElementsMetadataResult, import("./types.gen").Result, ThrowOnError>;
|
|
107
|
-
/**
|
|
108
|
-
* Returns all submodel elements including their hierarchy in the ValueOnly representation
|
|
109
|
-
*/
|
|
110
|
-
export declare const getAllSubmodelElementsValueOnlyAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAllSubmodelElementsValueOnlyAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetSubmodelElementsValueResult, import("./types.gen").Result, ThrowOnError>;
|
|
111
|
-
/**
|
|
112
|
-
* Returns all submodel elements as a list of References
|
|
113
|
-
*/
|
|
114
|
-
export declare const getAllSubmodelElementsReferenceAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAllSubmodelElementsReferenceAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetReferencesResult, import("./types.gen").Result, ThrowOnError>;
|
|
115
|
-
/**
|
|
116
|
-
* Returns all submodel elements including their hierarchy
|
|
117
|
-
*/
|
|
118
|
-
export declare const getAllSubmodelElementsPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetAllSubmodelElementsPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GetPathItemsResult, import("./types.gen").Result, ThrowOnError>;
|
|
119
|
-
/**
|
|
120
|
-
* Deletes a submodel element at a specified path within the submodel elements hierarchy
|
|
121
|
-
*/
|
|
122
|
-
export declare const deleteSubmodelElementByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<DeleteSubmodelElementByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
123
|
-
/**
|
|
124
|
-
* Returns a specific submodel element from the Submodel at a specified path
|
|
125
|
-
*/
|
|
126
|
-
export declare const getSubmodelElementByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelElementByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SubmodelElement, import("./types.gen").Result, ThrowOnError>;
|
|
127
|
-
/**
|
|
128
|
-
* Updates an existing submodel element value at a specified path within submodel elements hierarchy
|
|
129
|
-
*/
|
|
130
|
-
export declare const patchSubmodelElementValueByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<PatchSubmodelElementValueByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
131
|
-
/**
|
|
132
|
-
* Creates a new submodel element at a specified path within submodel elements hierarchy
|
|
133
|
-
*/
|
|
134
|
-
export declare const postSubmodelElementByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<PostSubmodelElementByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SubmodelElement, import("./types.gen").Result, ThrowOnError>;
|
|
135
|
-
/**
|
|
136
|
-
* Updates an existing submodel element at a specified path within submodel elements hierarchy
|
|
137
|
-
*/
|
|
138
|
-
export declare const putSubmodelElementByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<PutSubmodelElementByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
139
|
-
/**
|
|
140
|
-
* Returns the metadata attributes if a specific submodel element from the Submodel at a specified path
|
|
141
|
-
*/
|
|
142
|
-
export declare const getSubmodelElementByPathMetadataAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelElementByPathMetadataAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SubmodelElementMetadata, import("./types.gen").Result, ThrowOnError>;
|
|
143
|
-
/**
|
|
144
|
-
* Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy
|
|
145
|
-
*/
|
|
146
|
-
export declare const patchSubmodelElementValueByPathMetadata: <ThrowOnError extends boolean = false>(options: Options<PatchSubmodelElementValueByPathMetadataData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
147
|
-
/**
|
|
148
|
-
* Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
|
|
149
|
-
*/
|
|
150
|
-
export declare const getSubmodelElementByPathValueOnlyAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelElementByPathValueOnlyAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SubmodelElementValue, import("./types.gen").Result, ThrowOnError>;
|
|
151
|
-
/**
|
|
152
|
-
* Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy
|
|
153
|
-
*/
|
|
154
|
-
export declare const patchSubmodelElementValueByPathValueOnly: <ThrowOnError extends boolean = false>(options: Options<PatchSubmodelElementValueByPathValueOnlyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
155
|
-
/**
|
|
156
|
-
* Returns the Reference of a specific submodel element from the Submodel at a specified path
|
|
157
|
-
*/
|
|
158
|
-
export declare const getSubmodelElementByPathReferenceAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelElementByPathReferenceAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Reference, import("./types.gen").Result, ThrowOnError>;
|
|
159
|
-
/**
|
|
160
|
-
* Returns a specific submodel element from the Submodel at a specified path in the Path notation
|
|
161
|
-
*/
|
|
162
|
-
export declare const getSubmodelElementByPathPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetSubmodelElementByPathPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<string[], import("./types.gen").Result, ThrowOnError>;
|
|
163
|
-
/**
|
|
164
|
-
* Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy
|
|
165
|
-
*/
|
|
166
|
-
export declare const deleteFileByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<DeleteFileByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, import("./types.gen").Result, ThrowOnError>;
|
|
167
|
-
/**
|
|
168
|
-
* Downloads file content from a specific submodel element from the Submodel at a specified path
|
|
169
|
-
*/
|
|
170
|
-
export declare const getFileByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetFileByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<Blob | File, import("./types.gen").Result, ThrowOnError>;
|
|
171
|
-
/**
|
|
172
|
-
* Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy
|
|
173
|
-
*/
|
|
174
|
-
export declare const putFileByPathAasRepository: <ThrowOnError extends boolean = false>(options: Options<PutFileByPathAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").Result, ThrowOnError>;
|
|
175
|
-
/**
|
|
176
|
-
* Synchronously invokes an Operation at a specified path
|
|
177
|
-
*/
|
|
178
|
-
export declare const invokeOperationAasRepository: <ThrowOnError extends boolean = false>(options: Options<InvokeOperationAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").OperationResult, import("./types.gen").Result, ThrowOnError>;
|
|
179
|
-
/**
|
|
180
|
-
* Synchronously invokes an Operation at a specified path
|
|
181
|
-
*/
|
|
182
|
-
export declare const invokeOperationValueOnlyAasRepository: <ThrowOnError extends boolean = false>(options: Options<InvokeOperationValueOnlyAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").OperationResultValueOnly, import("./types.gen").Result, ThrowOnError>;
|
|
183
|
-
/**
|
|
184
|
-
* Asynchronously invokes an Operation at a specified path
|
|
185
|
-
*/
|
|
186
|
-
export declare const invokeOperationAsyncAasRepository: <ThrowOnError extends boolean = false>(options: Options<InvokeOperationAsyncAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, import("./types.gen").Result, ThrowOnError>;
|
|
187
|
-
/**
|
|
188
|
-
* Asynchronously invokes an Operation at a specified path
|
|
189
|
-
*/
|
|
190
|
-
export declare const invokeOperationAsyncValueOnlyAasRepository: <ThrowOnError extends boolean = false>(options: Options<InvokeOperationAsyncValueOnlyAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, import("./types.gen").Result, ThrowOnError>;
|
|
191
|
-
/**
|
|
192
|
-
* Returns the Operation status of an asynchronous invoked Operation
|
|
193
|
-
*/
|
|
194
|
-
export declare const getOperationAsyncStatusAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetOperationAsyncStatusAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").BaseOperationResult, import("./types.gen").Result, ThrowOnError>;
|
|
195
|
-
/**
|
|
196
|
-
* Returns the Operation result of an asynchronous invoked Operation
|
|
197
|
-
*/
|
|
198
|
-
export declare const getOperationAsyncResultAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetOperationAsyncResultAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").OperationResult, import("./types.gen").Result, ThrowOnError>;
|
|
199
|
-
/**
|
|
200
|
-
* Returns the ValueOnly notation of the Operation result of an asynchronous invoked Operation
|
|
201
|
-
*/
|
|
202
|
-
export declare const getOperationAsyncResultValueOnlyAasRepository: <ThrowOnError extends boolean = false>(options: Options<GetOperationAsyncResultValueOnlyAasRepositoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").OperationResultValueOnly, import("./types.gen").Result, ThrowOnError>;
|
|
203
|
-
/**
|
|
204
|
-
* Returns an appropriate serialization based on the specified format (see SerializationFormat)
|
|
205
|
-
*/
|
|
206
|
-
export declare const generateSerializationByIds: <ThrowOnError extends boolean = false>(options?: Options<GenerateSerializationByIdsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<Blob | File, import("./types.gen").Result, ThrowOnError>;
|
|
207
|
-
/**
|
|
208
|
-
* Returns the self-describing information of a network resource (ServiceDescription)
|
|
209
|
-
*/
|
|
210
|
-
export declare const getDescription: <ThrowOnError extends boolean = false>(options?: Options<GetDescriptionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ServiceDescription, import("./types.gen").Result, ThrowOnError>;
|