files.com 1.1.521 → 1.1.523

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f97f841328ce55b8b6af2396e8ae1ae490f6af3728c26d0ef2619041e71db51
-  data.tar.gz: ed28506e03a339d33fb14f6b825bf690b3d1ea29b9358712d6b3f8c30f1730a3
+  metadata.gz: 1a87136180440e5be8891cd2d8f2e8ad7b9c427548ec76d5524b2a2ba4ea2ac0
+  data.tar.gz: c47f9f7702fffd25e1b257014a78c0deac92eb658a0773e2893d378fff4a4e1b
 SHA512:
-  metadata.gz: e8456512dc44ac96e5774883f6ec5d80ad7d220da7adc3af73d4163e79f5c258af1ca3f0f7beb7514c40acf74ffed0dc744b211af093febdaeb186ea1be80dc3
-  data.tar.gz: a198c8dec523f1ce75f990cf1aee36169a351c4777953eb96476172315a112cd0c38f82a451271cf427557b6343fb91520b074884abbd3419b4cc6c00ef55324
+  metadata.gz: 9ac15cc9b59b28e94813afd262e68aaf2865a6b0c2064473eac3bdc8b0ee3cf193054832f00111d61e74bddbc8552357ff36fb830f8153e3c94d376bed3fc660
+  data.tar.gz: d11fb3fca8098225ac1282b8f62fbb8662a1901866c6b9b8ea761c7c3f54a5bad0abed7f60abd7d3ca9c346e7c8a2ad6b230e9ca1b023c1d03b7253b5a3a28f4

data/_VERSION

@@ -1 +1 @@
-1.1.521
+1.1.523

data/docs/bundle.md

@@ -154,7 +154,7 @@ Files::Bundle.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 `expires_at`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

data/docs/file.md

