From f3c69d3a343c742d420643cdc487fdba299ff100 Mon Sep 17 00:00:00 2001
From: StevanFreeborn <65925598+StevanFreeborn@users.noreply.github.com>
Date: Mon, 20 Feb 2023 19:12:15 -0600
Subject: [PATCH] fix: update jsdoc comments for enums

---
 src/enums/DelegateType.ts      | 20 ++++++++++++++++----
 src/enums/FileStorageSite.ts   |  3 +++
 src/enums/FilterOperators.ts   | 10 ++++++++++
 src/enums/FormulaOutputType.ts |  3 +++
 4 files changed, 32 insertions(+), 4 deletions(-)

diff --git a/src/enums/DelegateType.ts b/src/enums/DelegateType.ts
index 5a8c529..57e23fa 100644
--- a/src/enums/DelegateType.ts
+++ b/src/enums/DelegateType.ts
@@ -1,4 +1,16 @@
-export enum DelegateType {
-  External = 'External',
-  Internal = 'Internal',
-}
+/**
+ * @enum DelegateType - The type of delegate
+ */
+export enum DelegateType {
+  /**
+   * @constant External - The delegate is external.
+   * @type {string}
+   */
+  External = 'External',
+
+  /**
+   * @constant Internal - The delegate is internal.
+   * @type {string}
+   */
+  Internal = 'Internal',
+}
diff --git a/src/enums/FileStorageSite.ts b/src/enums/FileStorageSite.ts
index 34883a1..bf13da4 100644
--- a/src/enums/FileStorageSite.ts
+++ b/src/enums/FileStorageSite.ts
@@ -1,3 +1,6 @@
+/**
+ * @enum FileStorageSite - The site where the file is stored.
+ */
 export enum FileStorageSite {
   /**
    * @constant Internal - The file is stored in the internal file storage.
diff --git a/src/enums/FilterOperators.ts b/src/enums/FilterOperators.ts
index 5210291..b66d368 100644
--- a/src/enums/FilterOperators.ts
+++ b/src/enums/FilterOperators.ts
@@ -4,60 +4,70 @@
 export enum FilterOperators {
   /**
    * @constant Equal - The equal operator
+   * @type {string}
    * @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
    */
   Equal = 'eq',
 
   /**
    * @constant NotEqual - The not equal operator
+   * @type {string}
    * @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
    */
   NotEqual = 'ne',
 
   /**
    * @constant Contains - The contains operator
+   * @type {string}
    * @remarks Can be used with list fields as well as their formula equivalents.
    */
   Contains = 'contains',
 
   /**
    * @constant IsNull - The is null operator
+   * @type {string}
    * @remarks Can be used with text, date, and number fields as well as their formula equivalents.
    */
   IsNull = 'isnull',
 
   /**
    * @constant NotNull - The not null operator
+   * @type {string}
    * @remarks Can be used with text, date, and number fields as well as their formula equivalents.
    */
   NotNull = 'notnull',
 
   /**
    * @constant GreaterThan - The greater than operator
+   * @type {string}
    * @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
    */
   GreaterThan = 'gt',
 
   /**
    * @constant LessThan - The less than operator
+   * @type {string}
    * @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
    */
   LessThan = 'lt',
 
   /**
    * @constant And - The and operator
+   * @type {string}
    * @remarks Can be used to create compound filters.
    */
   And = 'and',
 
   /**
    * @constant Or - The or operator
+   * @type {string}
    * @remarks Can be used to create compound filters.
    */
   Or = 'or',
 
   /**
    * @constant Not - The not operator
+   * @type {string}
    * @remarks Can be used to negate a filter and create compound filters.
    */
   Not = 'not',
diff --git a/src/enums/FormulaOutputType.ts b/src/enums/FormulaOutputType.ts
index ca7c9b8..5de8038 100644
--- a/src/enums/FormulaOutputType.ts
+++ b/src/enums/FormulaOutputType.ts
@@ -1,3 +1,6 @@
+/**
+ * @enum FormulaOutputType - The type of the formula output.
+ */
 export enum FormulaOutputType {
   /**
    * @constant Text - The formula output is a text value.