@sovity.de/edc-client 8.1.0 → 10.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.
- package/README.md +6 -6
- package/dist/sovity-edc-client.d.ts +654 -218
- package/dist/sovity-edc-client.js +1810 -1366
- package/dist/sovity-edc-client.js.map +1 -1
- package/dist/sovity-edc-client.umd.cjs +1 -1
- package/dist/sovity-edc-client.umd.cjs.map +1 -1
- package/package.json +3 -3
|
@@ -23,41 +23,9 @@ export declare function AssetPageFromJSONTyped(json: any, ignoreDiscriminator: b
|
|
|
23
23
|
|
|
24
24
|
export declare function AssetPageToJSON(value?: AssetPage | null): any;
|
|
25
25
|
|
|
26
|
-
/**
|
|
27
|
-
* Type-Safe OpenAPI generator friendly Constraint DTO that supports an opinionated subset of the original EDC Constraint Entity.
|
|
28
|
-
* @export
|
|
29
|
-
* @interface AtomicConstraintDto
|
|
30
|
-
*/
|
|
31
|
-
export declare interface AtomicConstraintDto {
|
|
32
|
-
/**
|
|
33
|
-
* Left part of the constraint.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof AtomicConstraintDto
|
|
36
|
-
*/
|
|
37
|
-
leftExpression: string;
|
|
38
|
-
/**
|
|
39
|
-
*
|
|
40
|
-
* @type {OperatorDto}
|
|
41
|
-
* @memberof AtomicConstraintDto
|
|
42
|
-
*/
|
|
43
|
-
operator: OperatorDto;
|
|
44
|
-
/**
|
|
45
|
-
* Right part of the constraint.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof AtomicConstraintDto
|
|
48
|
-
*/
|
|
49
|
-
rightExpression: string;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
export declare function AtomicConstraintDtoFromJSON(json: any): AtomicConstraintDto;
|
|
53
|
-
|
|
54
|
-
export declare function AtomicConstraintDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AtomicConstraintDto;
|
|
55
|
-
|
|
56
|
-
export declare function AtomicConstraintDtoToJSON(value?: AtomicConstraintDto | null): any;
|
|
57
|
-
|
|
58
26
|
/**
|
|
59
27
|
* sovity EDC API Wrapper
|
|
60
|
-
* 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 APIs, etc. We bundled these APIs, so we can have an easier time generating our API Client Libraries.
|
|
28
|
+
* 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.
|
|
61
29
|
*
|
|
62
30
|
* The version of the OpenAPI document: 0.0.0
|
|
63
31
|
* Contact: contact@sovity.de
|
|
@@ -386,6 +354,18 @@ export declare interface ContractAgreementCard {
|
|
|
386
354
|
* @memberof ContractAgreementCard
|
|
387
355
|
*/
|
|
388
356
|
transferProcesses: Array<ContractAgreementTransferProcess>;
|
|
357
|
+
/**
|
|
358
|
+
*
|
|
359
|
+
* @type {ContractTerminationStatus}
|
|
360
|
+
* @memberof ContractAgreementCard
|
|
361
|
+
*/
|
|
362
|
+
terminationStatus: ContractTerminationStatus;
|
|
363
|
+
/**
|
|
364
|
+
*
|
|
365
|
+
* @type {ContractAgreementTerminationInfo}
|
|
366
|
+
* @memberof ContractAgreementCard
|
|
367
|
+
*/
|
|
368
|
+
terminationInformation?: ContractAgreementTerminationInfo;
|
|
389
369
|
}
|
|
390
370
|
|
|
391
371
|
export declare function ContractAgreementCardFromJSON(json: any): ContractAgreementCard;
|
|
@@ -412,7 +392,7 @@ export declare function ContractAgreementDirectionFromJSONTyped(json: any, ignor
|
|
|
412
392
|
export declare function ContractAgreementDirectionToJSON(value?: ContractAgreementDirection | null): any;
|
|
413
393
|
|
|
414
394
|
/**
|
|
415
|
-
*
|
|
395
|
+
* Data as required by the UI's Contract Agreement Page
|
|
416
396
|
* @export
|
|
417
397
|
* @interface ContractAgreementPage
|
|
418
398
|
*/
|
|
@@ -429,8 +409,66 @@ export declare function ContractAgreementPageFromJSON(json: any): ContractAgreem
|
|
|
429
409
|
|
|
430
410
|
export declare function ContractAgreementPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractAgreementPage;
|
|
431
411
|
|
|
412
|
+
/**
|
|
413
|
+
* Filters for querying a Contract Contract Agreement Page
|
|
414
|
+
* @export
|
|
415
|
+
* @interface ContractAgreementPageQuery
|
|
416
|
+
*/
|
|
417
|
+
export declare interface ContractAgreementPageQuery {
|
|
418
|
+
/**
|
|
419
|
+
*
|
|
420
|
+
* @type {ContractTerminationStatus}
|
|
421
|
+
* @memberof ContractAgreementPageQuery
|
|
422
|
+
*/
|
|
423
|
+
terminationStatus?: ContractTerminationStatus;
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
export declare function ContractAgreementPageQueryFromJSON(json: any): ContractAgreementPageQuery;
|
|
427
|
+
|
|
428
|
+
export declare function ContractAgreementPageQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractAgreementPageQuery;
|
|
429
|
+
|
|
430
|
+
export declare function ContractAgreementPageQueryToJSON(value?: ContractAgreementPageQuery | null): any;
|
|
431
|
+
|
|
432
432
|
export declare function ContractAgreementPageToJSON(value?: ContractAgreementPage | null): any;
|
|
433
433
|
|
|
434
|
+
/**
|
|
435
|
+
* Contract's agreement metadata
|
|
436
|
+
* @export
|
|
437
|
+
* @interface ContractAgreementTerminationInfo
|
|
438
|
+
*/
|
|
439
|
+
export declare interface ContractAgreementTerminationInfo {
|
|
440
|
+
/**
|
|
441
|
+
* Termination's date and time
|
|
442
|
+
* @type {Date}
|
|
443
|
+
* @memberof ContractAgreementTerminationInfo
|
|
444
|
+
*/
|
|
445
|
+
terminatedAt: Date;
|
|
446
|
+
/**
|
|
447
|
+
* The termination's nature e.g. User Termination
|
|
448
|
+
* @type {string}
|
|
449
|
+
* @memberof ContractAgreementTerminationInfo
|
|
450
|
+
*/
|
|
451
|
+
reason: string;
|
|
452
|
+
/**
|
|
453
|
+
* Detailed message from the terminating party about why the contract was terminated.
|
|
454
|
+
* @type {string}
|
|
455
|
+
* @memberof ContractAgreementTerminationInfo
|
|
456
|
+
*/
|
|
457
|
+
detail: string;
|
|
458
|
+
/**
|
|
459
|
+
*
|
|
460
|
+
* @type {ContractTerminatedBy}
|
|
461
|
+
* @memberof ContractAgreementTerminationInfo
|
|
462
|
+
*/
|
|
463
|
+
terminatedBy: ContractTerminatedBy;
|
|
464
|
+
}
|
|
465
|
+
|
|
466
|
+
export declare function ContractAgreementTerminationInfoFromJSON(json: any): ContractAgreementTerminationInfo;
|
|
467
|
+
|
|
468
|
+
export declare function ContractAgreementTerminationInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractAgreementTerminationInfo;
|
|
469
|
+
|
|
470
|
+
export declare function ContractAgreementTerminationInfoToJSON(value?: ContractAgreementTerminationInfo | null): any;
|
|
471
|
+
|
|
434
472
|
/**
|
|
435
473
|
* A Contract Agreement's Transfer Process
|
|
436
474
|
* @export
|
|
@@ -508,7 +546,7 @@ export declare function ContractDefinitionEntryFromJSONTyped(json: any, ignoreDi
|
|
|
508
546
|
export declare function ContractDefinitionEntryToJSON(value?: ContractDefinitionEntry | null): any;
|
|
509
547
|
|
|
510
548
|
/**
|
|
511
|
-
*
|
|
549
|
+
*
|
|
512
550
|
* @export
|
|
513
551
|
* @interface ContractDefinitionPage
|
|
514
552
|
*/
|
|
@@ -659,6 +697,66 @@ export declare function ContractNegotiationStateFromJSONTyped(json: any, ignoreD
|
|
|
659
697
|
|
|
660
698
|
export declare function ContractNegotiationStateToJSON(value?: ContractNegotiationState | null): any;
|
|
661
699
|
|
|
700
|
+
/**
|
|
701
|
+
* Whether the contract termination was initiated by this EDC or a counterparty EDC.
|
|
702
|
+
* @export
|
|
703
|
+
*/
|
|
704
|
+
export declare const ContractTerminatedBy: {
|
|
705
|
+
readonly Self: "SELF";
|
|
706
|
+
readonly Counterparty: "COUNTERPARTY";
|
|
707
|
+
};
|
|
708
|
+
|
|
709
|
+
export declare type ContractTerminatedBy = (typeof ContractTerminatedBy)[keyof typeof ContractTerminatedBy];
|
|
710
|
+
|
|
711
|
+
export declare function ContractTerminatedByFromJSON(json: any): ContractTerminatedBy;
|
|
712
|
+
|
|
713
|
+
export declare function ContractTerminatedByFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractTerminatedBy;
|
|
714
|
+
|
|
715
|
+
export declare function ContractTerminatedByToJSON(value?: ContractTerminatedBy | null): any;
|
|
716
|
+
|
|
717
|
+
/**
|
|
718
|
+
* Data for terminating a Contract Agreement
|
|
719
|
+
* @export
|
|
720
|
+
* @interface ContractTerminationRequest
|
|
721
|
+
*/
|
|
722
|
+
export declare interface ContractTerminationRequest {
|
|
723
|
+
/**
|
|
724
|
+
* A user explanation to detail why the contract was terminated.
|
|
725
|
+
* @type {string}
|
|
726
|
+
* @memberof ContractTerminationRequest
|
|
727
|
+
*/
|
|
728
|
+
detail: string;
|
|
729
|
+
/**
|
|
730
|
+
* A short reason why this contract was terminated
|
|
731
|
+
* @type {string}
|
|
732
|
+
* @memberof ContractTerminationRequest
|
|
733
|
+
*/
|
|
734
|
+
reason: string;
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
export declare function ContractTerminationRequestFromJSON(json: any): ContractTerminationRequest;
|
|
738
|
+
|
|
739
|
+
export declare function ContractTerminationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractTerminationRequest;
|
|
740
|
+
|
|
741
|
+
export declare function ContractTerminationRequestToJSON(value?: ContractTerminationRequest | null): any;
|
|
742
|
+
|
|
743
|
+
/**
|
|
744
|
+
* The contract termination status
|
|
745
|
+
* @export
|
|
746
|
+
*/
|
|
747
|
+
export declare const ContractTerminationStatus: {
|
|
748
|
+
readonly Ongoing: "ONGOING";
|
|
749
|
+
readonly Terminated: "TERMINATED";
|
|
750
|
+
};
|
|
751
|
+
|
|
752
|
+
export declare type ContractTerminationStatus = (typeof ContractTerminationStatus)[keyof typeof ContractTerminationStatus];
|
|
753
|
+
|
|
754
|
+
export declare function ContractTerminationStatusFromJSON(json: any): ContractTerminationStatus;
|
|
755
|
+
|
|
756
|
+
export declare function ContractTerminationStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractTerminationStatus;
|
|
757
|
+
|
|
758
|
+
export declare function ContractTerminationStatusToJSON(value?: ContractTerminationStatus | null): any;
|
|
759
|
+
|
|
662
760
|
export declare interface CreateAssetRequest {
|
|
663
761
|
uiAssetCreateRequest?: UiAssetCreateRequest;
|
|
664
762
|
}
|
|
@@ -671,8 +769,8 @@ export declare interface CreatePolicyDefinitionRequest {
|
|
|
671
769
|
policyDefinitionCreateRequest?: PolicyDefinitionCreateRequest;
|
|
672
770
|
}
|
|
673
771
|
|
|
674
|
-
export declare interface
|
|
675
|
-
|
|
772
|
+
export declare interface CreatePolicyDefinitionV2Request {
|
|
773
|
+
policyDefinitionCreateDto?: PolicyDefinitionCreateDto;
|
|
676
774
|
}
|
|
677
775
|
|
|
678
776
|
/**
|
|
@@ -734,7 +832,7 @@ export declare function DashboardMiwConfigFromJSONTyped(json: any, ignoreDiscrim
|
|
|
734
832
|
export declare function DashboardMiwConfigToJSON(value?: DashboardMiwConfig | null): any;
|
|
735
833
|
|
|
736
834
|
/**
|
|
737
|
-
*
|
|
835
|
+
* Data as required by the UI's Dashboard Page
|
|
738
836
|
* @export
|
|
739
837
|
* @interface DashboardPage
|
|
740
838
|
*/
|
|
@@ -850,7 +948,7 @@ export declare function DashboardPageFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
850
948
|
export declare function DashboardPageToJSON(value?: DashboardPage | null): any;
|
|
851
949
|
|
|
852
950
|
/**
|
|
853
|
-
*
|
|
951
|
+
* Number of Transfer Processes for given direction.
|
|
854
952
|
* @export
|
|
855
953
|
* @interface DashboardTransferAmounts
|
|
856
954
|
*/
|
|
@@ -887,6 +985,41 @@ export declare function DashboardTransferAmountsFromJSONTyped(json: any, ignoreD
|
|
|
887
985
|
|
|
888
986
|
export declare function DashboardTransferAmountsToJSON(value?: DashboardTransferAmounts | null): any;
|
|
889
987
|
|
|
988
|
+
/**
|
|
989
|
+
* Differentiate 'Live' Data Offers that have a real data source from 'On Request' Data Offers that contain only a contact email address for requesting an individual data offer.
|
|
990
|
+
* @export
|
|
991
|
+
*/
|
|
992
|
+
export declare const DataSourceAvailability: {
|
|
993
|
+
readonly Live: "LIVE";
|
|
994
|
+
readonly OnRequest: "ON_REQUEST";
|
|
995
|
+
};
|
|
996
|
+
|
|
997
|
+
export declare type DataSourceAvailability = (typeof DataSourceAvailability)[keyof typeof DataSourceAvailability];
|
|
998
|
+
|
|
999
|
+
export declare function DataSourceAvailabilityFromJSON(json: any): DataSourceAvailability;
|
|
1000
|
+
|
|
1001
|
+
export declare function DataSourceAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceAvailability;
|
|
1002
|
+
|
|
1003
|
+
export declare function DataSourceAvailabilityToJSON(value?: DataSourceAvailability | null): any;
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Supported Data Source Types by UiDataSource
|
|
1007
|
+
* @export
|
|
1008
|
+
*/
|
|
1009
|
+
export declare const DataSourceType: {
|
|
1010
|
+
readonly HttpData: "HTTP_DATA";
|
|
1011
|
+
readonly OnRequest: "ON_REQUEST";
|
|
1012
|
+
readonly Custom: "CUSTOM";
|
|
1013
|
+
};
|
|
1014
|
+
|
|
1015
|
+
export declare type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
|
|
1016
|
+
|
|
1017
|
+
export declare function DataSourceTypeFromJSON(json: any): DataSourceType;
|
|
1018
|
+
|
|
1019
|
+
export declare function DataSourceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceType;
|
|
1020
|
+
|
|
1021
|
+
export declare function DataSourceTypeToJSON(value?: DataSourceType | null): any;
|
|
1022
|
+
|
|
890
1023
|
export declare const DefaultConfig: Configuration;
|
|
891
1024
|
|
|
892
1025
|
export declare interface DeleteAssetRequest {
|
|
@@ -920,9 +1053,9 @@ export declare interface EdcClientOptions {
|
|
|
920
1053
|
configOverrides?: Partial<ConfigurationParameters>;
|
|
921
1054
|
}
|
|
922
1055
|
|
|
923
|
-
export declare interface
|
|
1056
|
+
export declare interface EditAssetRequest {
|
|
924
1057
|
assetId: string;
|
|
925
|
-
|
|
1058
|
+
uiAssetEditRequest?: UiAssetEditRequest;
|
|
926
1059
|
}
|
|
927
1060
|
|
|
928
1061
|
/**
|
|
@@ -969,61 +1102,6 @@ export declare interface ErrorContext {
|
|
|
969
1102
|
|
|
970
1103
|
export declare function exists(json: any, key: string): boolean;
|
|
971
1104
|
|
|
972
|
-
/**
|
|
973
|
-
* Represents a single atomic constraint or a multiplicity constraint. The atomicConstraint will be evaluated if the constraintType is ATOMIC_CONSTRAINT.
|
|
974
|
-
* @export
|
|
975
|
-
* @interface Expression
|
|
976
|
-
*/
|
|
977
|
-
export declare interface Expression {
|
|
978
|
-
/**
|
|
979
|
-
*
|
|
980
|
-
* @type {ExpressionType}
|
|
981
|
-
* @memberof Expression
|
|
982
|
-
*/
|
|
983
|
-
expressionType?: ExpressionType;
|
|
984
|
-
/**
|
|
985
|
-
* List of policy elements that are evaluated according the expressionType.
|
|
986
|
-
* @type {Array<Expression>}
|
|
987
|
-
* @memberof Expression
|
|
988
|
-
*/
|
|
989
|
-
expressions?: Array<Expression>;
|
|
990
|
-
/**
|
|
991
|
-
*
|
|
992
|
-
* @type {AtomicConstraintDto}
|
|
993
|
-
* @memberof Expression
|
|
994
|
-
*/
|
|
995
|
-
atomicConstraint?: AtomicConstraintDto;
|
|
996
|
-
}
|
|
997
|
-
|
|
998
|
-
export declare function ExpressionFromJSON(json: any): Expression;
|
|
999
|
-
|
|
1000
|
-
export declare function ExpressionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Expression;
|
|
1001
|
-
|
|
1002
|
-
export declare function ExpressionToJSON(value?: Expression | null): any;
|
|
1003
|
-
|
|
1004
|
-
/**
|
|
1005
|
-
* Expression types:
|
|
1006
|
-
* * `ATOMIC_CONSTRAINT` - A single constraint for the policy
|
|
1007
|
-
* * `AND` - Several constraints, all of which must be respected
|
|
1008
|
-
* * `OR` - Several constraints, of which at least one must be respected
|
|
1009
|
-
* * `XOR` - Several constraints, of which exactly one must be respected
|
|
1010
|
-
* @export
|
|
1011
|
-
*/
|
|
1012
|
-
export declare const ExpressionType: {
|
|
1013
|
-
readonly AtomicConstraint: "ATOMIC_CONSTRAINT";
|
|
1014
|
-
readonly And: "AND";
|
|
1015
|
-
readonly Or: "OR";
|
|
1016
|
-
readonly Xor: "XOR";
|
|
1017
|
-
};
|
|
1018
|
-
|
|
1019
|
-
export declare type ExpressionType = (typeof ExpressionType)[keyof typeof ExpressionType];
|
|
1020
|
-
|
|
1021
|
-
export declare function ExpressionTypeFromJSON(json: any): ExpressionType;
|
|
1022
|
-
|
|
1023
|
-
export declare function ExpressionTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExpressionType;
|
|
1024
|
-
|
|
1025
|
-
export declare function ExpressionTypeToJSON(value?: ExpressionType | null): any;
|
|
1026
|
-
|
|
1027
1105
|
export declare type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
|
|
1028
1106
|
|
|
1029
1107
|
export declare class FetchError extends Error {
|
|
@@ -1046,6 +1124,10 @@ export declare interface GetCatalogPageDataOffersRequest {
|
|
|
1046
1124
|
connectorEndpoint?: string;
|
|
1047
1125
|
}
|
|
1048
1126
|
|
|
1127
|
+
export declare interface GetContractAgreementPageRequest {
|
|
1128
|
+
contractAgreementPageQuery?: ContractAgreementPageQuery;
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1049
1131
|
export declare interface GetContractNegotiationRequest {
|
|
1050
1132
|
contractNegotiationId: string;
|
|
1051
1133
|
}
|
|
@@ -1073,6 +1155,32 @@ export declare type HTTPRequestInit = {
|
|
|
1073
1155
|
body?: HTTPBody;
|
|
1074
1156
|
};
|
|
1075
1157
|
|
|
1158
|
+
/**
|
|
1159
|
+
* Object indicates whether an ID for the given object type is already taken or not
|
|
1160
|
+
* @export
|
|
1161
|
+
* @interface IdAvailabilityResponse
|
|
1162
|
+
*/
|
|
1163
|
+
export declare interface IdAvailabilityResponse {
|
|
1164
|
+
/**
|
|
1165
|
+
* ID
|
|
1166
|
+
* @type {string}
|
|
1167
|
+
* @memberof IdAvailabilityResponse
|
|
1168
|
+
*/
|
|
1169
|
+
id: string;
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @type {boolean}
|
|
1173
|
+
* @memberof IdAvailabilityResponse
|
|
1174
|
+
*/
|
|
1175
|
+
available?: boolean;
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1178
|
+
export declare function IdAvailabilityResponseFromJSON(json: any): IdAvailabilityResponse;
|
|
1179
|
+
|
|
1180
|
+
export declare function IdAvailabilityResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IdAvailabilityResponse;
|
|
1181
|
+
|
|
1182
|
+
export declare function IdAvailabilityResponseToJSON(value?: IdAvailabilityResponse | null): any;
|
|
1183
|
+
|
|
1076
1184
|
/**
|
|
1077
1185
|
* Marks the operation as successful
|
|
1078
1186
|
* @export
|
|
@@ -1183,11 +1291,6 @@ export declare type InitOverrideFunction = (requestContext: {
|
|
|
1183
1291
|
*/
|
|
1184
1292
|
export declare function instanceOfAssetPage(value: object): boolean;
|
|
1185
1293
|
|
|
1186
|
-
/**
|
|
1187
|
-
* Check if a given object implements the AtomicConstraintDto interface.
|
|
1188
|
-
*/
|
|
1189
|
-
export declare function instanceOfAtomicConstraintDto(value: object): boolean;
|
|
1190
|
-
|
|
1191
1294
|
/**
|
|
1192
1295
|
* Check if a given object implements the CatalogFilterExpression interface.
|
|
1193
1296
|
*/
|
|
@@ -1218,6 +1321,16 @@ export declare function instanceOfContractAgreementCard(value: object): boolean;
|
|
|
1218
1321
|
*/
|
|
1219
1322
|
export declare function instanceOfContractAgreementPage(value: object): boolean;
|
|
1220
1323
|
|
|
1324
|
+
/**
|
|
1325
|
+
* Check if a given object implements the ContractAgreementPageQuery interface.
|
|
1326
|
+
*/
|
|
1327
|
+
export declare function instanceOfContractAgreementPageQuery(value: object): boolean;
|
|
1328
|
+
|
|
1329
|
+
/**
|
|
1330
|
+
* Check if a given object implements the ContractAgreementTerminationInfo interface.
|
|
1331
|
+
*/
|
|
1332
|
+
export declare function instanceOfContractAgreementTerminationInfo(value: object): boolean;
|
|
1333
|
+
|
|
1221
1334
|
/**
|
|
1222
1335
|
* Check if a given object implements the ContractAgreementTransferProcess interface.
|
|
1223
1336
|
*/
|
|
@@ -1248,6 +1361,11 @@ export declare function instanceOfContractNegotiationRequest(value: object): boo
|
|
|
1248
1361
|
*/
|
|
1249
1362
|
export declare function instanceOfContractNegotiationState(value: object): boolean;
|
|
1250
1363
|
|
|
1364
|
+
/**
|
|
1365
|
+
* Check if a given object implements the ContractTerminationRequest interface.
|
|
1366
|
+
*/
|
|
1367
|
+
export declare function instanceOfContractTerminationRequest(value: object): boolean;
|
|
1368
|
+
|
|
1251
1369
|
/**
|
|
1252
1370
|
* Check if a given object implements the DashboardDapsConfig interface.
|
|
1253
1371
|
*/
|
|
@@ -1269,9 +1387,9 @@ export declare function instanceOfDashboardPage(value: object): boolean;
|
|
|
1269
1387
|
export declare function instanceOfDashboardTransferAmounts(value: object): boolean;
|
|
1270
1388
|
|
|
1271
1389
|
/**
|
|
1272
|
-
* Check if a given object implements the
|
|
1390
|
+
* Check if a given object implements the IdAvailabilityResponse interface.
|
|
1273
1391
|
*/
|
|
1274
|
-
export declare function
|
|
1392
|
+
export declare function instanceOfIdAvailabilityResponse(value: object): boolean;
|
|
1275
1393
|
|
|
1276
1394
|
/**
|
|
1277
1395
|
* Check if a given object implements the IdResponseDto interface.
|
|
@@ -1294,14 +1412,9 @@ export declare function instanceOfInitiateTransferRequest(value: object): boolea
|
|
|
1294
1412
|
export declare function instanceOfKpiResult(value: object): boolean;
|
|
1295
1413
|
|
|
1296
1414
|
/**
|
|
1297
|
-
* Check if a given object implements the
|
|
1298
|
-
*/
|
|
1299
|
-
export declare function instanceOfPermissionDto(value: object): boolean;
|
|
1300
|
-
|
|
1301
|
-
/**
|
|
1302
|
-
* Check if a given object implements the PolicyCreateRequest interface.
|
|
1415
|
+
* Check if a given object implements the PolicyDefinitionCreateDto interface.
|
|
1303
1416
|
*/
|
|
1304
|
-
export declare function
|
|
1417
|
+
export declare function instanceOfPolicyDefinitionCreateDto(value: object): boolean;
|
|
1305
1418
|
|
|
1306
1419
|
/**
|
|
1307
1420
|
* Check if a given object implements the PolicyDefinitionCreateRequest interface.
|
|
@@ -1318,6 +1431,11 @@ export declare function instanceOfPolicyDefinitionDto(value: object): boolean;
|
|
|
1318
1431
|
*/
|
|
1319
1432
|
export declare function instanceOfPolicyDefinitionPage(value: object): boolean;
|
|
1320
1433
|
|
|
1434
|
+
/**
|
|
1435
|
+
* Check if a given object implements the SecretValue interface.
|
|
1436
|
+
*/
|
|
1437
|
+
export declare function instanceOfSecretValue(value: object): boolean;
|
|
1438
|
+
|
|
1321
1439
|
/**
|
|
1322
1440
|
* Check if a given object implements the TransferHistoryEntry interface.
|
|
1323
1441
|
*/
|
|
@@ -1349,9 +1467,9 @@ export declare function instanceOfUiAsset(value: object): boolean;
|
|
|
1349
1467
|
export declare function instanceOfUiAssetCreateRequest(value: object): boolean;
|
|
1350
1468
|
|
|
1351
1469
|
/**
|
|
1352
|
-
* Check if a given object implements the
|
|
1470
|
+
* Check if a given object implements the UiAssetEditRequest interface.
|
|
1353
1471
|
*/
|
|
1354
|
-
export declare function
|
|
1472
|
+
export declare function instanceOfUiAssetEditRequest(value: object): boolean;
|
|
1355
1473
|
|
|
1356
1474
|
/**
|
|
1357
1475
|
* Check if a given object implements the UiContractNegotiation interface.
|
|
@@ -1378,6 +1496,21 @@ export declare function instanceOfUiCriterionLiteral(value: object): boolean;
|
|
|
1378
1496
|
*/
|
|
1379
1497
|
export declare function instanceOfUiDataOffer(value: object): boolean;
|
|
1380
1498
|
|
|
1499
|
+
/**
|
|
1500
|
+
* Check if a given object implements the UiDataSource interface.
|
|
1501
|
+
*/
|
|
1502
|
+
export declare function instanceOfUiDataSource(value: object): boolean;
|
|
1503
|
+
|
|
1504
|
+
/**
|
|
1505
|
+
* Check if a given object implements the UiDataSourceHttpData interface.
|
|
1506
|
+
*/
|
|
1507
|
+
export declare function instanceOfUiDataSourceHttpData(value: object): boolean;
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* Check if a given object implements the UiDataSourceOnRequest interface.
|
|
1511
|
+
*/
|
|
1512
|
+
export declare function instanceOfUiDataSourceOnRequest(value: object): boolean;
|
|
1513
|
+
|
|
1381
1514
|
/**
|
|
1382
1515
|
* Check if a given object implements the UiPolicy interface.
|
|
1383
1516
|
*/
|
|
@@ -1393,11 +1526,28 @@ export declare function instanceOfUiPolicyConstraint(value: object): boolean;
|
|
|
1393
1526
|
*/
|
|
1394
1527
|
export declare function instanceOfUiPolicyCreateRequest(value: object): boolean;
|
|
1395
1528
|
|
|
1529
|
+
/**
|
|
1530
|
+
* Check if a given object implements the UiPolicyExpression interface.
|
|
1531
|
+
*/
|
|
1532
|
+
export declare function instanceOfUiPolicyExpression(value: object): boolean;
|
|
1533
|
+
|
|
1396
1534
|
/**
|
|
1397
1535
|
* Check if a given object implements the UiPolicyLiteral interface.
|
|
1398
1536
|
*/
|
|
1399
1537
|
export declare function instanceOfUiPolicyLiteral(value: object): boolean;
|
|
1400
1538
|
|
|
1539
|
+
export declare interface IsAssetIdAvailableRequest {
|
|
1540
|
+
assetId: string;
|
|
1541
|
+
}
|
|
1542
|
+
|
|
1543
|
+
export declare interface IsContractDefinitionIdAvailableRequest {
|
|
1544
|
+
contractDefinitionId: string;
|
|
1545
|
+
}
|
|
1546
|
+
|
|
1547
|
+
export declare interface IsPolicyIdAvailableRequest {
|
|
1548
|
+
policyId: string;
|
|
1549
|
+
}
|
|
1550
|
+
|
|
1401
1551
|
export declare type Json = any;
|
|
1402
1552
|
|
|
1403
1553
|
export declare class JSONApiResponse<T> {
|
|
@@ -1462,7 +1612,7 @@ export declare interface Middleware {
|
|
|
1462
1612
|
export declare type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
|
|
1463
1613
|
|
|
1464
1614
|
/**
|
|
1465
|
-
* Operator
|
|
1615
|
+
* Type-Safe ODRL Policy Operator as supported by the sovity product landscape
|
|
1466
1616
|
* @export
|
|
1467
1617
|
*/
|
|
1468
1618
|
export declare const OperatorDto: {
|
|
@@ -1489,53 +1639,33 @@ export declare function OperatorDtoFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
1489
1639
|
export declare function OperatorDtoToJSON(value?: OperatorDto | null): any;
|
|
1490
1640
|
|
|
1491
1641
|
/**
|
|
1492
|
-
*
|
|
1493
|
-
* @export
|
|
1494
|
-
* @interface PermissionDto
|
|
1495
|
-
*/
|
|
1496
|
-
export declare interface PermissionDto {
|
|
1497
|
-
/**
|
|
1498
|
-
*
|
|
1499
|
-
* @type {Expression}
|
|
1500
|
-
* @memberof PermissionDto
|
|
1501
|
-
*/
|
|
1502
|
-
expression: Expression;
|
|
1503
|
-
}
|
|
1504
|
-
|
|
1505
|
-
export declare function PermissionDtoFromJSON(json: any): PermissionDto;
|
|
1506
|
-
|
|
1507
|
-
export declare function PermissionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PermissionDto;
|
|
1508
|
-
|
|
1509
|
-
export declare function PermissionDtoToJSON(value?: PermissionDto | null): any;
|
|
1510
|
-
|
|
1511
|
-
/**
|
|
1512
|
-
* Policy Creation Request Supporting Multiplicity Constraints.
|
|
1642
|
+
* Create a Policy Definition
|
|
1513
1643
|
* @export
|
|
1514
|
-
* @interface
|
|
1644
|
+
* @interface PolicyDefinitionCreateDto
|
|
1515
1645
|
*/
|
|
1516
|
-
export declare interface
|
|
1646
|
+
export declare interface PolicyDefinitionCreateDto {
|
|
1517
1647
|
/**
|
|
1518
1648
|
* Policy Definition ID
|
|
1519
1649
|
* @type {string}
|
|
1520
|
-
* @memberof
|
|
1650
|
+
* @memberof PolicyDefinitionCreateDto
|
|
1521
1651
|
*/
|
|
1522
1652
|
policyDefinitionId: string;
|
|
1523
1653
|
/**
|
|
1524
1654
|
*
|
|
1525
|
-
* @type {
|
|
1526
|
-
* @memberof
|
|
1655
|
+
* @type {UiPolicyExpression}
|
|
1656
|
+
* @memberof PolicyDefinitionCreateDto
|
|
1527
1657
|
*/
|
|
1528
|
-
|
|
1658
|
+
expression: UiPolicyExpression;
|
|
1529
1659
|
}
|
|
1530
1660
|
|
|
1531
|
-
export declare function
|
|
1661
|
+
export declare function PolicyDefinitionCreateDtoFromJSON(json: any): PolicyDefinitionCreateDto;
|
|
1532
1662
|
|
|
1533
|
-
export declare function
|
|
1663
|
+
export declare function PolicyDefinitionCreateDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyDefinitionCreateDto;
|
|
1534
1664
|
|
|
1535
|
-
export declare function
|
|
1665
|
+
export declare function PolicyDefinitionCreateDtoToJSON(value?: PolicyDefinitionCreateDto | null): any;
|
|
1536
1666
|
|
|
1537
1667
|
/**
|
|
1538
|
-
*
|
|
1668
|
+
* [Deprecated] Create a Policy Definition. Use PolicyDefinitionCreateDto
|
|
1539
1669
|
* @export
|
|
1540
1670
|
* @interface PolicyDefinitionCreateRequest
|
|
1541
1671
|
*/
|
|
@@ -1550,6 +1680,7 @@ export declare interface PolicyDefinitionCreateRequest {
|
|
|
1550
1680
|
*
|
|
1551
1681
|
* @type {UiPolicyCreateRequest}
|
|
1552
1682
|
* @memberof PolicyDefinitionCreateRequest
|
|
1683
|
+
* @deprecated
|
|
1553
1684
|
*/
|
|
1554
1685
|
policy: UiPolicyCreateRequest;
|
|
1555
1686
|
}
|
|
@@ -1689,6 +1820,37 @@ declare namespace runtime {
|
|
|
1689
1820
|
}
|
|
1690
1821
|
}
|
|
1691
1822
|
|
|
1823
|
+
/**
|
|
1824
|
+
* A value either inlined or to be fetched from the Vault. Raw secret values will land in the database and will be retrievable via the Eclipse EDC Management API.
|
|
1825
|
+
* @export
|
|
1826
|
+
* @interface SecretValue
|
|
1827
|
+
*/
|
|
1828
|
+
export declare interface SecretValue {
|
|
1829
|
+
/**
|
|
1830
|
+
* Secret Name / Vault Key Name.
|
|
1831
|
+
* @type {string}
|
|
1832
|
+
* @memberof SecretValue
|
|
1833
|
+
*/
|
|
1834
|
+
secretName?: string;
|
|
1835
|
+
/**
|
|
1836
|
+
* Raw inline Value.
|
|
1837
|
+
* @type {string}
|
|
1838
|
+
* @memberof SecretValue
|
|
1839
|
+
*/
|
|
1840
|
+
rawValue?: string;
|
|
1841
|
+
}
|
|
1842
|
+
|
|
1843
|
+
export declare function SecretValueFromJSON(json: any): SecretValue;
|
|
1844
|
+
|
|
1845
|
+
export declare function SecretValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretValue;
|
|
1846
|
+
|
|
1847
|
+
export declare function SecretValueToJSON(value?: SecretValue | null): any;
|
|
1848
|
+
|
|
1849
|
+
export declare interface TerminateContractAgreementRequest {
|
|
1850
|
+
contractAgreementId: string;
|
|
1851
|
+
contractTerminationRequest?: ContractTerminationRequest;
|
|
1852
|
+
}
|
|
1853
|
+
|
|
1692
1854
|
export declare class TextApiResponse {
|
|
1693
1855
|
raw: Response;
|
|
1694
1856
|
constructor(raw: Response);
|
|
@@ -1776,7 +1938,7 @@ export declare function TransferHistoryEntryFromJSONTyped(json: any, ignoreDiscr
|
|
|
1776
1938
|
export declare function TransferHistoryEntryToJSON(value?: TransferHistoryEntry | null): any;
|
|
1777
1939
|
|
|
1778
1940
|
/**
|
|
1779
|
-
*
|
|
1941
|
+
* Data as required by the UI's Transfer History Page
|
|
1780
1942
|
* @export
|
|
1781
1943
|
* @interface TransferHistoryPage
|
|
1782
1944
|
*/
|
|
@@ -1896,13 +2058,21 @@ export declare class UIApi extends runtime.BaseAPI {
|
|
|
1896
2058
|
*/
|
|
1897
2059
|
createContractDefinition(requestParameters?: CreateContractDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
1898
2060
|
/**
|
|
1899
|
-
* Create a new Policy Definition
|
|
2061
|
+
* [Deprecated] Create a new Policy Definition from a list of constraints. Use createPolicyDefinitionV2 instead.
|
|
1900
2062
|
*/
|
|
1901
2063
|
createPolicyDefinitionRaw(requestParameters: CreatePolicyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
|
|
1902
2064
|
/**
|
|
1903
|
-
* Create a new Policy Definition
|
|
2065
|
+
* [Deprecated] Create a new Policy Definition from a list of constraints. Use createPolicyDefinitionV2 instead.
|
|
1904
2066
|
*/
|
|
1905
2067
|
createPolicyDefinition(requestParameters?: CreatePolicyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
2068
|
+
/**
|
|
2069
|
+
* Create a new Policy Definition
|
|
2070
|
+
*/
|
|
2071
|
+
createPolicyDefinitionV2Raw(requestParameters: CreatePolicyDefinitionV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
|
|
2072
|
+
/**
|
|
2073
|
+
* Create a new Policy Definition
|
|
2074
|
+
*/
|
|
2075
|
+
createPolicyDefinitionV2(requestParameters?: CreatePolicyDefinitionV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
1906
2076
|
/**
|
|
1907
2077
|
* Delete an Asset
|
|
1908
2078
|
*/
|
|
@@ -1928,13 +2098,13 @@ export declare class UIApi extends runtime.BaseAPI {
|
|
|
1928
2098
|
*/
|
|
1929
2099
|
deletePolicyDefinition(requestParameters: DeletePolicyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
1930
2100
|
/**
|
|
1931
|
-
* Updates an Asset\'s metadata
|
|
2101
|
+
* Updates an Asset\'s metadata and optionally also the data source.
|
|
1932
2102
|
*/
|
|
1933
|
-
|
|
2103
|
+
editAssetRaw(requestParameters: EditAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
|
|
1934
2104
|
/**
|
|
1935
|
-
* Updates an Asset\'s metadata
|
|
2105
|
+
* Updates an Asset\'s metadata and optionally also the data source.
|
|
1936
2106
|
*/
|
|
1937
|
-
|
|
2107
|
+
editAsset(requestParameters: EditAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
1938
2108
|
/**
|
|
1939
2109
|
* Collect all data for Asset Page
|
|
1940
2110
|
*/
|
|
@@ -1952,13 +2122,13 @@ export declare class UIApi extends runtime.BaseAPI {
|
|
|
1952
2122
|
*/
|
|
1953
2123
|
getCatalogPageDataOffers(requestParameters?: GetCatalogPageDataOffersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UiDataOffer>>;
|
|
1954
2124
|
/**
|
|
1955
|
-
* Collect
|
|
2125
|
+
* Collect filtered data for the Contract Agreement Page
|
|
1956
2126
|
*/
|
|
1957
|
-
getContractAgreementPageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContractAgreementPage>>;
|
|
2127
|
+
getContractAgreementPageRaw(requestParameters: GetContractAgreementPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContractAgreementPage>>;
|
|
1958
2128
|
/**
|
|
1959
|
-
* Collect
|
|
2129
|
+
* Collect filtered data for the Contract Agreement Page
|
|
1960
2130
|
*/
|
|
1961
|
-
getContractAgreementPage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContractAgreementPage>;
|
|
2131
|
+
getContractAgreementPage(requestParameters?: GetContractAgreementPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContractAgreementPage>;
|
|
1962
2132
|
/**
|
|
1963
2133
|
* Collect all data for Contract Definition Page
|
|
1964
2134
|
*/
|
|
@@ -2031,14 +2201,52 @@ export declare class UIApi extends runtime.BaseAPI {
|
|
|
2031
2201
|
* Initiate a Transfer Process
|
|
2032
2202
|
*/
|
|
2033
2203
|
initiateTransfer(requestParameters?: InitiateTransferOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
2204
|
+
/**
|
|
2205
|
+
* Validates if the provided assetId is already taken
|
|
2206
|
+
*/
|
|
2207
|
+
isAssetIdAvailableRaw(requestParameters: IsAssetIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdAvailabilityResponse>>;
|
|
2208
|
+
/**
|
|
2209
|
+
* Validates if the provided assetId is already taken
|
|
2210
|
+
*/
|
|
2211
|
+
isAssetIdAvailable(requestParameters: IsAssetIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
|
|
2212
|
+
/**
|
|
2213
|
+
* Validates if the provided contractDefinitionId is already taken
|
|
2214
|
+
*/
|
|
2215
|
+
isContractDefinitionIdAvailableRaw(requestParameters: IsContractDefinitionIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdAvailabilityResponse>>;
|
|
2216
|
+
/**
|
|
2217
|
+
* Validates if the provided contractDefinitionId is already taken
|
|
2218
|
+
*/
|
|
2219
|
+
isContractDefinitionIdAvailable(requestParameters: IsContractDefinitionIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
|
|
2220
|
+
/**
|
|
2221
|
+
* Validates if the provided policyId is already taken
|
|
2222
|
+
*/
|
|
2223
|
+
isPolicyIdAvailableRaw(requestParameters: IsPolicyIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdAvailabilityResponse>>;
|
|
2224
|
+
/**
|
|
2225
|
+
* Validates if the provided policyId is already taken
|
|
2226
|
+
*/
|
|
2227
|
+
isPolicyIdAvailable(requestParameters: IsPolicyIdAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdAvailabilityResponse>;
|
|
2228
|
+
/**
|
|
2229
|
+
* Terminates a contract agreement designated by its contract agreement id.
|
|
2230
|
+
*/
|
|
2231
|
+
terminateContractAgreementRaw(requestParameters: TerminateContractAgreementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
|
|
2232
|
+
/**
|
|
2233
|
+
* Terminates a contract agreement designated by its contract agreement id.
|
|
2234
|
+
*/
|
|
2235
|
+
terminateContractAgreement(requestParameters: TerminateContractAgreementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
2034
2236
|
}
|
|
2035
2237
|
|
|
2036
2238
|
/**
|
|
2037
|
-
* Type-
|
|
2239
|
+
* Type-safe data offer metadata as supported by the sovity product landscape. Contains extension points.
|
|
2038
2240
|
* @export
|
|
2039
2241
|
* @interface UiAsset
|
|
2040
2242
|
*/
|
|
2041
2243
|
export declare interface UiAsset {
|
|
2244
|
+
/**
|
|
2245
|
+
*
|
|
2246
|
+
* @type {DataSourceAvailability}
|
|
2247
|
+
* @memberof UiAsset
|
|
2248
|
+
*/
|
|
2249
|
+
dataSourceAvailability: DataSourceAvailability;
|
|
2042
2250
|
/**
|
|
2043
2251
|
* Asset Id
|
|
2044
2252
|
* @type {string}
|
|
@@ -2069,6 +2277,18 @@ export declare interface UiAsset {
|
|
|
2069
2277
|
* @memberof UiAsset
|
|
2070
2278
|
*/
|
|
2071
2279
|
creatorOrganizationName: string;
|
|
2280
|
+
/**
|
|
2281
|
+
* Contact E-Mail address. Only for dataSourceAvailability ON_REQUEST.
|
|
2282
|
+
* @type {string}
|
|
2283
|
+
* @memberof UiAsset
|
|
2284
|
+
*/
|
|
2285
|
+
onRequestContactEmail?: string;
|
|
2286
|
+
/**
|
|
2287
|
+
* Contact Preferred E-Mail Subject. Only for dataSourceAvailability ON_REQUEST.
|
|
2288
|
+
* @type {string}
|
|
2289
|
+
* @memberof UiAsset
|
|
2290
|
+
*/
|
|
2291
|
+
onRequestContactEmailSubject?: string;
|
|
2072
2292
|
/**
|
|
2073
2293
|
* Asset Language
|
|
2074
2294
|
* @type {string}
|
|
@@ -2130,25 +2350,25 @@ export declare interface UiAsset {
|
|
|
2130
2350
|
*/
|
|
2131
2351
|
landingPageUrl?: string;
|
|
2132
2352
|
/**
|
|
2133
|
-
* HTTP Datasource
|
|
2353
|
+
* HTTP Datasource Hint: Proxy Method. Only for dataSourceAvailability LIVE with an underlying HTTP_DATA Data Source.
|
|
2134
2354
|
* @type {boolean}
|
|
2135
2355
|
* @memberof UiAsset
|
|
2136
2356
|
*/
|
|
2137
2357
|
httpDatasourceHintsProxyMethod?: boolean;
|
|
2138
2358
|
/**
|
|
2139
|
-
* HTTP Datasource
|
|
2359
|
+
* HTTP Datasource Hint: Proxy Path. Only for dataSourceAvailability LIVE with an underlying HTTP_DATA Data Source.
|
|
2140
2360
|
* @type {boolean}
|
|
2141
2361
|
* @memberof UiAsset
|
|
2142
2362
|
*/
|
|
2143
2363
|
httpDatasourceHintsProxyPath?: boolean;
|
|
2144
2364
|
/**
|
|
2145
|
-
* HTTP Datasource
|
|
2365
|
+
* HTTP Datasource Hint: Proxy Query Params. Only for dataSourceAvailability LIVE with an underlying HTTP_DATA Data Source.
|
|
2146
2366
|
* @type {boolean}
|
|
2147
2367
|
* @memberof UiAsset
|
|
2148
2368
|
*/
|
|
2149
2369
|
httpDatasourceHintsProxyQueryParams?: boolean;
|
|
2150
2370
|
/**
|
|
2151
|
-
* HTTP Datasource
|
|
2371
|
+
* HTTP Datasource Hint: Proxy Body. Only for dataSourceAvailability LIVE with an underlying HTTP_DATA Data Source.
|
|
2152
2372
|
* @type {boolean}
|
|
2153
2373
|
* @memberof UiAsset
|
|
2154
2374
|
*/
|
|
@@ -2276,11 +2496,17 @@ export declare interface UiAsset {
|
|
|
2276
2496
|
}
|
|
2277
2497
|
|
|
2278
2498
|
/**
|
|
2279
|
-
* Type-
|
|
2499
|
+
* Type-safe data offer metadata for creating an asset as supported by the sovity product landscape. Contains extension points.
|
|
2280
2500
|
* @export
|
|
2281
2501
|
* @interface UiAssetCreateRequest
|
|
2282
2502
|
*/
|
|
2283
2503
|
export declare interface UiAssetCreateRequest {
|
|
2504
|
+
/**
|
|
2505
|
+
*
|
|
2506
|
+
* @type {UiDataSource}
|
|
2507
|
+
* @memberof UiAssetCreateRequest
|
|
2508
|
+
*/
|
|
2509
|
+
dataSource: UiDataSource;
|
|
2284
2510
|
/**
|
|
2285
2511
|
* Asset Id
|
|
2286
2512
|
* @type {string}
|
|
@@ -2431,14 +2657,6 @@ export declare interface UiAssetCreateRequest {
|
|
|
2431
2657
|
* @memberof UiAssetCreateRequest
|
|
2432
2658
|
*/
|
|
2433
2659
|
temporalCoverageToInclusive?: Date;
|
|
2434
|
-
/**
|
|
2435
|
-
* Data Address
|
|
2436
|
-
* @type {{ [key: string]: string; }}
|
|
2437
|
-
* @memberof UiAssetCreateRequest
|
|
2438
|
-
*/
|
|
2439
|
-
dataAddressProperties: {
|
|
2440
|
-
[key: string]: string;
|
|
2441
|
-
};
|
|
2442
2660
|
/**
|
|
2443
2661
|
* Contains serialized custom properties in the JSON format.
|
|
2444
2662
|
* @type {string}
|
|
@@ -2472,186 +2690,192 @@ export declare function UiAssetCreateRequestFromJSONTyped(json: any, ignoreDiscr
|
|
|
2472
2690
|
export declare function UiAssetCreateRequestToJSON(value?: UiAssetCreateRequest | null): any;
|
|
2473
2691
|
|
|
2474
2692
|
/**
|
|
2475
|
-
*
|
|
2693
|
+
* Type-safe data offer metadata for editing an asset as supported by the sovity product landscape. Contains extension points.
|
|
2476
2694
|
* @export
|
|
2477
|
-
* @interface
|
|
2695
|
+
* @interface UiAssetEditRequest
|
|
2478
2696
|
*/
|
|
2479
|
-
export declare interface
|
|
2697
|
+
export declare interface UiAssetEditRequest {
|
|
2698
|
+
/**
|
|
2699
|
+
*
|
|
2700
|
+
* @type {UiDataSource}
|
|
2701
|
+
* @memberof UiAssetEditRequest
|
|
2702
|
+
*/
|
|
2703
|
+
dataSourceOverrideOrNull?: UiDataSource;
|
|
2480
2704
|
/**
|
|
2481
2705
|
* Asset Title
|
|
2482
2706
|
* @type {string}
|
|
2483
|
-
* @memberof
|
|
2707
|
+
* @memberof UiAssetEditRequest
|
|
2484
2708
|
*/
|
|
2485
2709
|
title?: string;
|
|
2486
2710
|
/**
|
|
2487
2711
|
* Asset Language
|
|
2488
2712
|
* @type {string}
|
|
2489
|
-
* @memberof
|
|
2713
|
+
* @memberof UiAssetEditRequest
|
|
2490
2714
|
*/
|
|
2491
2715
|
language?: string;
|
|
2492
2716
|
/**
|
|
2493
2717
|
* Asset Description
|
|
2494
2718
|
* @type {string}
|
|
2495
|
-
* @memberof
|
|
2719
|
+
* @memberof UiAssetEditRequest
|
|
2496
2720
|
*/
|
|
2497
2721
|
description?: string;
|
|
2498
2722
|
/**
|
|
2499
2723
|
* Asset Homepage
|
|
2500
2724
|
* @type {string}
|
|
2501
|
-
* @memberof
|
|
2725
|
+
* @memberof UiAssetEditRequest
|
|
2502
2726
|
*/
|
|
2503
2727
|
publisherHomepage?: string;
|
|
2504
2728
|
/**
|
|
2505
2729
|
* License URL
|
|
2506
2730
|
* @type {string}
|
|
2507
|
-
* @memberof
|
|
2731
|
+
* @memberof UiAssetEditRequest
|
|
2508
2732
|
*/
|
|
2509
2733
|
licenseUrl?: string;
|
|
2510
2734
|
/**
|
|
2511
2735
|
* Version
|
|
2512
2736
|
* @type {string}
|
|
2513
|
-
* @memberof
|
|
2737
|
+
* @memberof UiAssetEditRequest
|
|
2514
2738
|
*/
|
|
2515
2739
|
version?: string;
|
|
2516
2740
|
/**
|
|
2517
2741
|
* Asset Keywords
|
|
2518
2742
|
* @type {Array<string>}
|
|
2519
|
-
* @memberof
|
|
2743
|
+
* @memberof UiAssetEditRequest
|
|
2520
2744
|
*/
|
|
2521
2745
|
keywords?: Array<string>;
|
|
2522
2746
|
/**
|
|
2523
2747
|
* Asset MediaType
|
|
2524
2748
|
* @type {string}
|
|
2525
|
-
* @memberof
|
|
2749
|
+
* @memberof UiAssetEditRequest
|
|
2526
2750
|
*/
|
|
2527
2751
|
mediaType?: string;
|
|
2528
2752
|
/**
|
|
2529
2753
|
* Landing Page URL
|
|
2530
2754
|
* @type {string}
|
|
2531
|
-
* @memberof
|
|
2755
|
+
* @memberof UiAssetEditRequest
|
|
2532
2756
|
*/
|
|
2533
2757
|
landingPageUrl?: string;
|
|
2534
2758
|
/**
|
|
2535
2759
|
* Data Category
|
|
2536
2760
|
* @type {string}
|
|
2537
|
-
* @memberof
|
|
2761
|
+
* @memberof UiAssetEditRequest
|
|
2538
2762
|
*/
|
|
2539
2763
|
dataCategory?: string;
|
|
2540
2764
|
/**
|
|
2541
2765
|
* Data Subcategory
|
|
2542
2766
|
* @type {string}
|
|
2543
|
-
* @memberof
|
|
2767
|
+
* @memberof UiAssetEditRequest
|
|
2544
2768
|
*/
|
|
2545
2769
|
dataSubcategory?: string;
|
|
2546
2770
|
/**
|
|
2547
2771
|
* Data Model
|
|
2548
2772
|
* @type {string}
|
|
2549
|
-
* @memberof
|
|
2773
|
+
* @memberof UiAssetEditRequest
|
|
2550
2774
|
*/
|
|
2551
2775
|
dataModel?: string;
|
|
2552
2776
|
/**
|
|
2553
2777
|
* Geo-Reference Method
|
|
2554
2778
|
* @type {string}
|
|
2555
|
-
* @memberof
|
|
2779
|
+
* @memberof UiAssetEditRequest
|
|
2556
2780
|
*/
|
|
2557
2781
|
geoReferenceMethod?: string;
|
|
2558
2782
|
/**
|
|
2559
2783
|
* Transport Mode
|
|
2560
2784
|
* @type {string}
|
|
2561
|
-
* @memberof
|
|
2785
|
+
* @memberof UiAssetEditRequest
|
|
2562
2786
|
*/
|
|
2563
2787
|
transportMode?: string;
|
|
2564
2788
|
/**
|
|
2565
2789
|
* The sovereign is distinct from the publisher by being the legal owner of the data.
|
|
2566
2790
|
* @type {string}
|
|
2567
|
-
* @memberof
|
|
2791
|
+
* @memberof UiAssetEditRequest
|
|
2568
2792
|
*/
|
|
2569
2793
|
sovereignLegalName?: string;
|
|
2570
2794
|
/**
|
|
2571
2795
|
* Geo location
|
|
2572
2796
|
* @type {string}
|
|
2573
|
-
* @memberof
|
|
2797
|
+
* @memberof UiAssetEditRequest
|
|
2574
2798
|
*/
|
|
2575
2799
|
geoLocation?: string;
|
|
2576
2800
|
/**
|
|
2577
2801
|
* Locations by NUTS standard which divides countries into administrative divisions
|
|
2578
2802
|
* @type {Array<string>}
|
|
2579
|
-
* @memberof
|
|
2803
|
+
* @memberof UiAssetEditRequest
|
|
2580
2804
|
*/
|
|
2581
2805
|
nutsLocations?: Array<string>;
|
|
2582
2806
|
/**
|
|
2583
2807
|
* Data sample URLs
|
|
2584
2808
|
* @type {Array<string>}
|
|
2585
|
-
* @memberof
|
|
2809
|
+
* @memberof UiAssetEditRequest
|
|
2586
2810
|
*/
|
|
2587
2811
|
dataSampleUrls?: Array<string>;
|
|
2588
2812
|
/**
|
|
2589
2813
|
* Reference file/schema URLs
|
|
2590
2814
|
* @type {Array<string>}
|
|
2591
|
-
* @memberof
|
|
2815
|
+
* @memberof UiAssetEditRequest
|
|
2592
2816
|
*/
|
|
2593
2817
|
referenceFileUrls?: Array<string>;
|
|
2594
2818
|
/**
|
|
2595
2819
|
* Additional information on reference files/schemas
|
|
2596
2820
|
* @type {string}
|
|
2597
|
-
* @memberof
|
|
2821
|
+
* @memberof UiAssetEditRequest
|
|
2598
2822
|
*/
|
|
2599
2823
|
referenceFilesDescription?: string;
|
|
2600
2824
|
/**
|
|
2601
2825
|
* Instructions for use that are not legally relevant e.g. information on how to cite the dataset in papers
|
|
2602
2826
|
* @type {string}
|
|
2603
|
-
* @memberof
|
|
2827
|
+
* @memberof UiAssetEditRequest
|
|
2604
2828
|
*/
|
|
2605
2829
|
conditionsForUse?: string;
|
|
2606
2830
|
/**
|
|
2607
2831
|
* Data update frequency
|
|
2608
2832
|
* @type {string}
|
|
2609
|
-
* @memberof
|
|
2833
|
+
* @memberof UiAssetEditRequest
|
|
2610
2834
|
*/
|
|
2611
2835
|
dataUpdateFrequency?: string;
|
|
2612
2836
|
/**
|
|
2613
2837
|
* Temporal coverage start date
|
|
2614
2838
|
* @type {Date}
|
|
2615
|
-
* @memberof
|
|
2839
|
+
* @memberof UiAssetEditRequest
|
|
2616
2840
|
*/
|
|
2617
2841
|
temporalCoverageFrom?: Date;
|
|
2618
2842
|
/**
|
|
2619
2843
|
* Temporal coverage end date (inclusive)
|
|
2620
2844
|
* @type {Date}
|
|
2621
|
-
* @memberof
|
|
2845
|
+
* @memberof UiAssetEditRequest
|
|
2622
2846
|
*/
|
|
2623
2847
|
temporalCoverageToInclusive?: Date;
|
|
2624
2848
|
/**
|
|
2625
2849
|
* Contains serialized custom properties in the JSON format.
|
|
2626
2850
|
* @type {string}
|
|
2627
|
-
* @memberof
|
|
2851
|
+
* @memberof UiAssetEditRequest
|
|
2628
2852
|
*/
|
|
2629
2853
|
customJsonAsString?: string;
|
|
2630
2854
|
/**
|
|
2631
2855
|
* Contains serialized custom properties in the JSON LD format. Contrary to the customJsonAsString field, this string must represent a JSON LD object and will be affected by JSON LD compaction and expansion. Due to a technical limitation, the properties can't be booleans.
|
|
2632
2856
|
* @type {string}
|
|
2633
|
-
* @memberof
|
|
2857
|
+
* @memberof UiAssetEditRequest
|
|
2634
2858
|
*/
|
|
2635
2859
|
customJsonLdAsString?: string;
|
|
2636
2860
|
/**
|
|
2637
2861
|
* Same as customJsonAsString but the data will be stored in the private properties.
|
|
2638
2862
|
* @type {string}
|
|
2639
|
-
* @memberof
|
|
2863
|
+
* @memberof UiAssetEditRequest
|
|
2640
2864
|
*/
|
|
2641
2865
|
privateCustomJsonAsString?: string;
|
|
2642
2866
|
/**
|
|
2643
2867
|
* Same as customJsonLdAsString but the data will be stored in the private properties. The same limitations apply.
|
|
2644
2868
|
* @type {string}
|
|
2645
|
-
* @memberof
|
|
2869
|
+
* @memberof UiAssetEditRequest
|
|
2646
2870
|
*/
|
|
2647
2871
|
privateCustomJsonLdAsString?: string;
|
|
2648
2872
|
}
|
|
2649
2873
|
|
|
2650
|
-
export declare function
|
|
2874
|
+
export declare function UiAssetEditRequestFromJSON(json: any): UiAssetEditRequest;
|
|
2651
2875
|
|
|
2652
|
-
export declare function
|
|
2876
|
+
export declare function UiAssetEditRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiAssetEditRequest;
|
|
2653
2877
|
|
|
2654
|
-
export declare function
|
|
2878
|
+
export declare function UiAssetEditRequestToJSON(value?: UiAssetEditRequest | null): any;
|
|
2655
2879
|
|
|
2656
2880
|
export declare function UiAssetFromJSON(json: any): UiAsset;
|
|
2657
2881
|
|
|
@@ -2861,7 +3085,170 @@ export declare function UiDataOfferFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
2861
3085
|
export declare function UiDataOfferToJSON(value?: UiDataOffer | null): any;
|
|
2862
3086
|
|
|
2863
3087
|
/**
|
|
2864
|
-
* Type-
|
|
3088
|
+
* Type-safe data source as supported by the sovity product landscape. Contains extension points for using custom data address properties.
|
|
3089
|
+
* @export
|
|
3090
|
+
* @interface UiDataSource
|
|
3091
|
+
*/
|
|
3092
|
+
export declare interface UiDataSource {
|
|
3093
|
+
/**
|
|
3094
|
+
*
|
|
3095
|
+
* @type {DataSourceType}
|
|
3096
|
+
* @memberof UiDataSource
|
|
3097
|
+
*/
|
|
3098
|
+
type: DataSourceType;
|
|
3099
|
+
/**
|
|
3100
|
+
*
|
|
3101
|
+
* @type {UiDataSourceHttpData}
|
|
3102
|
+
* @memberof UiDataSource
|
|
3103
|
+
*/
|
|
3104
|
+
httpData?: UiDataSourceHttpData;
|
|
3105
|
+
/**
|
|
3106
|
+
*
|
|
3107
|
+
* @type {UiDataSourceOnRequest}
|
|
3108
|
+
* @memberof UiDataSource
|
|
3109
|
+
*/
|
|
3110
|
+
onRequest?: UiDataSourceOnRequest;
|
|
3111
|
+
/**
|
|
3112
|
+
* For all types. Custom Data Address Properties.
|
|
3113
|
+
* @type {{ [key: string]: string; }}
|
|
3114
|
+
* @memberof UiDataSource
|
|
3115
|
+
*/
|
|
3116
|
+
customProperties?: {
|
|
3117
|
+
[key: string]: string;
|
|
3118
|
+
};
|
|
3119
|
+
}
|
|
3120
|
+
|
|
3121
|
+
export declare function UiDataSourceFromJSON(json: any): UiDataSource;
|
|
3122
|
+
|
|
3123
|
+
export declare function UiDataSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSource;
|
|
3124
|
+
|
|
3125
|
+
/**
|
|
3126
|
+
* HTTP_DATA type Data Source.
|
|
3127
|
+
* @export
|
|
3128
|
+
* @interface UiDataSourceHttpData
|
|
3129
|
+
*/
|
|
3130
|
+
export declare interface UiDataSourceHttpData {
|
|
3131
|
+
/**
|
|
3132
|
+
*
|
|
3133
|
+
* @type {UiDataSourceHttpDataMethod}
|
|
3134
|
+
* @memberof UiDataSourceHttpData
|
|
3135
|
+
*/
|
|
3136
|
+
method?: UiDataSourceHttpDataMethod;
|
|
3137
|
+
/**
|
|
3138
|
+
* HTTP Request URL. If parameterized, additional pathParams will be joined onto existing one.
|
|
3139
|
+
* @type {string}
|
|
3140
|
+
* @memberof UiDataSourceHttpData
|
|
3141
|
+
*/
|
|
3142
|
+
baseUrl: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* HTTP Request Query Params / Query String.
|
|
3145
|
+
* @type {string}
|
|
3146
|
+
* @memberof UiDataSourceHttpData
|
|
3147
|
+
*/
|
|
3148
|
+
queryString?: string;
|
|
3149
|
+
/**
|
|
3150
|
+
* Auth Header name. The auth header is handled specially by the EDC as its value can be read from a vault.
|
|
3151
|
+
* @type {string}
|
|
3152
|
+
* @memberof UiDataSourceHttpData
|
|
3153
|
+
*/
|
|
3154
|
+
authHeaderName?: string;
|
|
3155
|
+
/**
|
|
3156
|
+
*
|
|
3157
|
+
* @type {SecretValue}
|
|
3158
|
+
* @memberof UiDataSourceHttpData
|
|
3159
|
+
*/
|
|
3160
|
+
authHeaderValue?: SecretValue;
|
|
3161
|
+
/**
|
|
3162
|
+
* HTTP Request Headers. HTTP Header Parameterization is not available.
|
|
3163
|
+
* @type {{ [key: string]: string; }}
|
|
3164
|
+
* @memberof UiDataSourceHttpData
|
|
3165
|
+
*/
|
|
3166
|
+
headers?: {
|
|
3167
|
+
[key: string]: string;
|
|
3168
|
+
};
|
|
3169
|
+
/**
|
|
3170
|
+
* Enable Method Parameterization. This forces consumers to provide a method, otherwise the transfer will fail.
|
|
3171
|
+
* @type {boolean}
|
|
3172
|
+
* @memberof UiDataSourceHttpData
|
|
3173
|
+
*/
|
|
3174
|
+
enableMethodParameterization?: boolean;
|
|
3175
|
+
/**
|
|
3176
|
+
* Enable Path Parameterization.
|
|
3177
|
+
* @type {boolean}
|
|
3178
|
+
* @memberof UiDataSourceHttpData
|
|
3179
|
+
*/
|
|
3180
|
+
enablePathParameterization?: boolean;
|
|
3181
|
+
/**
|
|
3182
|
+
* Enable Query Parameterization. Any additionally provided queryString will be merged with the existing one.
|
|
3183
|
+
* @type {boolean}
|
|
3184
|
+
* @memberof UiDataSourceHttpData
|
|
3185
|
+
*/
|
|
3186
|
+
enableQueryParameterization?: boolean;
|
|
3187
|
+
/**
|
|
3188
|
+
* Enable Body Parameterization. Forces the provider to provide both a request body and a content type. Only Methods POST, PUT and PATCH allow request bodies.
|
|
3189
|
+
* @type {boolean}
|
|
3190
|
+
* @memberof UiDataSourceHttpData
|
|
3191
|
+
*/
|
|
3192
|
+
enableBodyParameterization?: boolean;
|
|
3193
|
+
}
|
|
3194
|
+
|
|
3195
|
+
export declare function UiDataSourceHttpDataFromJSON(json: any): UiDataSourceHttpData;
|
|
3196
|
+
|
|
3197
|
+
export declare function UiDataSourceHttpDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSourceHttpData;
|
|
3198
|
+
|
|
3199
|
+
/**
|
|
3200
|
+
* Supported HTTP Methods by UiDataSource
|
|
3201
|
+
* @export
|
|
3202
|
+
*/
|
|
3203
|
+
export declare const UiDataSourceHttpDataMethod: {
|
|
3204
|
+
readonly Get: "GET";
|
|
3205
|
+
readonly Post: "POST";
|
|
3206
|
+
readonly Put: "PUT";
|
|
3207
|
+
readonly Patch: "PATCH";
|
|
3208
|
+
readonly Delete: "DELETE";
|
|
3209
|
+
readonly Options: "OPTIONS";
|
|
3210
|
+
};
|
|
3211
|
+
|
|
3212
|
+
export declare type UiDataSourceHttpDataMethod = (typeof UiDataSourceHttpDataMethod)[keyof typeof UiDataSourceHttpDataMethod];
|
|
3213
|
+
|
|
3214
|
+
export declare function UiDataSourceHttpDataMethodFromJSON(json: any): UiDataSourceHttpDataMethod;
|
|
3215
|
+
|
|
3216
|
+
export declare function UiDataSourceHttpDataMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSourceHttpDataMethod;
|
|
3217
|
+
|
|
3218
|
+
export declare function UiDataSourceHttpDataMethodToJSON(value?: UiDataSourceHttpDataMethod | null): any;
|
|
3219
|
+
|
|
3220
|
+
export declare function UiDataSourceHttpDataToJSON(value?: UiDataSourceHttpData | null): any;
|
|
3221
|
+
|
|
3222
|
+
/**
|
|
3223
|
+
* ON_REQUEST type Data Source.
|
|
3224
|
+
* @export
|
|
3225
|
+
* @interface UiDataSourceOnRequest
|
|
3226
|
+
*/
|
|
3227
|
+
export declare interface UiDataSourceOnRequest {
|
|
3228
|
+
/**
|
|
3229
|
+
* Contact E-Mail address
|
|
3230
|
+
* @type {string}
|
|
3231
|
+
* @memberof UiDataSourceOnRequest
|
|
3232
|
+
*/
|
|
3233
|
+
contactEmail: string;
|
|
3234
|
+
/**
|
|
3235
|
+
* Contact Preferred E-Mail Subject
|
|
3236
|
+
* @type {string}
|
|
3237
|
+
* @memberof UiDataSourceOnRequest
|
|
3238
|
+
*/
|
|
3239
|
+
contactPreferredEmailSubject: string;
|
|
3240
|
+
}
|
|
3241
|
+
|
|
3242
|
+
export declare function UiDataSourceOnRequestFromJSON(json: any): UiDataSourceOnRequest;
|
|
3243
|
+
|
|
3244
|
+
export declare function UiDataSourceOnRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiDataSourceOnRequest;
|
|
3245
|
+
|
|
3246
|
+
export declare function UiDataSourceOnRequestToJSON(value?: UiDataSourceOnRequest | null): any;
|
|
3247
|
+
|
|
3248
|
+
export declare function UiDataSourceToJSON(value?: UiDataSource | null): any;
|
|
3249
|
+
|
|
3250
|
+
/**
|
|
3251
|
+
* Type-Safe OpenAPI generator friendly ODLR policy subset as endorsed by sovity.
|
|
2865
3252
|
* @export
|
|
2866
3253
|
* @interface UiPolicy
|
|
2867
3254
|
*/
|
|
@@ -2873,11 +3260,11 @@ export declare interface UiPolicy {
|
|
|
2873
3260
|
*/
|
|
2874
3261
|
policyJsonLd: string;
|
|
2875
3262
|
/**
|
|
2876
|
-
*
|
|
2877
|
-
* @type {
|
|
3263
|
+
*
|
|
3264
|
+
* @type {UiPolicyExpression}
|
|
2878
3265
|
* @memberof UiPolicy
|
|
2879
3266
|
*/
|
|
2880
|
-
|
|
3267
|
+
expression?: UiPolicyExpression;
|
|
2881
3268
|
/**
|
|
2882
3269
|
* 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.
|
|
2883
3270
|
* @type {Array<string>}
|
|
@@ -2887,7 +3274,7 @@ export declare interface UiPolicy {
|
|
|
2887
3274
|
}
|
|
2888
3275
|
|
|
2889
3276
|
/**
|
|
2890
|
-
* ODRL AtomicConstraint as supported by
|
|
3277
|
+
* ODRL AtomicConstraint as supported by the sovity product landscape. For example 'a EQ b', 'c IN [d, e, f]'
|
|
2891
3278
|
* @export
|
|
2892
3279
|
* @interface UiPolicyConstraint
|
|
2893
3280
|
*/
|
|
@@ -2919,15 +3306,16 @@ export declare function UiPolicyConstraintFromJSONTyped(json: any, ignoreDiscrim
|
|
|
2919
3306
|
export declare function UiPolicyConstraintToJSON(value?: UiPolicyConstraint | null): any;
|
|
2920
3307
|
|
|
2921
3308
|
/**
|
|
2922
|
-
*
|
|
3309
|
+
* [Deprecated] Conjunction of constraints (simplified UiPolicyExpression)
|
|
2923
3310
|
* @export
|
|
2924
3311
|
* @interface UiPolicyCreateRequest
|
|
2925
3312
|
*/
|
|
2926
3313
|
export declare interface UiPolicyCreateRequest {
|
|
2927
3314
|
/**
|
|
2928
|
-
* Conjunction of required
|
|
3315
|
+
* Conjunction of required constraints
|
|
2929
3316
|
* @type {Array<UiPolicyConstraint>}
|
|
2930
3317
|
* @memberof UiPolicyCreateRequest
|
|
3318
|
+
* @deprecated
|
|
2931
3319
|
*/
|
|
2932
3320
|
constraints?: Array<UiPolicyConstraint>;
|
|
2933
3321
|
}
|
|
@@ -2938,6 +3326,62 @@ export declare function UiPolicyCreateRequestFromJSONTyped(json: any, ignoreDisc
|
|
|
2938
3326
|
|
|
2939
3327
|
export declare function UiPolicyCreateRequestToJSON(value?: UiPolicyCreateRequest | null): any;
|
|
2940
3328
|
|
|
3329
|
+
/**
|
|
3330
|
+
* ODRL constraint as supported by the sovity product landscape
|
|
3331
|
+
* @export
|
|
3332
|
+
* @interface UiPolicyExpression
|
|
3333
|
+
*/
|
|
3334
|
+
export declare interface UiPolicyExpression {
|
|
3335
|
+
/**
|
|
3336
|
+
*
|
|
3337
|
+
* @type {UiPolicyExpressionType}
|
|
3338
|
+
* @memberof UiPolicyExpression
|
|
3339
|
+
*/
|
|
3340
|
+
type: UiPolicyExpressionType;
|
|
3341
|
+
/**
|
|
3342
|
+
* Only for types AND, OR, XONE. List of sub-expressions to be evaluated according to the expressionType.
|
|
3343
|
+
* @type {Array<UiPolicyExpression>}
|
|
3344
|
+
* @memberof UiPolicyExpression
|
|
3345
|
+
*/
|
|
3346
|
+
expressions?: Array<UiPolicyExpression>;
|
|
3347
|
+
/**
|
|
3348
|
+
*
|
|
3349
|
+
* @type {UiPolicyConstraint}
|
|
3350
|
+
* @memberof UiPolicyExpression
|
|
3351
|
+
*/
|
|
3352
|
+
constraint?: UiPolicyConstraint;
|
|
3353
|
+
}
|
|
3354
|
+
|
|
3355
|
+
export declare function UiPolicyExpressionFromJSON(json: any): UiPolicyExpression;
|
|
3356
|
+
|
|
3357
|
+
export declare function UiPolicyExpressionFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiPolicyExpression;
|
|
3358
|
+
|
|
3359
|
+
export declare function UiPolicyExpressionToJSON(value?: UiPolicyExpression | null): any;
|
|
3360
|
+
|
|
3361
|
+
/**
|
|
3362
|
+
* Ui Policy Expression types:
|
|
3363
|
+
* * `CONSTRAINT` - Expression 'a=b'
|
|
3364
|
+
* * `AND` - Conjunction of several expressions. Evaluates to true iff all child expressions are true.
|
|
3365
|
+
* * `OR` - Disjunction of several expressions. Evaluates to true iff at least one child expression is true.
|
|
3366
|
+
* * `XONE` - XONE operation. Evaluates to true iff exactly one child expression is true.
|
|
3367
|
+
* @export
|
|
3368
|
+
*/
|
|
3369
|
+
export declare const UiPolicyExpressionType: {
|
|
3370
|
+
readonly Empty: "EMPTY";
|
|
3371
|
+
readonly Constraint: "CONSTRAINT";
|
|
3372
|
+
readonly And: "AND";
|
|
3373
|
+
readonly Or: "OR";
|
|
3374
|
+
readonly Xone: "XONE";
|
|
3375
|
+
};
|
|
3376
|
+
|
|
3377
|
+
export declare type UiPolicyExpressionType = (typeof UiPolicyExpressionType)[keyof typeof UiPolicyExpressionType];
|
|
3378
|
+
|
|
3379
|
+
export declare function UiPolicyExpressionTypeFromJSON(json: any): UiPolicyExpressionType;
|
|
3380
|
+
|
|
3381
|
+
export declare function UiPolicyExpressionTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiPolicyExpressionType;
|
|
3382
|
+
|
|
3383
|
+
export declare function UiPolicyExpressionTypeToJSON(value?: UiPolicyExpressionType | null): any;
|
|
3384
|
+
|
|
2941
3385
|
export declare function UiPolicyFromJSON(json: any): UiPolicy;
|
|
2942
3386
|
|
|
2943
3387
|
export declare function UiPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiPolicy;
|
|
@@ -2998,14 +3442,6 @@ export declare function UiPolicyToJSON(value?: UiPolicy | null): any;
|
|
|
2998
3442
|
*
|
|
2999
3443
|
*/
|
|
3000
3444
|
export declare class UseCaseApi extends runtime.BaseAPI {
|
|
3001
|
-
/**
|
|
3002
|
-
* Create a new Policy Definition
|
|
3003
|
-
*/
|
|
3004
|
-
createPolicyDefinitionUseCaseRaw(requestParameters: CreatePolicyDefinitionUseCaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdResponseDto>>;
|
|
3005
|
-
/**
|
|
3006
|
-
* Create a new Policy Definition
|
|
3007
|
-
*/
|
|
3008
|
-
createPolicyDefinitionUseCase(requestParameters?: CreatePolicyDefinitionUseCaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdResponseDto>;
|
|
3009
3445
|
/**
|
|
3010
3446
|
* Basic KPIs about the running EDC Connector.
|
|
3011
3447
|
*/
|