@twin.org/auditable-item-graph-models 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -4,9 +4,9 @@ Get the a list of the vertices with matching ids or aliases.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,68 +16,68 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### id?
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id or alias to try and find.
 
 #### idMode?
 
-> `optional` **idMode**: `"id"` \| `"alias"` \| `"both"`
+> `optional` **idMode?**: `"id"` \| `"alias"` \| `"both"`
 
 Which field to look in with the id, defaults to both.
 
 #### idExact?
 
-> `optional` **idExact**: `string`
+> `optional` **idExact?**: `string`
 
 Find only exact matches, default to false meaning partial matching.
 
 #### resourceTypes?
 
-> `optional` **resourceTypes**: `string`
+> `optional` **resourceTypes?**: `string`
 
 Include vertices with specific resource types, comma separated.
 
 #### conditions?
 
-> `optional` **conditions**: `string`
+> `optional` **conditions?**: `string`
 
 The conditions to filter the streams, JSON stringified IComparator[].
 
 #### orderBy?
 
-> `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
+> `optional` **orderBy?**: `"dateCreated"` \| `"dateModified"`
 
 The order for the results, default to dateCreated.
 
 #### orderByDirection?
 
-> `optional` **orderByDirection**: `SortDirection`
+> `optional` **orderByDirection?**: `SortDirection`
 
 The direction for the order, defaults to desc.
 
 #### properties?
 
-> `optional` **properties**: `string`
+> `optional` **properties?**: `string`
 
 The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
 
 #### 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.

package/docs/reference/interfaces/IAuditableItemGraphListResponse.md

@@ -4,9 +4,9 @@ The response to getting the a list of the vertices with matching ids or aliases.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -14,9 +14,13 @@ The headers which can be used to determine the response data type.
 
 > **content-type**: `"application/json"` \| `"application/ld+json"`
 
+#### link?
+
+> `optional` **link?**: `string` \| `string`[]
+
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)
 

package/docs/reference/interfaces/IAuditableItemGraphPartialVertex.md

@@ -0,0 +1,149 @@
+# Interface: IAuditableItemGraphPartialVertex
+
+Partial vertex payload for updatePartial (PATCH — requires id).
+Sub-lists use explicit `{ add, remove }` patches; bare arrays are not supported.
+
+## Extends
+
+- `Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"type"` \| `"aliases"` \| `"edges"` \| `"resources"`\>
+
+## Properties
+
+### dateCreated? {#datecreated}
+
+> `optional` **dateCreated?**: `string`
+
+The date/time of when the element was created.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the element was modified.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
+
+***
+
+### dateDeleted? {#datedeleted}
+
+> `optional` **dateDeleted?**: `string`
+
+The date/time of when the element was deleted, as we never actually remove items.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)
+
+***
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the vertex to update.
+
+#### Overrides
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`id`](IAuditableItemGraphVertex.md#id)
+
+***
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+#### Overrides
+
+`Omit.@context`
+
+***
+
+### type? {#type}
+
+> `optional` **type?**: `"AuditableItemGraphVertex"`
+
+JSON-LD Type.
+
+***
+
+### aliasPatches? {#aliaspatches}
+
+> `optional` **aliasPatches?**: [`IAuditableItemGraphListPatch`](IAuditableItemGraphListPatch.md)\<[`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)\>
+
+Patch operations for aliases.
+
+***
+
+### resourcePatches? {#resourcepatches}
+
+> `optional` **resourcePatches?**: [`IAuditableItemGraphListPatch`](IAuditableItemGraphListPatch.md)\<[`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)\>
+
+Patch operations for resources.
+
+***
+
+### edgePatches? {#edgepatches}
+
+> `optional` **edgePatches?**: [`IAuditableItemGraphListPatch`](IAuditableItemGraphListPatch.md)\<[`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)\>
+
+Patch operations for edges.
+
+***
+
+### organizationIdentity? {#organizationidentity}
+
+> `optional` **organizationIdentity?**: `string`
+
+The identity of the organization which controls the vertex.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`organizationIdentity`](IAuditableItemGraphVertex.md#organizationidentity)
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+The JSON-LD annotation object for the vertex.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`annotationObject`](IAuditableItemGraphVertex.md#annotationobject)
+
+***
+
+### verified? {#verified}
+
+> `optional` **verified?**: `boolean`
+
+Is the vertex verified, will only be populated when verification is requested.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`verified`](IAuditableItemGraphVertex.md#verified)
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version of the vertex, populated only when getting a specific version.
+Maps to https://schema.org/version.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`version`](IAuditableItemGraphVertex.md#version)

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -4,15 +4,15 @@ The patch operation for JSON diffs.
 
 ## Properties
 
-### @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.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphPatchOperation"`
 
@@ -20,7 +20,7 @@ JSON-LD Type.
 
 ***
 
-### patchOperation
+### patchOperation {#patchoperation}
 
 > **patchOperation**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
@@ -28,7 +28,7 @@ The operation that was performed on the item.
 
 ***
 
-### patchPath
+### patchPath {#patchpath}
 
 > **patchPath**: `string`
 
@@ -36,16 +36,16 @@ The path to the object that was changed.
 
 ***
 
-### patchFrom?
+### patchFrom? {#patchfrom}
 
-> `optional` **patchFrom**: `string`
+> `optional` **patchFrom?**: `string`
 
 The path the value was copied or moved from.
 
 ***
 
-### patchValue?
+### patchValue? {#patchvalue}
 
-> `optional` **patchValue**: `unknown`
+> `optional` **patchValue?**: `unknown`
 
 The value to add.

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -8,9 +8,9 @@ Interface describing an auditable item graph vertex resource.
 
 ## Properties
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the element.
 
@@ -20,9 +20,9 @@ The id of the element.
 
 ***
 
-### dateCreated?
+### dateCreated? {#datecreated}
 
-> `optional` **dateCreated**: `string`
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
 
@@ -32,9 +32,9 @@ The date/time of when the element was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
 
@@ -44,9 +44,9 @@ The date/time of when the element was modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
 
@@ -56,15 +56,15 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ***
 
-### @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.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphResource"`
 
@@ -72,8 +72,8 @@ JSON-LD Type.
 
 ***
 
-### resourceObject?
+### resourceObject? {#resourceobject}
 
-> `optional` **resourceObject**: `IJsonLdNodeObject`
+> `optional` **resourceObject?**: `IJsonLdNodeObject`
 
 The JSON-LD object for the resource.

package/docs/reference/interfaces/IAuditableItemGraphUpdatePartialRequest.md

@@ -0,0 +1,26 @@
+# Interface: IAuditableItemGraphUpdatePartialRequest
+
+Partially update an auditable item graph vertex (PATCH — explicit list patches).
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex to update.
+
+***
+
+### body {#body}
+
+> **body**: `Omit`\<[`IAuditableItemGraphPartialVertex`](IAuditableItemGraphPartialVertex.md), `"id"`\>
+
+Partial vertex data; only defined properties are applied.
+Sub-lists use `{ add, remove }` patch objects.

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -1,10 +1,10 @@
 # Interface: IAuditableItemGraphUpdateRequest
 
-Update an auditable item graph vertex.
+Update an auditable item graph vertex (PUT — full replacement of vertex state).
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,32 +18,8 @@ The id of the vertex to update.
 
 ***
 
-### 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.
+The full vertex payload. Replaces annotation and active sub-lists; omitted collections are cleared.

package/docs/reference/interfaces/IAuditableItemGraphVersionGetRequest.md

@@ -0,0 +1,35 @@
+# Interface: IAuditableItemGraphVersionGetRequest
+
+Get an auditable item graph vertex at a specific version.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex.
+
+#### version
+
+> **version**: `string`
+
+The version number to get.

package/docs/reference/interfaces/IAuditableItemGraphVersionGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphVersionGetResponse
+
+Response to getting an auditable item graph vertex at a specific version.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphVersionListRequest.md

@@ -0,0 +1,49 @@
+# Interface: IAuditableItemGraphVersionListRequest
+
+Get all versions of an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### after?
+
+> `optional` **after?**: `string`
+
+Only return versions created after this ISO 8601 timestamp (exclusive).
+
+#### before?
+
+> `optional` **before?**: `string`
+
+Only return versions created before this ISO 8601 timestamp (exclusive).

package/docs/reference/interfaces/IAuditableItemGraphVersionListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphVersionListResponse
+
+Response to getting all versions of an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertexVersionList`](IAuditableItemGraphVertexVersionList.md)
+
+The response body.