docs: add documentation to code

Added extensive xmldocs to every class.

Author: ducksoop

QuickbaseNet/Errors/QuickbaseError.cs

@@ -1,10 +1,27 @@
 namespace QuickbaseNet.Errors
 {
+    /// <summary>
+    /// Represents an error in the QuickBase API.
+    /// </summary>
     public class QuickbaseError
     {
+        /// <summary>
+        /// Represents no error.
+        /// </summary>
         public static readonly QuickbaseError None = new QuickbaseError(string.Empty, string.Empty, string.Empty, QuickbaseErrorType.Failure);
+
+        /// <summary>
+        /// Represents an error indicating a null value was provided.
+        /// </summary>
         public static readonly QuickbaseError NullValue = new QuickbaseError("Error.NullValue", "Null value was provided", string.Empty, QuickbaseErrorType.Failure);
 
+        /// <summary>
+        /// Initializes a new instance of the QuickbaseError class.
+        /// </summary>
+        /// <param name="code">The error code.</param>
+        /// <param name="message">The error message.</param>
+        /// <param name="description">The error description.</param>
+        /// <param name="quickbaseErrorType">The type of the error.</param>
         public QuickbaseError(string code, string message, string description, QuickbaseErrorType quickbaseErrorType)
         {
             Code = code;
@@ -13,24 +30,64 @@ public QuickbaseError(string code, string message, string description, Quickbase
             Type = quickbaseErrorType;
         }
 
+        /// <summary>
+        /// Gets the error code.
+        /// </summary>
         public string Code { get; private set; }
 
+        /// <summary>
+        /// Gets the error message.
+        /// </summary>
         public string Message { get; private set; }
 
+        /// <summary>
+        /// Gets the error description.
+        /// </summary>
         public string Description { get; private set; }
 
+        /// <summary>
+        /// Gets the type of the error.
+        /// </summary>
         public QuickbaseErrorType Type { get; private set; }
 
+        /// <summary>
+        /// Creates a new QuickbaseError representing a not found error.
+        /// </summary>
+        /// <param name="code">The error code.</param>
+        /// <param name="message">The error message.</param>
+        /// <param name="description">The error description.</param>
+        /// <returns>A QuickbaseError representing a not found error.</returns>
         public static QuickbaseError NotFound(string code, string message, string description) =>
             new QuickbaseError(code, message, description, QuickbaseErrorType.NotFound);
 
+        /// <summary>
+        /// Creates a new QuickbaseError representing a failure error.
+        /// </summary>
+        /// <param name="code">The error code.</param>
+        /// <param name="message">The error message.</param>
+        /// <param name="description">The error description.</param>
+        /// <returns>A QuickbaseError representing a failure error.</returns>
         public static QuickbaseError Failure(string code, string message, string description) =>
             new QuickbaseError(code, message, description, QuickbaseErrorType.Failure);
 
+        /// <summary>
+        /// Creates a new QuickbaseError representing a client error.
+        /// </summary>
+        /// <param name="code">The error code.</param>
+        /// <param name="message">The error message.</param>
+        /// <param name="description">The error description.</param>
+        /// <returns>A QuickbaseError representing a client error.</returns>
         public static QuickbaseError ClientError(string code, string message, string description) =>
             new QuickbaseError(code, message, description, QuickbaseErrorType.ClientError);
 
+        /// <summary>
+        /// Creates a new QuickbaseError representing a server error.
+        /// </summary>
+        /// <param name="code">The error code.</param>
+        /// <param name="message">The error message.</param>
+        /// <param name="description">The error description.</param>
+        /// <returns>A QuickbaseError representing a server error.</returns>
         public static QuickbaseError ServerError(string code, string message, string description) =>
             new QuickbaseError(code, message, description, QuickbaseErrorType.ServerError);
     }
-}
+}

QuickbaseNet/Errors/QuickbaseErrorType.cs

@@ -1,10 +1,28 @@
 namespace QuickbaseNet.Errors
 {
+    /// <summary>
+    /// Represents the type of QuickBase API error.
+    /// </summary>
     public enum QuickbaseErrorType
     {
+        /// <summary>
+        /// Indicates a general failure error.
+        /// </summary>
         Failure = 0,
+
+        /// <summary>
+        /// Indicates a not found error.
+        /// </summary>
         NotFound = 1,
+
+        /// <summary>
+        /// Indicates a client error.
+        /// </summary>
         ClientError = 3,
+
+        /// <summary>
+        /// Indicates a server error.
+        /// </summary>
         ServerError = 4
     }
 }

QuickbaseNet/Helpers/QuickbaseCommandBuilder.cs

