added support for Name (#61)

* added support for NAme

* added test suite

* updated readme

---------

Co-authored-by: ANKUR DWIVEDI <[email protected]>

Author: ankur-dwivedi

Imagekit.UnitTests/ImageKitRequestModelValidation.cs

@@ -141,6 +141,7 @@ public void GetFileListRequest_ModelValidation()
         {
             GetFileListRequest ob = new GetFileListRequest
             {
+                Name = "Test",
                 Limit = 10,
                 Skip = 20,
                 Type = "Test",
@@ -150,7 +151,7 @@ public void GetFileListRequest_ModelValidation()
                 FileType = "Test",
                 Tags = null
             };
-            string param = "sort=Test&path=Test&searchQuery=Test&fileType=Test&limit=10&skip=20";
+            string param = "sort=Test&path=Test&searchQuery=Test&fileType=Test&name=Test&limit=10&skip=20";
             string url = string.Format("https://api.imagekit.io/v1/files/?{0}", param);
 
             var mockHttp = new MockHttpMessageHandler();

Imagekit.UnitTests/ImageKitTestCasesAsync.cs

@@ -70,6 +70,33 @@ public void GetFileRequest_Default()
             Assert.Equal(responseObj.Raw, responseObj1);
         }
         [Fact]
+        public async void GetFileRequestByNameWithoutSearchQuery()
+        {
+            GetFileListRequest ob = new GetFileListRequest
+            {
+               
+                Name = "file_name.jpg",
+               
+            };
+            var responseObj = TestHelpers.ImagekitResponseFaker.Generate();
+
+            var httpResponse = new HttpResponseMessage
+            {
+                StatusCode = HttpStatusCode.OK,
+                Content = new StringContent(JsonConvert.SerializeObject(responseObj))
+            };
+            var httpClient = TestHelpers.GetTestHttpClient(httpResponse);
+            var restClient = new RestClient(GOOD_PUBLICKEY, GOOD_URLENDPOINT, httpClient);
+
+            var response = await restClient.GetFileListRequestAsync(ob);
+            // Console.WriteLine("res",response);
+            var responseObj1 = JsonConvert.SerializeObject(responseObj.Raw);
+            responseObj1 = JToken.Parse(responseObj1).ToString();
+
+            Assert.Equal(responseObj.Raw, responseObj1);
+            Console.WriteLine(responseObj.Raw);
+        }
+        [Fact]
         public void GetFileRequestByName()
         {
             GetFileListRequest ob = new GetFileListRequest

Imagekit/Helper/GetJsonBody.cs

@@ -383,6 +383,11 @@ public static string GetFileRequestBody(GetFileListRequest getFileListRequest)
                 options.Add("skip", getFileListRequest.Skip.ToString());
             }
 
+            if (getFileListRequest.Name != null)
+            {
+                options.Add("name", getFileListRequest.Name.ToString());
+            }
+
             foreach (KeyValuePair<string, string> entry in options)
             {
                 queryMaker.Add(string.Format("{0}={1}", entry.Key, entry.Value));

Imagekit/Imagekit.csproj

@@ -17,10 +17,10 @@
 		<Description>Library to Integrate Imagekit.io Service.</Description>
 		<PackageId>Imagekit</PackageId>
 		<PackOnBuild>true</PackOnBuild>
-		<ReleaseVersion>4.0.1</ReleaseVersion>
+		<ReleaseVersion>4.0.2</ReleaseVersion>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 		<SynchReleaseVersion>false</SynchReleaseVersion>
-		<Version>4.0.1</Version>
+		<Version>4.0.2</Version>
 		<RepositoryUrl>[email protected]:imagekit-developer/imagekit-dotnet.git</RepositoryUrl>
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 		<PackageReleaseNotes>-Fixes</PackageReleaseNotes>

Imagekit/Models/GetFileListRequest.cs

@@ -6,6 +6,8 @@ namespace Imagekit.Models
 {
     public class GetFileListRequest
     {
+        public string Name { get; set; }
+
         public string Type { get; set; }
 
         public string Sort { get; set; }

Imagekit/Util/Constants.cs

@@ -21,6 +21,6 @@ public static class Constants
         public const string UploadApiHost = "dasdasd.sadsdasd.io";
         public const string FileApi = "/v1/files";
         public const string UploadApi = "/api/v1/files/upload";
-        public const string SdkVersion = "4.0.1";
+        public const string SdkVersion = "4.0.2";
     }
 }

README.md

@@ -375,6 +375,9 @@ The SDK provides a simple interface for all the [media APIs mentioned here](http
 
 Accepts an object specifying the parameters to be used to list and search files. All parameters specified in the [documentation here](https://docs.imagekit.io/api-reference/media-api/list-and-search-files) can be passed as it is with the correct values to get the results.
 
+#### Applying Filters
+Filter out the files by specifying the parameters.
+
 ```cs
 GetFileListRequest model = new GetFileListRequest
 {
@@ -383,13 +386,25 @@ GetFileListRequest model = new GetFileListRequest
 	Limit = 10,
 	Skip = 0,
 	Sort = "ASC_CREATED",
-	SearchQuery = "createdAt >= \"7d\"",
 	FileType = "image",
 	Tags = new string[] { "tag1", "tag2" }
 };
-ResultList resp = await imagekit.GetFileDetail(model);
+ResultList res = await imagekit.GetFileListRequestAsync(model);
 ```
 
+#### Advance Search
+In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and providing this generated string as the value of the `SearchQuery`.
+
+```cs
+GetFileListRequest model = new GetFileListRequest
+{
+	SearchQuery = "createdAt >= '2d' OR size < '2mb' OR format='png'",
+};
+ResultList res = await imagekit.GetFileListRequestAsync(model);
+```
+
+Detailed documentation can be found here for [advance search queries](https://docs.imagekit.io/api-reference/media-api/list-and-search-files#advanced-search-queries).
+
 **2\. Get File Details**
 
 Accepts the file ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/get-file-details).