@sovity.de/edc-client 3.2.0 → 3.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import { ConfigurationParameters, EnterpriseEditionApi, UIApi, UseCaseApi } from './generated';
1
+ import { BrokerServerApi, ConfigurationParameters, EnterpriseEditionApi, UIApi, UseCaseApi } from './generated';
2
2
  /**
3
3
  * API Client for our sovity EDC
4
4
  */
@@ -6,16 +6,13 @@ export interface EdcClient {
6
6
  uiApi: UIApi;
7
7
  useCaseApi: UseCaseApi;
8
8
  enterpriseEditionApi: EnterpriseEditionApi;
9
+ brokerServerApi: BrokerServerApi;
9
10
  }
10
11
  /**
11
12
  * Configure & Build new EDC Client
12
13
  * @param opts opts
13
14
  */
14
- export declare function buildEdcClient(opts: EdcClientOptions): {
15
- uiApi: UIApi;
16
- useCaseApi: UseCaseApi;
17
- enterpriseEditionApi: EnterpriseEditionApi;
18
- };
15
+ export declare function buildEdcClient(opts: EdcClientOptions): EdcClient;
19
16
  /**
20
17
  * Options for instantiating an EDC API Client
21
18
  */
@@ -17,9 +17,6 @@ export interface CreateStoredFileAssetRequest {
17
17
  [key: string]: string;
18
18
  };
19
19
  }
20
- export interface UploadStoredFileRequest {
21
- file?: Blob;
22
- }
23
20
  /**
24
21
  *
25
22
  */
