Replace ShareDoccumentsRequestEvent with separate classes for each ac…

…tion
digipost · Nov 10, 2023 · 96983b9 · 96983b9
1 parent 5abea5f
commit 96983b9
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 97 deletions.
diff --git a/datatypes-examples.xml b/datatypes-examples.xml
@@ -396,11 +396,11 @@
     <purpose>We require to see your latest pay slip in order to grant you a loan.</purpose>
 </share-documents-request>
 
-<share-documents-request-event xmlns="http://api.digipost.no/schema/datatypes">
-    <event-type>FILES_SHARED</event-type>
-    <timestamp>2017-09-30T13:37:00+02:00</timestamp>
+<share-documents-request-documents-shared xmlns="http://api.digipost.no/schema/datatypes">
     <document-ids>123</document-ids>
-</share-documents-request-event>
+</share-documents-request-documents-shared>
+
+<share-documents-request-sharing-stopped xmlns="http://api.digipost.no/schema/datatypes"/>
 
 <signedDocument xmlns="http://api.digipost.no/schema/datatypes">
     <document-issuer>Bedrift AS</document-issuer>

diff --git a/datatypes.xsd b/datatypes.xsd
@@ -29,7 +29,9 @@
 
   <xs:element name="share-documents-request" type="tns:shareDocumentsRequest"/>
 
-  <xs:element name="share-documents-request-event" type="tns:shareDocumentsRequestEvent"/>
+  <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"/>
 
@@ -491,29 +493,31 @@
     </xs:sequence>
   </xs:complexType>
 
-  <xs:complexType final="extension restriction" name="shareDocumentsRequestEvent">
+  <xs:complexType final="extension restriction" name="shareDocumentsRequestDocumentsShared">
     <xs:sequence>
-      <xs:element name="event-type" type="tns:shareDocumentsRequestEventType"/>
-      <xs:element name="timestamp" type="xs:dateTime"/>
       <xs:element maxOccurs="unbounded" minOccurs="0" name="document-ids" type="xs:long"/>
     </xs:sequence>
   </xs:complexType>
 
+  <xs:complexType final="extension restriction" name="shareDocumentsRequestSharingStopped">
+    <xs:sequence/>
+  </xs:complexType>
+
   <xs:simpleType name="language">
     <xs:restriction base="xs:string">
       <xs:enumeration value="EN"/>
-      <xs:enumeration value="NN"/>
       <xs:enumeration value="NB"/>
+      <xs:enumeration value="NN"/>
     </xs:restriction>
   </xs:simpleType>
 
   <xs:simpleType name="status">
     <xs:restriction base="xs:string">
-      <xs:enumeration value="UNKNOWN"/>
       <xs:enumeration value="DEVIATION"/>
-      <xs:enumeration value="PICKED_UP"/>
-      <xs:enumeration value="RETURNED"/>
       <xs:enumeration value="READY_FOR_PICKUP"/>
+      <xs:enumeration value="RETURNED"/>
+      <xs:enumeration value="PICKED_UP"/>
+      <xs:enumeration value="UNKNOWN"/>
     </xs:restriction>
   </xs:simpleType>
 
@@ -524,11 +528,4 @@
       <xs:enumeration value="POSTEN"/>
     </xs:restriction>
   </xs:simpleType>
-
-  <xs:simpleType name="shareDocumentsRequestEventType">
-    <xs:restriction base="xs:string">
-      <xs:enumeration value="SHARING_STOPPED"/>
-      <xs:enumeration value="FILES_SHARED"/>
-    </xs:restriction>
-  </xs:simpleType>
 </xs:schema>
