@sovity.de/edc-client 16.2.1 → 16.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -192,6 +192,68 @@ export declare function AssetsPageSortPropertyToJSON(value?: AssetsPageSortPrope
192
192
 
193
193
  export declare function AssetsPageSortPropertyToJSONTyped(value: any, ignoreDiscriminator: boolean): AssetsPageSortProperty;
194
194
 
195
+ /**
196
+ * Azure List Blobs Request
197
+ * @export
198
+ * @interface AzureStorageListBlobsRequest
199
+ */
200
+ export declare interface AzureStorageListBlobsRequest {
201
+ /**
202
+ * Storage Account Name
203
+ * @type {string}
204
+ * @memberof AzureStorageListBlobsRequest
205
+ */
206
+ storageAccountName: string;
207
+ /**
208
+ * Container Name
209
+ * @type {string}
210
+ * @memberof AzureStorageListBlobsRequest
211
+ */
212
+ containerName: string;
213
+ /**
214
+ * Location of the Storage Account Secret in the Vault
215
+ * @type {string}
216
+ * @memberof AzureStorageListBlobsRequest
217
+ */
218
+ storageAccountVaultKey: string;
219
+ }
220
+
221
+ export declare function AzureStorageListBlobsRequestFromJSON(json: any): AzureStorageListBlobsRequest;
222
+
223
+ export declare function AzureStorageListBlobsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureStorageListBlobsRequest;
224
+
225
+ export declare function AzureStorageListBlobsRequestToJSON(json: any): AzureStorageListBlobsRequest;
226
+
227
+ export declare function AzureStorageListBlobsRequestToJSONTyped(value?: AzureStorageListBlobsRequest | null, ignoreDiscriminator?: boolean): any;
228
+
229
+ /**
230
+ * Azure List Containers Request
231
+ * @export
232
+ * @interface AzureStorageListContainersRequest
233
+ */
234
+ export declare interface AzureStorageListContainersRequest {
235
+ /**
236
+ * Storage Account Name
237
+ * @type {string}
238
+ * @memberof AzureStorageListContainersRequest
239
+ */
240
+ storageAccountName: string;
241
+ /**
242
+ * Location of the Storage Account Secret in the Vault
243
+ * @type {string}
244
+ * @memberof AzureStorageListContainersRequest
245
+ */
246
+ storageAccountVaultKey: string;
247
+ }
248
+
249
+ export declare function AzureStorageListContainersRequestFromJSON(json: any): AzureStorageListContainersRequest;
250
+
251
+ export declare function AzureStorageListContainersRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureStorageListContainersRequest;
252
+
253
+ export declare function AzureStorageListContainersRequestToJSON(json: any): AzureStorageListContainersRequest;
254
+
255
+ export declare function AzureStorageListContainersRequestToJSONTyped(value?: AzureStorageListContainersRequest | null, ignoreDiscriminator?: boolean): any;
256
+
195
257
  /**
196
258
  * sovity EDC API Wrapper
197
259
  * sovity\'s EDC API Wrapper contains a selection of APIs for multiple consumers, e.g. our EDC UI API, our generic Use Case API, our Commercial Edition APIs, etc. We bundled these APIs, so we can have an easier time generating our API Client Libraries.
@@ -1505,6 +1567,10 @@ export declare interface CreateDataOfferRequest {
1505
1567
  dataOfferCreateRequest?: DataOfferCreateRequest;
1506
1568
  }
1507
1569
 
1570
+ export declare interface CreatePolicyDefinitionFromJsonLdRequest {
1571
+ policyDefinitionCreateFromJsonLdDto?: PolicyDefinitionCreateFromJsonLdDto;
1572
+ }
1573
+
1508
1574
  export declare interface CreatePolicyDefinitionRequest {
1509
1575
  policyDefinitionCreateRequest?: PolicyDefinitionCreateRequest;
1510
1576
  }
@@ -1768,17 +1834,29 @@ export declare interface DataOfferCreateRequest {
1768
1834
  */
1769
1835
  asset: UiAssetCreateRequest;
1770
1836
  /**
1771
- *
1837
+ * The data offer publishing type
1772
1838
  * @type {DataOfferPublishType}
1773
1839
  * @memberof DataOfferCreateRequest
1774
1840
  */
1775
1841
  publishType: DataOfferPublishType;
1776
1842
  /**
1777
- * Policy Expression. Only relevant if policyType is 'RESTRICTED'
1843
+ * The policy creation type. Only required if publishType is PUBLISH_RESTRICTED.
1844
+ * @type {DataOfferPolicyCreateType}
1845
+ * @memberof DataOfferCreateRequest
1846
+ */
1847
+ policyCreateType?: DataOfferPolicyCreateType;
1848
+ /**
1849
+ * Tree-structured policy expression. Only required if publishType is PUBLISH_RESTRICTED and policyCreateType is POLICY_EXPRESSION.
1778
1850
  * @type {UiPolicyExpression}
1779
1851
  * @memberof DataOfferCreateRequest
1780
1852
  */
1781
1853
  policyExpression?: UiPolicyExpression;
1854
+ /**
1855
+ * ODRL policy as JSON-LD. Only required if publishType is PUBLISH_RESTRICTED and policyCreateType is POLICY_JSON_LD.
1856
+ * @type {string}
1857
+ * @memberof DataOfferCreateRequest
1858
+ */
1859
+ policyJsonLd?: string;
1782
1860
  }
