Add new datatype OpeningReceipt and OpeningReceiptAccepted

Author: isollid

datatypes-examples.xml

@@ -404,6 +404,12 @@
 
 <share-documents-request-sharing-stopped xmlns="http://api.digipost.no/schema/datatypes"/>
 
+<opening-receipt xmlns="http://api.digipost.no/schema/datatypes">
+    <group>aarsoppgave-bedriftAS-2025</group>
+</opening-receipt>
+
+<opening-receipt-accepted xmlns="http://api.digipost.no/schema/datatypes"/>
+
 <signedDocument xmlns="http://api.digipost.no/schema/datatypes">
     <document-issuer>Bedrift AS</document-issuer>
     <document-subject>Ansettelseskontrakt</document-subject>

datatypes.xsd

@@ -18,6 +18,8 @@
     <xs:element name="share-documents-request-documents-shared" type="tns:shareDocumentsRequestDocumentsShared"/>
     <xs:element name="share-documents-request-sharing-stopped" type="tns:shareDocumentsRequestSharingStopped"/>
     <xs:element name="signedDocument" type="tns:signedDocument"/>
+    <xs:element name="opening-receipt" type="openingReceipt"/>
+    <xs:element name="opening-receipt-accepted" type="openingReceiptAccepted"/>
     <xs:complexType final="extension restriction" name="address">
         <xs:sequence>
             <xs:element minOccurs="0" name="street-address" type="xs:string"/>
@@ -442,6 +444,14 @@
     <xs:complexType final="extension restriction" name="shareDocumentsRequestSharingStopped">
         <xs:sequence/>
     </xs:complexType>
+    <xs:complexType final="extension restriction" name="openingReceipt">
+        <xs:sequence>
+            <xs:element name="group" type="xs:string"/>
+        </xs:sequence>
+    </xs:complexType>
+    <xs:complexType final="extension restriction" name="openingReceiptAccepted">
+        <xs:sequence/>
+    </xs:complexType>
     <xs:simpleType name="language">
         <xs:restriction base="xs:string">
             <xs:enumeration value="NB"/>

readme.md

