@sovity.de/edc-client 9.0.0 → 10.1.0

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

@@ -23,38 +23,6 @@ export declare function AssetPageFromJSONTyped(json: any, ignoreDiscriminator: b
 
 export declare function AssetPageToJSON(value?: AssetPage | null): any;
 
-/**
- * Type-Safe OpenAPI generator friendly Constraint DTO that supports an opinionated subset of the original EDC Constraint Entity.
- * @export
- * @interface AtomicConstraintDto
- */
-export declare interface AtomicConstraintDto {
-    /**
-     * Left part of the constraint.
-     * @type {string}
-     * @memberof AtomicConstraintDto
-     */
-    leftExpression: string;
-    /**
-     *
-     * @type {OperatorDto}
-     * @memberof AtomicConstraintDto
-     */
-    operator: OperatorDto;
-    /**
-     * Right part of the constraint.
-     * @type {string}
-     * @memberof AtomicConstraintDto
-     */
-    rightExpression: string;
-}
-
-export declare function AtomicConstraintDtoFromJSON(json: any): AtomicConstraintDto;
-
-export declare function AtomicConstraintDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AtomicConstraintDto;
-
-export declare function AtomicConstraintDtoToJSON(value?: AtomicConstraintDto | null): 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.
@@ -753,17 +721,17 @@ export declare function ContractTerminatedByToJSON(value?: ContractTerminatedBy
  */
 export declare interface ContractTerminationRequest {
     /**
-     * A short reason why this contract was terminated
+     * A user explanation to detail why the contract was terminated.
      * @type {string}
      * @memberof ContractTerminationRequest
      */
-    reason: string;
+    detail: string;
     /**
-     * A user explanation to detail why the contract was terminated.
+     * A short reason why this contract was terminated
      * @type {string}
      * @memberof ContractTerminationRequest
      */
-    detail?: string;
+    reason: string;
 }
 
 export declare function ContractTerminationRequestFromJSON(json: any): ContractTerminationRequest;
@@ -801,8 +769,8 @@ export declare interface CreatePolicyDefinitionRequest {
     policyDefinitionCreateRequest?: PolicyDefinitionCreateRequest;
 }
 
-export declare interface CreatePolicyDefinitionUseCaseRequest {
-    policyCreateRequest?: PolicyCreateRequest;
+export declare interface CreatePolicyDefinitionV2Request {
+    policyDefinitionCreateDto?: PolicyDefinitionCreateDto;
 }
 
 /**
@@ -1134,61 +1102,6 @@ export declare interface ErrorContext {
 
 export declare function exists(json: any, key: string): boolean;
 
-/**
- * Represents a single atomic constraint or a multiplicity constraint. The atomicConstraint will be evaluated if the constraintType is ATOMIC_CONSTRAINT.
- * @export
- * @interface Expression
- */
-export declare interface Expression {
-    /**
-     *
-     * @type {ExpressionType}
-     * @memberof Expression
-     */
-    expressionType?: ExpressionType;
-    /**
-     * List of policy elements that are evaluated according the expressionType.
-     * @type {Array<Expression>}
-     * @memberof Expression
-     */
-    expressions?: Array<Expression>;
-    /**
-     *
-     * @type {AtomicConstraintDto}
-     * @memberof Expression
-     */
-    atomicConstraint?: AtomicConstraintDto;
-}
-
-export declare function ExpressionFromJSON(json: any): Expression;
-
-export declare function ExpressionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Expression;
-
-export declare function ExpressionToJSON(value?: Expression | null): any;
-
-/**
- * Expression types:
- * * `ATOMIC_CONSTRAINT` - A single constraint for the policy
- * * `AND` - Several constraints, all of which must be respected
- * * `OR` - Several constraints, of which at least one must be respected
- * * `XOR` - Several constraints, of which exactly one must be respected
- * @export
- */
-export declare const ExpressionType: {
-    readonly AtomicConstraint: "ATOMIC_CONSTRAINT";
-    readonly And: "AND";
-    readonly Or: "OR";
-    readonly Xor: "XOR";
-};
-
-export declare type ExpressionType = (typeof ExpressionType)[keyof typeof ExpressionType];
-
-export declare function ExpressionTypeFromJSON(json: any): ExpressionType;
-
-export declare function ExpressionTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExpressionType;
-
-export declare function ExpressionTypeToJSON(value?: ExpressionType | null): any;
-
 export declare type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
 
 export declare class FetchError extends Error {
@@ -1211,6 +1124,10 @@ export declare interface GetCatalogPageDataOffersRequest {
     connectorEndpoint?: string;
 }
 
+export declare interface GetContractAgreementCardRequest {
+    contractAgreementId: string;
+}
+
 export declare interface GetContractAgreementPageRequest {
     contractAgreementPageQuery?: ContractAgreementPageQuery;
 }
@@ -1242,6 +1159,32 @@ export declare type HTTPRequestInit = {
     body?: HTTPBody;
 };
 
+/**
+ * Object indicates whether an ID for the given object type is already taken or not
+ * @export
+ * @interface IdAvailabilityResponse
+ */
+export declare interface IdAvailabilityResponse {
+    /**
+     * ID
+     * @type {string}
+     * @memberof IdAvailabilityResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IdAvailabilityResponse
+     */
+    available?: boolean;
+}
+
+export declare function IdAvailabilityResponseFromJSON(json: any): IdAvailabilityResponse;
+
+export declare function IdAvailabilityResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IdAvailabilityResponse;
+
+export declare function IdAvailabilityResponseToJSON(value?: IdAvailabilityResponse | null): any;
+
 /**
  * Marks the operation as successful
  * @export
@@ -1352,11 +1295,6 @@ export declare type InitOverrideFunction = (requestContext: {
  */
 export declare function instanceOfAssetPage(value: object): boolean;
 
-/**
- * Check if a given object implements the AtomicConstraintDto interface.
- */
-export declare function instanceOfAtomicConstraintDto(value: object): boolean;
-
 /**
  * Check if a given object implements the CatalogFilterExpression interface.
  */
@@ -1453,9 +1391,9 @@ export declare function instanceOfDashboardPage(value: object): boolean;
 export declare function instanceOfDashboardTransferAmounts(value: object): boolean;
 
 /**
- * Check if a given object implements the Expression interface.
+ * Check if a given object implements the IdAvailabilityResponse interface.
  */
-export declare function instanceOfExpression(value: object): boolean;
+export declare function instanceOfIdAvailabilityResponse(value: object): boolean;
 
 /**
  * Check if a given object implements the IdResponseDto interface.
@@ -1478,14 +1416,9 @@ export declare function instanceOfInitiateTransferRequest(value: object): boolea
 export declare function instanceOfKpiResult(value: object): boolean;
 
 /**
- * Check if a given object implements the PermissionDto interface.
+ * Check if a given object implements the PolicyDefinitionCreateDto interface.
  */
-export declare function instanceOfPermissionDto(value: object): boolean;
-
-/**
- * Check if a given object implements the PolicyCreateRequest interface.
- */
-export declare function instanceOfPolicyCreateRequest(value: object): boolean;
+export declare function instanceOfPolicyDefinitionCreateDto(value: object): boolean;
 
 /**
  * Check if a given object implements the PolicyDefinitionCreateRequest interface.
@@ -1597,11 +1530,28 @@ export declare function instanceOfUiPolicyConstraint(value: object): boolean;
  */
 export declare function instanceOfUiPolicyCreateRequest(value: object): boolean;
 
+/**
+ * Check if a given object implements the UiPolicyExpression interface.
+ */
+export declare function instanceOfUiPolicyExpression(value: object): boolean;
+
 /**
  * Check if a given object implements the UiPolicyLiteral interface.
  */
 export declare function instanceOfUiPolicyLiteral(value: object): boolean;
 
+export declare interface IsAssetIdAvailableRequest {
+    assetId: string;
+}
+
+export declare interface IsContractDefinitionIdAvailableRequest {
+    contractDefinitionId: string;
+}
+
+export declare interface IsPolicyIdAvailableRequest {
+    policyId: string;
+}
+
 export declare type Json = any;
 
 export declare class JSONApiResponse<T> {
@@ -1666,7 +1616,7 @@ export declare interface Middleware {
 export declare type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
 
 /**
- * Operator for policies
+ * Type-Safe ODRL Policy Operator as supported by the sovity product landscape
  * @export
  */
 export declare const OperatorDto: {
@@ -1693,53 +1643,33 @@ export declare function OperatorDtoFromJSONTyped(json: any, ignoreDiscriminator:
 export declare function OperatorDtoToJSON(value?: OperatorDto | null): any;
 
 /**
- * Permission description for the policy to evaluate to TRUE.
- * @export
- * @interface PermissionDto
- */
-export declare interface PermissionDto {
-    /**
-     *
-     * @type {Expression}
-     * @memberof PermissionDto
-     */
-    expression: Expression;
-}
-
-export declare function PermissionDtoFromJSON(json: any): PermissionDto;
-
-export declare function PermissionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PermissionDto;
-
-export declare function PermissionDtoToJSON(value?: PermissionDto | null): any;
-
-/**
- * Policy Creation Request Supporting Multiplicity Constraints.
+ * Create a Policy Definition
  * @export
- * @interface PolicyCreateRequest
+ * @interface PolicyDefinitionCreateDto
  */
-export declare interface PolicyCreateRequest {
+export declare interface PolicyDefinitionCreateDto {
     /**
      * Policy Definition ID
      * @type {string}
-     * @memberof PolicyCreateRequest
+     * @memberof PolicyDefinitionCreateDto
      */
     policyDefinitionId: string;
     /**
      *
-     * @type {PermissionDto}
-     * @memberof PolicyCreateRequest
+     * @type {UiPolicyExpression}
+     * @memberof PolicyDefinitionCreateDto
      */
-    permission?: PermissionDto;
+    expression: UiPolicyExpression;
 }
 
-export declare function PolicyCreateRequestFromJSON(json: any): PolicyCreateRequest;
+export declare function PolicyDefinitionCreateDtoFromJSON(json: any): PolicyDefinitionCreateDto;
 
-export declare function PolicyCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyCreateRequest;
+export declare function PolicyDefinitionCreateDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyDefinitionCreateDto;
 
-export declare function PolicyCreateRequestToJSON(value?: PolicyCreateRequest | null): any;
+export declare function PolicyDefinitionCreateDtoToJSON(value?: PolicyDefinitionCreateDto | null): any;
 
 /**
- * Data for creating a Policy Definition
+ * [Deprecated] Create a Policy Definition. Use PolicyDefinitionCreateDto
  * @export
  * @interface PolicyDefinitionCreateRequest
  */
@@ -1754,6 +1684,7 @@ export declare interface PolicyDefinitionCreateRequest {
      *
      * @type {UiPolicyCreateRequest}
      * @memberof PolicyDefinitionCreateRequest
+     * @deprecated
      */
     policy: UiPolicyCreateRequest;
 }
@@ -2131,13 +2062,21 @@ export declare class UIApi extends runtime.BaseAPI {
      */
     createContractDefinition(requestParameters?: CreateContractDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
     /**
-     * Create a new Policy Definition
+     * [Deprecated] Create a new Policy Definition from a list of constraints. Use createPolicyDefinitionV2 instead.
      */
     createPolicyDefinitionRaw(requestParameters: CreatePolicyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
     /**
-     * Create a new Policy Definition
+     * [Deprecated] Create a new Policy Definition from a list of constraints. Use createPolicyDefinitionV2 instead.
      */
     createPolicyDefinition(requestParameters?: CreatePolicyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
+    /**
+     * Create a new Policy Definition
+     */
+    createPolicyDefinitionV2Raw(requestParameters: CreatePolicyDefinitionV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
+    /**
+     * Create a new Policy Definition
+     */
+    createPolicyDefinitionV2(requestParameters?: CreatePolicyDefinitionV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
     /**
      * Delete an Asset
      */
@@ -2186,6 +2125,14 @@ export declare class UIApi extends runtime.BaseAPI {
      * Fetch a connector\'s data offers
      */
     getCatalogPageDataOffers(requestParameters?: GetCatalogPageDataOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UiDataOffer>>;
+    /**
+     * Get a single contract agreement card by its identifier
+     */
+    getContractAgreementCardRaw(requestParameters: GetContractAgreementCardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContractAgreementCard>>;
+    /**
+     * Get a single contract agreement card by its identifier
+     */
+    getContractAgreementCard(requestParameters: GetContractAgreementCardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContractAgreementCard>;
     /**
      * Collect filtered data for the Contract Agreement Page
      */
@@ -2266,6 +2213,30 @@ export declare class UIApi extends runtime.BaseAPI {
      * Initiate a Transfer Process
      */
     initiateTransfer(requestParameters?: InitiateTransferOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
+    /**
+     * Validates if the provided assetId is already taken
+     */
+    isAssetIdAvailableRaw(requestParameters: IsAssetIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdAvailabilityResponse>>;
+    /**
+     * Validates if the provided assetId is already taken
+     */
+    isAssetIdAvailable(requestParameters: IsAssetIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
+    /**
+     * Validates if the provided contractDefinitionId is already taken
+     */
+    isContractDefinitionIdAvailableRaw(requestParameters: IsContractDefinitionIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdAvailabilityResponse>>;
+    /**
+     * Validates if the provided contractDefinitionId is already taken
+     */
+    isContractDefinitionIdAvailable(requestParameters: IsContractDefinitionIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
+    /**
+     * Validates if the provided policyId is already taken
+     */
+    isPolicyIdAvailableRaw(requestParameters: IsPolicyIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdAvailabilityResponse>>;
+    /**
+     * Validates if the provided policyId is already taken
+     */
+    isPolicyIdAvailable(requestParameters: IsPolicyIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
     /**
      * Terminates a contract agreement designated by its contract agreement id.
      */
@@ -2277,7 +2248,7 @@ export declare class UIApi extends runtime.BaseAPI {
 }
 
 /**
- * Type-Safe Asset Metadata as needed by our UI
+ * Type-safe data offer metadata as supported by the sovity product landscape. Contains extension points.
  * @export
  * @interface UiAsset
  */
@@ -2537,7 +2508,7 @@ export declare interface UiAsset {
 }
 
 /**
- * Type-Safe OpenAPI generator friendly Asset Create DTO that supports an opinionated subset of the original EDC Asset Entity.
+ * Type-safe data offer metadata for creating an asset as supported by the sovity product landscape. Contains extension points.
  * @export
  * @interface UiAssetCreateRequest
  */
@@ -2731,7 +2702,7 @@ export declare function UiAssetCreateRequestFromJSONTyped(json: any, ignoreDiscr
 export declare function UiAssetCreateRequestToJSON(value?: UiAssetCreateRequest | null): any;
 
 /**
- * Data for editing an asset.
+ * Type-safe data offer metadata for editing an asset as supported by the sovity product landscape. Contains extension points.
  * @export
  * @interface UiAssetEditRequest
  */
@@ -3126,7 +3097,7 @@ export declare function UiDataOfferFromJSONTyped(json: any, ignoreDiscriminator:
 export declare function UiDataOfferToJSON(value?: UiDataOffer | null): any;
 
 /**
- * Data Offer Data Source Model. Supports certain Data Address types but also leaves a backdoor for custom Data Address Properties.
+ * Type-safe data source as supported by the sovity product landscape. Contains extension points for using custom data address properties.
  * @export
  * @interface UiDataSource
  */
@@ -3164,7 +3135,7 @@ export declare function UiDataSourceFromJSON(json: any): UiDataSource;
 export declare function UiDataSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSource;
 
 /**
- * Only for type HTTP_DATA
+ * HTTP_DATA type Data Source.
  * @export
  * @interface UiDataSourceHttpData
  */
@@ -3289,7 +3260,7 @@ export declare function UiDataSourceOnRequestToJSON(value?: UiDataSourceOnReques
 export declare function UiDataSourceToJSON(value?: UiDataSource | null): any;
 
 /**
- * Type-Safe OpenAPI generator friendly Policy DTO as needed by our UI
+ * Type-Safe OpenAPI generator friendly ODLR policy subset as endorsed by sovity.
  * @export
  * @interface UiPolicy
  */
@@ -3301,11 +3272,11 @@ export declare interface UiPolicy {
      */
     policyJsonLd: string;
     /**
-     * Conjunction of required expressions for the policy to evaluate to TRUE.
-     * @type {Array<UiPolicyConstraint>}
+     *
+     * @type {UiPolicyExpression}
      * @memberof UiPolicy
      */
-    constraints?: Array<UiPolicyConstraint>;
+    expression?: UiPolicyExpression;
     /**
      * When trying to reduce the policy JSON-LD to our opinionated subset of functionalities, many fields and functionalities are unsupported. Should any discrepancies occur during the mapping process, we'll collect them here.
      * @type {Array<string>}
@@ -3315,7 +3286,7 @@ export declare interface UiPolicy {
 }
 
 /**
- * ODRL AtomicConstraint as supported by our UI
+ * ODRL AtomicConstraint as supported by the sovity product landscape. For example 'a EQ b', 'c IN [d, e, f]'
  * @export
  * @interface UiPolicyConstraint
  */
@@ -3347,15 +3318,16 @@ export declare function UiPolicyConstraintFromJSONTyped(json: any, ignoreDiscrim
 export declare function UiPolicyConstraintToJSON(value?: UiPolicyConstraint | null): any;
 
 /**
- * Type-Safe OpenAPI generator friendly Policy Create DTO that supports an opinionated subset of the original EDC Policy Entity.
+ * [Deprecated] Conjunction of constraints (simplified UiPolicyExpression)
  * @export
  * @interface UiPolicyCreateRequest
  */
 export declare interface UiPolicyCreateRequest {
     /**
-     * Conjunction of required expressions for the policy to evaluate to TRUE.
+     * Conjunction of required constraints
      * @type {Array<UiPolicyConstraint>}
      * @memberof UiPolicyCreateRequest
+     * @deprecated
      */
     constraints?: Array<UiPolicyConstraint>;
 }
@@ -3366,6 +3338,62 @@ export declare function UiPolicyCreateRequestFromJSONTyped(json: any, ignoreDisc
 
 export declare function UiPolicyCreateRequestToJSON(value?: UiPolicyCreateRequest | null): any;
 
+/**
+ * ODRL constraint as supported by the sovity product landscape
+ * @export
+ * @interface UiPolicyExpression
+ */
+export declare interface UiPolicyExpression {
+    /**
+     *
+     * @type {UiPolicyExpressionType}
+     * @memberof UiPolicyExpression
+     */
+    type: UiPolicyExpressionType;
+    /**
+     * Only for types AND, OR, XONE. List of sub-expressions to be evaluated according to the expressionType.
+     * @type {Array<UiPolicyExpression>}
+     * @memberof UiPolicyExpression
+     */
+    expressions?: Array<UiPolicyExpression>;
+    /**
+     *
+     * @type {UiPolicyConstraint}
+     * @memberof UiPolicyExpression
+     */
+    constraint?: UiPolicyConstraint;
+}
+
+export declare function UiPolicyExpressionFromJSON(json: any): UiPolicyExpression;
+
+export declare function UiPolicyExpressionFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiPolicyExpression;
+
+export declare function UiPolicyExpressionToJSON(value?: UiPolicyExpression | null): any;
+
+/**
+ * Ui Policy Expression types:
+ * * `CONSTRAINT` - Expression 'a=b'
+ * * `AND` - Conjunction of several expressions. Evaluates to true iff all child expressions are true.
+ * * `OR` - Disjunction of several expressions. Evaluates to true iff at least one child expression is true.
+ * * `XONE` - XONE operation. Evaluates to true iff exactly one child expression is true.
+ * @export
+ */
+export declare const UiPolicyExpressionType: {
+    readonly Empty: "EMPTY";
+    readonly Constraint: "CONSTRAINT";
+    readonly And: "AND";
+    readonly Or: "OR";
+    readonly Xone: "XONE";
+};
+
+export declare type UiPolicyExpressionType = (typeof UiPolicyExpressionType)[keyof typeof UiPolicyExpressionType];
+
+export declare function UiPolicyExpressionTypeFromJSON(json: any): UiPolicyExpressionType;
+
+export declare function UiPolicyExpressionTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiPolicyExpressionType;
+
+export declare function UiPolicyExpressionTypeToJSON(value?: UiPolicyExpressionType | null): any;
+
 export declare function UiPolicyFromJSON(json: any): UiPolicy;
 
 export declare function UiPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiPolicy;
@@ -3426,14 +3454,6 @@ export declare function UiPolicyToJSON(value?: UiPolicy | null): any;
  *
  */
 export declare class UseCaseApi extends runtime.BaseAPI {
-    /**
-     * Create a new Policy Definition
-     */
-    createPolicyDefinitionUseCaseRaw(requestParameters: CreatePolicyDefinitionUseCaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
-    /**
-     * Create a new Policy Definition
-     */
-    createPolicyDefinitionUseCase(requestParameters?: CreatePolicyDefinitionUseCaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
     /**
      * Basic KPIs about the running EDC Connector.
      */