files.com 1.1.170 → 1.1.171

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bec5c3ab068720a1e61fbac4bbacbb7bc774d168d54ce0c7ac3fc532165c43d
-  data.tar.gz: e54526612d35ded8063ba6291c880f09c12fc20a542dfd97ae8531d22713f0e7
+  metadata.gz: 7d19b0cd3a4eeb6e7e3534cba99ad43f6b929af41b58a625aa783f98b73e70df
+  data.tar.gz: ccd21731f2e64291248e69db69cf2be2253d4a353d551fb604bb9e4e541aa7d0
 SHA512:
-  metadata.gz: daca73e090ca96c31da73622c7ce1e7bcd29276401f860b6b085a97a66d6062139ee950696c00b63b26fc5b95918c6f656323549e67ec7e70cb322f739abcd16
-  data.tar.gz: 8bb6a75260ba6884407a8fc606da87d885c984079ecc6be9475c3513ac9928359d9129f2d9bbc1c6e73cffb4e4a968f60f93b9be7f5154fca87ea306c1c2a021
+  metadata.gz: 167deddace8f8721e1777d67e05f4bd6a3b9af65daa7fe9124c9a75c64cecd9d6b54258121d4998407af2a5baf8db27e422440431d740d7517a5a5b6a0f8cf49
+  data.tar.gz: 04cff6c35a74784370b166434448177b96bb704db618e0c037335494d9c39f55a9cc11eee7018ba1f3f77c4f9447de16ecc4502a9031caf7db2f3980c4ecb2d8

data/_VERSION

@@ -1 +1 @@
-1.1.170
+1.1.171

data/docs/folder.md

@@ -99,6 +99,7 @@ Files::Dir is an alias of Files::Folder
 
 ```
 Files::Folder.list_for(path, 
+  search: "some-partial-filename", 
   search_all: true, 
   with_previews: true, 
   with_priority_color: true
@@ -110,10 +111,9 @@ Files::Folder.list_for(path,
 * `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `path` (string): Required - Path to operate on.
-* `filter` (string): If specified, will filter folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-* `search` (string): If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
+* `search` (string): If specified, will filter folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `search_all` (boolean): Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `with_previews` (boolean): Include file previews?
 * `with_priority_color` (boolean): Include file priority color information?

data/lib/files.com/models/folder.rb

@@ -480,10 +480,9 @@ module Files
     #   cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   path (required) - string - Path to operate on.
-    #   filter - string - If specified, will filter folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
     #   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-    #   search - string - If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
+    #   search - string - If specified, will filter folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
     #   search_all - boolean - Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
     #   with_previews - boolean - Include file previews?
     #   with_priority_color - boolean - Include file priority color information?
@@ -493,7 +492,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: filter must be an String") if params[:filter] and !params[:filter].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params[:preview_size] and !params[:preview_size].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: search must be an String") if params[:search] and !params[:search].is_a?(String)

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.170"
+  VERSION = "1.1.171"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.170
+  version: 1.1.171
 platform: ruby
 authors:
 - files.com