@twin.org/standards-unece 0.0.3-next.4 → 0.0.3-next.6

package/docs/reference/interfaces/IAssociatedTransportEquipment.md

@@ -0,0 +1,390 @@
+# Interface: IAssociatedTransportEquipment
+
+A piece of transport equipment that is associated with another piece of transport equipment, such as a maritime
+container placed on a rail wagon for transportation.
+
+## See
+
+https://vocabulary.uncefact.org/AssociatedTransportEquipment
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `string`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`UneceContextType`](../type-aliases/UneceContextType.md)
+
+JSON-LD Context.
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### type
+
+> **type**: `"AssociatedTransportEquipment"`
+
+JSON-LD Type.
+
+***
+
+### affixedSeal?
+
+> `optional` **affixedSeal**: [`ISeal`](ISeal.md)[]
+
+A logistics seal affixed to this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/affixedSeal
+
+***
+
+### associatedTransportEquipmentUsedCapacityCode?
+
+> `optional` **associatedTransportEquipmentUsedCapacityCode**: `string`
+
+The code specifying the used capacity, such as full or empty, of this associated piece of transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/associatedTransportEquipmentUsedCapacityCode
+
+***
+
+### cargoResidueStatusCode?
+
+> `optional` **cargoResidueStatusCode**: `string`
+
+A code specifying the cargo residue status for this piece of associated transport equipment, such as required by
+dangerous goods regulations.
+
+#### See
+
+https://vocabulary.uncefact.org/cargoResidueStatusCode
+
+***
+
+### characteristic?
+
+> `optional` **characteristic**: `string`
+
+The textual description of the characteristics, i.e. size and type, of this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/characteristic
+
+***
+
+### containedConsignment?
+
+> `optional` **containedConsignment**: [`IConsignment`](IConsignment.md)[]
+
+A supply chain consignment contained in this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/containedConsignment
+
+***
+
+### goodsItemUnitQuantity?
+
+> `optional` **goodsItemUnitQuantity**: [`IQuantityType`](IQuantityType.md)[]
+
+A quantity of goods items in this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/goodsItemUnitQuantity
+
+***
+
+### grossGoodsVolumeMeasure?
+
+> `optional` **grossGoodsVolumeMeasure**: [`IVolumeUnitMeasureType`](IVolumeUnitMeasureType.md)[]
+
+A measure of the gross goods volume of this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/grossGoodsVolumeMeasure
+
+***
+
+### grossGoodsWeightMeasure?
+
+> `optional` **grossGoodsWeightMeasure**: [`IWeightUnitMeasureType`](IWeightUnitMeasureType.md)[]
+
+A measure of the gross goods weight of this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/grossGoodsWeightMeasure
+
+***
+
+### grossVolumeMeasure?
+
+> `optional` **grossVolumeMeasure**: [`IMeasureType`](IMeasureType.md)
+
+The measure of the gross volume of this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/grossVolumeMeasure
+
+***
+
+### grossWeightMeasure?
+
+> `optional` **grossWeightMeasure**: [`IMeasureType`](IMeasureType.md)[]
+
+The measure of the gross weight (mass) of this piece of associated transport equipment which is the weight (mass)
+including loaded goods, packing and transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/grossWeightMeasure
+
+***
+
+### identifier?
+
+> `optional` **identifier**: `string`
+
+A unique number, mark or name which identifies this associated piece of transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/identifier
+
+***
+
+### loadedDangerousGoods?
+
+> `optional` **loadedDangerousGoods**: [`IDangerousGoods`](IDangerousGoods.md)[]
+
+Dangerous goods loaded into or onto this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/loadedDangerousGoods
+
+***
+
+### loadedPackageQuantity?
+
+> `optional` **loadedPackageQuantity**: [`IQuantityType`](IQuantityType.md)
+
+The number of packages loaded into or onto this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/loadedPackageQuantity
+
+***
+
+### netGoodsVolumeMeasure?
+
+> `optional` **netGoodsVolumeMeasure**: [`IVolumeUnitMeasureType`](IVolumeUnitMeasureType.md)[]
+
+A measure of the net goods volume of this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/netGoodsVolumeMeasure
+
+***
+
+### netGoodsWeightMeasure?
+
+> `optional` **netGoodsWeightMeasure**: [`IWeightUnitMeasureType`](IWeightUnitMeasureType.md)[]
+
+A measure of the net goods weight of this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/netGoodsWeightMeasure
+
+***
+
+### registrationCountry?
+
+> `optional` **registrationCountry**: [`ICountry`](ICountry.md)[]
+
+A registration country for this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/registrationCountry
+
+***
+
+### reportableQuantity?
+
+> `optional` **reportableQuantity**: [`IQuantityType`](IQuantityType.md)[]
+
+A reportable quantity for this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/reportableQuantity
+
+***
+
+### sealQuantity?
+
+> `optional` **sealQuantity**: [`IQuantityType`](IQuantityType.md)[]
+
+A quantity of seals for this associated piece of transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/sealQuantity
+
+***
+
+### sealedIndicator?
+
+> `optional` **sealedIndicator**: `boolean`
+
+The indication of whether or not this associated piece of transport equipment is sealed.
+
+#### See
+
+https://vocabulary.uncefact.org/sealedIndicator
+
+***
+
+### sequenceNumeric?
+
+> `optional` **sequenceNumeric**: `string`
+
+The sequence number differentiating this piece of transport equipment from others in a set of associated transport
+equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/sequenceNumeric
+
+***
+
+### settingTemperature?
+
+> `optional` **settingTemperature**: [`ITransportSettingTemperature`](ITransportSettingTemperature.md)[]
+
+A temperature setting for this piece of associated transport equipment, such as storage temperature or operational
+temperature.
+
+#### See
+
+https://vocabulary.uncefact.org/settingTemperature
+
+***
+
+### stowagePositionId?
+
+> `optional` **stowagePositionId**: `string`
+
+The stowage position identifier for this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/stowagePositionId
+
+***
+
+### tareWeightMeasure?
+
+> `optional` **tareWeightMeasure**: [`IMeasureType`](IMeasureType.md)
+
+The measure of the tare weight (mass) of this piece of associated transport equipment which is the weight (mass)
+including permanent equipment but excluding goods and loose accessories.
+
+#### See
+
+https://vocabulary.uncefact.org/tareWeightMeasure
+
+***
+
+### transportEquipmentCategoryCode?
+
+> `optional` **transportEquipmentCategoryCode**: [`TransportEquipmentCategoryCodeList`](../type-aliases/TransportEquipmentCategoryCodeList.md)[]
+
+A code specifying a category of this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/transportEquipmentCategoryCode
+
+***
+
+### transportEquipmentSizeTypeCharacteristicCode?
+
+> `optional` **transportEquipmentSizeTypeCharacteristicCode**: [`TransportEquipmentSizeTypeCodeList`](../type-aliases/TransportEquipmentSizeTypeCodeList.md)
+
+The code specifying the characteristics, i.e. size and type, of this piece of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/transportEquipmentSizeTypeCharacteristicCode
+
+***
+
+### unitQuantity?
+
+> `optional` **unitQuantity**: [`IQuantityType`](IQuantityType.md)[]
+
+The number of units of this type of associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/unitQuantity
+
+***
+
+### usedCapacityCode?
+
+> `optional` **usedCapacityCode**: `string`
+
+The code specifying the used capacity, such as full or empty, of this associated piece of transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/usedCapacityCode
+
+***
+
+### verifiedGrossWeightMeasure?
+
+> `optional` **verifiedGrossWeightMeasure**: [`IWeightUnitMeasureType`](IWeightUnitMeasureType.md)[]
+
+A measure of the verified gross weight (mass) of this piece of associated transport equipment which is the weight (mass)
+including loaded goods, packing and transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/verifiedGrossWeightMeasure
+
+***
+
+### weightUnitNetWeightMeasure?
+
+> `optional` **weightUnitNetWeightMeasure**: [`IWeightUnitMeasureType`](IWeightUnitMeasureType.md)[]
+
+A measure of the net weight of this associated transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/weightUnitNetWeightMeasure