@@ -9,6 +9,8 @@
 |[Inkasso](#inkasso)|A debt collection payment|
 |[Invoice](#invoice)|An invoice|
 |[InvoicePayment](#invoicepayment)|Payment information for an invoice|
+|[OpeningReceipt](#openingreceipt)|To open the document the user must accept to send an opening receipt|
+|[OpeningReceiptAccepted](#openingreceiptaccepted)|The document has been opened, and the opening receipt has been accepted and sent.|
 |[Payslip](#payslip)|For treating documents as Payslips.|
 |[PickupNotice](#pickupnotice)|Details about a pickup notice|
 |[PickupNoticeStatus](#pickupnoticestatus)|Updates to status for PickupNotice|
@@ -1143,6 +1145,44 @@ Stop sharing of documents for ShareDocumentsRequest
 ```xml
 <share-documents-request-sharing-stopped xmlns="http://api.digipost.no/schema/datatypes"/>
 ```
+```
+
+## OpeningReceipt
+
+To open the document the user must accept to send an opening receipt
+
+### Complemented by: 
+[OpeningReceiptAccepted](#openingreceiptaccepted)
+
+### Fields
+
+|Name|Type|Required|Description|
+|----|----|--------|-----------|
+|group|String|yes|This is the group identifier for the opening receipt|
+
+### XML
+
+```xml
+<opening-receipt xmlns="http://api.digipost.no/schema/datatypes">
+    <group>aarsoppgave-bedriftAS-2025</group>
+</opening-receipt>
+```
+
+## OpeningReceiptAccepted
+
+The document has been opened, and the opening receipt has been accepted and sent.
+
+### Fields
+
+|Name|Type|Required|Description|
+|----|----|--------|-----------|
+
+
+### XML
+
+```xml
+<opening-receipt-accepted xmlns="http://api.digipost.no/schema/datatypes"/>
+```
 
 ## SignedDocument
 

src/main/java/no/digipost/api/datatypes/DataType.java

@@ -14,6 +14,8 @@
 import no.digipost.api.datatypes.types.SignedDocument;
 import no.digipost.api.datatypes.types.invoice.Invoice;
 import no.digipost.api.datatypes.types.invoice.InvoicePayment;
+import no.digipost.api.datatypes.types.openingreceipt.OpeningReceipt;
+import no.digipost.api.datatypes.types.openingreceipt.OpeningReceiptAccepted;
 import no.digipost.api.datatypes.types.pickup.PickupNotice;
 import no.digipost.api.datatypes.types.pickup.PickupNoticeStatus;
 import no.digipost.api.datatypes.types.proof.Proof;
@@ -41,6 +43,8 @@
         , @JsonSubTypes.Type(ShareDocumentsRequest.class)
         , @JsonSubTypes.Type(ShareDocumentsRequestSharingStopped.class)
         , @JsonSubTypes.Type(ShareDocumentsRequestDocumentsShared.class)
+        , @JsonSubTypes.Type(OpeningReceipt.class)
+        , @JsonSubTypes.Type(OpeningReceiptAccepted.class)
 })
 public interface DataType {
 

src/main/java/no/digipost/api/datatypes/DataTypeIdentifier.java

@@ -10,6 +10,8 @@
 import no.digipost.api.datatypes.types.SignedDocument;
 import no.digipost.api.datatypes.types.invoice.Invoice;
 import no.digipost.api.datatypes.types.invoice.InvoicePayment;
+import no.digipost.api.datatypes.types.openingreceipt.OpeningReceipt;
+import no.digipost.api.datatypes.types.openingreceipt.OpeningReceiptAccepted;
 import no.digipost.api.datatypes.types.pickup.PickupNotice;
 import no.digipost.api.datatypes.types.pickup.PickupNoticeStatus;
 import no.digipost.api.datatypes.types.proof.Proof;
@@ -56,6 +58,8 @@ public enum DataTypeIdentifier {
     , SHARE_DOCUMENT_REQUEST(ShareDocumentsRequest.class, "SHAR", ShareDocumentsRequest.EXAMPLE)
     , SHARE_DOCUMENT_REQUEST_SHARING_STOPPED(ShareDocumentsRequestSharingStopped.class, "SHSS", ShareDocumentsRequestSharingStopped.EXAMPLE)
     , SHARE_DOCUMENT_REQUEST_DOCUMENTS_SHARED(ShareDocumentsRequestDocumentsShared.class, "SHDS", ShareDocumentsRequestDocumentsShared.EXAMPLE)
+    , OPENING_RECEIPT(OpeningReceipt.class, "OPRC", OpeningReceipt.EXAMPLE)
+    , OPENING_RECEIPT_ACCEPTED(OpeningReceiptAccepted.class, "OPAC", OpeningReceiptAccepted.EXAMPLE)
     ;
 
     private final Class<? extends DataType> dataType;

src/main/java/no/digipost/api/datatypes/types/openingreceipt/OpeningReceipt.java

@@ -0,0 +1,36 @@
+package no.digipost.api.datatypes.types.openingreceipt;
+
+
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlRootElement;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.NoArgsConstructor;
+import lombok.Value;
+import lombok.With;
+import no.digipost.api.datatypes.ComplementedBy;
+import no.digipost.api.datatypes.DataType;
+import no.digipost.api.datatypes.documentation.Description;
+
+
+@XmlRootElement(name = "opening-receipt")
+@Value
+@AllArgsConstructor
+@NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
+@With
+@Description("To open the document the user must accept to send an opening receipt")
+public class OpeningReceipt implements DataType {
+
+    @XmlElement(name="group", required = true)
+    @NotNull
+    @Description("This is the group identifier for the opening receipt")
+    @Size(max = 100)
+    String group;
+
+    public static final OpeningReceipt EXAMPLE = new OpeningReceipt(
+           "aarsoppgave-bedriftAS-2025"
+    );
+
+}

src/main/java/no/digipost/api/datatypes/types/openingreceipt/OpeningReceiptAccepted.java

@@ -0,0 +1,20 @@
+package no.digipost.api.datatypes.types.openingreceipt;
+
+import jakarta.xml.bind.annotation.XmlRootElement;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import lombok.Value;
+import lombok.With;
+import no.digipost.api.datatypes.DataType;
+import no.digipost.api.datatypes.documentation.Description;
+
+@XmlRootElement(name = "opening-receipt-accepted")
+@Value
+@NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
+@With
+@Description("The document has been opened, and the opening receipt has been accepted and sent.")
+public class OpeningReceiptAccepted implements DataType {
+
+    public static final OpeningReceiptAccepted EXAMPLE = new OpeningReceiptAccepted();
+
+}

src/main/java/no/digipost/api/datatypes/types/openingreceipt/package-info.java

@@ -0,0 +1,14 @@
+@XmlSchema(namespace = DIGIPOST_DATATYPES_NAMESPACE, elementFormDefault = jakarta.xml.bind.annotation.XmlNsForm.QUALIFIED)
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlJavaTypeAdapter(ZonedDateTimeXmlAdapter.class)
+@DataTypePackage
+package no.digipost.api.datatypes.types.openingreceipt;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlSchema;
+import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
+import no.digipost.api.datatypes.documentation.DataTypePackage;
+import no.digipost.api.datatypes.marshalling.ZonedDateTimeXmlAdapter;
+
+import static no.digipost.api.datatypes.marshalling.DataTypesJAXBContext.DIGIPOST_DATATYPES_NAMESPACE;

src/main/resources/no/digipost/api/datatypes/types/jaxb.index

@@ -15,3 +15,5 @@ Inkasso
 share.ShareDocumentsRequest
 share.ShareDocumentsRequestSharingStopped
 share.ShareDocumentsRequestDocumentsShared
+openingreceipt.OpeningReceipt
+openingreceipt.OpeningReceiptAccepted