documentation

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" />

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 ();
     }
 }

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; } = "";
     }
 }

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; } = "";
     }
 }

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; } = "";
     }
 }

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();
     }
 }

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();
     }
 }

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)
         {

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; } = "";
     }
 }

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))

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

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?>();

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; } = "";
     }
 }

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

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();
     }
 }