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

---
 FCS.Lib.Vies.csproj   |  1 +
 ViesEntityModel.cs    | 21 +++++++++++++++++++++
 ViesHttpRequest.cs    | 15 ++++++++++++++-
 ViesQuery.cs          |  9 +++++++++
 ViesQueryValidator.cs |  9 +++++++++
 ViesResponseParser.cs |  9 +++++++++
 ViesResponseView.cs   | 12 ++++++++++++
 ViesVatInfoMapper.cs  | 12 ++++++++++++
 8 files changed, 87 insertions(+), 1 deletion(-)

diff --git a/FCS.Lib.Vies.csproj b/FCS.Lib.Vies.csproj
index b08a8e9..1b122df 100644
--- a/FCS.Lib.Vies.csproj
+++ b/FCS.Lib.Vies.csproj
@@ -24,6 +24,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\FCS.Lib.Vies.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
diff --git a/ViesEntityModel.cs b/ViesEntityModel.cs
index 1ddf547..8fc40ae 100644
--- a/ViesEntityModel.cs
+++ b/ViesEntityModel.cs
@@ -28,12 +28,33 @@ using System;
 
 namespace FCS.Lib.Vies;
 
+/// <summary>
+/// Vies Entity Model
+/// </summary>
 public class ViesEntityModel
 {
+    /// <summary>
+    /// Business entity's country code of origin
+    /// </summary>
     public string CountryCode { get; set; }
+    /// <summary>
+    /// Business entity vat number
+    /// </summary>
     public string VatNumber { get; set; }
+    /// <summary>
+    /// Request date
+    /// </summary>
     public DateTime RequestDate { get; set; }
+    /// <summary>
+    /// Valid flag
+    /// </summary>
     public bool Valid { get; set; }
+    /// <summary>
+    /// Business entity name
+    /// </summary>
     public string Name { get; set; }
+    /// <summary>
+    /// Business entity address
+    /// </summary>
     public string Address { get; set; }
 }
\ No newline at end of file
diff --git a/ViesHttpRequest.cs b/ViesHttpRequest.cs
index 719efde..5bf36be 100644
--- a/ViesHttpRequest.cs
+++ b/ViesHttpRequest.cs
@@ -29,11 +29,24 @@ using System.Threading.Tasks;
 
 namespace FCS.Lib.Vies
 {
+    /// <summary>
+    /// http request to vies registrar
+    /// </summary>
     public class ViesHttpRequest
     {
-        // "http://ec.europa.eu/taxation_customs/vies/services/checkVatService"
+        /// <summary>
+        /// Async http request to vies registrar
+        /// </summary>
+        /// <param name="endpoint"></param>
+        /// <param name="countryCode"></param>
+        /// <param name="vatNumber"></param>
+        /// <param name="userAgent"></param>
+        /// <returns>Vies Response View model</returns>
+        /// <see cref="ViesResponseView"/>
+        /// <remarks>Service http://ec.europa.eu/taxation_customs/vies/services/checkVatService</remarks>
         public async Task<ViesResponseView> GetResponseAsync(string endpoint, string countryCode, string vatNumber, string userAgent)
         {
+
             var xml = new StringBuilder();
             xml.Append($"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:urn=\"urn:ec.europa.eu:taxud:vies:services:checkVat:types\">");
             xml.Append($"<soapenv:Header/>");
diff --git a/ViesQuery.cs b/ViesQuery.cs
index 9669674..c4a62df 100644
--- a/ViesQuery.cs
+++ b/ViesQuery.cs
@@ -25,8 +25,17 @@
 // ***********************************************************************
 namespace FCS.Lib.Vies;
 
+/// <summary>
+/// Vies Query model
+/// </summary>
 public class ViesQuery
 {
+    /// <summary>
+    /// Country code for country to query
+    /// </summary>
     public string CountryCode { get; set; }
+    /// <summary>
+    /// Vat number to query
+    /// </summary>
     public string VatNumber { get; set; }
 }
\ No newline at end of file
diff --git a/ViesQueryValidator.cs b/ViesQueryValidator.cs
index d187c06..b822937 100644
--- a/ViesQueryValidator.cs
+++ b/ViesQueryValidator.cs
@@ -26,8 +26,17 @@
 
 namespace FCS.Lib.Vies;
 
+/// <summary>
+/// Vies Query Validator
+/// </summary>
 public static class ViesQueryValidator
 {
+    /// <summary>
+    /// Validate Vies query
+    /// </summary>
+    /// <param name="query"></param>
+    /// <returns>bool indicating valid query</returns>
+    /// <see cref="ViesQuery"/>
     public static bool ValidateViesQuery(ViesQuery query)
     {
         return !string.IsNullOrWhiteSpace(query.VatNumber) && !string.IsNullOrWhiteSpace(query.CountryCode);
diff --git a/ViesResponseParser.cs b/ViesResponseParser.cs
index 2be7df2..d2cf094 100644
--- a/ViesResponseParser.cs
+++ b/ViesResponseParser.cs
@@ -30,8 +30,17 @@ using System.Xml.Linq;
 
 namespace FCS.Lib.Vies;
 
+/// <summary>
+/// Vies http response parser
+/// </summary>
 public class ViesResponseParser
 {
+    /// <summary>
+    /// Parser
+    /// </summary>
+    /// <param name="responseData"></param>
+    /// <returns>Vies Entity Model parsed from XML data</returns>
+    /// <see cref="ViesEntityModel"/>
     public ViesEntityModel ParseViesResponse(string responseData)
     {
         var xml = XDocument.Parse(responseData);
diff --git a/ViesResponseView.cs b/ViesResponseView.cs
index 76596e3..d8f073d 100644
--- a/ViesResponseView.cs
+++ b/ViesResponseView.cs
@@ -27,9 +27,21 @@ using System.Net;
 
 namespace FCS.Lib.Vies;
 
+/// <summary>
+/// Vies Response view
+/// </summary>
 public class ViesResponseView
 {
+    /// <summary>
+    /// http request status code
+    /// </summary>
     public HttpStatusCode Code { get; set; }
+    /// <summary>
+    /// boolean indicating success
+    /// </summary>
     public bool IsSuccessStatusCode { get; set; }
+    /// <summary>
+    /// response message
+    /// </summary>
     public string Message { get; set; } = "";
 }
\ No newline at end of file
diff --git a/ViesVatInfoMapper.cs b/ViesVatInfoMapper.cs
index c28712a..dfc8c7d 100644
--- a/ViesVatInfoMapper.cs
+++ b/ViesVatInfoMapper.cs
@@ -30,8 +30,20 @@ using FCS.Lib.Common;
 
 namespace FCS.Lib.Vies
 {
+    /// <summary>
+    /// Vies vat info mapper
+    /// </summary>
     public class ViesVatInfoMapper
     {
+        /// <summary>
+        /// map vies response to Crm
+        /// </summary>
+        /// <param name="viesEntity"></param>
+        /// <returns>Vat Info Data Transfer Object</returns>
+        /// <see cref="VatInfoDto"/>
+        /// <see cref="ViesEntityModel"/>
+        /// <see cref="VatState"/>
+        /// <see cref="TimeFrame"/>
         public VatInfoDto MapViesToCrm(ViesEntityModel viesEntity)
         {
             var addressBlock = viesEntity.Address.Split('\n');