@@ -212,6 +212,19 @@ Files::File.find(path,
 * `with_priority_color` (boolean): Include file priority color information?
 
 
+---
+
+## List the contents of a ZIP file
+
+```
+Files::File.zip_list_contents(path)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+
+
 ---
 
 ## Copy File/Folder
@@ -250,6 +263,44 @@ Files::File.move(path,
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
 
 
+---
+
+## Extract a ZIP file to a destination folder
+
+```
+Files::File.unzip(path, 
+  destination: "destination", 
+  overwrite: false
+)
+```
+
+### Parameters
+
+* `path` (string): Required - ZIP file path to extract.
+* `destination` (string): Required - Destination folder path for extracted files.
+* `filename` (string): Optional single entry filename to extract.
+* `overwrite` (boolean): Overwrite existing files in the destination?
+
+
+---
+
+## Create a ZIP from one or more paths and save it to a destination path
+
+```
+Files::File.zip(
+  paths: "paths", 
+  destination: "destination", 
+  overwrite: false
+)
+```
+
+### Parameters
+
+* `paths` (array(string)): Required - Paths to include in the ZIP.
+* `destination` (string): Required - Destination file path for the ZIP.
+* `overwrite` (boolean): Overwrite existing file in the destination?
+
+
 ---
 
 ## Begin File Upload
@@ -340,6 +391,21 @@ file.delete(
 * `recursive` (boolean): If true, will recursively delete folders.  Otherwise, will error on non-empty folders.
 
 
+---
+
+## List the contents of a ZIP file
+
+```
+file = Files::File.find(path)
+
+file.zip_list_contents
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+
+
 ---
 
 ## Copy File/Folder
@@ -382,6 +448,27 @@ file.move(
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
 
 
+---
+
+## Extract a ZIP file to a destination folder
+
+```
+file = Files::File.find(path)
+
+file.unzip(
+  destination: "destination",
+  overwrite: false
+)
+```
+
+### Parameters
+
+* `path` (string): Required - ZIP file path to extract.
+* `destination` (string): Required - Destination folder path for extracted files.
+* `filename` (string): Optional single entry filename to extract.
+* `overwrite` (boolean): Overwrite existing files in the destination?
+
+
 ---
 
 ## Begin File Upload

data/docs/zip_list_entry.md

@@ -0,0 +1,13 @@
+# ZipListEntry
+
+## Example ZipListEntry Object
+
+```
+{
+  "path": "example",
+  "size": 1
+}
+```
+
+* `path` (string): Entry path inside the ZIP. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `size` (int64): Uncompressed size in bytes.

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

@@ -531,7 +531,7 @@ module Files
     #   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 `expires_at`.
-    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
     #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
     #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
     #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

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

@@ -1019,6 +1019,17 @@ module Files
       nil
     end
 
+    # List the contents of a ZIP file
+    def zip_list_contents(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+
+      Api.send_request("/file_actions/zip_list/#{@attributes[:path]}", :get, params, @options)
+    end
+
     # Copy File/Folder
     #
     # Parameters:
@@ -1054,6 +1065,25 @@ module Files
       Api.send_request("/file_actions/move/#{@attributes[:path]}", :post, params, @options)
     end
 
+    # Extract a ZIP file to a destination folder
+    #
+    # Parameters:
+    #   destination (required) - string - Destination folder path for extracted files.
+    #   filename - string - Optional single entry filename to extract.
+    #   overwrite - boolean - Overwrite existing files in the destination?
+    def unzip(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: filename must be an String") if params[:filename] and !params[:filename].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+      raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
+
+      Api.send_request("/file_actions/unzip", :post, params, @options)
+    end
+
     # Begin File Upload
     #
     # Parameters:
@@ -1193,6 +1223,19 @@ module Files
       find(path, params, options)
     end
 
+    # List the contents of a ZIP file
+    def self.zip_list_contents(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+
+      response, options = Api.send_request("/file_actions/zip_list/#{params[:path]}", :get, params, options)
+      response.data.map do |entity_data|
+        ZipListEntry.new(entity_data, options)
+      end
+    end
+
     # Copy File/Folder
     #
     # Parameters:
@@ -1228,6 +1271,39 @@ module Files
       FileAction.new(response.data, options)
     end
 
+    # Extract a ZIP file to a destination folder
+    #
+    # Parameters:
+    #   destination (required) - string - Destination folder path for extracted files.
+    #   filename - string - Optional single entry filename to extract.
+    #   overwrite - boolean - Overwrite existing files in the destination?
+    def self.unzip(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: filename must be an String") if params[:filename] and !params[:filename].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+      raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
+
+      response, options = Api.send_request("/file_actions/unzip", :post, params, options)
+      FileAction.new(response.data, options)
+    end
+
+    # Parameters:
+    #   paths (required) - array(string) - Paths to include in the ZIP.
+    #   destination (required) - string - Destination file path for the ZIP.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def self.zip(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params[:paths] and !params[:paths].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: paths") unless params[:paths]
+      raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
+
+      response, options = Api.send_request("/file_actions/zip", :post, params, options)
+      FileAction.new(response.data, options)
+    end
+
     # Begin File Upload
     #
     # Parameters:

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Files
+  class ZipListEntry
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Entry path inside the ZIP. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    def path
+      @attributes[:path]
+    end
+
+    # int64 - Uncompressed size in bytes.
+    def size
+      @attributes[:size]
+    end
+  end
+end

data/lib/files.com/version.rb

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

data/lib/files.com.rb

@@ -145,6 +145,7 @@ require "files.com/models/user_sftp_client_use"
 require "files.com/models/web_dav_action_log"
 require "files.com/models/webhook_test"
 require "files.com/models/workspace"
+require "files.com/models/zip_list_entry"
 
 require "files.com/models/dir"
 require "files.com/models/file_utils"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.521
+  version: 1.1.523
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-01-23 00:00:00.000000000 Z
+date: 2026-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -270,6 +270,7 @@ files:
 - docs/web_dav_action_log.md
 - docs/webhook_test.md
 - docs/workspace.md
+- docs/zip_list_entry.md
 - files.com.gemspec
 - lib/files.com.rb
 - lib/files.com/api.rb
@@ -391,6 +392,7 @@ files:
 - lib/files.com/models/web_dav_action_log.rb
 - lib/files.com/models/webhook_test.rb
 - lib/files.com/models/workspace.rb
+- lib/files.com/models/zip_list_entry.rb
 - lib/files.com/path_util.rb
 - lib/files.com/response.rb
 - lib/files.com/sizable_io.rb