diff --git a/readme.md b/readme.md
@@ -16,7 +16,8 @@
 |[Receipt](#receipt)|Receipt represents a document containing details about a purchase|
 |[Residence](#residence)|Residence is a way of linking separate data for the same residence|
 |[ShareDocumentsRequest](#sharedocumentsrequest)|A request for a user to share one or more documents|
-|[ShareDocumentsRequestEvent](#sharedocumentsrequestevent)|An update or event related to a ShareDocumentsRequest|
+|[ShareDocumentsRequestDocumentsShared](#sharedocumentsrequestdocumentsshared)|Documents have been shared for ShareDocumentsRequest|
+|[ShareDocumentsRequestSharingStopped](#sharedocumentsrequestsharingstopped)|Stop sharing of documents for ShareDocumentsRequest|
 |[SignedDocument](#signeddocument)|Details about a signed document|
 
 ## Appointment
@@ -1086,6 +1087,9 @@ Residence is a way of linking separate data for the same residence
 
 A request for a user to share one or more documents
 
+### Complemented by: 
+[ShareDocumentsRequestSharingStopped](#sharedocumentsrequestsharingstopped)
+
 ### Fields
 
 |Name|Type|Required|Description|
@@ -1102,33 +1106,38 @@ A request for a user to share one or more documents
 </share-documents-request>
 ```
 
-## ShareDocumentsRequestEvent
+## ShareDocumentsRequestDocumentsShared
 
-An update or event related to a ShareDocumentsRequest
+Documents have been shared for ShareDocumentsRequest
 
 ### Fields
 
 |Name|Type|Required|Description|
 |----|----|--------|-----------|
-|eventType|[ShareDocumentsRequestEventType](#sharedocumentsrequesteventsharedocumentsrequesteventtype)|yes|The type of event that has occurred|
-|timestamp|ZonedDateTime|yes|When the event occurred|
 |documentIds|List|no|The IDs of the documents related to this specific event|
 
-### ShareDocumentsRequestEvent.ShareDocumentsRequestEventType
+### XML
 
-Valid values:
+```xml
+<share-documents-request-documents-shared xmlns="http://api.digipost.no/schema/datatypes">
+    <document-ids>123</document-ids>
+</share-documents-request-documents-shared>
+```
+
+## ShareDocumentsRequestSharingStopped
+
+Stop sharing of documents for ShareDocumentsRequest
+
+### Fields
+
+|Name|Type|Required|Description|
+|----|----|--------|-----------|
 
-* FILES_SHARED
-* SHARING_STOPPED
 
 ### XML
 
 ```xml
-<share-documents-request-event xmlns="http://api.digipost.no/schema/datatypes">
-    <event-type>FILES_SHARED</event-type>
-    <timestamp>2017-09-30T13:37:00+02:00</timestamp>
-    <document-ids>123</document-ids>
-</share-documents-request-event>
+<share-documents-request-sharing-stopped xmlns="http://api.digipost.no/schema/datatypes"/>
 ```
 
 ## SignedDocument

diff --git a/src/main/java/no/digipost/api/datatypes/DataTypeIdentifier.java b/src/main/java/no/digipost/api/datatypes/DataTypeIdentifier.java
@@ -27,7 +27,9 @@
 import static java.util.stream.Collectors.collectingAndThen;
 import static java.util.stream.Collectors.toMap;
 import static java.util.stream.Collectors.toSet;
-import no.digipost.api.datatypes.types.share.ShareDocumentsRequestEvent;
+
+import no.digipost.api.datatypes.types.share.ShareDocumentsRequestDocumentsShared;
+import no.digipost.api.datatypes.types.share.ShareDocumentsRequestSharingStopped;
 
 /**
  * HOWTO: Add new data type
@@ -53,7 +55,8 @@ public enum DataTypeIdentifier {
     , INVOICE(Invoice.class, "INVO", Invoice.EXAMPLE)
     , INVOICE_PAYMENT(InvoicePayment.class, "INVP", InvoicePayment.EXAMPLE)
     , SHARE_DOCUMENT_REQUEST(ShareDocumentsRequest.class, "SHAR", ShareDocumentsRequest.EXAMPLE)
-    , SHARE_DOCUMENT_REQUEST_EVENT(ShareDocumentsRequestEvent.class, "SHRE", ShareDocumentsRequestEvent.EXAMPLE)
+    , SHARE_DOCUMENT_REQUEST_SHARING_STOPPED(ShareDocumentsRequestSharingStopped.class, "SHSS", ShareDocumentsRequestSharingStopped.EXAMPLE)
+    , SHARE_DOCUMENT_REQUEST_DOCUMENTS_SHARED(ShareDocumentsRequestDocumentsShared.class, "SHDS", ShareDocumentsRequestDocumentsShared.EXAMPLE)
     ;
 
     private final Class<? extends DataType> dataType;

diff --git a/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequest.java b/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequest.java
@@ -19,7 +19,7 @@
 @NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
 @With
 @Description("A request for a user to share one or more documents")
-@ComplementedBy({ShareDocumentsRequestEvent.class})
+@ComplementedBy({ShareDocumentsRequestSharingStopped.class})
 public class ShareDocumentsRequest implements DataType {
 
     @XmlElement(name="max-share-duration-seconds", required = true)

diff --git a/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequestEvent.java b/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequestEvent.java
diff --git a/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequestEventType.java b/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequestEventType.java
diff --git a/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequestSharingStopped.java b/src/main/java/no/digipost/api/datatypes/types/share/ShareDocumentsRequestSharingStopped.java
@@ -0,0 +1,22 @@
+package no.digipost.api.datatypes.types.share;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.NoArgsConstructor;
+import lombok.Value;
+import lombok.With;
+import no.digipost.api.datatypes.DataType;
+import no.digipost.api.datatypes.documentation.Description;
+
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement(name = "share-documents-request-sharing-stopped")
+@Value
+@NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
+@With
+@Description("Stop sharing of documents for ShareDocumentsRequest")
+public class ShareDocumentsRequestSharingStopped implements DataType {
+
+    public static final ShareDocumentsRequestSharingStopped EXAMPLE = new ShareDocumentsRequestSharingStopped();
+
+}
diff --git a/src/main/resources/no/digipost/api/datatypes/types/jaxb.index b/src/main/resources/no/digipost/api/datatypes/types/jaxb.index
@@ -13,4 +13,5 @@ invoice.Invoice
 invoice.InvoicePayment
 Inkasso
 share.ShareDocumentsRequest
-share.ShareDocumentsRequestEvent
+share.ShareDocumentsRequestSharingStopped
+share.ShareDocumentsRequestDocumentsShared