From 86989537b51621085a2482d12b5cf49d13cfb918 Mon Sep 17 00:00:00 2001
From: FH <fh@uex.dk>
Date: Wed, 16 Nov 2022 11:34:36 +0100
Subject: [PATCH] documentation

---
 FCS.Lib.Virk.csproj          |  3 ++-
 LivsforloebModel.cs          | 10 ++++++++++
 NyesteBeliggenhedsadresse.cs | 21 +++++++++++++++++++++
 NyesteNavn.cs                |  6 ++++++
 Periode.cs                   |  9 +++++++++
 VirksomhedMetadata.cs        | 11 +++++++++++
 VirksomhedsStatus.cs         | 13 +++++++++++++
 VrHttpRequest.cs             | 12 ++++++++++++
 VrQuery.cs                   | 18 ++++++++++++++++++
 VrQueryMapper.cs             | 10 ++++++++++
 VrQueryValidator.cs          |  9 +++++++++
 VrResponseParser.cs          |  8 ++++++--
 VrResponseView.cs            | 12 ++++++++++++
 VrVatInfoMapper.cs           | 13 +++++++++++++
 VrVirksomhed.cs              | 19 +++++++++++++++++++
 15 files changed, 171 insertions(+), 3 deletions(-)

diff --git a/FCS.Lib.Virk.csproj b/FCS.Lib.Virk.csproj
index c322f0e..c5cb192 100644
--- a/FCS.Lib.Virk.csproj
+++ b/FCS.Lib.Virk.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <LangVersion>10.0</LangVersion>
   </PropertyGroup>
@@ -11,6 +11,7 @@
     <FileVersion>1.0.0.100</FileVersion>
     <IsPublishable>False</IsPublishable>
     <PackageLicenseExpression> AGPL-3.0-or-later</PackageLicenseExpression>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="NewtonSoft.Json" Version="13.0.1" />
diff --git a/LivsforloebModel.cs b/LivsforloebModel.cs
index df3a28a..1a8c697 100644
--- a/LivsforloebModel.cs
+++ b/LivsforloebModel.cs
@@ -25,9 +25,19 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Lifecycle model
+    /// </summary>
     public class LivsforloebModel
     {
+        /// <summary>
+        /// Last registrar update
+        /// </summary>
         public string SidstOpdateret { get; set; } = "";
+        /// <summary>
+        /// Period
+        /// </summary>
+        /// <see cref="Periode"/>
         public Periode Periode { get; set; } = new ();
     }
 }
\ No newline at end of file
diff --git a/NyesteBeliggenhedsadresse.cs b/NyesteBeliggenhedsadresse.cs
index 39a7602..8e6c545 100644
--- a/NyesteBeliggenhedsadresse.cs
+++ b/NyesteBeliggenhedsadresse.cs
@@ -25,13 +25,34 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Current address
+    /// </summary>
     public class NyesteBeliggenhedsadresse
     {
+        /// <summary>
+        /// House number from
+        /// </summary>
         public int? HusnummerFra { get; set; }
+        /// <summary>
+        /// House number to
+        /// </summary>
         public int? HusnummerTil { get; set; }
+        /// <summary>
+        /// Zip code
+        /// </summary>
         public int? Postnummer { get; set; }
+        /// <summary>
+        /// Street name
+        /// </summary>
         public string Vejnavn { get; set; } = "";
+        /// <summary>
+        /// CO name
+        /// </summary>
         public string CoNavn { get; set; } = "";
+        /// <summary>
+        /// Mail district name
+        /// </summary>
         public string PostDistrikt { get; set; } = "";
     }
 }
\ No newline at end of file
diff --git a/NyesteNavn.cs b/NyesteNavn.cs
index db8b634..ab6e620 100644
--- a/NyesteNavn.cs
+++ b/NyesteNavn.cs
@@ -26,8 +26,14 @@
 
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Current name object
+    /// </summary>
     public class NyesteNavn
     {
+        /// <summary>
+        /// Name
+        /// </summary>
         public string Navn { get; set; } = "";
     }
 }
\ No newline at end of file
diff --git a/Periode.cs b/Periode.cs
index 370eb88..0bb22f4 100644
--- a/Periode.cs
+++ b/Periode.cs
@@ -25,9 +25,18 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Period object
+    /// </summary>
     public class Periode
     {
+        /// <summary>
+        /// Valid from
+        /// </summary>
         public string GyldigFra { get; set; } = "";
+        /// <summary>
+        /// Valid to
+        /// </summary>
         public string GyldigTil { get; set; } = "";
     }
 }