@@ -52,14 +49,4 @@ export declare class EnterpriseEditionApi extends runtime.BaseAPI {
52
49
  * Get all stored files.
53
50
  */
54
51
  listStoredFiles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StoredFile>>;
55
- /**
56
- * Upload a file to the file storage. <br> On a successful upload to the file storage a StoredFile object is returned. <br> The assetProperties remain empty and are only added upon a asset create request.
57
- * Upload a file.
58
- */
59
- uploadStoredFileRaw(requestParameters: UploadStoredFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StoredFile>>;
60
- /**
61
- * Upload a file to the file storage. <br> On a successful upload to the file storage a StoredFile object is returned. <br> The assetProperties remain empty and are only added upon a asset create request.
62
- * Upload a file.
63
- */
64
- uploadStoredFile(requestParameters?: UploadStoredFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StoredFile>;
65
52
  }
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { ContractAgreementPage } from '../models';
12
+ import type { ContractAgreementPage, TransferHistoryPage } from '../models';
13
13
  import * as runtime from '../runtime';
14
14
  /**
15
15
  *
@@ -23,4 +23,10 @@ export declare class UIApi extends runtime.BaseAPI {
23
23
  * Collect all data for Contract Agreement Page
24
24
  */
25
25
  contractAgreementEndpoint(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContractAgreementPage>;
26
+ /**
27
+ */
28
+ transferHistoryPageEndpointRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransferHistoryPage>>;
29
+ /**
30
+ */
31
+ transferHistoryPageEndpoint(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransferHistoryPage>;
26
32
  }
@@ -34,9 +34,8 @@ export interface CatalogPageQuery {
34
34
  * @export
35
35
  */
36
36
  export declare const CatalogPageQuerySortingEnum: {
37
- readonly Match: "MATCH";
38
- readonly Title: "TITLE";
39
37
  readonly MostRecent: "MOST_RECENT";
38
+ readonly Title: "TITLE";
40
39
  readonly Originator: "ORIGINATOR";
41
40
  };
42
41
  export type CatalogPageQuerySortingEnum = (typeof CatalogPageQuerySortingEnum)[keyof typeof CatalogPageQuerySortingEnum];
@@ -1,6 +1,6 @@
1
1
  import type { CatalogPageSortingItem } from './CatalogPageSortingItem';
2
2
  import type { CnfFilter } from './CnfFilter';
3
- import type { ContractOfferDto } from './ContractOfferDto';
3
+ import type { DataOfferListEntry } from './DataOfferListEntry';
4
4
  import type { PaginationMetadata } from './PaginationMetadata';
5
5
  /**
6
6
  * Catalog Page and visible filters
@@ -27,11 +27,11 @@ export interface CatalogPageResult {
27
27
  */
28
28
  paginationMetadata: PaginationMetadata;
29
29
  /**
30
- * Current page of contract offers
31
- * @type {Array<ContractOfferDto>}
30
+ * Current page of data offers
31
+ * @type {Array<DataOfferListEntry>}
32
32
  * @memberof CatalogPageResult
33
33
  */
34
- contractOffers: Array<ContractOfferDto>;
34
+ dataOffers: Array<DataOfferListEntry>;
35
35
  }
36
36
  /**
37
37
  * Check if a given object implements the CatalogPageResult interface.
@@ -21,9 +21,8 @@ export interface CatalogPageSortingItem {
21
21
  * @export
22
22
  */
23
23
  export declare const CatalogPageSortingItemSortingEnum: {
24
- readonly Match: "MATCH";
25
- readonly Title: "TITLE";
26
24
  readonly MostRecent: "MOST_RECENT";
25
+ readonly Title: "TITLE";
27
26
  readonly Originator: "ORIGINATOR";
28
27
  };
29
28
  export type CatalogPageSortingItemSortingEnum = (typeof CatalogPageSortingItemSortingEnum)[keyof typeof CatalogPageSortingItemSortingEnum];
@@ -10,12 +10,6 @@ export interface ConnectorListEntry {
10
10
  * @memberof ConnectorListEntry
11
11
  */
12
12
  id: string;
13
- /**
14
- * Connector IDS ID
15
- * @type {string}
16
- * @memberof ConnectorListEntry
17
- */
18
- idsId: string;
19
13
  /**
20
14
  * Connector Endpoint
21
15
  * @type {string}
@@ -23,41 +17,29 @@ export interface ConnectorListEntry {
23
17
  */
24
18
  endpoint: string;
25
19
  /**
26
- * Connector IDS Title
27
- * @type {string}
28
- * @memberof ConnectorListEntry
29
- */
30
- title: string;
31
- /**
32
- * Connector IDS Description
33
- * @type {string}
20
+ * Creation date in Broker
21
+ * @type {Date}
34
22
  * @memberof ConnectorListEntry
35
23
  */
36
- description: string;
24
+ createdAt: Date;
37
25
  /**
38
- * Time the connector was added
26
+ * Last time the connector was successfully refreshed.
39
27
  * @type {Date}
40
28
  * @memberof ConnectorListEntry
41
29
  */
42
- createdAt?: Date;
30
+ lastSuccessfulRefreshAt?: Date;
43
31
  /**
44
- * Last time the connector was attempted to be updated.
32
+ * Last time the connector was tried to be refreshed.
45
33
  * @type {Date}
46
34
  * @memberof ConnectorListEntry
47
35
  */
48
- lastFetchAt?: Date;
36
+ lastRefreshAttemptAt?: Date;
49
37
  /**
50
38
  * Connector's online status
51
39
  * @type {string}
52
40
  * @memberof ConnectorListEntry
53
41
  */
54
42
  onlineStatus: ConnectorListEntryOnlineStatusEnum;
55
- /**
56
- * Last time the connector was created or successfully updated.
57
- * @type {Date}
58
- * @memberof ConnectorListEntry
59
- */
60
- offlineSince?: Date;
61
43
  /**
62
44
  * Number of known data offerings
63
45
  * @type {number}
@@ -27,8 +27,8 @@ export interface ConnectorPageQuery {
27
27
  * @export
28
28
  */
29
29
  export declare const ConnectorPageQuerySortingEnum: {
30
- readonly Title: "TITLE";
31
30
  readonly MostRecent: "MOST_RECENT";
31
+ readonly Title: "TITLE";
32
32
  };
33
33
  export type ConnectorPageQuerySortingEnum = (typeof ConnectorPageQuerySortingEnum)[keyof typeof ConnectorPageQuerySortingEnum];
34
34
  /**
@@ -21,8 +21,8 @@ export interface ConnectorPageSortingItem {
21
21
  * @export
22
22
  */
23
23
  export declare const ConnectorPageSortingItemSortingEnum: {
24
- readonly Title: "TITLE";
25
24
  readonly MostRecent: "MOST_RECENT";
25
+ readonly Title: "TITLE";
26
26
  };
27
27
  export type ConnectorPageSortingItemSortingEnum = (typeof ConnectorPageSortingItemSortingEnum)[keyof typeof ConnectorPageSortingItemSortingEnum];
28
28
  /**
@@ -0,0 +1,73 @@
1
+ import type { DataOfferListEntryContractOffer } from './DataOfferListEntryContractOffer';
2
+ /**
3
+ * Data Offer, meaning an offered asset.
4
+ * @export
5
+ * @interface DataOfferListEntry
6
+ */
7
+ export interface DataOfferListEntry {
8
+ /**
9
+ * ID of asset
10
+ * @type {string}
11
+ * @memberof DataOfferListEntry
12
+ */
13
+ assetId: string;
14
+ /**
15
+ * Connector Endpoint
16
+ * @type {string}
17
+ * @memberof DataOfferListEntry
18
+ */
19
+ connectorEndpoint: string;
20
+ /**
21
+ * Connector's online status
22
+ * @type {string}
23
+ * @memberof DataOfferListEntry
24
+ */
25
+ connectorOnlineStatus: DataOfferListEntryConnectorOnlineStatusEnum;
26
+ /**
27
+ * Date to be displayed as last update date, for online connectors it's the last refresh date, for offline connectors it's the creation date or last successful fetch.
28
+ * @type {Date}
29
+ * @memberof DataOfferListEntry
30
+ */
31
+ connectorOfflineSinceOrLastUpdatedAt?: Date;
32
+ /**
33
+ * Creation date in Broker
34
+ * @type {Date}
35
+ * @memberof DataOfferListEntry
36
+ */
37
+ createdAt: Date;
38
+ /**
39
+ * Update date in Broker
40
+ * @type {Date}
41
+ * @memberof DataOfferListEntry
42
+ */
43
+ updatedAt: Date;
44
+ /**
45
+ * Asset properties
46
+ * @type {{ [key: string]: string; }}
47
+ * @memberof DataOfferListEntry
48
+ */
49
+ properties: {
50
+ [key: string]: string;
51
+ };
52
+ /**
53
+ * Available Contract Offers
54
+ * @type {Array<DataOfferListEntryContractOffer>}
55
+ * @memberof DataOfferListEntry
56
+ */
57
+ contractOffers: Array<DataOfferListEntryContractOffer>;
58
+ }
59
+ /**
60
+ * @export
61
+ */
62
+ export declare const DataOfferListEntryConnectorOnlineStatusEnum: {
63
+ readonly Online: "ONLINE";
64
+ readonly Offline: "OFFLINE";
65
+ };
66
+ export type DataOfferListEntryConnectorOnlineStatusEnum = (typeof DataOfferListEntryConnectorOnlineStatusEnum)[keyof typeof DataOfferListEntryConnectorOnlineStatusEnum];
67
+ /**
68
+ * Check if a given object implements the DataOfferListEntry interface.
69
+ */
70
+ export declare function instanceOfDataOfferListEntry(value: object): boolean;
71
+ export declare function DataOfferListEntryFromJSON(json: any): DataOfferListEntry;
72
+ export declare function DataOfferListEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataOfferListEntry;
73
+ export declare function DataOfferListEntryToJSON(value?: DataOfferListEntry | null): any;
@@ -0,0 +1,39 @@
1
+ import type { PolicyDto } from './PolicyDto';
2
+ /**
3
+ * A contract offer a data offer is available under.
4
+ * @export
5
+ * @interface DataOfferListEntryContractOffer
6
+ */
7
+ export interface DataOfferListEntryContractOffer {
8
+ /**
9
+ * Contract Offer ID
10
+ * @type {string}
11
+ * @memberof DataOfferListEntryContractOffer
12
+ */
13
+ contractOfferId: string;
14
+ /**
15
+ * Creation date in Broker
16
+ * @type {Date}
17
+ * @memberof DataOfferListEntryContractOffer
18
+ */
19
+ createdAt: Date;
20
+ /**
21
+ * Update date in Broker
22
+ * @type {Date}
23
+ * @memberof DataOfferListEntryContractOffer
24
+ */
25
+ updatedAt: Date;
26
+ /**
27
+ *
28
+ * @type {PolicyDto}
29
+ * @memberof DataOfferListEntryContractOffer
30
+ */
31
+ contractPolicy: PolicyDto;
32
+ }
33
+ /**
34
+ * Check if a given object implements the DataOfferListEntryContractOffer interface.
35
+ */
36
+ export declare function instanceOfDataOfferListEntryContractOffer(value: object): boolean;
37
+ export declare function DataOfferListEntryContractOfferFromJSON(json: any): DataOfferListEntryContractOffer;
38
+ export declare function DataOfferListEntryContractOfferFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataOfferListEntryContractOffer;
39
+ export declare function DataOfferListEntryContractOfferToJSON(value?: DataOfferListEntryContractOffer | null): any;
@@ -0,0 +1,83 @@
1
+ import type { TransferProcessState } from './TransferProcessState';
2
+ /**
3
+ * Transfer History Entry for Transfer History Page
4
+ * @export
5
+ * @interface TransferHistoryEntry
6
+ */
7
+ export interface TransferHistoryEntry {
8
+ /**
9
+ * Transfer Process ID
10
+ * @type {string}
11
+ * @memberof TransferHistoryEntry
12
+ */
13
+ transferProcessId: string;
14
+ /**
15
+ * Created Date
16
+ * @type {Date}
17
+ * @memberof TransferHistoryEntry
18
+ */
19
+ createdDate: Date;
20
+ /**
21
+ * Last Change Date
22
+ * @type {Date}
23
+ * @memberof TransferHistoryEntry
24
+ */
25
+ lastUpdatedDate: Date;
26
+ /**
27
+ *
28
+ * @type {TransferProcessState}
29
+ * @memberof TransferHistoryEntry
30
+ */
31
+ state: TransferProcessState;
32
+ /**
33
+ * Contract Agreement ID
34
+ * @type {string}
35
+ * @memberof TransferHistoryEntry
36
+ */
37
+ contractAgreementId: string;
38
+ /**
39
+ * Whether the contract agreement is incoming or outgoing
40
+ * @type {string}
41
+ * @memberof TransferHistoryEntry
42
+ */
43
+ direction: TransferHistoryEntryDirectionEnum;
44
+ /**
45
+ * Other Connector's Endpoint
46
+ * @type {string}
47
+ * @memberof TransferHistoryEntry
48
+ */
49
+ counterPartyConnectorEndpoint: string;
50
+ /**
51
+ * Asset Name
52
+ * @type {string}
53
+ * @memberof TransferHistoryEntry
54
+ */
55
+ assetName: string;
56
+ /**
57
+ * Asset ID
58
+ * @type {string}
59
+ * @memberof TransferHistoryEntry
60
+ */
61
+ assetId: string;
62
+ /**
63
+ * Error Message
64
+ * @type {string}
65
+ * @memberof TransferHistoryEntry
66
+ */
67
+ errorMessage?: string;
68
+ }
69
+ /**
70
+ * @export
71
+ */
72
+ export declare const TransferHistoryEntryDirectionEnum: {
73
+ readonly Consuming: "CONSUMING";
74
+ readonly Providing: "PROVIDING";
75
+ };
76
+ export type TransferHistoryEntryDirectionEnum = (typeof TransferHistoryEntryDirectionEnum)[keyof typeof TransferHistoryEntryDirectionEnum];
77
+ /**
78
+ * Check if a given object implements the TransferHistoryEntry interface.
79
+ */
80
+ export declare function instanceOfTransferHistoryEntry(value: object): boolean;
81
+ export declare function TransferHistoryEntryFromJSON(json: any): TransferHistoryEntry;
82
+ export declare function TransferHistoryEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferHistoryEntry;
83
+ export declare function TransferHistoryEntryToJSON(value?: TransferHistoryEntry | null): any;
@@ -0,0 +1,21 @@
1
+ import type { TransferHistoryEntry } from './TransferHistoryEntry';
2
+ /**
3
+ *
4
+ * @export
5
+ * @interface TransferHistoryPage
6
+ */
7
+ export interface TransferHistoryPage {
8
+ /**
9
+ * Transfer History Page Entries
10
+ * @type {Array<TransferHistoryEntry>}
11
+ * @memberof TransferHistoryPage
12
+ */
13
+ transferEntries: Array<TransferHistoryEntry>;
14
+ }
15
+ /**
16
+ * Check if a given object implements the TransferHistoryPage interface.
17
+ */
18
+ export declare function instanceOfTransferHistoryPage(value: object): boolean;
19
+ export declare function TransferHistoryPageFromJSON(json: any): TransferHistoryPage;
20
+ export declare function TransferHistoryPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferHistoryPage;
21
+ export declare function TransferHistoryPageToJSON(value?: TransferHistoryPage | null): any;
@@ -15,11 +15,13 @@ export * from './ConnectorPageSortingItem';
15
15
  export * from './ContractAgreementCard';
16
16
  export * from './ContractAgreementPage';
17
17
  export * from './ContractAgreementTransferProcess';
18
- export * from './ContractOfferConnectorInfo';
19
- export * from './ContractOfferDto';
18
+ export * from './DataOfferListEntry';
19
+ export * from './DataOfferListEntryContractOffer';
20
20
  export * from './KpiResult';
21
21
  export * from './PaginationMetadata';
22
22
  export * from './PolicyDto';
23
23
  export * from './StoredFile';
24
+ export * from './TransferHistoryEntry';
25
+ export * from './TransferHistoryPage';
24
26
  export * from './TransferProcessState';
25
27
  export * from './TransferProcessStatesDto';