@sovity.de/edc-client 16.2.2 → 16.4.0

package/dist/sovity-edc-client.d.ts

@@ -192,6 +192,68 @@ export declare function AssetsPageSortPropertyToJSON(value?: AssetsPageSortPrope
 
 export declare function AssetsPageSortPropertyToJSONTyped(value: any, ignoreDiscriminator: boolean): AssetsPageSortProperty;
 
+/**
+ * Azure List Blobs Request
+ * @export
+ * @interface AzureStorageListBlobsRequest
+ */
+export declare interface AzureStorageListBlobsRequest {
+    /**
+     * Storage Account Name
+     * @type {string}
+     * @memberof AzureStorageListBlobsRequest
+     */
+    storageAccountName: string;
+    /**
+     * Container Name
+     * @type {string}
+     * @memberof AzureStorageListBlobsRequest
+     */
+    containerName: string;
+    /**
+     * Location of the Storage Account Secret in the Vault
+     * @type {string}
+     * @memberof AzureStorageListBlobsRequest
+     */
+    storageAccountVaultKey: string;
+}
+
+export declare function AzureStorageListBlobsRequestFromJSON(json: any): AzureStorageListBlobsRequest;
+
+export declare function AzureStorageListBlobsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureStorageListBlobsRequest;
+
+export declare function AzureStorageListBlobsRequestToJSON(json: any): AzureStorageListBlobsRequest;
+
+export declare function AzureStorageListBlobsRequestToJSONTyped(value?: AzureStorageListBlobsRequest | null, ignoreDiscriminator?: boolean): any;
+
+/**
+ * Azure List Containers Request
+ * @export
+ * @interface AzureStorageListContainersRequest
+ */
+export declare interface AzureStorageListContainersRequest {
+    /**
+     * Storage Account Name
+     * @type {string}
+     * @memberof AzureStorageListContainersRequest
+     */
+    storageAccountName: string;
+    /**
+     * Location of the Storage Account Secret in the Vault
+     * @type {string}
+     * @memberof AzureStorageListContainersRequest
+     */
+    storageAccountVaultKey: string;
+}
+
+export declare function AzureStorageListContainersRequestFromJSON(json: any): AzureStorageListContainersRequest;
+
+export declare function AzureStorageListContainersRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureStorageListContainersRequest;
+
+export declare function AzureStorageListContainersRequestToJSON(json: any): AzureStorageListContainersRequest;
+
+export declare function AzureStorageListContainersRequestToJSONTyped(value?: AzureStorageListContainersRequest | null, ignoreDiscriminator?: boolean): any;
+
 /**
  * sovity EDC API Wrapper
  * 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 {
     dataOfferCreateRequest?: DataOfferCreateRequest;
 }
 
+export declare interface CreatePolicyDefinitionFromJsonLdRequest {
+    policyDefinitionCreateFromJsonLdDto?: PolicyDefinitionCreateFromJsonLdDto;
+}
+
 export declare interface CreatePolicyDefinitionRequest {
     policyDefinitionCreateRequest?: PolicyDefinitionCreateRequest;
 }
@@ -1768,17 +1834,29 @@ export declare interface DataOfferCreateRequest {
      */
     asset: UiAssetCreateRequest;
     /**
-     *
+     * The data offer publishing type
      * @type {DataOfferPublishType}
      * @memberof DataOfferCreateRequest
      */
     publishType: DataOfferPublishType;
     /**
-     * Policy Expression. Only relevant if policyType is 'RESTRICTED'
+     * The policy creation type. Only required if publishType is PUBLISH_RESTRICTED.
+     * @type {DataOfferPolicyCreateType}
+     * @memberof DataOfferCreateRequest
+     */
+    policyCreateType?: DataOfferPolicyCreateType;
+    /**
+     * Tree-structured policy expression. Only required if publishType is PUBLISH_RESTRICTED and policyCreateType is POLICY_EXPRESSION.
      * @type {UiPolicyExpression}
      * @memberof DataOfferCreateRequest
      */
     policyExpression?: UiPolicyExpression;
+    /**
+     * ODRL policy as JSON-LD. Only required if publishType is PUBLISH_RESTRICTED and policyCreateType is POLICY_JSON_LD.
+     * @type {string}
+     * @memberof DataOfferCreateRequest
+     */
+    policyJsonLd?: string;
 }
 
 export declare function DataOfferCreateRequestFromJSON(json: any): DataOfferCreateRequest;