package/docs/reference/interfaces/IAttachedTransportEquipment.md

@@ -0,0 +1,95 @@
+# Interface: IAttachedTransportEquipment
+
+A piece of attached transport equipment, such as a chain or a tarpaulin.
+
+## See
+
+https://vocabulary.uncefact.org/AttachedTransportEquipment
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `string`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`UneceContextType`](../type-aliases/UneceContextType.md)
+
+JSON-LD Context.
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### type
+
+> **type**: `"AttachedTransportEquipment"`
+
+JSON-LD Type.
+
+***
+
+### characteristic?
+
+> `optional` **characteristic**: `string`
+
+The textual description of the characteristics, i.e. size and type, of this piece of attached transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/characteristic
+
+***
+
+### identifier?
+
+> `optional` **identifier**: `string`
+
+A unique identifier of this piece of attached transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/identifier
+
+***
+
+### transportEquipmentCategoryCode?
+
+> `optional` **transportEquipmentCategoryCode**: [`TransportEquipmentCategoryCodeList`](../type-aliases/TransportEquipmentCategoryCodeList.md)[]
+
+A code specifying a category of this piece of attached transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/transportEquipmentCategoryCode
+
+***
+
+### transportEquipmentSizeTypeCharacteristicCode?
+
+> `optional` **transportEquipmentSizeTypeCharacteristicCode**: [`TransportEquipmentSizeTypeCodeList`](../type-aliases/TransportEquipmentSizeTypeCodeList.md)
+
+The code specifying the characteristics, i.e. size and type, of this piece of attached transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/transportEquipmentSizeTypeCharacteristicCode
+
+***
+
+### unitQuantity?
+
+> `optional` **unitQuantity**: [`IQuantityType`](IQuantityType.md)[]
+
+The number of units of attached transport equipment.
+
+#### See
+
+https://vocabulary.uncefact.org/unitQuantity

