@twin.org/dataspace-models 0.0.3-next.19 → 0.0.3-next.21

package/docs/reference/interfaces/IDataspaceApp.md

@@ -8,7 +8,7 @@ Interface describes a Dataspace App.
 
 ## Methods
 
-### activitiesHandled()
+### activitiesHandled() {#activitieshandled}
 
 > **activitiesHandled**(): [`IActivityQuery`](IActivityQuery.md)[]
 
@@ -22,7 +22,7 @@ A query that describes the set of activities handled by the App.
 
 ***
 
-### datasetsHandled()
+### datasetsHandled() {#datasetshandled}
 
 > **datasetsHandled**(): `Promise`\<`IDataspaceProtocolDataset`[]\>
 
@@ -36,7 +36,7 @@ The Dataspace Protocol compliant datasets handled by the App.
 
 ***
 
-### supportedQueryTypes()
+### supportedQueryTypes() {#supportedquerytypes}
 
 > **supportedQueryTypes**(): `string`[]
 
@@ -50,7 +50,7 @@ The types of queries supported by the Dataspace App to retrieve data.
 
 ***
 
-### handleActivity()?
+### handleActivity()? {#handleactivity}
 
 > `optional` **handleActivity**\<`T`\>(`activity`): `Promise`\<`T`\>
 
@@ -78,7 +78,7 @@ The result of executing the Activity.
 
 ***
 
