Merge pull request #206 from dvonthenen/audit-manage-model

Audit of Manage Model Classes

Deepgram/Models/Manage/v1/BalanceResponse.cs

@@ -6,23 +6,23 @@ public record BalanceResponse
     /// Balance id
     /// </summary>
     [JsonPropertyName("balance_id")]
-    public string BalanceId { get; set; }
+    public string? BalanceId { get; set; }
 
     /// <summary>
     /// Balance amount
     /// </summary>
     [JsonPropertyName("amount")]
-    public int Amount { get; set; }
+    public decimal? Amount { get; set; }
 
     /// <summary>
     /// Units of the balance. May use usd or hour, depending on the project billing settings
     /// </summary>
     [JsonPropertyName("units")]
-    public string Units { get; set; }
+    public string? Units { get; set; }
 
     /// <summary>
     /// Unique identifier of the purchase order associated with the balance
     /// </summary>
     [JsonPropertyName("purchase")]
-    public string Purchase { get; set; }
+    public string? Purchase { get; set; }
 }

Deepgram/Models/Manage/v1/Callback.cs

@@ -2,12 +2,21 @@
 
 public record Callback
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("attempts")]
     public int? Attempts { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("code")]
     public int? Code { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("completed")]
     public string? Completed { get; set; }
 }

Deepgram/Models/Manage/v1/Config.cs

@@ -8,9 +8,18 @@ public record Config
     [JsonPropertyName("alternatives")]
     public int? Alternatives { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("callback")]
     public string? Callback { get; set; }
 
+    /// <summary>
+    /// Indicates whether topic detection was requested.
+    /// </summary>
+    [JsonPropertyName("detect_topics")]
+    public bool? DetectTopics { get; set; }
+
     /// <summary>
     /// Indicates whether diarization was requested.
     /// </summary>
@@ -23,6 +32,12 @@ public record Config
     [JsonPropertyName("keywords")]
     public IReadOnlyList<string>? Keywords { get; set; }
 
+    /// <summary>
+    /// Indicates whether InterimResults was associated with the request.
+    /// </summary>
+    [JsonPropertyName("interim_results")]
+    public bool? InterimResults { get; set; }
+
     /// <summary>
     /// Language associated with the request.
     /// </summary>
@@ -41,18 +56,6 @@ public record Config
     [JsonPropertyName("multichannel")]
     public bool? Multichannel { get; set; }
 
-    /// <summary>
-    /// Indicates whether named-entity recognition (NER) was requested.
-    /// </summary>
-    [JsonPropertyName("ner")]
-    public bool? Ner { get; set; }
-
-    /// <summary>
-    /// Indicates whether numeral conversion was requested.
-    /// </summary>
-    [JsonPropertyName("numerals")]
-    public bool? Numerals { get; set; }
-
     /// <summary>
     /// Indicates whether filtering profanity was requested.
     /// </summary>
@@ -79,10 +82,10 @@ public record Config
     public IReadOnlyList<string>? Search { get; set; }
 
     /// <summary>
-    /// Indicates whether utterance segmentation was requested.
+    /// Indicates whether SmartFormat was associated with the request.
     /// </summary>
-    [JsonPropertyName("utterances")]
-    public bool? Utterances { get; set; }
+    [JsonPropertyName("smart_format")]
+    public bool? SmartFormat { get; set; }
 
     /// <summary>
     /// ReadOnlyList of translations associated with the request.
@@ -91,9 +94,8 @@ public record Config
     public IReadOnlyList<string>? Translation { get; set; }
 
     /// <summary>
-    /// Indicates whether topic detection was requested.
+    /// Indicates whether utterance segmentation was requested.
     /// </summary>
-    [JsonPropertyName("detect_topics")]
-    public bool? DetectTopics { get; set; }
-
+    [JsonPropertyName("utterances")]
+    public bool? Utterances { get; set; }
 }

Deepgram/Models/Manage/v1/Details.cs