package/docs/reference/interfaces/IAuthentication.md

@@ -0,0 +1,227 @@
+# Interface: IAuthentication
+
+A proof that a document is genuine.
+
+## See
+
+https://vocabulary.uncefact.org/Authentication
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `string`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`UneceContextType`](../type-aliases/UneceContextType.md)
+
+JSON-LD Context.
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### type
+
+> **type**: `"Authentication"`
+
+JSON-LD Type.
+
+***
+
+### actualDateTime?
+
+> `optional` **actualDateTime**: `string`
+
+The actual date, time, date time, or other date time value of this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/actualDateTime
+
+***
+
+### categoryCode?
+
+> `optional` **categoryCode**: `string`
+
+A code specifying a category for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/categoryCode
+
+***
+
+### governmentActionTypeCode?
+
+> `optional` **governmentActionTypeCode**: [`GovernmentActionCodeList`](../type-aliases/GovernmentActionCodeList.md)
+
+The code specifying the type of document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/governmentActionTypeCode
+
+***
+
+### identifier?
+
+> `optional` **identifier**: `string`
+
+A unique identifier for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/identifier
+
+***
+
+### includedClause?
+
+> `optional` **includedClause**: [`IClause`](IClause.md)[]
+
+A document clause included in this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/includedClause
+
+***
+
+### information?
+
+> `optional` **information**: `string`
+
+Information, expressed as text, for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/information
+
+***
+
+### issueLocation?
+
+> `optional` **issueLocation**: [`ILocation`](ILocation.md)[]
+
+The referenced location of issue of this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/issueLocation
+
+***
+
+### issueLogisticsLocation?
+
+> `optional` **issueLogisticsLocation**: [`ILogisticsLocation`](ILogisticsLocation.md)[]
+
+The issue location for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/issueLogisticsLocation
+
+***
+
+### locationProviderParty?
+
+> `optional` **locationProviderParty**: [`ITradeParty`](ITradeParty.md)[]
+
+The trade party providing the location for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/locationProviderParty
+
+***
+
+### providerParty?
+
+> `optional` **providerParty**: [`ITradeParty`](ITradeParty.md)[]
+
+The trade party providing this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/providerParty
+
+***
+
+### representationTypeCode?
+
+> `optional` **representationTypeCode**: `string`
+
+The code specifying the type of representation of this document authentication, such as direct or indirect.
+
+#### See
+
+https://vocabulary.uncefact.org/representationTypeCode
+
+***
+
+### signatory?
+
+> `optional` **signatory**: `string`
+
+The signatory, expressed as text, for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/signatory
+
+***
+
+### signatoryImageBinaryObject?
+
+> `optional` **signatoryImageBinaryObject**: `string`
+
+The signatory image, expressed as a binary object, for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/signatoryImageBinaryObject
+
+***
+
+### statement?
+
+> `optional` **statement**: `string`
+
+The statement, expressed as text, for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/statement
+
+***
+
+### statementCode?
+
+> `optional` **statementCode**: `string`
+
+The code specifying the statement for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/statementCode
+
+***
+
+### transportMeansId?
+
+> `optional` **transportMeansId**: `string`
+
+The unique identifier of a transport means for this document authentication.
+
+#### See
+
+https://vocabulary.uncefact.org/transportMeansId