From 4368a849fb14caa9687eb212860fe339f1d3a9ab Mon Sep 17 00:00:00 2001
From: Constantin Nickel <constantin.nickel@gmail.com>
Date: Tue, 15 Mar 2022 10:46:20 +0100
Subject: [PATCH] Add a static method for creating custom filters

```
using Modio.Filters;

var filter = Filter.Custom("name", Operator.Equals, "foobar");
```
---
 Modio/Filters/Filter.cs | 48 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/Modio/Filters/Filter.cs b/Modio/Filters/Filter.cs
index 86d43a8..b5ac2f2 100644
--- a/Modio/Filters/Filter.cs
+++ b/Modio/Filters/Filter.cs
@@ -26,6 +26,14 @@ internal Filter(string name, string value) : this()
             parameters[name] = value;
         }
 
+        /// <summary>
+        /// Initializes a new custom instance of <see cref="Filter"/>.
+        /// </summary>
+        public static Filter Custom(string name, Operator op, string value)
+        {
+            return new Filter(op.ToName(name), value);
+        }
+
         /// <summary>
         /// Initializes a new instance of <see cref="Filter"/> with <paramref name="limit"/>.
         /// </summary>
@@ -450,18 +458,56 @@ public Filter NotIn(params T[] values)
         }
     }
 
-    internal enum Operator
+    /// <summary>
+    /// Filter operators of mod.io
+    /// </summary>
+    ///
+    /// <seealso>https://docs.mod.io/#filtering</seealso>
+    public enum Operator
     {
+        /// <summary>
+        /// Equal to (`id=1`)
+        /// </summary>
         Equal,
+        /// <summary>
+        /// Equal to (`id-not=1`)
+        /// </summary>
         NotEqual,
+        /// <summary>
+        /// Equivalent to SQL's `LIKE`. `*` is equivalent to SQL's `%`. (`name-lk=foo*`)
+        /// </summary>
         Like,
+        /// <summary>
+        /// Equivalent to SQL's `NOT LIKE` (`name-not-lk=foo*`)
+        /// </summary>
         NotLike,
+        /// <summary>
+        /// Equivalent to SQL's `IN` (`id-in=1,3,5`)
+        /// </summary>
         In,
+        /// <summary>
+        /// Equivalent to SQL's `NOT IN` (`id-not-in=1,3,5`)
+        /// </summary>
         NotIn,
+        /// <summary>
+        /// Less than (`id-st=10`)
+        /// </summary>
         LessThan,
+        /// <summary>
+        /// Less than or equal to (`id-max=10`)
+        /// </summary>
         LessOrEqual,
+        /// <summary>
+        /// Greater than (`id-gt=5`)
+        /// </summary>
         GreaterThan,
+        /// <summary>
+        /// Greater than or equal to (`id-min=5`)
+        /// </summary>
         GreaterOrEqual,
+        /// <summary>
+        /// Match bits (`maturity_option-bitwise-and=5`)
+        /// </summary>
         BitwiseAnd,
     }