@@ -1789,6 +1867,25 @@ export declare function DataOfferCreateRequestToJSON(json: any): DataOfferCreate
 
 export declare function DataOfferCreateRequestToJSONTyped(value?: DataOfferCreateRequest | null, ignoreDiscriminator?: boolean): any;
 
+/**
+ * The policy creation type
+ * @export
+ */
+export declare const DataOfferPolicyCreateType: {
+    readonly Expression: "POLICY_EXPRESSION";
+    readonly JsonLd: "POLICY_JSON_LD";
+};
+
+export declare type DataOfferPolicyCreateType = (typeof DataOfferPolicyCreateType)[keyof typeof DataOfferPolicyCreateType];
+
+export declare function DataOfferPolicyCreateTypeFromJSON(json: any): DataOfferPolicyCreateType;
+
+export declare function DataOfferPolicyCreateTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataOfferPolicyCreateType;
+
+export declare function DataOfferPolicyCreateTypeToJSON(value?: DataOfferPolicyCreateType | null): any;
+
+export declare function DataOfferPolicyCreateTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): DataOfferPolicyCreateType;
+
 /**
  * Decides whether the data offer is to be published published:
  * * `DONT_PUBLISH` - Data offer is not published. Only an asset is created.
@@ -1839,6 +1936,7 @@ export declare function DataSourceAvailabilityToJSONTyped(value: any, ignoreDisc
 export declare const DataSourceType: {
     readonly HttpData: "HTTP_DATA";
     readonly OnRequest: "ON_REQUEST";
+    readonly AzureStorage: "AZURE_STORAGE";
     readonly Custom: "CUSTOM";
 };
 
@@ -2226,6 +2324,16 @@ export declare function instanceOfAssetsPageResult(value: any): value is AssetsP
 
 export declare function instanceOfAssetsPageSortProperty(value: any): boolean;
 
+/**
+ * Check if a given object implements the AzureStorageListBlobsRequest interface.
+ */
+export declare function instanceOfAzureStorageListBlobsRequest(value: any): value is AzureStorageListBlobsRequest;
+
+/**
+ * Check if a given object implements the AzureStorageListContainersRequest interface.
+ */
+export declare function instanceOfAzureStorageListContainersRequest(value: any): value is AzureStorageListContainersRequest;
+
 /**
  * Check if a given object implements the BuildInfo interface.
  */
@@ -2399,6 +2507,8 @@ export declare function instanceOfDashboardTransferAmounts(value: any): value is
  */
 export declare function instanceOfDataOfferCreateRequest(value: any): value is DataOfferCreateRequest;
 
+export declare function instanceOfDataOfferPolicyCreateType(value: any): boolean;
+
 export declare function instanceOfDataOfferPublishType(value: any): boolean;
 
 export declare function instanceOfDataSourceAvailability(value: any): boolean;
@@ -2462,6 +2572,11 @@ export declare function instanceOfPaginationResult(value: any): value is Paginat
  */
 export declare function instanceOfPolicyDefinitionCreateDto(value: any): value is PolicyDefinitionCreateDto;
 
+/**
+ * Check if a given object implements the PolicyDefinitionCreateFromJsonLdDto interface.
+ */
+export declare function instanceOfPolicyDefinitionCreateFromJsonLdDto(value: any): value is PolicyDefinitionCreateFromJsonLdDto;
+
 /**
  * Check if a given object implements the PolicyDefinitionCreateRequest interface.
  */
@@ -2577,6 +2692,11 @@ export declare function instanceOfUiCriterionOperator(value: any): boolean;
  */
 export declare function instanceOfUiDataOffer(value: any): value is UiDataOffer;
 
+/**
+ * Check if a given object implements the UiDataSinkAzureStorage interface.
+ */
+export declare function instanceOfUiDataSinkAzureStorage(value: any): value is UiDataSinkAzureStorage;
+
 /**
  * Check if a given object implements the UiDataSinkHttpDataPush interface.
  */
@@ -2589,6 +2709,11 @@ export declare function instanceOfUiDataSinkHttpDataPushMethod(value: any): bool
  */
 export declare function instanceOfUiDataSource(value: any): value is UiDataSource;
 
+/**
+ * Check if a given object implements the UiDataSourceAzureStorage interface.
+ */
+export declare function instanceOfUiDataSourceAzureStorage(value: any): value is UiDataSourceAzureStorage;
+
 /**
  * Check if a given object implements the UiDataSourceHttpData interface.
  */
@@ -2770,6 +2895,14 @@ export declare function KpiResultToJSON(json: any): KpiResult;
 
 export declare function KpiResultToJSONTyped(value?: KpiResult | null, ignoreDiscriminator?: boolean): any;
 