@@ -12,7 +12,7 @@ public record Details
     /// Length of time (in hours) of audio processed in the request.
     /// </summary>
     [JsonPropertyName("duration")]
-    public decimal? Duration { get; set; }
+    public double? Duration { get; set; }
 
     /// <summary>
     /// Number of audio files processed in the request.
@@ -36,29 +36,29 @@ public record Details
     /// Model applied when running the request.
     /// </summary>
     [JsonPropertyName("models")]
-    public IReadOnlyList<string> Models { get; set; }
+    public IReadOnlyList<string>? Models { get; set; }
 
     /// <summary>
     /// Processing method used when running the request.
     /// </summary>
     [JsonPropertyName("method")]
-    public string Method { get; set; }
+    public string? Method { get; set; }
 
     /// <summary>
     /// List of tags applied when running the request.
     /// </summary>
     [JsonPropertyName("tags")]
-    public IReadOnlyList<string> Tags { get; set; }
+    public IReadOnlyList<string>? Tags { get; set; }
 
     /// <summary>
     /// List of features used when running the request.
     /// </summary>
     [JsonPropertyName("features")]
-    public IReadOnlyList<string> Features { get; set; }
+    public IReadOnlyList<string>? Features { get; set; }
 
     /// <summary>
     /// Configuration used when running the request.<see cref="v1.Config"/>
     /// </summary>
     [JsonPropertyName("config")]
-    public Config Config { get; set; }
+    public Config? Config { get; set; }
 }

Deepgram/Models/Manage/v1/Invite.cs

@@ -2,9 +2,15 @@
 
 public record Invite
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("email")]
     public string? Email { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("scope")]
     public string? Scope { get; set; }
 }

Deepgram/Models/Manage/v1/InviteSchema.cs

@@ -5,12 +5,12 @@ public class InviteSchema(string email, string scope)
     /// email of the person being invited
     /// </summary>
     [JsonPropertyName("email")]
-    public string Email { get; set; } = email;
+    public string? Email { get; set; } = email;
 
     /// <summary>
     /// scopes to add for the invited person
     /// </summary>
     [JsonPropertyName("scope")]
-    public string Scope { get; set; } = scope;
+    public string? Scope { get; set; } = scope;
 
 }

Deepgram/Models/Manage/v1/Key.cs

@@ -14,12 +14,22 @@ public record Key
     [JsonPropertyName("comment")]
     public string? Comment { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("scopes")]
     public IReadOnlyList<string>? Scopes { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
+    [JsonPropertyName("created")]
+    public DateTime? Created { get; set; }
+
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("tags")]
     public IReadOnlyList<string>? Tags { get; set; }
-
-    [JsonPropertyName("created")]
-    public string? Created { get; set; }
 }
+

Deepgram/Models/Manage/v1/KeyResponse.cs

@@ -1,29 +1,6 @@
 namespace Deepgram.Models.Manage.v1;
 
-public record KeyResponse
+public record KeyResponse : Key
 {
-    /// <summary>
-    /// Unique identifier of the Deepgram API key
-    /// </summary>
-    [JsonPropertyName("api_key_id")]
-    public string ApiKeyId { get; set; }
-
-    [JsonPropertyName("key")]
-    public string Key { get; set; }
-
-    /// <summary>
-    /// Comment for the Deepgram API key
-    /// </summary>
-    [JsonPropertyName("comment")]
-    public string Comment { get; set; }
-
-    [JsonPropertyName("scopes")]
-    public IReadOnlyList<string> Scopes { get; set; }
-
-    [JsonPropertyName("tags")]
-    public IReadOnlyList<string> Tags { get; set; }
-
-    [JsonPropertyName("created")]
-    public DateTime Created { get; set; }
 }
 

Deepgram/Models/Manage/v1/KeySchema.cs

@@ -6,13 +6,13 @@ public class KeySchema(string comment, List<string> scopes)
     /// Comment to describe key
     /// </summary>
     [JsonPropertyName("comment")]