\ No newline at end of file
diff --git a/VirksomhedMetadata.cs b/VirksomhedMetadata.cs
index c5b01af..fc850cc 100644
--- a/VirksomhedMetadata.cs
+++ b/VirksomhedMetadata.cs
@@ -25,9 +25,20 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Business meta data object
+    /// </summary>
     public class VirksomhedMetadata
     {
+        /// <summary>
+        /// Business current name object
+        /// </summary>
+        /// <see cref="NyesteNavn"/>
         public NyesteNavn NyesteNavn { get; set; } = new();
+        /// <summary>
+        /// Business current address object
+        /// </summary>
+        /// <see cref="NyesteBeliggenhedsadresse"/>
         public NyesteBeliggenhedsadresse NyesteBeliggenhedsadresse { get; set; } = new();
     }
 }
\ No newline at end of file
diff --git a/VirksomhedsStatus.cs b/VirksomhedsStatus.cs
index d968c12..8028e3d 100644
--- a/VirksomhedsStatus.cs
+++ b/VirksomhedsStatus.cs
@@ -25,10 +25,23 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// VirksomhedsStatus object
+    /// </summary>
     public class VirksomhedsStatus
     {
+        /// <summary>
+        /// Business last updated with registrar
+        /// </summary>
         public string SidstOpdateret { get; set; } = "";
+        /// <summary>
+        /// Business status with registrar
+        /// </summary>
         public string Status { get; set; } = "";
+        /// <summary>
+        /// Period object
+        /// </summary>
+        /// <see cref="Periode"/>
         public Periode Periode { get; set; } = new();
     }
 }
