files.com 1.1.186 → 1.1.188

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620caceed8d041f86ccb966010f80f6708936bb7d6176a05c97c19bc139cd3c1
-  data.tar.gz: 740fdc967930f91692e6426a3a711c52e8470cb0476e6cd60e058f87616569dd
+  metadata.gz: 436982bd53cec725451211974fd0b03bf5bac4e828386e4c6747d722e4f89680
+  data.tar.gz: 495052e1e6d4a0bf7eccadc884742170164da9aa79bb346d9b22c5488655ac2f
 SHA512:
-  metadata.gz: 07aa95ef57a284e2d35c74b1f0d2b0167a41bfcdab45f08f192b145ebdd526a0cbc40e71acd0b6f89663703b0cd4cddf2420f662515ea86223b68a4ffdbd94b5
-  data.tar.gz: 6e6714095b0a4026fc1198ea777d69924c23801ccbd3528227a468dcbd003de7c343320faa0f290e86dcdf5d99bfbcfd1d8b84e95200b9e5a44924b5fb9b69fb
+  metadata.gz: 0cd6d5b6fae5c067743d28e15f3916277d8eae5964685a68c5d0380bb80ef9b6dabc599c9166adb9262eaf4617985be81615c6bcfe49c1594daa20f5ad53b198
+  data.tar.gz: 2f0e629d1d9dca0309a91fd09e881f6c0baa682b8d91c2aa564a8206cc04e24ea5b126c7e46edd36be3b3ec270ff8f169141398e0fa79e4c09ac2ac75f4885df

data/README.md

@@ -345,6 +345,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`InvalidFilterAliasCombinationError`|  `BadRequestError` |
 |`InvalidFilterFieldError`|  `BadRequestError` |
 |`InvalidFilterParamError`|  `BadRequestError` |
+|`InvalidFilterParamFormatError`|  `BadRequestError` |
 |`InvalidFilterParamValueError`|  `BadRequestError` |
 |`InvalidInputEncodingError`|  `BadRequestError` |
 |`InvalidInterfaceError`|  `BadRequestError` |
@@ -499,25 +500,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`TrialLockedError`|  `SiteConfigurationError` |
 |`UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
 
-## Mock Server
-
-Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
-SDKs and other direct integrations against the Files.com API in an integration test environment.
-
-It is a Ruby app that operates as a minimal server for the purpose of testing basic network
-operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
-deeply inspect your submissions for correctness.
-
-Eventually we will add more features intended for integration testing, such as the ability to
-intentionally provoke errors.
-
-Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
-
-The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
-
-A README is available on the GitHub link.
-
-## File/Folder Operations
+## Examples
 
 The Files::File and Files::Dir models implement the standard Ruby API
 for File and Dir, respectively.  (Note that the Files.com SDK uses the
@@ -526,11 +509,15 @@ Files::Folder).
 
 ### Upload
 
+#### Upload a File
+
 ```ruby
-## Upload a file on disk.
-Files::upload_file("local.txt", "/remote.txt")
+Files::File.upload_file("local.txt", "remote.txt")
+```
+
+#### Upload Raw File Data
 
-## Upload raw file data.
+```ruby
 File.open("local.txt") do |local_file|
   Files::File.open("remote.txt", "w") do |remote_file|
     remote_file.write(local_file.read)
@@ -538,16 +525,78 @@ File.open("local.txt") do |local_file|
 end
 ```
 
+#### Create a Folder
+
+```ruby
+Files::Folder.create("path/to/folder/to/be/created",
+  mkdir_parents: true
+)
+```
+
 ### Download
 
+#### Download a File
+
 ```ruby
-Files::File.find("foo.txt").read
+Files::File.download_file("remote.txt", "local.txt")
 ```
 
 ### List
 
+#### List Folder Contents
+
 ```ruby
-Files::Folder.list_for("/").each do |file|
+Files::Folder.list_for("remote/path/to/folder/").each do |file|
   puts file.path
 end
 ```
+
+### Copy
+
+The copy method works for both files and folders.
+
+```ruby
+file = Files::File.new("source/path")
+file.copy(destination: "destination/path")
+```
+
+### Move
+
+The move method works for both files and folders.
+
+```ruby
+file = Files::File.new("source/path")
+file.move(destination: "destination/path")
+```
+
+### Delete
+
+The delete method works for both files and folders.
+
+```ruby
+Files::File.delete("path/to/file/or/folder")
+```
+
+In case the folder is not empty, you can use the `recursive` argument:
+
+```ruby
+Files::File.delete("path/to/folder", recursive: true)
+```
+
+## Mock Server
+
+Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+SDKs and other direct integrations against the Files.com API in an integration test environment.
+
+It is a Ruby app that operates as a minimal server for the purpose of testing basic network
+operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
+deeply inspect your submissions for correctness.
+
+Eventually we will add more features intended for integration testing, such as the ability to
+intentionally provoke errors.
+
+Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
+
+The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
+
+A README is available on the GitHub link.

data/_VERSION

@@ -1 +1 @@
-1.1.186
+1.1.188

data/docs/user.md

@@ -167,7 +167,7 @@ Files::User.list(
 
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required` or `username`.
 * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]` and `[ company, name ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.

data/lib/files.com/errors.rb

@@ -61,6 +61,7 @@ module Files
   class InvalidFilterAliasCombinationError < BadRequestError; end
   class InvalidFilterFieldError < BadRequestError; end
   class InvalidFilterParamError < BadRequestError; end
+  class InvalidFilterParamFormatError < BadRequestError; end
   class InvalidFilterParamValueError < BadRequestError; end
   class InvalidInputEncodingError < BadRequestError; end
   class InvalidInterfaceError < BadRequestError; end

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

@@ -836,7 +836,7 @@ module Files
     # Parameters:
     #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required` or `username`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]` and `[ company, name ]`.
     #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
     #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.

data/lib/files.com/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.186
+  version: 1.1.188
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable