@sovity.de/edc-client 7.4.2 → 8.0.0

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

@@ -82,6 +82,143 @@ export declare function buildEdcClient(opts: EdcClientOptions): EdcClient;
 
 export declare function canConsumeForm(consumes: Consume[]): boolean;
 
+/**
+ * Generic expression for filtering the data offers in the catalog
+ * @export
+ * @interface CatalogFilterExpression
+ */
+export declare interface CatalogFilterExpression {
+    /**
+     * Asset property name
+     * @type {string}
+     * @memberof CatalogFilterExpression
+     */
+    operandLeft: string;
+    /**
+     *
+     * @type {CatalogFilterExpressionOperator}
+     * @memberof CatalogFilterExpression
+     */
+    operator: CatalogFilterExpressionOperator;
+    /**
+     *
+     * @type {CatalogFilterExpressionLiteral}
+     * @memberof CatalogFilterExpression
+     */
+    operandRight: CatalogFilterExpressionLiteral;
+}
+
+export declare function CatalogFilterExpressionFromJSON(json: any): CatalogFilterExpression;
+
+export declare function CatalogFilterExpressionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogFilterExpression;
+
+/**
+ * FilterExpression Criterion Literal
+ * @export
+ * @interface CatalogFilterExpressionLiteral
+ */
+export declare interface CatalogFilterExpressionLiteral {
+    /**
+     *
+     * @type {CatalogFilterExpressionLiteralType}
+     * @memberof CatalogFilterExpressionLiteral
+     */
+    type?: CatalogFilterExpressionLiteralType;
+    /**
+     * Only for type VALUE. The single value representation.
+     * @type {string}
+     * @memberof CatalogFilterExpressionLiteral
+     */
+    value?: string;
+    /**
+     * Only for type VALUE_LIST. List of values, e.g. for the IN-Operator.
+     * @type {Array<string>}
+     * @memberof CatalogFilterExpressionLiteral
+     */
+    valueList?: Array<string>;
+}
+
+export declare function CatalogFilterExpressionLiteralFromJSON(json: any): CatalogFilterExpressionLiteral;
+
+export declare function CatalogFilterExpressionLiteralFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogFilterExpressionLiteral;
+
+export declare function CatalogFilterExpressionLiteralToJSON(value?: CatalogFilterExpressionLiteral | null): any;
+
+/**
+ * Value type of a filter expression criterion
+ * @export
+ */
+export declare const CatalogFilterExpressionLiteralType: {
+    readonly Value: "VALUE";
+    readonly ValueList: "VALUE_LIST";
+};
+
+export declare type CatalogFilterExpressionLiteralType = (typeof CatalogFilterExpressionLiteralType)[keyof typeof CatalogFilterExpressionLiteralType];
+
+export declare function CatalogFilterExpressionLiteralTypeFromJSON(json: any): CatalogFilterExpressionLiteralType;
+
+export declare function CatalogFilterExpressionLiteralTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogFilterExpressionLiteralType;
+
+export declare function CatalogFilterExpressionLiteralTypeToJSON(value?: CatalogFilterExpressionLiteralType | null): any;
+
+/**
+ * Operator for filter expressions
+ * @export
+ */
+export declare const CatalogFilterExpressionOperator: {
+    readonly Like: "LIKE";
+    readonly Eq: "EQ";
+    readonly In: "IN";
+};
+
+export declare type CatalogFilterExpressionOperator = (typeof CatalogFilterExpressionOperator)[keyof typeof CatalogFilterExpressionOperator];
+
+export declare function CatalogFilterExpressionOperatorFromJSON(json: any): CatalogFilterExpressionOperator;
+
+export declare function CatalogFilterExpressionOperatorFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogFilterExpressionOperator;
+
+export declare function CatalogFilterExpressionOperatorToJSON(value?: CatalogFilterExpressionOperator | null): any;
+
+export declare function CatalogFilterExpressionToJSON(value?: CatalogFilterExpression | null): any;
+
+/**
+ * Catalog query parameters
+ * @export
+ * @interface CatalogQuery
+ */
+export declare interface CatalogQuery {
+    /**
+     * Target EDC DSP endpoint URL
+     * @type {string}
+     * @memberof CatalogQuery
+     */
+    connectorEndpoint: string;
+    /**
+     * Limit the number of results
+     * @type {number}
+     * @memberof CatalogQuery
+     */
+    limit?: number;
+    /**
+     * Offset for returned results, e.g. start at result 2
+     * @type {number}
+     * @memberof CatalogQuery
+     */
+    offset?: number;
+    /**
+     * Filter expressions for catalog filtering
+     * @type {Array<CatalogFilterExpression>}
+     * @memberof CatalogQuery
+     */
+    filterExpressions?: Array<CatalogFilterExpression>;
+}
+
+export declare function CatalogQueryFromJSON(json: any): CatalogQuery;
+
+export declare function CatalogQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): CatalogQuery;
+
+export declare function CatalogQueryToJSON(value?: CatalogQuery | null): any;
+
 /**
  * Credentials for connecting to the EDC via the OAuth2 "Client Credentials" flow.
  */
@@ -955,6 +1092,21 @@ export declare type InitOverrideFunction = (requestContext: {
  */
 export declare function instanceOfAssetPage(value: object): boolean;
 
+/**
+ * Check if a given object implements the CatalogFilterExpression interface.
+ */
+export declare function instanceOfCatalogFilterExpression(value: object): boolean;
+
+/**
+ * Check if a given object implements the CatalogFilterExpressionLiteral interface.
+ */
+export declare function instanceOfCatalogFilterExpressionLiteral(value: object): boolean;
+
+/**
+ * Check if a given object implements the CatalogQuery interface.
+ */
+export declare function instanceOfCatalogQuery(value: object): boolean;
+
 /**
  * Check if a given object implements the ConnectorLimits interface.
  */
@@ -1297,6 +1449,10 @@ export declare function PolicyDefinitionPageFromJSONTyped(json: any, ignoreDiscr
 
 export declare function PolicyDefinitionPageToJSON(value?: PolicyDefinitionPage | null): any;
 
+export declare interface QueryCatalogRequest {
+    catalogQuery: CatalogQuery;
+}
+
 export declare function querystring(params: HTTPQuery, prefix?: string): string;
 
 export declare interface RequestContext {
@@ -2701,6 +2857,14 @@ export declare class UseCaseApi extends runtime.BaseAPI {
      * List available functions in policies, prohibitions and obligations.
      */
     getSupportedFunctions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Fetch a connector\'s data offers
+     */
+    queryCatalogRaw(requestParameters: QueryCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<UiDataOffer>>>;
+    /**
+     * Fetch a connector\'s data offers
+     */
+    queryCatalog(requestParameters: QueryCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UiDataOffer>>;
 }
 
 export declare class VoidApiResponse {