@@ -5,25 +5,43 @@
 
 namespace QuickbaseNet.Helpers
 {
+    /// <summary>
+    /// Helper class for building QuickBase API commands.
+    /// </summary>
     public class QuickbaseCommandBuilder
     {
         private string _tableId;
         private string _whereClauseForDeletion;
         private readonly List<Dictionary<string, FieldValue>> _records = new List<Dictionary<string, FieldValue>>();
         private int[] _fieldsToReturn;
 
+        /// <summary>
+        /// Specifies the table to operate on.
+        /// </summary>
+        /// <param name="tableId">The ID of the QuickBase table.</param>
+        /// <returns>The current instance of QuickbaseCommandBuilder.</returns>
         public QuickbaseCommandBuilder ForTable(string tableId)
         {
             _tableId = tableId;
             return this;
         }
 
+        /// <summary>
+        /// Specifies which fields to return after the operation.
+        /// </summary>
+        /// <param name="fieldIds">The IDs of the fields to return.</param>
+        /// <returns>The current instance of QuickbaseCommandBuilder.</returns>
         public QuickbaseCommandBuilder ReturnFields(params int[] fieldIds)
         {
             _fieldsToReturn = fieldIds;
             return this;
         }
 
+        /// <summary>
+        /// Adds a new record to the command being built.
+        /// </summary>
+        /// <param name="config">Action to configure the new record.</param>
+        /// <returns>The current instance of QuickbaseCommandBuilder.</returns>
         public QuickbaseCommandBuilder AddNewRecord(Action<RecordBuilder> config)
         {
             var recordBuilder = new RecordBuilder();
@@ -32,23 +50,38 @@ public QuickbaseCommandBuilder AddNewRecord(Action<RecordBuilder> config)
             return this;
         }
 
+        /// <summary>
+        /// Updates an existing record in the command being built.
+        /// </summary>
+        /// <param name="recordId">The ID of the record to update.</param>
+        /// <param name="config">Action to configure the updated record.</param>
+        /// <returns>The current instance of QuickbaseCommandBuilder.</returns>
         public QuickbaseCommandBuilder UpdateRecord(int recordId, Action<RecordBuilder> config)
         {
             var recordBuilder = new RecordBuilder();
             config(recordBuilder);
 
             // Assuming '3' is the default key field ID for record ID
-            recordBuilder.AddField("3", recordId.ToString());
+            recordBuilder.AddField(3, recordId.ToString());
             _records.Add(recordBuilder.Build());
             return this;
         }
 
+        /// <summary>
+        /// Specifies deletion criteria for records.
+        /// </summary>
+        /// <param name="whereClause">The deletion criteria.</param>
+        /// <returns>The current instance of QuickbaseCommandBuilder.</returns>
         public QuickbaseCommandBuilder WithDeletionCriteria(string whereClause)
         {
             _whereClauseForDeletion = whereClause;
             return this;
         }
 
+        /// <summary>
+        /// Builds an insert or update command.
+        /// </summary>
+        /// <returns>An InsertOrUpdateRecordRequest object representing the command.</returns>
         public InsertOrUpdateRecordRequest BuildInsertUpdateCommand()
         {
             return new InsertOrUpdateRecordRequest
@@ -59,6 +92,10 @@ public InsertOrUpdateRecordRequest BuildInsertUpdateCommand()
             };
         }
 
+        /// <summary>
+        /// Builds a delete command.
+        /// </summary>
+        /// <returns>A DeleteRecordRequest object representing the command.</returns>
         public DeleteRecordRequest BuildDeleteCommand()
         {
             return new DeleteRecordRequest
@@ -68,16 +105,30 @@ public DeleteRecordRequest BuildDeleteCommand()
             };
         }
 