\ No newline at end of file
diff --git a/VrHttpRequest.cs b/VrHttpRequest.cs
index 3e2a69a..fc61aea 100644
--- a/VrHttpRequest.cs
+++ b/VrHttpRequest.cs
@@ -29,8 +29,20 @@ using System.Text;
 
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Registrar http request 
+    /// </summary>
     public class VrHttpRequest
     {
+        /// <summary>
+        /// Async registrar http request
+        /// </summary>
+        /// <param name="endpoint"></param>
+        /// <param name="jsonData"></param>
+        /// <param name="auth"></param>
+        /// <param name="userAgent"></param>
+        /// <returns>VrResponseView object</returns>
+        /// <see cref="VrResponseView"/>
         public async Task<VrResponseView> GetResponseAsync(string endpoint, string jsonData, string auth,
             string userAgent)
         {
diff --git a/VrQuery.cs b/VrQuery.cs
index 82aceff..f62adaf 100644
--- a/VrQuery.cs
+++ b/VrQuery.cs
@@ -25,12 +25,30 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Registrar query object
+    /// </summary>
     public class VrQuery
     {
+        /// <summary>
+        /// Vat number
+        /// </summary>
         public string VatNumber { get; set; } = "";
+        /// <summary>
+        /// Street name
+        /// </summary>
         public string StreetName { get; set; } = "";
+        /// <summary>
+        /// House number
+        /// </summary>
         public string HouseNumber { get; set; } = "";
+        /// <summary>
+        /// Zip code
+        /// </summary>
         public string ZipCode { get; set; } = "";
+        /// <summary>
+        /// Entity name
+        /// </summary>
         public string EntityName { get; set; } = "";
     }
 }
\ No newline at end of file
diff --git a/VrQueryMapper.cs b/VrQueryMapper.cs
index 0ce9f5a..f031732 100644
--- a/VrQueryMapper.cs
+++ b/VrQueryMapper.cs
@@ -28,8 +28,18 @@ using Newtonsoft.Json.Linq;
 
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// VrQueryMapper
+    /// </summary>
+    /// <remarks>Maps the VrQuery object into an Elastic Search JObject</remarks>
     public class VrQueryMapper
     {
+        /// <summary>
+        /// VrMapQuery
+        /// </summary>
+        /// <param name="query"></param>
+        /// <returns>Elastic Search JObject</returns>
+        /// <see cref="VrQuery"/>
         public JObject VrMapQuery(VrQuery query)
         {
             if (string.IsNullOrWhiteSpace(query.VatNumber) && string.IsNullOrWhiteSpace(query.EntityName))
diff --git a/VrQueryValidator.cs b/VrQueryValidator.cs
index a0d8fc3..1cf9c02 100644
--- a/VrQueryValidator.cs
+++ b/VrQueryValidator.cs
@@ -25,8 +25,17 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Query validator
+    /// </summary>
     public static class VrQueryValidator
     {
+        /// <summary>
+        /// Validate query
+        /// </summary>
+        /// <param name="query"></param>
+        /// <returns>true or false</returns>
+        /// <see cref="VrQuery"/>
         public static bool ValidateVrQuery(VrQuery query)
         {
             try
diff --git a/VrResponseParser.cs b/VrResponseParser.cs
index 6f25219..402faf8 100644
--- a/VrResponseParser.cs
+++ b/VrResponseParser.cs
@@ -29,13 +29,17 @@ using Newtonsoft.Json.Linq;
 
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// VrResponseParser
+    /// </summary>
     public class VrResponseParser
     {
         /// <summary>
-        /// parse response from danish vat registrar
+        /// Registrar response parser
         /// </summary>
         /// <param name="responseData"></param>
-        /// <returns></returns>
+        /// <returns>List of VrVirksomhed models</returns>
+        /// <see cref="VrVirksomhed"/>
         public List<VrVirksomhed?> ParseVrResponse(string responseData)
         {
             var result = new List<VrVirksomhed?>();
diff --git a/VrResponseView.cs b/VrResponseView.cs
index 9b4689d..2b23d17 100644
--- a/VrResponseView.cs
+++ b/VrResponseView.cs
@@ -28,10 +28,22 @@ using System.Net;
 
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Service response view model
+    /// </summary>
     public class VrResponseView
     {
+        /// <summary>
+        /// Http request status code
+        /// </summary>
         public HttpStatusCode Code { get; set; }
+        /// <summary>
+        /// boolean value indicating success
+        /// </summary>
         public bool IsSuccessStatusCode { get; set; }
+        /// <summary>
+        /// Service response as string
+        /// </summary>
         public string Message { get; set; } = "";
     }
 }
\ No newline at end of file
diff --git a/VrVatInfoMapper.cs b/VrVatInfoMapper.cs
index f14ea05..f629371 100644
--- a/VrVatInfoMapper.cs
+++ b/VrVatInfoMapper.cs
@@ -28,8 +28,21 @@ using FCS.Lib.Common;
 
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Vr Vat Info Mapper
+    /// </summary>
     public class VrVatInfoMapper
     {
+        /// <summary>
+        /// Vr to CRM mapper
+        /// </summary>
+        /// <param name="vrVirk"></param>
+        /// <returns>Vat Info Data Transfer Object</returns>
+        /// <see cref="VatInfoDto"/>
+        /// <see cref="VrVirksomhed"/>
+        /// <see cref="VatState"/>
+        /// <see cref="LifeCycle"/>
+        /// <see cref="TimeFrame"/>
         public VatInfoDto MapVrToCrm(VrVirksomhed vrVirk)
         {
             var c = new VatInfoDto
diff --git a/VrVirksomhed.cs b/VrVirksomhed.cs
index e600452..7a1805e 100644
--- a/VrVirksomhed.cs
+++ b/VrVirksomhed.cs
@@ -25,11 +25,30 @@
 // ***********************************************************************
 namespace FCS.Lib.Virk
 {
+    /// <summary>
+    /// Business model with registrar
+    /// </summary>
+    /// <remarks>JSON property 1-1 relation</remarks>
     public class VrVirksomhed
     {
+        /// <summary>
+        /// Vat number
+        /// </summary>
         public string CvrNummer { get; set; } = "";
+        /// <summary>
+        /// Status list
+        /// </summary>
+        /// <see cref="VirksomhedsStatus"/>
         public List<VirksomhedsStatus> VirksomhedsStatus { get; set; } = new ();
+        /// <summary>
+        /// Meta data
+        /// </summary>
+        /// <see cref="VirksomhedMetadata"/>
         public VirksomhedMetadata VirksomhedMetadata { get; set; } = new();
+        /// <summary>
+        /// Company stages
+        /// </summary>
+        /// <see cref="LivsforloebModel"/>
         public List<LivsforloebModel> Livsforloeb { get; set; } = new();
     }
 }
\ No newline at end of file