files.com 1.1.213 → 1.1.215

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa1b1dabdffac54052c89ac87f15ee9ac650bdc965d70828f4e1bc4e7751ec3
-  data.tar.gz: 7ddc9231cfbb86f353f343e89214aa36618fade837ca97f615d555b6d502a95a
+  metadata.gz: bbd484d37bc76b30ccf6b83aecbd6dc3ea290bc48e7ffc800c88eaf01789dfad
+  data.tar.gz: 55474dd7880a576b0841db13709743c563811943b41c3c0adbe1f81517e5abf3
 SHA512:
-  metadata.gz: d80ba5f257c67eddd460a67a60f5f857e21bbddd2f7afbb73e96786d5e2a1358b78ff8971e5e73f4227fe9fe2f1c921135e5f0d9d670a0101a1c2a999ce81fc6
-  data.tar.gz: 3f373231f8e777bc9eec36c09301732b5d1b30a346c52bbce762429ebbef2b22459352450880308b3ed6f4c49e688d7d86ab366e93cc7ecb5c5ca4734a29d436
+  metadata.gz: 216284c45420dab170114d42625eb036252146d1377130405c8d64f3f818ec0150becb73c61b51d6fba20a79ad0575207451f435b13be81d4eeb179038a8d524
+  data.tar.gz: bef4589ef41d24231b12d7c5e320aea30e9cb1ace59120226ed51ed3f2f57fca80856023150ff656a6615f58a6f17d472920286b8e070fb273f414cf71d47214

data/README.md

@@ -557,6 +557,28 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`TrialLockedError`|  `SiteConfigurationError` |
 |`UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
 
+## {frontmatter.title}
+
+Certain API operations return lists of objects. When the number of objects in the list is large,
+the API will paginate the results.
+
+The Files.com Ruby SDK automatically paginates through lists of objects by default.
+
+```ruby title="Example Request" hasDataFormatSelector
+begin
+  files = Files::Folder.list_for(path,
+    search: "some-partial-filename"
+  )
+  files.auto_paging_each do |file|
+    # Operate on file
+  end
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
+```
+
 ## Case Sensitivity
 
 The Files.com API compares files and paths in a case-insensitive manner.

data/_VERSION

@@ -1 +1 @@
-1.1.213
+1.1.215

data/docs/permission.md

@@ -11,7 +11,8 @@
   "group_id": 1,
   "group_name": "example",
   "permission": "full",
-  "recursive": true
+  "recursive": true,
+  "site_id": 1
 }
 ```
 
@@ -23,6 +24,7 @@
 * `group_name` (string): Group name (if applicable)
 * `permission` (string): Permission type.  See the table referenced in the documentation for an explanation of each permission.
 * `recursive` (boolean): Recursive: does this permission apply to subfolders?
+* `site_id` (int64): Site ID
 
 
 ---
@@ -42,7 +44,7 @@ Files::Permission.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 `group_id`, `path` or `user_id`.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path` or `user_id`.
 * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]` or `[ user_id, group_id ]`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
 * `path` (string): Permission path.  If provided, will scope all permissions(including upward) to this path.
@@ -63,7 +65,8 @@ Files::Permission.create(
   recursive: false, 
   user_id: 1, 
   username: "user", 
-  group_name: "example"
+  group_name: "example", 
+  site_id: 1
 )
 ```
 
@@ -76,6 +79,7 @@ Files::Permission.create(
 * `user_id` (int64): User ID.  Provide `username` or `user_id`
 * `username` (string): User username.  Provide `username` or `user_id`
 * `group_name` (string): Group name.  Provide `group_name` or `group_id`
+* `site_id` (int64): Site ID. If not provided, will default to current site. Used when creating a permission for a child site.
 
 
 ---

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

@@ -81,6 +81,15 @@ module Files
       @attributes[:recursive] = value
     end
 
+    # int64 - Site ID
+    def site_id
+      @attributes[:site_id]
+    end
+
+    def site_id=(value)
+      @attributes[:site_id] = value
+    end
+
     def delete(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -110,7 +119,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 `group_id`, `path` or `user_id`.
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path` or `user_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]` or `[ user_id, group_id ]`.
     #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
     #   path - string - Permission path.  If provided, will scope all permissions(including upward) to this path.
@@ -144,6 +153,7 @@ module Files
     #   user_id - int64 - User ID.  Provide `username` or `user_id`
     #   username - string - User username.  Provide `username` or `user_id`
     #   group_name - string - Group name.  Provide `group_name` or `group_id`
+    #   site_id - int64 - Site ID. If not provided, will default to current site. Used when creating a permission for a child site.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
@@ -151,6 +161,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: group_name must be an String") if params[:group_name] and !params[:group_name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: site_id must be an Integer") if params[:site_id] and !params[:site_id].is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params[:path]
 
       response, options = Api.send_request("/permissions", :post, params, options)

data/lib/files.com/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.213
+  version: 1.1.215
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable