@twin.org/auditable-item-graph-models 0.0.3-next.11 → 0.0.3-next.13

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -10,35 +10,32 @@ Interface describing the base properties for auditable elements.
 
 ## Properties
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the element.
 
 ***
 
-### dateCreated?
+### dateCreated? {#datecreated}
 
-> `optional` **dateCreated**: `string`
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
-json-ld namespace:sch
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
-json-ld namespace:sch
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
-json-ld namespace:sch

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -4,15 +4,15 @@ Interface describing a set of changes to the vertex.
 
 ## Properties
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context?**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphChangeset"`
 
@@ -20,7 +20,7 @@ JSON-LD Type.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -28,45 +28,40 @@ The id of the changeset.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
 The date/time of when the changeset was created.
-json-ld namespace:sch
 
 ***
 
-### userIdentity?
+### userIdentity? {#useridentity}
 
-> `optional` **userIdentity**: `string`
+> `optional` **userIdentity?**: `string`
 
 The user identity that created the changes.
-json-ld namespace:twin-common
 
 ***
 
-### patches
+### patches {#patches}
 
 > **patches**: [`IAuditableItemGraphPatchOperation`](IAuditableItemGraphPatchOperation.md)[]
 
 The patches in the changeset.
-json-ld container:set
 
 ***
 
-### proofId?
+### proofId? {#proofid}
 
-> `optional` **proofId**: `string`
+> `optional` **proofId?**: `string`
 
 The immutable proof id which contains the signature for this changeset.
-json-ld type:sch:identifier
 
 ***
 
-### verification?
+### verification? {#verification}
 
-> `optional` **verification**: `IImmutableProofVerification`
+> `optional` **verification?**: `IImmutableProofVerification`
 
 The verification for the changeset.
-json-ld id

package/docs/reference/interfaces/IAuditableItemGraphChangesetGetRequest.md

@@ -4,9 +4,9 @@ Get an auditable item graph vertex changeset.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -36,14 +36,14 @@ The id of the changeset to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### verifySignatureDepth?
 
-> `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+> `optional` **verifySignatureDepth?**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
 How many signatures to verify, none, current or all, defaults to "none".

package/docs/reference/interfaces/IAuditableItemGraphChangesetGetResponse.md

@@ -4,9 +4,9 @@ Response to getting an auditable item graph vertex changeset.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)
 

package/docs/reference/interfaces/IAuditableItemGraphChangesetList.md

@@ -4,7 +4,7 @@ Interface describing an auditable item graph changeset list.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: \[`"ItemList"`, `"AuditableItemGraphChangesetList"`\]
 
@@ -20,9 +20,8 @@ JSON-LD Type.
 
 ***
 
-### itemListElement
+### itemListElement {#itemlistelement}
 
 > **itemListElement**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
 
 The list of changesets.
-json-ld namespace:sch

package/docs/reference/interfaces/IAuditableItemGraphChangesetListRequest.md

@@ -4,9 +4,9 @@ Get an auditable item graph changeset.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -30,26 +30,26 @@ The id of the changeset to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The optional cursor to get next chunk.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 Limit the number of entities to return.
 
 #### verifySignatureDepth?
 
-> `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+> `optional` **verifySignatureDepth?**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
 How many signatures to verify, none, current or all, defaults to "none".

package/docs/reference/interfaces/IAuditableItemGraphChangesetListResponse.md

@@ -4,9 +4,9 @@ Response to getting an auditable item graph changeset list.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md)
 

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -8,7 +8,7 @@ Interface describing an auditable item graph contract.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`vertex`): `Promise`\<`string`\>
 
@@ -18,31 +18,9 @@ Create a new graph vertex.
 
 ##### vertex
 
