files.com 1.1.758 → 1.1.759

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e917c5d08c3c750307bc35cb7aef5507439f60568f9596b7e0f45ed0a9c39a28
-  data.tar.gz: 6e82a18df76ec1f7aaf0a47282e074a3edabb4aa5f5edd5a9bbe5ef7945c0d5b
+  metadata.gz: 844199f222c0d7a81f7a17742192f06608db347a37872ff38e1cb6d07998c1ee
+  data.tar.gz: b84c2d7340036beafea02c69321fe1b718ff7370f847dff54af10d587572b276
 SHA512:
-  metadata.gz: e9b037ea4d58cf29c688aac0f84862a9f346cf8b9c1a88e2bad74b79756891a47cecdb6514c3c76e57492e2fa9a0d62a322f622b273b6826f6697ace8984e438
-  data.tar.gz: 1e9830c3a3c8c1be3dbcf19b549eb706747a00dc91343efbe954b31242c413496f47cb7a5d2bd91197373e6b8c4cfc376b2735c9dcfb1b396853634fe40463c4
+  metadata.gz: 773fa097b3fdbf512cbb946d82a367bf220606f3743b68c00cab6af1f2ed5ae011fa678d3d963a46384a301e86f605c2bdf9934488d37d0719c06a77236de6e0
+  data.tar.gz: ff3a484319e8e215f48ab3241f09d3dd9e548858f3e04441b3cff3f998e4233fa3971c07fd7241c3950d83f819648e6d85f1ff5a493c29a165d81ad2c6a51162

data/README.md

@@ -684,6 +684,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`TooManySharesError`|  `RateLimitedError` |
 |`AutomationsUnavailableError`|  `ServiceUnavailableError` |
 |`MigrationInProgressError`|  `ServiceUnavailableError` |
+|`SearchUnavailableError`|  `ServiceUnavailableError` |
 |`SiteDisabledError`|  `ServiceUnavailableError` |
 |`UploadsUnavailableError`|  `ServiceUnavailableError` |
 |`AccountAlreadyExistsError`|  `SiteConfigurationError` |

data/_VERSION

@@ -1 +1 @@
-1.1.758
+1.1.759

data/docs/folder.md

@@ -125,7 +125,7 @@ Files::Folder.list_for(path,
 * `path` (string): Required - Path to operate on.
 * `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 specified, will search the 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.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+* `search` (string): If specified, will search the 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.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process. During scheduled search maintenance, indexed searches return HTTP 422 with error type `service-unavailable/search-unavailable`; retry after maintenance ends. Folder listing without `search` remains available.
 * `search_custom_metadata_key` (string): If provided, the search string in `search` will search for files where this custom metadata key matches the value sent in `search`.  Set this to `*` to allow any metadata key to match the value sent in `search`.
 * `search_all` (boolean): Search entire site?  If true, we will search the entire site.  Do not provide a path when using this parameter.  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?

data/lib/files.com/errors.rb

@@ -257,6 +257,7 @@ module Files
   class ServiceUnavailableError < APIError; end
   class AutomationsUnavailableError < ServiceUnavailableError; end
   class MigrationInProgressError < ServiceUnavailableError; end
+  class SearchUnavailableError < ServiceUnavailableError; end
   class SiteDisabledError < ServiceUnavailableError; end
   class UploadsUnavailableError < ServiceUnavailableError; end
 

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

@@ -491,7 +491,7 @@ module Files
     #   path (required) - string - Path to operate on.
     #   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 specified, will search the 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.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+    #   search - string - If specified, will search the 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.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process. During scheduled search maintenance, indexed searches return HTTP 422 with error type `service-unavailable/search-unavailable`; retry after maintenance ends. Folder listing without `search` remains available.
     #   search_custom_metadata_key - string - If provided, the search string in `search` will search for files where this custom metadata key matches the value sent in `search`.  Set this to `*` to allow any metadata key to match the value sent in `search`.
     #   search_all - boolean - Search entire site?  If true, we will search the entire site.  Do not provide a path when using this parameter.  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?

data/lib/files.com/version.rb

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

metadata

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