+        /// <summary>
+        /// Builder class for constructing record objects.
+        /// </summary>
         public class RecordBuilder
         {
             private readonly Dictionary<string, FieldValue> _fields = new Dictionary<string, FieldValue>();
 
+            /// <summary>
+            /// Adds a field to the record being built.
+            /// </summary>
+            /// <typeparam name="T">The type of the field value.</typeparam>
+            /// <param name="fieldId">The ID of the field.</param>
+            /// <param name="value">The value of the field.</param>
+            /// <returns>The current instance of RecordBuilder.</returns>
             public RecordBuilder AddField<T>(int fieldId, T value)
             {
-                _fields[fieldId.ToString()] = new FieldValue { Value = value }; 
+                _fields[fieldId.ToString()] = new FieldValue { Value = value };
                 return this;
             }
 
+            /// <summary>
+            /// Builds the record.
+            /// </summary>
+            /// <returns>A dictionary representing the record.</returns>
             public Dictionary<string, FieldValue> Build()
             {
                 return _fields;

QuickbaseNet/Helpers/QuickbaseQueryBuilder.cs

@@ -5,6 +5,9 @@
 
 namespace QuickbaseNet.Helpers
 {
+    /// <summary>
+    /// Helper class for building QuickBase API queries.
+    /// </summary>
     public class QuickbaseQueryBuilder
     {
         private string _from;
@@ -13,24 +16,45 @@ public class QuickbaseQueryBuilder
         private List<SortByItem> _sortBy;
         private List<GroupByItem> _groupBy;
 
+        /// <summary>
+        /// Specifies the table to query.
+        /// </summary>
+        /// <param name="from">The ID or name of the QuickBase table.</param>
+        /// <returns>The current instance of QuickbaseQueryBuilder.</returns>
         public QuickbaseQueryBuilder From(string from)
         {
             _from = from;
             return this;
         }
 
+        /// <summary>
+        /// Specifies which fields to select in the query result.
+        /// </summary>
+        /// <param name="fields">The IDs of the fields to select.</param>
+        /// <returns>The current instance of QuickbaseQueryBuilder.</returns>
         public QuickbaseQueryBuilder Select(params int[] fields)
         {
             _select = fields.ToList();
             return this;
         }
 
+        /// <summary>
+        /// Specifies the WHERE clause of the query.
+        /// </summary>
+        /// <param name="where">The WHERE clause.</param>
+        /// <returns>The current instance of QuickbaseQueryBuilder.</returns>
         public QuickbaseQueryBuilder Where(string where)
         {
             _where = where;
             return this;
         }
 
+        /// <summary>
+        /// Specifies the fields to sort the query result by.
+        /// </summary>
+        /// <param name="fieldId">The ID of the field to sort by.</param>
+        /// <param name="order">The sorting order ("ASC" for ascending, "DESC" for descending).</param>
+        /// <returns>The current instance of QuickbaseQueryBuilder.</returns>
         public QuickbaseQueryBuilder SortBy(int fieldId, string order)
         {
             if (_sortBy == null)
@@ -40,6 +64,12 @@ public QuickbaseQueryBuilder SortBy(int fieldId, string order)
             return this;
         }
 
+        /// <summary>
+        /// Specifies the fields to group the query result by.
+        /// </summary>
+        /// <param name="fieldId">The ID of the field to group by.</param>
+        /// <param name="grouping">The grouping criteria.</param>
+        /// <returns>The current instance of QuickbaseQueryBuilder.</returns>
         public QuickbaseQueryBuilder GroupBy(int fieldId, string grouping)
         {
             if (_groupBy == null)
@@ -49,6 +79,10 @@ public QuickbaseQueryBuilder GroupBy(int fieldId, string grouping)
             return this;
         }
 
+        /// <summary>
+        /// Builds the query.
+        /// </summary>
+        /// <returns>A QuickbaseQueryRequest object representing the query.</returns>
         public QuickbaseQueryRequest Build()
         {
             return new QuickbaseQueryRequest
@@ -61,4 +95,4 @@ public QuickbaseQueryRequest Build()
             };
         }
     }
-}
+}

QuickbaseNet/Models/Field.cs

@@ -2,12 +2,26 @@
 
 namespace QuickbaseNet.Models
 {
+    /// <summary>
+    /// Represents a field in a QuickBase table.
+    /// </summary>
     public class Field
     {
+        /// <summary>
+        /// Gets or sets the ID of the field.
+        /// </summary>
         [JsonProperty("id")]
         public int Id { get; set; }
+
+        /// <summary>
+        /// Gets or sets the label of the field.
+        /// </summary>
         [JsonProperty("label")]
         public string Label { get; set; }
+
+        /// <summary>
+        /// Gets or sets the type of the field.
+        /// </summary>
         [JsonProperty("type")]
         public string Type { get; set; }
     }

QuickbaseNet/Models/FieldValue.cs

@@ -3,11 +3,22 @@
 
 namespace QuickbaseNet.Models
 {
+    /// <summary>
+    /// Represents a value of a field in a QuickBase record.
+    /// </summary>
     public class FieldValue
     {
+        /// <summary>
+        /// Gets or sets the value of the field.
+        /// </summary>
         [JsonProperty("value", NullValueHandling = NullValueHandling.Ignore)]
         public object Value { get; set; }
 
+        /// <summary>
+        /// Gets the strongly-typed value of the field.
+        /// </summary>
+        /// <typeparam name="T">The type to convert the value to.</typeparam>
+        /// <returns>The strongly-typed value of the field.</returns>
         public T GetValue<T>()
         {
             return Value == null ? default : (T)Convert.ChangeType(Value, typeof(T));