Merge pull request #216 from dvonthenen/audit-onprem-model

Audit of OnPrem Model Classes

Deepgram/Deepgram.csproj

@@ -10,11 +10,12 @@
   <PropertyGroup>
     <!-- Properties related to NuGet packaging: -->
     <IsPackable>true</IsPackable>
-    <PackageId>Deepgram.Net.SDK</PackageId>
-    <Title>Deepgram SDK</Title>  
+    <Company>Deepgram</Company>
+    <PackageId>Deepgram</PackageId>
+    <Title>Deepgram .NET SDK</Title>
     <Description>SDK for communicating with the Deepgram APIs </Description>
     <Summary>SDK for communicating with the Deepgram APIs </Summary>
-    <Authors>Deepgram</Authors>
+    <Authors>Deepgram .NET SDK Contributors</Authors>
     <Copyright>2021 Deepgram</Copyright>
     <PackageIcon>dg_logo.png</PackageIcon>
     <PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
@@ -23,7 +24,6 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryUrl>https://github.com/deepgram-devs/deepgram-dotnet-sdk</RepositoryUrl>
     <PackageTags>speech-to-text,captions,speech-recognition,deepgram,dotnet</PackageTags>
-    <Version>4.0.0-alpha</Version>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">     

Deepgram/Models/Authenticate/v1/DeepgramClientOptions.cs

@@ -16,12 +16,12 @@ public class DeepgramClientOptions
     /// no need to attach the protocol it will be added internally
     /// </summary>
 
-    public string BaseAddress { get; set; } = "api.deepgram.com";
+    public string? BaseAddress { get; set; } = "api.deepgram.com";
 
     /// <summary>
     /// Api endpoint version
     /// </summary>
-    public string APIVersion { get; set; } = "v1";
+    public string? APIVersion { get; set; } = "v1";
 
 
 }

Deepgram/Models/OnPrem/v1/CredentialResponse.cs

@@ -1,11 +1,16 @@
 namespace Deepgram.Models.OnPrem.v1;
 
 public record CredentialResponse
-
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("member")]
     public Member? Member { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("distribution_credentials")]
     public DistributionCredentials? DistributionCredentials { get; set; }
 }

Deepgram/Models/OnPrem/v1/CredentialsResponse.cs

@@ -1,6 +1,10 @@
 namespace Deepgram.Models.OnPrem.v1;
+
 public record CredentialsResponse
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("distribution_credentials")]
-    public IReadOnlyList<CredentialResponse> DistributionCredentials { get; set; }
+    public IReadOnlyList<CredentialResponse>? DistributionCredentials { get; set; }
 }

Deepgram/Models/OnPrem/v1/DistributionCredentials.cs

@@ -2,18 +2,33 @@
 
 public record DistributionCredentials
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("distribution_credentials_id")]
     public string? DistributionCredentialsId { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("provider")]
     public string? Provider { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("comment")]
     public string? Comment { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("scopes")]
-    public IReadOnlyList<string> Scopes { get; set; }
+    public IReadOnlyList<string>? Scopes { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("created")]
-    public string? Created { get; set; }
+    public DateTime? Created { get; set; }
 }

Deepgram/Models/OnPrem/v1/Member.cs

@@ -1,9 +1,16 @@
 namespace Deepgram.Models.OnPrem.v1;
+
 public record Member
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("member_id")]
     public string? MemberId { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("email")]
     public string? Email { get; set; }
 }