-    public string Comment { get; set; } = comment;
+    public string? Comment { get; set; } = comment;
 
     /// <summary>
     /// Scopes of the key
     /// </summary>
     [JsonPropertyName("scopes")]
-    public List<string> Scopes { get; set; } = scopes;
+    public List<string>? Scopes { get; set; } = scopes;
 
     /// <summary>
     /// Tag names for key
@@ -32,6 +32,4 @@ public class KeySchema(string comment, List<string> scopes)
     /// </summary>
     [JsonPropertyName("time_to_live_in_seconds")]
     public int? TimeToLiveInSeconds { get; set; }
-
-
 }

Deepgram/Models/Manage/v1/Member.cs

@@ -24,7 +24,11 @@ public record Member
     /// Email address of member
     /// </summary>
     [JsonPropertyName("email")]
-    public string? Email { get; set; } = string.Empty;
-
+    public string? Email { get; set; }
 
+    /// <summary>
+    /// Scopes of the key
+    /// </summary>
+    [JsonPropertyName("scopes")]
+    public List<string>? Scopes { get; set; }
 }

Deepgram/Models/Manage/v1/MemberScopeSchema.cs

@@ -5,5 +5,5 @@ public class MemberScopeSchema(string scope)
     /// Scope to add for member
     /// </summary>
     [JsonPropertyName("scope")]
-    public string Scope { get; set; } = scope;
+    public string? Scope { get; set; } = scope;
 }

Deepgram/Models/Manage/v1/MembersResponse.cs

@@ -2,7 +2,9 @@
 
 public record MembersResponse
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("members")]
     public IReadOnlyList<Member>? Members { get; set; }
 }
-

Deepgram/Models/Manage/v1/MessageResponse.cs

@@ -6,5 +6,5 @@ public record MessageResponse
     /// A message denoting the success of the operation
     /// </summary>
     [JsonPropertyName("message")]
-    public string Message { get; set; }
+    public string? Message { get; set; }
 }

Deepgram/Models/Manage/v1/UsageModel.cs → Deepgram/Models/Manage/v1/Model.cs

@@ -1,16 +1,28 @@
 namespace Deepgram.Models.Manage.v1;
 
-public record UsageModel
+public record Model
 {
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("name")]
     public string? Name { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("language")]
     public string? Language { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("version")]
     public string? Version { get; set; }
 
+    /// <summary>
+    /// TODO
+    /// </summary>
     [JsonPropertyName("model_id")]
     public string? ModelId { get; set; }
 }

Deepgram/Models/Manage/v1/Project.cs

@@ -13,5 +13,10 @@ public record Project
     /// </summary>
     [JsonPropertyName("name")]
     public string? Name { get; set; }
-}
 
+    /// <summary>
+    /// Name of the company
+    /// </summary>
+    [JsonPropertyName("company")]
+    public string? Company { get; set; }
+}

Deepgram/Models/Manage/v1/ProjectResponse.cs

@@ -1,21 +1,5 @@
 namespace Deepgram.Models.Manage.v1;
-public record ProjectResponse
-{
-    /// <summary>
-    /// Unique identifier of the Deepgram project
-    /// </summary>
-    [JsonPropertyName("project_id")]
-    public string? ProjectId { get; set; }
-
-    /// <summary>
-    /// Name of the Deepgram project
-    /// </summary>
-    [JsonPropertyName("name")]
-    public string? Name { get; set; }
 
-    /// <summary>
-    /// Name of the company associated with the Deepgram project
-    /// </summary>
-    [JsonPropertyName("company")]
-    public string? Company { get; set; }
+public record ProjectResponse : Project
+{
 }

Deepgram/Models/Manage/v1/ProjectSchema.cs

@@ -13,4 +13,3 @@ public class ProjectSchema
     [JsonPropertyName("company")]
     public string? Company { get; set; }
 }
-