@twin.org/standards-gs1 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IEpcisAggregationEvent.md

@@ -0,0 +1,219 @@
+# 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)
+
+## Properties
+
+### type {#type}
+
+> **type**: `"AggregationEvent"`
+
+The type.
+
+#### Overrides
+
+[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
+
+***
+
+### parentID? {#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? {#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? {#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}
+
+> **action**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.md)
+
+How this event relates to the lifecycle of the EPCs named in this event.
+
+***
+
+### bizStep? {#bizstep}
+
+> `optional` **bizStep?**: `string`
+
+(Optional) The business step of which this event was a part.
+
+***
+
+### disposition? {#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? {#readpoint}
+
+> `optional` **readPoint?**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The read point at which the event took place.
+
+***
+
+### bizLocation? {#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? {#biztransactionlist}
+
+> `optional` **bizTransactionList?**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
+
+(Optional) An unordered list of business transactions that define the context
+of this event.
+
+***
+
+### sourceList? {#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? {#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? {#sensorelementlist}
+
+> `optional` **sensorElementList?**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
+
+(Optional) Connects event to one or more SensorElements.
+
+***
+
+### @context {#context}
+
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
+
+JSON-LD @context.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
+
+***
+
+### eventID? {#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? {#certificationinfo}
+
+> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
+
+(Optional) CertificationDetails relevant for Objects, Places and/or
+Organizations mentioned in this Event.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`certificationInfo`](IEpcisEvent.md#certificationinfo)
+
+***
+
+### errorDeclaration? {#errordeclaration}
+
+> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
+
+Error declaration.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`errorDeclaration`](IEpcisEvent.md#errordeclaration)
+
+***
+
+### eventTime {#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}
+
+> **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? {#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,218 @@
+# 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)
+
+## Properties
+
+### type {#type}
+
+> **type**: `"AssociationEvent"`
+
+Type.
+
+#### Overrides
+
+[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
+
+***
+
+### parentID {#parentid}
+
+> **parentID**: `string`
+
+Identifier of the parent of the aggregation or association; use the pure
+identity URI when the parent is an EPC.
+
+***
+
+### childEPCs? {#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? {#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}
+
+> **action**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.md)
+
+How this event relates to the lifecycle of the EPCs named in this event.
+
+***
+
+### bizStep? {#bizstep}
+
+> `optional` **bizStep?**: `string`
+
+(Optional) The business step of which this event was a part.
+
+***
+
+### disposition? {#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? {#readpoint}
+
+> `optional` **readPoint?**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The read point at which the event took place.
+
+***
+
+### bizLocation? {#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? {#biztransactionlist}
+
+> `optional` **bizTransactionList?**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
+
+(Optional) An unordered list of business transactions that define the context
+of this event.
+
+***
+
+### sourceList? {#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? {#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? {#sensorelementlist}
+
+> `optional` **sensorElementList?**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
+
+(Optional) Connects event to one or more SensorElements.
+
+***
+
+### @context {#context}
+
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
+
+JSON-LD @context.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
+
+***
+
+### eventID? {#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? {#certificationinfo}
+
+> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
+
+(Optional) CertificationDetails relevant for Objects, Places and/or
+Organizations mentioned in this Event.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`certificationInfo`](IEpcisEvent.md#certificationinfo)
+
+***
+
+### errorDeclaration? {#errordeclaration}
+
+> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
+
+Error declaration.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`errorDeclaration`](IEpcisEvent.md#errordeclaration)
+
+***
+
+### eventTime {#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}
+
+> **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? {#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,23 @@
+# Interface: IEpcisAttribute
+
+EPCIS 2.0 Vocabulary Attribute describing metadata on vocabulary elements.
+
+## See
+
+https://ref.gs1.org/epcis/Attribute
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+Attribute id.
+
+***
+
+### attribute? {#attribute}
+
+> `optional` **attribute?**: `IJsonLdNodePrimitive`
+
+Attribute value.

package/docs/reference/interfaces/IEpcisBizTransaction.md

@@ -0,0 +1,27 @@
+# Interface: IEpcisBizTransaction
+
+EPCIS 2.0 BizTransaction element identifying a business document and its type.
+
+## See
+
+https://ref.gs1.org/epcis/BizTransaction
+
+## Properties
+
+### type? {#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}
+
+> **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,28 @@
+# Interface: IEpcisDestination
+
+EPCIS 2.0 Destination element identifying the terminating endpoint of a
+business transfer.
+
+## See
+
+https://ref.gs1.org/epcis/SourceOrDestination
+
+## Properties
+
+### type {#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}
+
+> **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,26 +1,30 @@
 # Interface: IEpcisDocument
 
-EPCIS Document.
+EPCIS 2.0 capture document containing header metadata and an event list.
+
+## See
+
+https://ref.gs1.org/epcis/EPCISDocument
 
 ## Properties
 
-### @context
+### @context {#context}
 
-> **@context**: `IJsonLdContextDefinition`
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
 
 The @context.
 
 ***
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The JSON-LD document id.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"EPCISDocument"`
 
@@ -28,7 +32,55 @@ JSON-LD Type.
 
 ***
 
-### epcisBody
+### schemaVersion {#schemaversion}
+
+> **schemaVersion**: `string`
+
+Schema version.
+
+***
+
+### creationDate {#creationdate}
+
+> **creationDate**: `string`
+
+Creation Date.
+
+***
+
+### instanceIdentifier? {#instanceidentifier}
+
+> `optional` **instanceIdentifier?**: `string`
+
+(Optional) The instance identifier of an EPCISDocument.
+
+***
+
+### sender? {#sender}
+
+> `optional` **sender?**: `string`
+
+(Optional) The sender of an EPCISDocument.
+
+***
+
+### receiver? {#receiver}
+
+> `optional` **receiver?**: `string`
+
+(Optional) The intended receiver of an EPCISDocument.
+
+***
+
+### epcisHeader? {#epcisheader}
+
+> `optional` **epcisHeader?**: [`IEpcisHeader`](IEpcisHeader.md)
+
+EPCIS Header.
+
+***
+
+### epcisBody {#epcisbody}
 
 > **epcisBody**: `object`
 
@@ -36,6 +88,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,36 @@
+# Interface: IEpcisErrorDeclaration
+
+EPCIS 2.0 ErrorDeclaration describing corrections to previously captured
+events.
+
+## See
+
+https://ref.gs1.org/epcis/ErrorDeclaration
+
+## Properties
+
+### declarationTime {#declarationtime}
+
+> **declarationTime**: `string`
+
+The date and time at which the declaration of error is made.
+
+***
+
+### reason? {#reason}
+
+> `optional` **reason?**: `string`
+
+Reason for the error.
+
+Use [EpcisErrorReasonTypes](../variables/EpcisErrorReasonTypes.md) for known values.
+
+***
+
+### correctiveEventIDs? {#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.