@twin.org/standards-gs1 0.0.3-next.10 → 0.0.3-next.11

package/docs/reference/interfaces/IEpcisAggregationEvent.md

@@ -0,0 +1,223 @@
+# Interface: IEpcisAggregationEvent
+
+EPCIS 2.0 AggregationEvent describing how child objects are associated with or
+disassociated from a parent object.
+
+## See
+
+https://ref.gs1.org/epcis/AggregationEvent
+
+## Extends
+
+- [`IEpcisEvent`](IEpcisEvent.md)
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### type
+
+> **type**: `"AggregationEvent"`
+
+The type.
+
+#### Overrides
+
+[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
+
+***
+
+### parentID?
+
+> `optional` **parentID**: `string`
+
+(Optional when action is OBSERVE, required otherwise) Identifier of the parent
+of the aggregation or association; use the pure identity URI when the parent is
+an EPC.
+
+***
+
+### childEPCs?
+
+> `optional` **childEPCs**: `string`[]
+
+(Optional) Unordered list of contained objects identified at the instance
+level; AggregationEvents normally include childEPCs or childQuantityList unless
+action is DELETE.
+
+***
+
+### childQuantityList?
+
+> `optional` **childQuantityList**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
+
+Unordered list of one or more QuantityElements identifying contained objects
+at the class level; may be empty only with action DELETE when disaggregating
+all children.
+
+***
+
+### action
+
+> **action**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.md)
+
+How this event relates to the lifecycle of the EPCs named in this event.
+
+***
+
+### bizStep?
+
+> `optional` **bizStep**: `string`
+
+(Optional) The business step of which this event was a part.
+
+***
+
+### disposition?
+
+> `optional` **disposition**: `string`
+
+(Optional) The business condition of the objects associated with the EPCs,
+presumed to hold true until contradicted by a subsequent event.
+
+***
+
+### readPoint?
+
+> `optional` **readPoint**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The read point at which the event took place.
+
+***
+
+### bizLocation?
+
+> `optional` **bizLocation**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The business location where the objects associated with the EPCs
+may be found, until contradicted by a subsequent event.
+
+***
+
+### bizTransactionList?
+
+> `optional` **bizTransactionList**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
+
+(Optional) An unordered list of business transactions that define the context
+of this event.
+
+***
+
+### sourceList?
+
+> `optional` **sourceList**: [`IEpcisSource`](IEpcisSource.md)[]
+
+(Optional) Unordered list of Source elements that provide context about the
+originating endpoint of a business transfer of which this event is a part.
+
+***
+
+### destinationList?
+
+> `optional` **destinationList**: [`IEpcisDestination`](IEpcisDestination.md)[]
+
+(Optional) Unordered list of Destination elements that provide context about the
+terminating endpoint of a business transfer of which this event is a part.
+
+***
+
+### sensorElementList?
+
+> `optional` **sensorElementList**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
+
+(Optional) Connects event to one or more SensorElements.
+
+***
+
+### @context
+
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
+
+JSON-LD @context.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
+
+***
+
+### eventID?
+
+> `optional` **eventID**: `string`
+
+URI identifier of a specific EPCIS event (alias of id in JSON or XML).
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventID`](IEpcisEvent.md#eventid)
+
+***
+
+### certificationInfo?
+
+> `optional` **certificationInfo**: `string` \| `string`[]
+
+(Optional) CertificationDetails relevant for Objects, Places and/or
+Organizations mentioned in this Event.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`certificationInfo`](IEpcisEvent.md#certificationinfo)
+
+***
+
+### errorDeclaration?
+
+> `optional` **errorDeclaration**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
+
+Error declaration.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`errorDeclaration`](IEpcisEvent.md#errordeclaration)
+
+***
+
+### eventTime
+
+> **eventTime**: `string`
+
+The date and time at which the EPCIS Capturing Applications asserts the event
+occurred.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTime`](IEpcisEvent.md#eventtime)
+
+***
+
+### eventTimeZoneOffset
+
+> **eventTimeZoneOffset**: `string`
+
+The time zone offset in effect at the time and place the event occurred,
+expressed as an offset from UTC.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTimeZoneOffset`](IEpcisEvent.md#eventtimezoneoffset)
+
+***
+
+### recordTime?
+
+> `optional` **recordTime**: `string`
+
+(Optional) The date and time at which this event was recorded by an EPCIS
+Repository; ignored at capture and present on query results.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`recordTime`](IEpcisEvent.md#recordtime)

package/docs/reference/interfaces/IEpcisAssociationEvent.md

@@ -0,0 +1,222 @@
+# Interface: IEpcisAssociationEvent
+
+EPCIS 2.0 AssociationEvent describing membership relationships between parent
+and child objects without implying physical containment.
+
+## See
+
+https://ref.gs1.org/epcis/AssociationEvent
+
+## Extends
+
+- [`IEpcisEvent`](IEpcisEvent.md)
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### type
+
+> **type**: `"AssociationEvent"`
+
+Type.
+
+#### Overrides
+
+[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
+
+***
+
+### parentID
+
+> **parentID**: `string`
+
+Identifier of the parent of the aggregation or association; use the pure
+identity URI when the parent is an EPC.
+
+***
+
+### childEPCs?
+
+> `optional` **childEPCs**: `string`[]
+
+(Optional) Unordered list of contained objects identified at the instance
+level; AssociationEvents normally include childEPCs or childQuantityList
+unless action is DELETE.
+
+***
+
+### childQuantityList?
+
+> `optional` **childQuantityList**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
+
+Unordered list of one or more QuantityElements identifying contained objects
+at the class level; may be empty only with action DELETE when disassociating
+all children.
+
+***
+
+### action
+
+> **action**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.md)
+
+How this event relates to the lifecycle of the EPCs named in this event.
+
+***
+
+### bizStep?
+
+> `optional` **bizStep**: `string`
+
+(Optional) The business step of which this event was a part.
+
+***
+
+### disposition?
+
+> `optional` **disposition**: `string`
+
+(Optional) The business condition of the objects associated with the EPCs,
+presumed to hold true until contradicted by a subsequent event.
+
+***
+
+### readPoint?
+
+> `optional` **readPoint**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The read point at which the event took place.
+
+***
+
+### bizLocation?
+
+> `optional` **bizLocation**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The business location where the objects associated with the EPCs
+may be found, until contradicted by a subsequent event.
+
+***
+
+### bizTransactionList?
+
+> `optional` **bizTransactionList**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
+
+(Optional) An unordered list of business transactions that define the context
+of this event.
+
+***
+
+### sourceList?
+
+> `optional` **sourceList**: [`IEpcisSource`](IEpcisSource.md)[]
+
+(Optional) Unordered list of Source elements that provide context about the
+originating endpoint of a business transfer of which this event is a part.
+
+***
+
+### destinationList?
+
+> `optional` **destinationList**: [`IEpcisDestination`](IEpcisDestination.md)[]
+
+(Optional) Unordered list of Destination elements that provide context about
+the terminating endpoint of a business transfer of which this event is a part.
+
+***
+
+### sensorElementList?
+
+> `optional` **sensorElementList**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
+
+(Optional) Connects event to one or more SensorElements.
+
+***
+
+### @context
+
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
+
+JSON-LD @context.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
+
+***
+
+### eventID?
+
+> `optional` **eventID**: `string`
+
+URI identifier of a specific EPCIS event (alias of id in JSON or XML).
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventID`](IEpcisEvent.md#eventid)
+
+***
+
+### certificationInfo?
+
+> `optional` **certificationInfo**: `string` \| `string`[]
+
+(Optional) CertificationDetails relevant for Objects, Places and/or
+Organizations mentioned in this Event.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`certificationInfo`](IEpcisEvent.md#certificationinfo)
+
+***
+
+### errorDeclaration?
+
+> `optional` **errorDeclaration**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
+
+Error declaration.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`errorDeclaration`](IEpcisEvent.md#errordeclaration)
+
+***
+
+### eventTime
+
+> **eventTime**: `string`
+
+The date and time at which the EPCIS Capturing Applications asserts the event
+occurred.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTime`](IEpcisEvent.md#eventtime)
+
+***
+
+### eventTimeZoneOffset
+
+> **eventTimeZoneOffset**: `string`
+
+The time zone offset in effect at the time and place the event occurred,
+expressed as an offset from UTC.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTimeZoneOffset`](IEpcisEvent.md#eventtimezoneoffset)
+
+***
+
+### recordTime?
+
+> `optional` **recordTime**: `string`
+
+(Optional) The date and time at which this event was recorded by an EPCIS
+Repository; ignored at capture and present on query results.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`recordTime`](IEpcisEvent.md#recordtime)

package/docs/reference/interfaces/IEpcisAttribute.md

@@ -0,0 +1,31 @@
+# Interface: IEpcisAttribute
+
+EPCIS 2.0 Vocabulary Attribute describing metadata on vocabulary elements.
+
+## See
+
+https://ref.gs1.org/epcis/Attribute
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Attribute id.
+
+***
+
+### attribute?
+
+> `optional` **attribute**: `IJsonLdNodePrimitive`
+
+Attribute value.

package/docs/reference/interfaces/IEpcisBizTransaction.md

@@ -0,0 +1,35 @@
+# Interface: IEpcisBizTransaction
+
+EPCIS 2.0 BizTransaction element identifying a business document and its type.
+
+## See
+
+https://ref.gs1.org/epcis/BizTransaction
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### type?
+
+> `optional` **type**: `string`
+
+Identifier that indicates the type of BizTransaction document (e.g. Purchase
+Order, Despatch Advice).
+
+Use [EpcisBizTransactionTypes](../variables/EpcisBizTransactionTypes.md) for known values.
+
+***
+
+### bizTransaction
+
+> **bizTransaction**: `string`
+
+URI identifier of the specific business transaction document (alias of id in
+JSON or XML).

package/docs/reference/interfaces/IEpcisDestination.md

@@ -0,0 +1,36 @@
+# Interface: IEpcisDestination
+
+EPCIS 2.0 Destination element identifying the terminating endpoint of a
+business transfer.
+
+## See
+
+https://ref.gs1.org/epcis/SourceOrDestination
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### type
+
+> **type**: `string`
+
+Identifier indicating the role of SourceOrDestination in a transfer (Owning
+Party, Possessing Party, or Location).
+
+Use [EpcisSourceDestTypes](../variables/EpcisSourceDestTypes.md) for known values.
+
+***
+
+### destination
+
+> **destination**: `string`
+
+Identifier that denotes the specific source or destination of a business
+transfer; must correlate with the selected type.

package/docs/reference/interfaces/IEpcisDocument.md

@@ -1,15 +1,31 @@
 # Interface: IEpcisDocument
 
-EPCIS Document.
+EPCIS 2.0 capture document containing header metadata and an event list.
+
+## See
+
+https://ref.gs1.org/epcis/EPCISDocument
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
 
 ## Properties
 
 ### @context
 
-> **@context**: `IJsonLdContextDefinition`
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
 
 The @context.
 
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
 ***
 
 ### id?
@@ -28,6 +44,54 @@ JSON-LD Type.
 
 ***
 
+### schemaVersion
+
+> **schemaVersion**: `string`
+
+Schema version.
+
+***
+
+### creationDate
+
+> **creationDate**: `string`
+
+Creation Date.
+
+***
+
+### instanceIdentifier?
+
+> `optional` **instanceIdentifier**: `string`
+
+(Optional) The instance identifier of an EPCISDocument.
+
+***
+
+### sender?
+
+> `optional` **sender**: `string`
+
+(Optional) The sender of an EPCISDocument.
+
+***
+
+### receiver?
+
+> `optional` **receiver**: `string`
+
+(Optional) The intended receiver of an EPCISDocument.
+
+***
+
+### epcisHeader?
+
+> `optional` **epcisHeader**: [`IEpcisHeader`](IEpcisHeader.md)
+
+EPCIS Header.
+
+***
+
 ### epcisBody
 
 > **epcisBody**: `object`
@@ -36,6 +100,6 @@ The EPCIS Body.
 
 #### eventList
 
-> **eventList**: [`IEpcisEvent`](IEpcisEvent.md)[]
+> **eventList**: [`EpcisEvents`](../type-aliases/EpcisEvents.md)[]
 
 The list of events.

package/docs/reference/interfaces/IEpcisErrorDeclaration.md

@@ -0,0 +1,44 @@
+# Interface: IEpcisErrorDeclaration
+
+EPCIS 2.0 ErrorDeclaration describing corrections to previously captured
+events.
+
+## See
+
+https://ref.gs1.org/epcis/ErrorDeclaration
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### declarationTime
+
+> **declarationTime**: `string`
+
+The date and time at which the declaration of error is made.
+
+***
+
+### reason?
+
+> `optional` **reason**: `string`
+
+Reason for the error.
+
+Use [EpcisErrorReasonTypes](../variables/EpcisErrorReasonTypes.md) for known values.
+
+***
+
+### correctiveEventIDs?
+
+> `optional` **correctiveEventIDs**: `string`[]
+
+(Optional) If present, indicates that the events having the specified URIs as
+the value of their eventID fields are to be considered as "corrections" to
+the event declared erroneous by this event.