+export declare interface ListAzureStorageBlobsRequest {
+    azureStorageListBlobsRequest?: AzureStorageListBlobsRequest;
+}
+
+export declare interface ListAzureStorageContainersRequest {
+    azureStorageListContainersRequest?: AzureStorageListContainersRequest;
+}
+
 export declare interface ListVaultSecretsPageRequest {
     vaultSecretQuery?: VaultSecretQuery;
 }
@@ -3020,11 +3153,11 @@ export declare interface PolicyDefinitionCreateDto {
      */
     policyDefinitionId: string;
     /**
-     * Policy Expression
+     * Tree-structured policy expression
      * @type {UiPolicyExpression}
      * @memberof PolicyDefinitionCreateDto
      */
-    expression: UiPolicyExpression;
+    policyExpression: UiPolicyExpression;
 }
 
 export declare function PolicyDefinitionCreateDtoFromJSON(json: any): PolicyDefinitionCreateDto;
@@ -3035,6 +3168,34 @@ export declare function PolicyDefinitionCreateDtoToJSON(json: any): PolicyDefini
 
 export declare function PolicyDefinitionCreateDtoToJSONTyped(value?: PolicyDefinitionCreateDto | null, ignoreDiscriminator?: boolean): any;
 
+/**
+ * Create a Policy Definition
+ * @export
+ * @interface PolicyDefinitionCreateFromJsonLdDto
+ */
+export declare interface PolicyDefinitionCreateFromJsonLdDto {
+    /**
+     * Policy Definition ID
+     * @type {string}
+     * @memberof PolicyDefinitionCreateFromJsonLdDto
+     */
+    policyDefinitionId: string;
+    /**
+     * ODRL policy as JSON-LD
+     * @type {string}
+     * @memberof PolicyDefinitionCreateFromJsonLdDto
+     */
+    policyJsonLd: string;
+}
+
+export declare function PolicyDefinitionCreateFromJsonLdDtoFromJSON(json: any): PolicyDefinitionCreateFromJsonLdDto;
+
+export declare function PolicyDefinitionCreateFromJsonLdDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyDefinitionCreateFromJsonLdDto;
+
+export declare function PolicyDefinitionCreateFromJsonLdDtoToJSON(json: any): PolicyDefinitionCreateFromJsonLdDto;
+
+export declare function PolicyDefinitionCreateFromJsonLdDtoToJSONTyped(value?: PolicyDefinitionCreateFromJsonLdDto | null, ignoreDiscriminator?: boolean): any;
+
 /**
  * [Deprecated] Create a Policy Definition. Use PolicyDefinitionCreateDto
  * @export
@@ -3645,6 +3806,14 @@ export declare class UIApi extends runtime.BaseAPI {
      * @deprecated
      */
     createPolicyDefinition(requestParameters?: CreatePolicyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
+    /**
+     * Create a new Policy Definition from Policy JSON-LD
+     */
+    createPolicyDefinitionFromJsonLdRaw(requestParameters: CreatePolicyDefinitionFromJsonLdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
+    /**
+     * Create a new Policy Definition from Policy JSON-LD
+     */
+    createPolicyDefinitionFromJsonLd(requestParameters?: CreatePolicyDefinitionFromJsonLdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
     /**
      * Create a new Policy Definition
      */
@@ -3849,6 +4018,22 @@ export declare class UIApi extends runtime.BaseAPI {
      * Validates if the provided policyId is already taken
      */
     isPolicyIdAvailable(requestParameters: IsPolicyIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
+    /**
+     * Lists all available Azure Storage Blobs for the given Storage Account Name and Container
+     */
+    listAzureStorageBlobsRaw(requestParameters: ListAzureStorageBlobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Lists all available Azure Storage Blobs for the given Storage Account Name and Container
+     */
+    listAzureStorageBlobs(requestParameters?: ListAzureStorageBlobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Lists all available Azure Storage Containers for the given Storage Account Name
+     */
+    listAzureStorageContainersRaw(requestParameters: ListAzureStorageContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Lists all available Azure Storage Containers for the given Storage Account Name
+     */
+    listAzureStorageContainers(requestParameters?: ListAzureStorageContainersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
     /**
      * Collect all data for the Vault Secrets List Page
      */
@@ -4874,6 +5059,46 @@ export declare function UiDataOfferToJSON(json: any): UiDataOffer;
 
 export declare function UiDataOfferToJSONTyped(value?: UiDataOffer | null, ignoreDiscriminator?: boolean): any;
 
+/**
+ * AZURE_STORAGE type Data Sink.
+ * @export
+ * @interface UiDataSinkAzureStorage
+ */
+export declare interface UiDataSinkAzureStorage {
+    /**
+     * Storage Account Name. Note, that the corresponding secret must be stored in the vault under storageAccountName + '-key1'
+     * @type {string}
+     * @memberof UiDataSinkAzureStorage
+     */
+    storageAccountName: string;
+    /**
+     * Container Name of the Blob Storage
+     * @type {string}
+     * @memberof UiDataSinkAzureStorage
+     */
+    containerName: string;
+    /**
+     * Folder Name of the Blob Storage
+     * @type {string}
+     * @memberof UiDataSinkAzureStorage
+     */
+    folderName?: string;
+    /**
+     * Blob Name of the Blob Storage
+     * @type {string}
+     * @memberof UiDataSinkAzureStorage
+     */
+    blobName?: string;
+}
+
+export declare function UiDataSinkAzureStorageFromJSON(json: any): UiDataSinkAzureStorage;
+
+export declare function UiDataSinkAzureStorageFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSinkAzureStorage;
+
+export declare function UiDataSinkAzureStorageToJSON(json: any): UiDataSinkAzureStorage;
+
+export declare function UiDataSinkAzureStorageToJSONTyped(value?: UiDataSinkAzureStorage | null, ignoreDiscriminator?: boolean): any;
+
 /**
  * HTTP_DATA type Data Source. This is an HttpData-PUSH data sink. Note that consumption of parameterized data sources is not supported via HttpData-PUSH
  * @export
@@ -4968,6 +5193,12 @@ export declare interface UiDataSource {
      * @memberof UiDataSource
      */
     onRequest?: UiDataSourceOnRequest;
+    /**
+     * Only for type AZURE_STORAGE
+     * @type {UiDataSourceAzureStorage}
+     * @memberof UiDataSource
+     */
+    azureStorage?: UiDataSourceAzureStorage;
     /**
      * For all types. Custom Data Address Properties.
      * @type {{ [key: string]: string; }}
@@ -4978,6 +5209,46 @@ export declare interface UiDataSource {
     };
 }
 
+/**
+ * AZURE_STORAGE type Data Source.
+ * @export
+ * @interface UiDataSourceAzureStorage
+ */
+export declare interface UiDataSourceAzureStorage {
+    /**
+     * Storage Account Name
+     * @type {string}
+     * @memberof UiDataSourceAzureStorage
+     */
+    storageAccountName: string;
+    /**
+     * Vault Key for the Storage Account Secret
+     * @type {string}
+     * @memberof UiDataSourceAzureStorage
+     */
+    accountKey: string;
+    /**
+     * Container Name of the Blob Storage
+     * @type {string}
+     * @memberof UiDataSourceAzureStorage
+     */
+    containerName: string;
+    /**
+     * Blob Name
+     * @type {string}
+     * @memberof UiDataSourceAzureStorage
+     */
+    blobName: string;
+}
+
+export declare function UiDataSourceAzureStorageFromJSON(json: any): UiDataSourceAzureStorage;
+
+export declare function UiDataSourceAzureStorageFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSourceAzureStorage;
+
+export declare function UiDataSourceAzureStorageToJSON(json: any): UiDataSourceAzureStorage;
+
+export declare function UiDataSourceAzureStorageToJSONTyped(value?: UiDataSourceAzureStorage | null, ignoreDiscriminator?: boolean): any;
+
 export declare function UiDataSourceFromJSON(json: any): UiDataSource;
 
 export declare function UiDataSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSource;
@@ -5423,6 +5694,12 @@ export declare interface UiInitiateTransferRequest {
      * @memberof UiInitiateTransferRequest
      */
     httpDataPush?: UiDataSinkHttpDataPush;
+    /**
+     * Only for type AZURE_STORAGE
+     * @type {UiDataSinkAzureStorage}
+     * @memberof UiInitiateTransferRequest
+     */
+    azureStorage?: UiDataSinkAzureStorage;
     /**
      * List of endpoints to call upon given transfer events
      * @type {Array<CallbackAddressDto>}
@@ -5476,6 +5753,7 @@ export declare const UiInitiateTransferType: {
     readonly HttpDataPush: "HTTP_DATA_PUSH";
     readonly HttpDataProxy: "HTTP_DATA_PROXY";
     readonly Custom: "CUSTOM";
+    readonly AzureStorage: "AZURE_STORAGE";
 };
 
 export declare type UiInitiateTransferType = (typeof UiInitiateTransferType)[keyof typeof UiInitiateTransferType];