1783
1861
 
1784
1862
  export declare function DataOfferCreateRequestFromJSON(json: any): DataOfferCreateRequest;
@@ -1789,6 +1867,25 @@ export declare function DataOfferCreateRequestToJSON(json: any): DataOfferCreate
1789
1867
 
1790
1868
  export declare function DataOfferCreateRequestToJSONTyped(value?: DataOfferCreateRequest | null, ignoreDiscriminator?: boolean): any;
1791
1869
 
1870
+ /**
1871
+ * The policy creation type
1872
+ * @export
1873
+ */
1874
+ export declare const DataOfferPolicyCreateType: {
1875
+ readonly Expression: "POLICY_EXPRESSION";
1876
+ readonly JsonLd: "POLICY_JSON_LD";
1877
+ };
1878
+
1879
+ export declare type DataOfferPolicyCreateType = (typeof DataOfferPolicyCreateType)[keyof typeof DataOfferPolicyCreateType];
1880
+
1881
+ export declare function DataOfferPolicyCreateTypeFromJSON(json: any): DataOfferPolicyCreateType;
1882
+
1883
+ export declare function DataOfferPolicyCreateTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataOfferPolicyCreateType;
1884
+
1885
+ export declare function DataOfferPolicyCreateTypeToJSON(value?: DataOfferPolicyCreateType | null): any;
1886
+
1887
+ export declare function DataOfferPolicyCreateTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): DataOfferPolicyCreateType;
1888
+
1792
1889
  /**
1793
1890
  * Decides whether the data offer is to be published published:
1794
1891
  * * `DONT_PUBLISH` - Data offer is not published. Only an asset is created.
@@ -1839,6 +1936,7 @@ export declare function DataSourceAvailabilityToJSONTyped(value: any, ignoreDisc
1839
1936
  export declare const DataSourceType: {
1840
1937
  readonly HttpData: "HTTP_DATA";
1841
1938
  readonly OnRequest: "ON_REQUEST";
1939
+ readonly AzureStorage: "AZURE_STORAGE";
1842
1940
  readonly Custom: "CUSTOM";
1843
1941
  };
1844
1942
 
@@ -2226,6 +2324,16 @@ export declare function instanceOfAssetsPageResult(value: any): value is AssetsP
2226
2324
 
2227
2325
  export declare function instanceOfAssetsPageSortProperty(value: any): boolean;
2228
2326
 
2327
+ /**
2328
+ * Check if a given object implements the AzureStorageListBlobsRequest interface.
2329
+ */
2330
+ export declare function instanceOfAzureStorageListBlobsRequest(value: any): value is AzureStorageListBlobsRequest;
2331
+
2332
+ /**
2333
+ * Check if a given object implements the AzureStorageListContainersRequest interface.
2334
+ */
2335
+ export declare function instanceOfAzureStorageListContainersRequest(value: any): value is AzureStorageListContainersRequest;
2336
+
2229
2337
  /**
2230
2338
  * Check if a given object implements the BuildInfo interface.
2231
2339
  */
@@ -2399,6 +2507,8 @@ export declare function instanceOfDashboardTransferAmounts(value: any): value is
2399
2507
  */
2400
2508
  export declare function instanceOfDataOfferCreateRequest(value: any): value is DataOfferCreateRequest;
2401
2509
 
2510
+ export declare function instanceOfDataOfferPolicyCreateType(value: any): boolean;
2511
+
2402
2512
  export declare function instanceOfDataOfferPublishType(value: any): boolean;
2403
2513
 
2404
2514
  export declare function instanceOfDataSourceAvailability(value: any): boolean;
@@ -2462,6 +2572,11 @@ export declare function instanceOfPaginationResult(value: any): value is Paginat
2462
2572
  */
2463
2573
  export declare function instanceOfPolicyDefinitionCreateDto(value: any): value is PolicyDefinitionCreateDto;
