documentation

BrAddressModel.cs

@@ -28,13 +28,37 @@ using System.Collections.Generic;
 
 namespace FCS.Lib.BrReg;
 
+/// <summary>
+/// 
+/// </summary>
 public class BrAddressModel
 {
+    /// <summary>
+    /// entity country
+    /// </summary>
     public string Land { get; set; } = "";
+    /// <summary>
+    /// entity country code
+    /// </summary>
     public string Landkode { get; set; } = "";
+    /// <summary>
+    /// entity zip code
+    /// </summary>
     public string Postnummer { get; set; } = "";
+    /// <summary>
+    /// entity postal name
+    /// </summary>
     public string Poststed { get; set; } = "";
+    /// <summary>
+    /// entity address
+    /// </summary>
     public List<string> Adresse { get; set; } = new();
+    /// <summary>
+    /// entity municipal
+    /// </summary>
     public string Kommune { get; set; } = "";
+    /// <summary>
+    /// entity municipal identification
+    /// </summary>
     public string Kommunenummer { get; set; } = "";
 }

BrCompanyModel.cs

@@ -26,16 +26,46 @@
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public class BrCompanyModel
     {
+        /// <summary>
+        /// Entity vat number
+        /// </summary>
         public string Organisasjonsnummer { get; set; } = "";
+        /// <summary>
+        /// Entity name
+        /// </summary>
         public string Navn { get; set; } = "";
+        /// <summary>
+        /// Entity deletion date
+        /// </summary>
         public string Slettedato { get; set; } = "";
+        /// <summary>
+        /// Entity business type
+        /// </summary>
         public BrCompanyTypeModel Organisasjonsform { get; set; } = new();
+        /// <summary>
+        /// entity postal address
+        /// </summary>
         public BrAddressModel Postadresse { get; set; } = new();
+        /// <summary>
+        /// entity business address
+        /// </summary>
         public BrAddressModel Forretningsadresse { get; set; } = new();
+        /// <summary>
+        /// entity out-of-business flag
+        /// </summary>
         public bool Konkurs { get; set; }
+        /// <summary>
+        /// entity to be closed flag
+        /// </summary>
         public bool UnderAvvikling { get; set; }
+        /// <summary>
+        /// entity to be force closed
+        /// </summary>
         public bool UnderTvangsavviklingEllerTvangsopplosning { get; set; }
 
     }

BrCompanyTypeModel.cs

@@ -25,9 +25,21 @@
 // ***********************************************************************
 namespace FCS.Lib.BrReg;
 
+/// <summary>
+/// Class BrCompanyTypeModel
+/// </summary>
 public class BrCompanyTypeModel
 {
+    /// <summary>
+    /// BrReg business code
+    /// </summary>
     public string Kode { get; set; } = "";
+    /// <summary>
+    /// BrReg description
+    /// </summary>
     public string Beskrivelse { get; set; } = "";
+    /// <summary>
+    /// BrReg discontinued
+    /// </summary>
     public string Utgaatt { get; set; } = "";
 }

BrHttpRequest.cs

@@ -29,8 +29,17 @@ using System.Threading.Tasks;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrHttpRequest
+    /// </summary>
     public class BrHttpRequest
     {
+        /// <summary>
+        /// Async http request
+        /// </summary>
+        /// <param name="endpoint"></param>
+        /// <param name="userAgent"></param>
+        /// <returns><see cref="BrResponseView"/></returns>
         public async Task<BrResponseView> GetResponseAsync(string endpoint, string userAgent)
         {
             using var client = new HttpClient();

BrRegQuery.cs

@@ -1,7 +1,13 @@
 namespace FCS.Lib.BrReg;
 
+/// <summary>
+/// BrRegQuery
+/// </summary>
 public class BrRegQuery
 {
+    /// <summary>
+    /// Vat number
+    /// </summary>
     public string VatNumber { get; set; }
 
 }

BrResponseParser.cs

@@ -28,8 +28,16 @@ using Newtonsoft.Json;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrResponseParser
+    /// </summary>
     public class BrResponseParser
     {
+        /// <summary>
+        /// Parse response to BrCompanyModel
+        /// </summary>
+        /// <param name="responseData"></param>
+        /// <returns><see cref="BrCompanyModel"/></returns>
         public BrCompanyModel ParseBrResponse(string responseData)
         {
             return JsonConvert.DeserializeObject<BrCompanyModel>(responseData);

BrResponseView.cs

@@ -28,10 +28,22 @@ using System.Net;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrResponseView
+    /// </summary>
     public class BrResponseView
     {
+        /// <summary>
+        /// http response status code
+        /// </summary>
         public HttpStatusCode Code { get; set; }
+        /// <summary>
+        /// Flag indicating success
+        /// </summary>
         public bool IsSuccessStatusCode { get; set; }
+        /// <summary>
+        /// Response message
+        /// </summary>
         public string Message { get; set; } = "";
     }
 }

BrVatInfoMapper.cs

@@ -30,9 +30,21 @@ using FCS.Lib.Common;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrVatInfoMapper
+    /// </summary>
     public class BrVatInfoMapper
     {
 
+        /// <summary>
+        /// Map BrCompanyModel to CRM
+        /// </summary>
+        /// <param name="brCompany"></param>
+        /// <returns><see cref="VatInfoDto"/></returns>
+        /// <see cref="BrCompanyModel"/>
+        /// <see cref="VatState"/>
+        /// <see cref="LifeCycle"/>
+        /// <see cref="TimeFrame"/>
         public VatInfoDto MapBrToCrm(BrCompanyModel brCompany)
         {
             return new VatInfoDto
@@ -69,6 +81,12 @@ namespace FCS.Lib.BrReg
                 }
             };
         }
+
+        /// <summary>
+        /// Map BrCompanyModel to VatStateInfo
+        /// </summary>
+        /// <param name="brCompany"></param>
+        /// <returns><see cref="VatStateInfo"/></returns>
         public VatStateInfo MapBrVatState(BrCompanyModel brCompany)
         {
             if (brCompany == null)

FCS.Lib.BrReg.csproj

@@ -24,6 +24,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\FCS.Lib.BrReg.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>