-The vertex to create.
-
-###### annotationObject?
-
-`IJsonLdNodeObject`
-
-The annotation object for the vertex as JSON-LD.
-
-###### aliases?
-
-`object`[]
-
-Alternative aliases that can be used to identify the vertex.
-
-###### resources?
+`Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
 
-`object`[]
-
-The resources attached to the vertex.
-
-###### edges?
-
-`object`[]
-
-The edges connected to the vertex.
+The vertex to create.
 
 #### Returns
 
@@ -52,7 +30,7 @@ The id of the new graph item.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`vertex`): `Promise`\<`void`\>
 
@@ -62,37 +40,9 @@ Update a graph vertex.
 
 ##### vertex
 
-The vertex to update.
-
-###### id
-
-`string`
-
-The id of the vertex to update.
-
-###### annotationObject?
-
-`IJsonLdNodeObject`
-
-The annotation object for the vertex as JSON-LD.
-
-###### aliases?
-
-`object`[]
-
-Alternative aliases that can be used to identify the vertex.
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
 
-###### resources?
-
-`object`[]
-
-The resources attached to the vertex.
-
-###### edges?
-
-`object`[]
-
-The edges connected to the vertex.
+The vertex to update.
 
 #### Returns
 
@@ -102,7 +52,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
@@ -144,7 +94,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### getChangesets()
+### getChangesets() {#getchangesets}
 
 > **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
 
@@ -192,7 +142,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### getChangeset()
+### getChangeset() {#getchangeset}
 
 > **getChangeset**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)\>
 
@@ -228,7 +178,7 @@ NotFoundError if the vertex or changeset is not found.
 
 ***
 
-### removeVerifiable()
+### removeVerifiable() {#removeverifiable}
 
 > **removeVerifiable**(`id`): `Promise`\<`void`\>
 
@@ -254,7 +204,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md); `cursor?`: `string`; \}\>
 
@@ -298,9 +248,9 @@ Conditions to use in the query.
 
 ##### orderBy?
 
-The order for the results, defaults to dateCreated.
+`"dateCreated"` \| `"dateModified"`
 
-`"dateCreated"` | `"dateModified"`
+The order for the results, defaults to dateCreated.
 
 ##### orderByDirection?
 

package/docs/reference/interfaces/IAuditableItemGraphCreateRequest.md

@@ -4,32 +4,8 @@ Create an auditable item graph vertex.
 
 ## Properties
 
-### body
+### body {#body}
 
-> **body**: `object`
+> **body**: `Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
 
 The data to be used in the vertex.
-
-#### annotationObject?
-
-> `optional` **annotationObject**: `IJsonLdNodeObject`
-
-The object to be used in the vertex as JSON-LD.
-
-#### aliases?
-
-> `optional` **aliases**: `object`[]
-
-Alternative aliases that can be used to identify the vertex.
-
-#### resources?
-
-> `optional` **resources**: `object`[]
-
-The resources attached to the vertex.
-
-#### edges?
-
-> `optional` **edges**: `object`[]
-
-The edges connected to the vertex.

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -8,12 +8,11 @@ Interface describing an edge between two vertices in an auditable item graph.
 
 ## Properties
 
-### dateCreated?
+### dateCreated? {#datecreated}
 
-> `optional` **dateCreated**: `string`
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
-json-ld namespace:sch
 
 #### Inherited from
 
@@ -21,12 +20,11 @@ json-ld namespace:sch
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
-json-ld namespace:sch
 
 #### Inherited from
 
@@ -34,12 +32,11 @@ json-ld namespace:sch
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
-json-ld namespace:sch
 
 #### Inherited from
 
@@ -47,17 +44,17 @@ json-ld namespace:sch
 
 ***
 
-### @context
+### @context? {#context}
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context?**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the element.
 
@@ -67,16 +64,15 @@ The id of the element.
 
 ***
 
-### targetId
+### targetId {#targetid}
 
 > **targetId**: `string`
 
 The target vertex id the edge connects to.
-json-ld type:@id
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphEdge"`
 
@@ -84,18 +80,16 @@ JSON-LD Type.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the edge.
-json-ld namespace:twin-common
 
 ***
 
-### edgeRelationships
+### edgeRelationships {#edgerelationships}
 
 > **edgeRelationships**: `string`[]
 
 The relationships between the two vertices.
-json-ld container:set

package/docs/reference/interfaces/IAuditableItemGraphEventBusVertexCreated.md

@@ -4,7 +4,7 @@ Event bus payload for vertex created.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 

package/docs/reference/interfaces/IAuditableItemGraphEventBusVertexUpdated.md

@@ -4,7 +4,7 @@ Event bus payload for vertex updated.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -12,7 +12,7 @@ The id of the vertex updated.
 
 ***
 
-### patches
+### patches {#patches}
 
 > **patches**: `IPatchOperation`[]
 

package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md

@@ -4,9 +4,9 @@ Get an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -30,20 +30,20 @@ The id of the vertex to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### includeDeleted?
 
-> `optional` **includeDeleted**: `string`
+> `optional` **includeDeleted?**: `string`
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
 #### verifySignatureDepth?
 
-> `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+> `optional` **verifySignatureDepth?**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
 How many signatures to verify, none, current or all, defaults to "none".

package/docs/reference/interfaces/IAuditableItemGraphGetResponse.md

@@ -4,9 +4,9 @@ Response to getting an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)