-### handleDataRequest()?
+### handleDataRequest()? {#handledatarequest}
 
 > `optional` **handleDataRequest**(`dataRequest`, `cursor?`, `limit?`): `Promise`\<\{ `data`: `IJsonLdDocument`; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md

@@ -16,7 +16,7 @@ DSP 2025-1 Specification: https://eclipse-dataspace-protocol-base.github.io/Data
 
 ## Methods
 
-### registerNegotiationCallback()
+### registerNegotiationCallback() {#registernegotiationcallback}
 
 > **registerNegotiationCallback**(`key`, `callback`): `void`
 
@@ -44,7 +44,7 @@ The callback interface to register.
 
 ***
 
-### unregisterNegotiationCallback()
+### unregisterNegotiationCallback() {#unregisternegotiationcallback}
 
 > **unregisterNegotiationCallback**(`key`): `void`
 
@@ -64,7 +64,7 @@ The key used when registering the callback.
 
 ***
 
-### negotiateAgreement()
+### negotiateAgreement() {#negotiateagreement}
 
 > **negotiateAgreement**(`datasetId`, `offerId`, `providerEndpoint`, `publicOrigin`, `trustPayload`): `Promise`\<\{ `negotiationId`: `string`; \}\>
 
@@ -119,7 +119,7 @@ The negotiation ID for tracking. Use registered callback for completion.
 
 ***
 
-### getNegotiation()
+### getNegotiation() {#getnegotiation}
 
 > **getNegotiation**(`negotiationId`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
 
@@ -154,7 +154,7 @@ DSP ContractNegotiation with current state, or error.
 
 ***
 
-### getNegotiationHistory()
+### getNegotiationHistory() {#getnegotiationhistory}
 
 > **getNegotiationHistory**(`state`, `cursor`, `trustPayload`): `Promise`\<\{ `negotiations`: `object`[]; `cursor?`: `string`; `count`: `number`; \}\>
 
@@ -192,7 +192,7 @@ List of negotiation history entries with pagination cursor.
 
 ***
 
-### requestTransfer()
+### requestTransfer() {#requesttransfer}
 
 > **requestTransfer**(`request`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`\>
 
@@ -229,7 +229,7 @@ both consumerPid and providerPid, or TransferError if the operation fails.
 
 ***
 
-### startTransfer()
+### startTransfer() {#starttransfer}
 
 > **startTransfer**(`message`, `publicOrigin`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferStartMessage`\>
 
@@ -269,7 +269,7 @@ Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or T
 
 ***
 
-### completeTransfer()
+### completeTransfer() {#completetransfer}
 
 > **completeTransfer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`\>
 
@@ -303,7 +303,7 @@ Transfer Process (DSP compliant) with state COMPLETED, or TransferError if the o
 
 ***
 
-### suspendTransfer()
+### suspendTransfer() {#suspendtransfer}
 
 > **suspendTransfer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`\>
 
@@ -337,7 +337,7 @@ Transfer Process (DSP compliant) with state SUSPENDED, or TransferError if the o
 
 ***
 
-### terminateTransfer()
+### terminateTransfer() {#terminatetransfer}
 
 > **terminateTransfer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`\>
 
@@ -371,7 +371,7 @@ Transfer Process (DSP compliant) with state TERMINATED, or TransferError if the
 
 ***
 
-### getTransferProcess()
+### getTransferProcess() {#gettransferprocess}
 
 > **getTransferProcess**(`pid`, `trustPayload`): `Promise`\<`IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`\>
 

package/docs/reference/interfaces/IDataspaceControlPlaneResolverComponent.md

@@ -16,7 +16,7 @@ accessible via ComponentFactory.get() for local, in-process service access.
 
 ## Methods
 
-### resolveConsumerPid()
+### resolveConsumerPid() {#resolveconsumerpid}
 
 > **resolveConsumerPid**(`consumerPid`, `trustPayload`): `Promise`\<[`ITransferContext`](ITransferContext.md)\>
 
@@ -64,7 +64,7 @@ GeneralError if Transfer Process is terminated or Agreement lookup fails.
 
 ***
 
-### resolveProviderPid()
+### resolveProviderPid() {#resolveproviderpid}
 
 > **resolveProviderPid**(`providerPid`, `trustPayload`): `Promise`\<[`ITransferContext`](ITransferContext.md)\>
 

package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md

@@ -9,7 +9,7 @@ Implements the Data Plane functionality for the Eclipse Dataspace Protocol.
 
 ## Methods
 
-### notifyActivity()
+### notifyActivity() {#notifyactivity}
 
 > **notifyActivity**(`activity`): `Promise`\<`string`\>
 
@@ -31,7 +31,7 @@ The Activity's identifier.
 
 ***
 
-### subscribeToActivityLog()
+### subscribeToActivityLog() {#subscribetoactivitylog}
 
 > **subscribeToActivityLog**(`callback`, `subscriptionId?`): `Promise`\<`string`\>
 
@@ -59,7 +59,7 @@ The subscription Id.
 
 ***
 
-### unSubscribeToActivityLog()
+### unSubscribeToActivityLog() {#unsubscribetoactivitylog}
 
 > **unSubscribeToActivityLog**(`subscriptionId`): `Promise`\<`void`\>
 
@@ -81,7 +81,7 @@ The subscription Id.
 
 ***
 
-### getActivityLogEntry()
+### getActivityLogEntry() {#getactivitylogentry}
 
 > **getActivityLogEntry**(`logEntryId`): `Promise`\<[`IActivityLogEntry`](IActivityLogEntry.md)\>
 
@@ -107,7 +107,7 @@ NotFoundError if activity log entry is not known.
 
 ***
 
-### getDataAssetEntities()
+### getDataAssetEntities() {#getdataassetentities}
 
 > **getDataAssetEntities**(`entitySet`, `consumerPid`, `cursor?`, `limit?`, `trustPayload?`): `Promise`\<[`IDataAssetItemListResult`](IDataAssetItemListResult.md)\>
 
@@ -154,7 +154,7 @@ The item list and optional cursor for pagination via Link headers.
 
 ***
 
-### queryDataAsset()
+### queryDataAsset() {#querydataasset}
 
 > **queryDataAsset**(`consumerPid`, `query`, `cursor?`, `limit?`, `trustPayload?`): `Promise`\<[`IDataAssetItemListResult`](IDataAssetItemListResult.md)\>
 

package/docs/reference/interfaces/IEntitySet.md

@@ -4,7 +4,7 @@ Part of the Data Request interface to represent a set of entities either by id o
 
 ## Properties
 
-### entityId?
+### entityId? {#entityid}
 
 > `optional` **entityId**: `string`[]
 
@@ -12,7 +12,7 @@ Entity Id.
 
 ***
 
-### entityType
+### entityType {#entitytype}
 
 > **entityType**: `string`
 

package/docs/reference/interfaces/IExecutionPayload.md

@@ -4,7 +4,7 @@ Execution payload.
 
 ## Properties
 
-### activityLogEntryId
+### activityLogEntryId {#activitylogentryid}
 
 > **activityLogEntryId**: `string`
 
@@ -12,7 +12,7 @@ The Activity Log Entry Id.
 
 ***
 
-### activity
+### activity {#activity}
 
 > **activity**: [`IDataspaceActivity`](IDataspaceActivity.md)
 
@@ -20,7 +20,7 @@ The activity
 
 ***
 
-### executorApp
+### executorApp {#executorapp}
 
 > **executorApp**: `string`
 

package/docs/reference/interfaces/IFilteringQuery.md

@@ -4,7 +4,7 @@ A query over a data asset that to be processed by a Dataspace Data Plane App.
 
 ## Properties
 
-### type
+### type {#type}
 
 > **type**: `string`
 
@@ -12,7 +12,7 @@ The query type.
 
 ***
 
-### q
+### q {#q}
 
 > **q**: `unknown`
 
@@ -20,7 +20,7 @@ The representation of the query.
 
 ***
 
-### jsonLdContext?
+### jsonLdContext? {#jsonldcontext}
 
 > `optional` **jsonLdContext**: `IJsonLdContextDefinitionElement`[]
 

package/docs/reference/interfaces/IGetTransferProcessRequest.md

@@ -4,7 +4,7 @@ API request for getting a transfer process state.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ Process ID (consumerPid or providerPid).
 
 ***
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 

package/docs/reference/interfaces/IGetTransferProcessResponse.md

@@ -4,7 +4,7 @@ API response for getting a transfer process state.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
 
@@ -12,7 +12,7 @@ Transfer Process (DSP compliant) with current state, or error.
 
 ***
 
-### statusCode?
+### statusCode? {#statuscode}
 
 > `optional` **statusCode**: `HttpStatusCode`
 

package/docs/reference/interfaces/INegotiationCallback.md

@@ -7,7 +7,7 @@ to be notified when PNP callbacks fire.
 
 ## Methods
 
-### onStateChanged()
+### onStateChanged() {#onstatechanged}
 
 > **onStateChanged**(`negotiationId`, `state`, `data?`): `Promise`\<`void`\>
 
@@ -51,7 +51,7 @@ Nothing.
 
 ***
 
-### onCompleted()
+### onCompleted() {#oncompleted}
 
 > **onCompleted**(`negotiationId`, `agreementId`): `Promise`\<`void`\>
 
@@ -79,7 +79,7 @@ Nothing.
 
 ***
 
-### onFailed()
+### onFailed() {#onfailed}
 
 > **onFailed**(`negotiationId`, `reason`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IQueryDataAssetRequest.md

@@ -4,7 +4,7 @@ Data Request type for representing data requests received by Dataspace Apps.
 
 ## Properties
 
-### type
+### type {#type}
 
 > **type**: `"QueryDataAsset"`
 
@@ -12,7 +12,7 @@ Data Asset Entities type.
 
 ***
 
-### dataAsset
+### dataAsset {#dataasset}
 
 > **dataAsset**: `IDataspaceProtocolDataset`
 
@@ -20,7 +20,7 @@ The data asset we are referring to.
 
 ***
 
-### query
+### query {#query}
 
 > **query**: [`IFilteringQuery`](IFilteringQuery.md)
 

package/docs/reference/interfaces/IRequestTransferRequest.md

@@ -4,7 +4,7 @@ API request for requesting a transfer process.
 
 ## Properties
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -16,7 +16,7 @@ Authorization header containing the Base64-encoded trust payload.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferRequestMessage`
 

package/docs/reference/interfaces/IRequestTransferResponse.md

@@ -4,7 +4,7 @@ API response for requesting a transfer process.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
 
@@ -12,7 +12,7 @@ Transfer Process (DSP compliant) with state REQUESTED, or error.
 
 ***
 
-### statusCode?
+### statusCode? {#statuscode}
 
 > `optional` **statusCode**: `HttpStatusCode`
 

package/docs/reference/interfaces/IStartTransferRequest.md

@@ -4,7 +4,7 @@ API request for starting a transfer process.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ Process ID (consumerPid).
 
 ***
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -30,7 +30,7 @@ Authorization header containing the Base64-encoded trust payload.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferStartMessage`
 

package/docs/reference/interfaces/IStartTransferResponse.md

@@ -4,7 +4,7 @@ API response for starting a transfer process.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferStartMessage`
 
@@ -12,7 +12,7 @@ Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or e
 
 ***
 
-### statusCode?
+### statusCode? {#statuscode}
 
 > `optional` **statusCode**: `HttpStatusCode`
 

package/docs/reference/interfaces/ISuspendTransferRequest.md

@@ -4,7 +4,7 @@ API request for suspending a transfer process.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ Process ID (consumerPid).
 
 ***
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -30,7 +30,7 @@ Authorization header containing the Base64-encoded trust payload.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferSuspensionMessage`
 

package/docs/reference/interfaces/ISuspendTransferResponse.md

@@ -4,7 +4,7 @@ API response for suspending a transfer process.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
 
@@ -12,7 +12,7 @@ Transfer Process (DSP compliant) with state SUSPENDED, or error.
 
 ***
 
-### statusCode?
+### statusCode? {#statuscode}
 
 > `optional` **statusCode**: `HttpStatusCode`
 

package/docs/reference/interfaces/ITaskApp.md

@@ -4,7 +4,7 @@ Denotes a task associated with a Dataspace App
 
 ## Properties
 
-### taskId
+### taskId {#taskid}
 
 > **taskId**: `string`
 
@@ -12,7 +12,7 @@ Task Id.
 
 ***
 
-### dataspaceAppId
+### dataspaceAppId {#dataspaceappid}
 
 > **dataspaceAppId**: `string`
 

package/docs/reference/interfaces/ITerminateTransferRequest.md

@@ -4,7 +4,7 @@ API request for terminating a transfer process.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ Process ID (consumerPid).
 
 ***
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -30,7 +30,7 @@ Authorization header containing the Base64-encoded trust payload.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferTerminationMessage`
 

package/docs/reference/interfaces/ITerminateTransferResponse.md

@@ -4,7 +4,7 @@ API response for terminating a transfer process.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
 
@@ -12,7 +12,7 @@ Transfer Process (DSP compliant) with state TERMINATED, or error.
 
 ***
 
-### statusCode?
+### statusCode? {#statuscode}
 
 > `optional` **statusCode**: `HttpStatusCode`
 

package/docs/reference/interfaces/ITransferContext.md

@@ -7,7 +7,7 @@ used by dataspace-control-plane to resolve consumerPid to datasetId and policies
 
 ## Properties
 
-### consumerPid
+### consumerPid {#consumerpid}
 
 > **consumerPid**: `string`
 
@@ -15,7 +15,7 @@ Consumer Process ID.
 
 ***
 
-### providerPid
+### providerPid {#providerpid}
 
 > **providerPid**: `string`
 
@@ -23,7 +23,7 @@ Provider Process ID.
 
 ***
 
-### agreement
+### agreement {#agreement}
 
 > **agreement**: `IDataspaceProtocolAgreement`
 
@@ -32,7 +32,7 @@ Contains permissions, obligations, and prohibitions that DSC uses for runtime po
 
 ***
 
-### datasetId
+### datasetId {#datasetid}
 
 > **datasetId**: `string`
 
@@ -41,7 +41,7 @@ Convenience field extracted from agreement.target for quick access.
 
 ***
 
-### offerId
+### offerId {#offerid}
 
 > **offerId**: `string`
 
@@ -49,7 +49,7 @@ Offer ID.
 
 ***
 
-### state
+### state {#state}
 
 > **state**: `DataspaceProtocolTransferProcessStateType`
 
@@ -58,7 +58,7 @@ DSC should only allow queries if state is STARTED.
 
 ***
 
-### consumerIdentity?
+### consumerIdentity? {#consumeridentity}
 
 > `optional` **consumerIdentity**: `string`
 
@@ -66,7 +66,7 @@ Consumer identity (for auditing).
 
 ***
 
-### providerIdentity?
+### providerIdentity? {#provideridentity}
 
 > `optional` **providerIdentity**: `string`
 
@@ -75,7 +75,7 @@ Extracted from Agreement's assigner field.
 
 ***
 
-### dataAddress?
+### dataAddress? {#dataaddress}
 
 > `optional` **dataAddress**: `IDataspaceProtocolDataAddress`
 

package/docs/reference/interfaces/ITransferContextResponse.md

@@ -6,7 +6,7 @@ used by dataspace-control-plane to resolve consumerPid to datasetId and policies
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: [`ITransferContext`](ITransferContext.md)