2464
2574
 
2575
+ /**
2576
+ * Check if a given object implements the PolicyDefinitionCreateFromJsonLdDto interface.
2577
+ */
2578
+ export declare function instanceOfPolicyDefinitionCreateFromJsonLdDto(value: any): value is PolicyDefinitionCreateFromJsonLdDto;
2579
+
2465
2580
  /**
2466
2581
  * Check if a given object implements the PolicyDefinitionCreateRequest interface.
2467
2582
  */
@@ -2589,6 +2704,11 @@ export declare function instanceOfUiDataSinkHttpDataPushMethod(value: any): bool
2589
2704
  */
2590
2705
  export declare function instanceOfUiDataSource(value: any): value is UiDataSource;
2591
2706
 
2707
+ /**
2708
+ * Check if a given object implements the UiDataSourceAzureStorage interface.
2709
+ */
2710
+ export declare function instanceOfUiDataSourceAzureStorage(value: any): value is UiDataSourceAzureStorage;
2711
+
2592
2712
  /**
2593
2713
  * Check if a given object implements the UiDataSourceHttpData interface.
2594
2714
  */
@@ -2770,6 +2890,14 @@ export declare function KpiResultToJSON(json: any): KpiResult;
2770
2890
 
2771
2891
  export declare function KpiResultToJSONTyped(value?: KpiResult | null, ignoreDiscriminator?: boolean): any;
2772
2892
 
2893
+ export declare interface ListAzureStorageBlobsRequest {
2894
+ azureStorageListBlobsRequest?: AzureStorageListBlobsRequest;
2895
+ }
2896
+
2897
+ export declare interface ListAzureStorageContainersRequest {
2898
+ azureStorageListContainersRequest?: AzureStorageListContainersRequest;
2899
+ }
2900
+
2773
2901
  export declare interface ListVaultSecretsPageRequest {
2774
2902
  vaultSecretQuery?: VaultSecretQuery;
2775
2903
  }
@@ -3020,11 +3148,11 @@ export declare interface PolicyDefinitionCreateDto {
3020
3148
  */
3021
3149
  policyDefinitionId: string;
3022
3150
  /**
3023
- * Policy Expression
3151
+ * Tree-structured policy expression
3024
3152
  * @type {UiPolicyExpression}
3025
3153
  * @memberof PolicyDefinitionCreateDto
3026
3154
  */
3027
- expression: UiPolicyExpression;
3155
+ policyExpression: UiPolicyExpression;
3028
3156
  }
3029
3157
 
3030
3158
  export declare function PolicyDefinitionCreateDtoFromJSON(json: any): PolicyDefinitionCreateDto;
@@ -3035,6 +3163,34 @@ export declare function PolicyDefinitionCreateDtoToJSON(json: any): PolicyDefini
3035
3163
 
3036
3164
  export declare function PolicyDefinitionCreateDtoToJSONTyped(value?: PolicyDefinitionCreateDto | null, ignoreDiscriminator?: boolean): any;
3037
3165
 
3166
+ /**
3167
+ * Create a Policy Definition
3168
+ * @export
3169
+ * @interface PolicyDefinitionCreateFromJsonLdDto
3170
+ */
3171
+ export declare interface PolicyDefinitionCreateFromJsonLdDto {
3172
+ /**
3173
+ * Policy Definition ID
3174
+ * @type {string}
3175
+ * @memberof PolicyDefinitionCreateFromJsonLdDto
3176
+ */
3177
+ policyDefinitionId: string;
3178
+ /**
3179
+ * ODRL policy as JSON-LD
3180
+ * @type {string}
3181
+ * @memberof PolicyDefinitionCreateFromJsonLdDto
3182
+ */
3183
+ policyJsonLd: string;
3184
+ }
3185
+
3186
+ export declare function PolicyDefinitionCreateFromJsonLdDtoFromJSON(json: any): PolicyDefinitionCreateFromJsonLdDto;
3187
+
3188
+ export declare function PolicyDefinitionCreateFromJsonLdDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyDefinitionCreateFromJsonLdDto;
3189
+
3190
+ export declare function PolicyDefinitionCreateFromJsonLdDtoToJSON(json: any): PolicyDefinitionCreateFromJsonLdDto;
3191
+
3192
+ export declare function PolicyDefinitionCreateFromJsonLdDtoToJSONTyped(value?: PolicyDefinitionCreateFromJsonLdDto | null, ignoreDiscriminator?: boolean): any;
3193
+
3038
3194
  /**
3039
3195
  * [Deprecated] Create a Policy Definition. Use PolicyDefinitionCreateDto
3040
3196
  * @export
@@ -3645,6 +3801,14 @@ export declare class UIApi extends runtime.BaseAPI {
3645
3801
  * @deprecated
3646
3802
  */
