@sovity.de/edc-client 3.2.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sovity.de/edc-client",
-    "version": "3.2.0",
+    "version": "4.0.0",
     "description": "TypeScript API Client for our EDC API Wrapper.",
     "author": "sovity GmbH",
     "license": "Apache-2.0",

package/dist/generated/apis/BrokerServerApi.d.ts

@@ -1,40 +0,0 @@
-/**
- * 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 APIs, etc. We bundled these APIs, so we can have an easier time generating our API Client Libraries.
- *
- * The version of the OpenAPI document: 0.0.0
- * Contact: contact@sovity.de
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { CatalogPageQuery, CatalogPageResult, ConnectorPageQuery, ConnectorPageResult } from '../models';
-import * as runtime from '../runtime';
-export interface CatalogPageRequest {
-    catalogPageQuery?: CatalogPageQuery;
-}
-export interface ConnectorPageRequest {
-    connectorPageQuery?: ConnectorPageQuery;
-}
-/**
- *
- */
-export declare class BrokerServerApi extends runtime.BaseAPI {
-    /**
-     * Query indexed Contract Offers
-     */
-    catalogPageRaw(requestParameters: CatalogPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CatalogPageResult>>;
-    /**
-     * Query indexed Contract Offers
-     */
-    catalogPage(requestParameters?: CatalogPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CatalogPageResult>;
-    /**
-     * Query known Connectors
-     */
-    connectorPageRaw(requestParameters: ConnectorPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConnectorPageResult>>;
-    /**
-     * Query known Connectors
-     */
-    connectorPage(requestParameters?: ConnectorPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConnectorPageResult>;
-}

package/dist/generated/models/CatalogPageQuery.d.ts

@@ -1,49 +0,0 @@
-import type { CnfFilterValue } from './CnfFilterValue';
-/**
- * Filterable Catalog Page Query
- * @export
- * @interface CatalogPageQuery
- */
-export interface CatalogPageQuery {
-    /**
-     *
-     * @type {CnfFilterValue}
-     * @memberof CatalogPageQuery
-     */
-    filter?: CnfFilterValue;
-    /**
-     * Search query
-     * @type {string}
-     * @memberof CatalogPageQuery
-     */
-    searchQuery?: string;
-    /**
-     * Catalog's sorting options
-     * @type {string}
-     * @memberof CatalogPageQuery
-     */
-    sorting?: CatalogPageQuerySortingEnum;
-    /**
-     * Page number, one based, meaning the first page is page 1.
-     * @type {number}
-     * @memberof CatalogPageQuery
-     */
-    pageOneBased?: number;
-}
-/**
- * @export
- */
-export declare const CatalogPageQuerySortingEnum: {
-    readonly Match: "MATCH";
-    readonly Title: "TITLE";
-    readonly MostRecent: "MOST_RECENT";
-    readonly Originator: "ORIGINATOR";
-};
-export type CatalogPageQuerySortingEnum = (typeof CatalogPageQuerySortingEnum)[keyof typeof CatalogPageQuerySortingEnum];
-/**
- * Check if a given object implements the CatalogPageQuery interface.
- */
-export declare function instanceOfCatalogPageQuery(value: object): boolean;
-export declare function CatalogPageQueryFromJSON(json: any): CatalogPageQuery;
-export declare function CatalogPageQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogPageQuery;
-export declare function CatalogPageQueryToJSON(value?: CatalogPageQuery | null): any;

package/dist/generated/models/CatalogPageResult.d.ts

@@ -1,42 +0,0 @@
-import type { CatalogPageSortingItem } from './CatalogPageSortingItem';
-import type { CnfFilter } from './CnfFilter';
-import type { ContractOfferDto } from './ContractOfferDto';
-import type { PaginationMetadata } from './PaginationMetadata';
-/**
- * Catalog Page and visible filters
- * @export
- * @interface CatalogPageResult
- */
-export interface CatalogPageResult {
-    /**
-     *
-     * @type {CnfFilter}
-     * @memberof CatalogPageResult
-     */
-    availableFilters: CnfFilter;
-    /**
-     * Available sorting options
-     * @type {Array<CatalogPageSortingItem>}
-     * @memberof CatalogPageResult
-     */
-    availableSortings: Array<CatalogPageSortingItem>;
-    /**
-     *
-     * @type {PaginationMetadata}
-     * @memberof CatalogPageResult
-     */
-    paginationMetadata: PaginationMetadata;
-    /**
-     * Current page of contract offers
-     * @type {Array<ContractOfferDto>}
-     * @memberof CatalogPageResult
-     */
-    contractOffers: Array<ContractOfferDto>;
-}
-/**
- * Check if a given object implements the CatalogPageResult interface.
- */
-export declare function instanceOfCatalogPageResult(value: object): boolean;
-export declare function CatalogPageResultFromJSON(json: any): CatalogPageResult;
-export declare function CatalogPageResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogPageResult;
-export declare function CatalogPageResultToJSON(value?: CatalogPageResult | null): any;

package/dist/generated/models/CatalogPageSortingItem.d.ts

@@ -1,36 +0,0 @@
-/**
- * Available Catalog Page Sorting Item
- * @export
- * @interface CatalogPageSortingItem
- */
-export interface CatalogPageSortingItem {
-    /**
-     * Catalog's sorting options
-     * @type {string}
-     * @memberof CatalogPageSortingItem
-     */
-    sorting: CatalogPageSortingItemSortingEnum;
-    /**
-     * Sorting Title
-     * @type {string}
-     * @memberof CatalogPageSortingItem
-     */
-    title: string;
-}
-/**
- * @export
- */
-export declare const CatalogPageSortingItemSortingEnum: {
-    readonly Match: "MATCH";
-    readonly Title: "TITLE";
-    readonly MostRecent: "MOST_RECENT";
-    readonly Originator: "ORIGINATOR";
-};
-export type CatalogPageSortingItemSortingEnum = (typeof CatalogPageSortingItemSortingEnum)[keyof typeof CatalogPageSortingItemSortingEnum];
-/**
- * Check if a given object implements the CatalogPageSortingItem interface.
- */
-export declare function instanceOfCatalogPageSortingItem(value: object): boolean;
-export declare function CatalogPageSortingItemFromJSON(json: any): CatalogPageSortingItem;
-export declare function CatalogPageSortingItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogPageSortingItem;
-export declare function CatalogPageSortingItemToJSON(value?: CatalogPageSortingItem | null): any;

package/dist/generated/models/CnfFilter.d.ts

@@ -1,21 +0,0 @@
-import type { CnfFilterAttribute } from './CnfFilterAttribute';
-/**
- * Filter in form of a conjunctive normal form, meaning (A=X OR A=Y) AND (B=M or B=N). Not selected attributes default to TRUE. Used here to let the backend be a SSOT for the available filter options, e.g. Transport Mode, Data Model, etc.
- * @export
- * @interface CnfFilter
- */
-export interface CnfFilter {
-    /**
-     * Available attributes to filter by.
-     * @type {Array<CnfFilterAttribute>}
-     * @memberof CnfFilter
-     */
-    fields: Array<CnfFilterAttribute>;
-}
-/**
- * Check if a given object implements the CnfFilter interface.
- */
-export declare function instanceOfCnfFilter(value: object): boolean;
-export declare function CnfFilterFromJSON(json: any): CnfFilter;
-export declare function CnfFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): CnfFilter;
-export declare function CnfFilterToJSON(value?: CnfFilter | null): any;

package/dist/generated/models/CnfFilterAttribute.d.ts

@@ -1,33 +0,0 @@
-import type { CnfFilterItem } from './CnfFilterItem';
-/**
- * Attribute, e.g. Language
- * @export
- * @interface CnfFilterAttribute
- */
-export interface CnfFilterAttribute {
-    /**
-     * Attribute ID
-     * @type {string}
-     * @memberof CnfFilterAttribute
-     */
-    id: string;
-    /**
-     * Attribute Title
-     * @type {string}
-     * @memberof CnfFilterAttribute
-     */
-    title: string;
-    /**
-     * Available values.
-     * @type {Array<CnfFilterItem>}
-     * @memberof CnfFilterAttribute
-     */
-    values: Array<CnfFilterItem>;
-}
-/**
- * Check if a given object implements the CnfFilterAttribute interface.
- */
-export declare function instanceOfCnfFilterAttribute(value: object): boolean;
-export declare function CnfFilterAttributeFromJSON(json: any): CnfFilterAttribute;
-export declare function CnfFilterAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CnfFilterAttribute;
-export declare function CnfFilterAttributeToJSON(value?: CnfFilterAttribute | null): any;

package/dist/generated/models/CnfFilterItem.d.ts

@@ -1,26 +0,0 @@
-/**
- * Attribute Value
- * @export
- * @interface CnfFilterItem
- */
-export interface CnfFilterItem {
-    /**
-     * Value ID
-     * @type {string}
-     * @memberof CnfFilterItem
-     */
-    id: string;
-    /**
-     * Value Title
-     * @type {string}
-     * @memberof CnfFilterItem
-     */
-    title: string;
-}
-/**
- * Check if a given object implements the CnfFilterItem interface.
- */
-export declare function instanceOfCnfFilterItem(value: object): boolean;
-export declare function CnfFilterItemFromJSON(json: any): CnfFilterItem;
-export declare function CnfFilterItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): CnfFilterItem;
-export declare function CnfFilterItemToJSON(value?: CnfFilterItem | null): any;

package/dist/generated/models/CnfFilterValue.d.ts

@@ -1,21 +0,0 @@
-import type { CnfFilterValueAttribute } from './CnfFilterValueAttribute';
-/**
- * Cnf filter's selected value.
- * @export
- * @interface CnfFilterValue
- */
-export interface CnfFilterValue {
-    /**
-     * Available attributes to filter by.
-     * @type {Array<CnfFilterValueAttribute>}
-     * @memberof CnfFilterValue
-     */
-    selectedAttributeValues: Array<CnfFilterValueAttribute>;
-}
-/**
- * Check if a given object implements the CnfFilterValue interface.
- */
-export declare function instanceOfCnfFilterValue(value: object): boolean;
-export declare function CnfFilterValueFromJSON(json: any): CnfFilterValue;
-export declare function CnfFilterValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): CnfFilterValue;
-export declare function CnfFilterValueToJSON(value?: CnfFilterValue | null): any;

package/dist/generated/models/CnfFilterValueAttribute.d.ts

@@ -1,26 +0,0 @@
-/**
- * Single attribute of selected cnf filter's value
- * @export
- * @interface CnfFilterValueAttribute
- */
-export interface CnfFilterValueAttribute {
-    /**
-     * Attribute ID
-     * @type {string}
-     * @memberof CnfFilterValueAttribute
-     */
-    id: string;
-    /**
-     * Selected attribute values' IDs.
-     * @type {Array<string>}
-     * @memberof CnfFilterValueAttribute
-     */
-    selectedIds: Array<string>;
-}
-/**
- * Check if a given object implements the CnfFilterValueAttribute interface.
- */
-export declare function instanceOfCnfFilterValueAttribute(value: object): boolean;
-export declare function CnfFilterValueAttributeFromJSON(json: any): CnfFilterValueAttribute;
-export declare function CnfFilterValueAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CnfFilterValueAttribute;
-export declare function CnfFilterValueAttributeToJSON(value?: CnfFilterValueAttribute | null): any;

package/dist/generated/models/ConnectorListEntry.d.ts

@@ -1,82 +0,0 @@
-/**
- * A Contract Offer's Connector Status
- * @export
- * @interface ConnectorListEntry
- */
-export interface ConnectorListEntry {
-    /**
-     * Connector ID
-     * @type {string}
-     * @memberof ConnectorListEntry
-     */
-    id: string;
-    /**
-     * Connector IDS ID
-     * @type {string}
-     * @memberof ConnectorListEntry
-     */
-    idsId: string;
-    /**
-     * Connector Endpoint
-     * @type {string}
-     * @memberof ConnectorListEntry
-     */
-    endpoint: string;
-    /**
-     * Connector IDS Title
-     * @type {string}
-     * @memberof ConnectorListEntry
-     */
-    title: string;
-    /**
-     * Connector IDS Description
-     * @type {string}
-     * @memberof ConnectorListEntry
-     */
-    description: string;
-    /**
-     * Time the connector was added
-     * @type {Date}
-     * @memberof ConnectorListEntry
-     */
-    createdAt?: Date;
-    /**
-     * Last time the connector was attempted to be updated.
-     * @type {Date}
-     * @memberof ConnectorListEntry
-     */
-    lastFetchAt?: Date;
-    /**
-     * Connector's online status
-     * @type {string}
-     * @memberof ConnectorListEntry
-     */
-    onlineStatus: ConnectorListEntryOnlineStatusEnum;
-    /**
-     * Last time the connector was created or successfully updated.
-     * @type {Date}
-     * @memberof ConnectorListEntry
-     */
-    offlineSince?: Date;
-    /**
-     * Number of known data offerings
-     * @type {number}
-     * @memberof ConnectorListEntry
-     */
-    numContractOffers?: number;
-}
-/**
- * @export
- */
-export declare const ConnectorListEntryOnlineStatusEnum: {
-    readonly Online: "ONLINE";
-    readonly Offline: "OFFLINE";
-};
-export type ConnectorListEntryOnlineStatusEnum = (typeof ConnectorListEntryOnlineStatusEnum)[keyof typeof ConnectorListEntryOnlineStatusEnum];
-/**
- * Check if a given object implements the ConnectorListEntry interface.
- */
-export declare function instanceOfConnectorListEntry(value: object): boolean;
-export declare function ConnectorListEntryFromJSON(json: any): ConnectorListEntry;
-export declare function ConnectorListEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectorListEntry;
-export declare function ConnectorListEntryToJSON(value?: ConnectorListEntry | null): any;

package/dist/generated/models/ConnectorPageQuery.d.ts

@@ -1,40 +0,0 @@
-/**
- * Filterable Connector Page Query
- * @export
- * @interface ConnectorPageQuery
- */
-export interface ConnectorPageQuery {
-    /**
-     * Search query
-     * @type {string}
-     * @memberof ConnectorPageQuery
-     */
-    searchQuery?: string;
-    /**
-     * Connector List Page's known sorting option IDs
-     * @type {string}
-     * @memberof ConnectorPageQuery
-     */
-    sorting?: ConnectorPageQuerySortingEnum;
-    /**
-     * Page number, one based, meaning the first page is page 1.
-     * @type {number}
-     * @memberof ConnectorPageQuery
-     */
-    pageOneBased?: number;
-}
-/**
- * @export
- */
-export declare const ConnectorPageQuerySortingEnum: {
-    readonly Title: "TITLE";
-    readonly MostRecent: "MOST_RECENT";
-};
-export type ConnectorPageQuerySortingEnum = (typeof ConnectorPageQuerySortingEnum)[keyof typeof ConnectorPageQuerySortingEnum];
-/**
- * Check if a given object implements the ConnectorPageQuery interface.
- */
-export declare function instanceOfConnectorPageQuery(value: object): boolean;
-export declare function ConnectorPageQueryFromJSON(json: any): ConnectorPageQuery;
-export declare function ConnectorPageQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectorPageQuery;
-export declare function ConnectorPageQueryToJSON(value?: ConnectorPageQuery | null): any;

package/dist/generated/models/ConnectorPageResult.d.ts

@@ -1,35 +0,0 @@
-import type { ConnectorListEntry } from './ConnectorListEntry';
-import type { ConnectorPageSortingItem } from './ConnectorPageSortingItem';
-import type { PaginationMetadata } from './PaginationMetadata';
-/**
- * Connector Page Data
- * @export
- * @interface ConnectorPageResult
- */
-export interface ConnectorPageResult {
-    /**
-     * Available sorting options
-     * @type {Array<ConnectorPageSortingItem>}
-     * @memberof ConnectorPageResult
-     */
-    availableSortings: Array<ConnectorPageSortingItem>;
-    /**
-     *
-     * @type {PaginationMetadata}
-     * @memberof ConnectorPageResult
-     */
-    paginationMetadata: PaginationMetadata;
-    /**
-     * Current page of connector list entries
-     * @type {Array<ConnectorListEntry>}
-     * @memberof ConnectorPageResult
-     */
-    connectors: Array<ConnectorListEntry>;
-}
-/**
- * Check if a given object implements the ConnectorPageResult interface.
- */
-export declare function instanceOfConnectorPageResult(value: object): boolean;
-export declare function ConnectorPageResultFromJSON(json: any): ConnectorPageResult;
-export declare function ConnectorPageResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectorPageResult;
-export declare function ConnectorPageResultToJSON(value?: ConnectorPageResult | null): any;

package/dist/generated/models/ConnectorPageSortingItem.d.ts

@@ -1,34 +0,0 @@
-/**
- * Available Connector Page Sorting Item
- * @export
- * @interface ConnectorPageSortingItem
- */
-export interface ConnectorPageSortingItem {
-    /**
-     * Connector List Page's known sorting option IDs
-     * @type {string}
-     * @memberof ConnectorPageSortingItem
-     */
-    sorting: ConnectorPageSortingItemSortingEnum;
-    /**
-     * Sorting Title
-     * @type {string}
-     * @memberof ConnectorPageSortingItem
-     */
-    title: string;
-}
-/**
- * @export
- */
-export declare const ConnectorPageSortingItemSortingEnum: {
-    readonly Title: "TITLE";
-    readonly MostRecent: "MOST_RECENT";
-};
-export type ConnectorPageSortingItemSortingEnum = (typeof ConnectorPageSortingItemSortingEnum)[keyof typeof ConnectorPageSortingItemSortingEnum];
-/**
- * Check if a given object implements the ConnectorPageSortingItem interface.
- */
-export declare function instanceOfConnectorPageSortingItem(value: object): boolean;
-export declare function ConnectorPageSortingItemFromJSON(json: any): ConnectorPageSortingItem;
-export declare function ConnectorPageSortingItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectorPageSortingItem;
-export declare function ConnectorPageSortingItemToJSON(value?: ConnectorPageSortingItem | null): any;

package/dist/generated/models/ContractOfferConnectorInfo.d.ts

@@ -1,52 +0,0 @@
-/**
- * A Contract Offer's Connector Status
- * @export
- * @interface ContractOfferConnectorInfo
- */
-export interface ContractOfferConnectorInfo {
-    /**
-     * Connector Endpoint
-     * @type {string}
-     * @memberof ContractOfferConnectorInfo
-     */
-    endpoint: string;
-    /**
-     * Connector IDS Title
-     * @type {string}
-     * @memberof ContractOfferConnectorInfo
-     */
-    title: string;
-    /**
-     * Connector IDS Description
-     * @type {string}
-     * @memberof ContractOfferConnectorInfo
-     */
-    description: string;
-    /**
-     * Connector's online status
-     * @type {string}
-     * @memberof ContractOfferConnectorInfo
-     */
-    onlineStatus: ContractOfferConnectorInfoOnlineStatusEnum;
-    /**
-     * 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.
-     * @type {Date}
-     * @memberof ContractOfferConnectorInfo
-     */
-    offlineSinceOrLastUpdatedAt?: Date;
-}
-/**
- * @export
- */
-export declare const ContractOfferConnectorInfoOnlineStatusEnum: {
-    readonly Online: "ONLINE";
-    readonly Offline: "OFFLINE";
-};
-export type ContractOfferConnectorInfoOnlineStatusEnum = (typeof ContractOfferConnectorInfoOnlineStatusEnum)[keyof typeof ContractOfferConnectorInfoOnlineStatusEnum];
-/**
- * Check if a given object implements the ContractOfferConnectorInfo interface.
- */
-export declare function instanceOfContractOfferConnectorInfo(value: object): boolean;
-export declare function ContractOfferConnectorInfoFromJSON(json: any): ContractOfferConnectorInfo;
-export declare function ContractOfferConnectorInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractOfferConnectorInfo;
-export declare function ContractOfferConnectorInfoToJSON(value?: ContractOfferConnectorInfo | null): any;

package/dist/generated/models/ContractOfferDto.d.ts

@@ -1,35 +0,0 @@
-import type { AssetDto } from './AssetDto';
-import type { ContractOfferConnectorInfo } from './ContractOfferConnectorInfo';
-import type { PolicyDto } from './PolicyDto';
-/**
- * Contract Offer
- * @export
- * @interface ContractOfferDto
- */
-export interface ContractOfferDto {
-    /**
-     *
-     * @type {ContractOfferConnectorInfo}
-     * @memberof ContractOfferDto
-     */
-    connectorInfo: ContractOfferConnectorInfo;
-    /**
-     *
-     * @type {AssetDto}
-     * @memberof ContractOfferDto
-     */
-    asset: AssetDto;
-    /**
-     *
-     * @type {PolicyDto}
-     * @memberof ContractOfferDto
-     */
-    policy: PolicyDto;
-}
-/**
- * Check if a given object implements the ContractOfferDto interface.
- */
-export declare function instanceOfContractOfferDto(value: object): boolean;
-export declare function ContractOfferDtoFromJSON(json: any): ContractOfferDto;
-export declare function ContractOfferDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractOfferDto;
-export declare function ContractOfferDtoToJSON(value?: ContractOfferDto | null): any;

package/dist/generated/models/PaginationMetadata.d.ts

@@ -1,38 +0,0 @@
-/**
- * Pagination Metadata
- * @export
- * @interface PaginationMetadata
- */
-export interface PaginationMetadata {
-    /**
-     * Total number of results
-     * @type {number}
-     * @memberof PaginationMetadata
-     */
-    numTotal: number;
-    /**
-     * Visible number of results
-     * @type {number}
-     * @memberof PaginationMetadata
-     */
-    numVisible: number;
-    /**
-     * Page number, one based, meaning the first page is page 1.
-     * @type {number}
-     * @memberof PaginationMetadata
-     */
-    pageOneBased: number;
-    /**
-     * Items per page
-     * @type {number}
-     * @memberof PaginationMetadata
-     */
-    pageSize: number;
-}
-/**
- * Check if a given object implements the PaginationMetadata interface.
- */
-export declare function instanceOfPaginationMetadata(value: object): boolean;
-export declare function PaginationMetadataFromJSON(json: any): PaginationMetadata;
-export declare function PaginationMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginationMetadata;
-export declare function PaginationMetadataToJSON(value?: PaginationMetadata | null): any;