3647
3803
  createPolicyDefinition(requestParameters?: CreatePolicyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
3804
+ /**
3805
+ * Create a new Policy Definition from Policy JSON-LD
3806
+ */
3807
+ createPolicyDefinitionFromJsonLdRaw(requestParameters: CreatePolicyDefinitionFromJsonLdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
3808
+ /**
3809
+ * Create a new Policy Definition from Policy JSON-LD
3810
+ */
3811
+ createPolicyDefinitionFromJsonLd(requestParameters?: CreatePolicyDefinitionFromJsonLdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
3648
3812
  /**
3649
3813
  * Create a new Policy Definition
3650
3814
  */
@@ -3849,6 +4013,22 @@ export declare class UIApi extends runtime.BaseAPI {
3849
4013
  * Validates if the provided policyId is already taken
3850
4014
  */
3851
4015
  isPolicyIdAvailable(requestParameters: IsPolicyIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
4016
+ /**
4017
+ * Lists all available Azure Storage Blobs for the given Storage Account Name and Container
4018
+ */
4019
+ listAzureStorageBlobsRaw(requestParameters: ListAzureStorageBlobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
4020
+ /**
4021
+ * Lists all available Azure Storage Blobs for the given Storage Account Name and Container
4022
+ */
4023
+ listAzureStorageBlobs(requestParameters?: ListAzureStorageBlobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
4024
+ /**
4025
+ * Lists all available Azure Storage Containers for the given Storage Account Name
4026
+ */
4027
+ listAzureStorageContainersRaw(requestParameters: ListAzureStorageContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
4028
+ /**
4029
+ * Lists all available Azure Storage Containers for the given Storage Account Name
4030
+ */
4031
+ listAzureStorageContainers(requestParameters?: ListAzureStorageContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
3852
4032
  /**
3853
4033
  * Collect all data for the Vault Secrets List Page
3854
4034
  */
@@ -4968,6 +5148,12 @@ export declare interface UiDataSource {
4968
5148
  * @memberof UiDataSource
4969
5149
  */
4970
5150
  onRequest?: UiDataSourceOnRequest;
5151
+ /**
5152
+ * Only for type AZURE_STORAGE
5153
+ * @type {UiDataSourceAzureStorage}
5154
+ * @memberof UiDataSource
5155
+ */
5156
+ azureStorage?: UiDataSourceAzureStorage;
4971
5157
  /**
4972
5158
  * For all types. Custom Data Address Properties.
4973
5159
  * @type {{ [key: string]: string; }}
@@ -4978,6 +5164,46 @@ export declare interface UiDataSource {
4978
5164
  };
4979
5165
  }
4980
5166
 
5167
+ /**
5168
+ * AZURE_STORAGE type Data Source.
5169
+ * @export
5170
+ * @interface UiDataSourceAzureStorage
5171
+ */
5172
+ export declare interface UiDataSourceAzureStorage {
5173
+ /**
5174
+ * Storage Account Name
5175
+ * @type {string}
5176
+ * @memberof UiDataSourceAzureStorage
5177
+ */
5178
+ storageAccountName: string;
5179
+ /**
5180
+ * Vault Key for the Storage Account Secret
5181
+ * @type {string}
5182
+ * @memberof UiDataSourceAzureStorage
5183
+ */
5184
+ accountKey: string;
5185
+ /**
5186
+ * Container Name of the Blob Storage
5187
+ * @type {string}
5188
+ * @memberof UiDataSourceAzureStorage
5189
+ */
5190
+ containerName: string;
5191
+ /**
5192
+ * Blob Name
5193
+ * @type {string}
5194
+ * @memberof UiDataSourceAzureStorage
5195
+ */
5196
+ blobName: string;
5197
+ }
5198
+
5199
+ export declare function UiDataSourceAzureStorageFromJSON(json: any): UiDataSourceAzureStorage;
5200
+
5201
+ export declare function UiDataSourceAzureStorageFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSourceAzureStorage;
5202
+
5203
+ export declare function UiDataSourceAzureStorageToJSON(json: any): UiDataSourceAzureStorage;
5204
+
5205
+ export declare function UiDataSourceAzureStorageToJSONTyped(value?: UiDataSourceAzureStorage | null, ignoreDiscriminator?: boolean): any;
5206
+
4981
5207
  export declare function UiDataSourceFromJSON(json: any): UiDataSource;
4982
5208
 
4983
5209
  export declare function UiDataSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSource;