Files.com 1.6.266__tar.gz → 1.6.277__tar.gz

{files_com-1.6.266/files_com.egg-info → files_com-1.6.277}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.266
+Version: 1.6.277
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

files_com-1.6.277/_VERSION

@@ -0,0 +1 @@
+1.6.277

{files_com-1.6.266 → files_com-1.6.277/files_com.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.266
+Version: 1.6.277
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

{files_com-1.6.266 → files_com-1.6.277}/files_com.egg-info/SOURCES.txt

@@ -129,6 +129,7 @@ files_sdk/models/user_sftp_client_use.py
 files_sdk/models/web_dav_action_log.py
 files_sdk/models/webhook_test.py
 files_sdk/models/workspace.py
+files_sdk/models/zip_list_entry.py
 tests/test_account_line_item.py
 tests/test_action.py
 tests/test_action_notification_export.py
@@ -244,4 +245,5 @@ tests/test_user_request.py
 tests/test_user_sftp_client_use.py
 tests/test_web_dav_action_log.py
 tests/test_webhook_test.py
-tests/test_workspace.py
+tests/test_workspace.py
+tests/test_zip_list_entry.py

{files_com-1.6.266 → files_com-1.6.277}/files_sdk/__init__.py

@@ -112,6 +112,7 @@ import files_sdk.models.user_sftp_client_use as user_sftp_client_use
 import files_sdk.models.web_dav_action_log as web_dav_action_log
 import files_sdk.models.webhook_test as webhook_test
 import files_sdk.models.workspace as workspace
+import files_sdk.models.zip_list_entry as zip_list_entry
 
 from files_sdk.models.account_line_item import AccountLineItem
 from files_sdk.models.action import Action
@@ -234,6 +235,7 @@ from files_sdk.models.user_sftp_client_use import UserSftpClientUse
 from files_sdk.models.web_dav_action_log import WebDavActionLog
 from files_sdk.models.webhook_test import WebhookTest
 from files_sdk.models.workspace import Workspace
+from files_sdk.models.zip_list_entry import ZipListEntry
 
 import files_sdk.path_util
 import socket
@@ -245,7 +247,7 @@ session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.266"
+version = "1.6.277"
 
 __version__ = version
 

{files_com-1.6.266 → files_com-1.6.277}/files_sdk/models/__init__.py

@@ -119,3 +119,4 @@ from files_sdk.models.user_sftp_client_use import UserSftpClientUse
 from files_sdk.models.web_dav_action_log import WebDavActionLog
 from files_sdk.models.webhook_test import WebhookTest
 from files_sdk.models.workspace import Workspace
+from files_sdk.models.zip_list_entry import ZipListEntry

{files_com-1.6.266 → files_com-1.6.277}/files_sdk/models/automation_run.py

@@ -54,7 +54,7 @@ class AutomationRun:
 #   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 `automation_id`, `created_at` or `status`.
-#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
 #   automation_id (required) - int64 - ID of the associated Automation.
 def list(params=None, options=None):
     if not isinstance(params, dict):

{files_com-1.6.266 → files_com-1.6.277}/files_sdk/models/file.py

@@ -3,6 +3,7 @@ from builtins import open as builtin_open
 from datetime import datetime
 import io
 from pathlib import Path
+from files_sdk.models.zip_list_entry import ZipListEntry
 from files_sdk.models.file_action import FileAction
 from files_sdk.models.file_upload_part import FileUploadPart
 from files_sdk.api import Api  # noqa: F401
@@ -305,6 +306,27 @@ class File:
     def destroy(self, params=None):
         self.delete(params)
 
+    # List the contents of a ZIP file
+    def zip_list_contents(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "path") and self.path:
+            params["path"] = self.path
+        else:
+            raise MissingParameterError("Current object doesn't have a path")
+        if "path" not in params:
+            raise MissingParameterError("Parameter missing: path")
+        if "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        response, _options = Api.send_request(
+            "GET",
+            "/file_actions/zip_list/{path}".format(path=params["path"]),
+            params,
+            self.options,
+        )
+        return response.data
+
     # Copy File/Folder
     #
     # Parameters:
@@ -372,6 +394,41 @@ class File:
         )
         return response.data
 
+    # 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(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "path") and self.path:
+            params["path"] = self.path
+        else:
+            raise MissingParameterError("Current object doesn't have a path")
+        if "path" not in params:
+            raise MissingParameterError("Parameter missing: path")
+        if "destination" not in params:
+            raise MissingParameterError("Parameter missing: destination")
+        if "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        if "destination" in params and not isinstance(
+            params["destination"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: destination must be an str"
+            )
+        if "filename" in params and not isinstance(params["filename"], str):
+            raise InvalidParameterError(
+                "Bad parameter: filename must be an str"
+            )
+        response, _options = Api.send_request(
+            "POST", "/file_actions/unzip", params, self.options
+        )
+        return response.data
+
     # Begin File Upload
     #
     # Parameters:
@@ -640,6 +697,28 @@ def get(path, params=None, options=None):
     find(path, params, options)
 
 
+# List the contents of a ZIP file
+def zip_list_contents(path, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["path"] = path
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    response, options = Api.send_request(
+        "GET",
+        "/file_actions/zip_list/{path}".format(path=params["path"]),
+        params,
+        options,
+    )
+    return [
+        ZipListEntry(entity_data, options) for entity_data in response.data
+    ]
+
+
 # Copy File/Folder
 #
 # Parameters:
@@ -707,6 +786,65 @@ def move(path, params=None, options=None):
     return FileAction(response.data, options)
 
 
+# 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(path, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["path"] = path
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "destination" in params and not isinstance(params["destination"], str):
+        raise InvalidParameterError(
+            "Bad parameter: destination must be an str"
+        )
+    if "filename" in params and not isinstance(params["filename"], str):
+        raise InvalidParameterError("Bad parameter: filename must be an str")
+    if "overwrite" in params and not isinstance(params["overwrite"], bool):
+        raise InvalidParameterError("Bad parameter: overwrite must be an bool")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    if "destination" not in params:
+        raise MissingParameterError("Parameter missing: destination")
+    response, options = Api.send_request(
+        "POST", "/file_actions/unzip", params, options
+    )
+    return FileAction(response.data, options)
+
+
+# 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 zip(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "paths" in params and not isinstance(params["paths"], builtins.list):
+        raise InvalidParameterError("Bad parameter: paths must be an list")
+    if "destination" in params and not isinstance(params["destination"], str):
+        raise InvalidParameterError(
+            "Bad parameter: destination must be an str"
+        )
+    if "overwrite" in params and not isinstance(params["overwrite"], bool):
+        raise InvalidParameterError("Bad parameter: overwrite must be an bool")
+    if "paths" not in params:
+        raise MissingParameterError("Parameter missing: paths")
+    if "destination" not in params:
+        raise MissingParameterError("Parameter missing: destination")
+    response, options = Api.send_request(
+        "POST", "/file_actions/zip", params, options
+    )
+    return FileAction(response.data, options)
+
+
 # Begin File Upload
 #
 # Parameters:

{files_com-1.6.266 → files_com-1.6.277}/files_sdk/models/remote_server.py

@@ -20,6 +20,7 @@ class RemoteServer:
         "hostname": None,  # string - Hostname or IP address
         "remote_home_path": None,  # string - Initial home folder on remote server
         "upload_staging_path": None,  # string - Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
+        "allow_relative_paths": None,  # boolean - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
         "name": None,  # string - Internal name for your reference
         "description": None,  # string - Internal description for your reference
         "port": None,  # int64 - Port for remote server.
@@ -244,6 +245,7 @@ class RemoteServer:
     #   linode_secret_key - string - Linode: Secret Key
     #   s3_compatible_secret_key - string - S3-compatible: Secret Key
     #   wasabi_secret_key - string - Wasabi: Secret Key
+    #   allow_relative_paths - boolean - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
     #   aws_access_key - string - AWS Access Key.
     #   azure_blob_storage_account - string - Azure Blob Storage: Account name
     #   azure_blob_storage_container - string - Azure Blob Storage: Container name
@@ -820,6 +822,7 @@ def find_configuration_file(id, params=None, options=None):
 #   linode_secret_key - string - Linode: Secret Key
 #   s3_compatible_secret_key - string - S3-compatible: Secret Key
 #   wasabi_secret_key - string - Wasabi: Secret Key
+#   allow_relative_paths - boolean - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
 #   aws_access_key - string - AWS Access Key.
 #   azure_blob_storage_account - string - Azure Blob Storage: Account name
 #   azure_blob_storage_container - string - Azure Blob Storage: Container name
@@ -988,6 +991,12 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: wasabi_secret_key must be an str"
         )
+    if "allow_relative_paths" in params and not isinstance(
+        params["allow_relative_paths"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_relative_paths must be an bool"
+        )
     if "aws_access_key" in params and not isinstance(
         params["aws_access_key"], str
     ):
@@ -1389,6 +1398,7 @@ def configuration_file(id, params=None, options=None):
 #   linode_secret_key - string - Linode: Secret Key
 #   s3_compatible_secret_key - string - S3-compatible: Secret Key
 #   wasabi_secret_key - string - Wasabi: Secret Key
+#   allow_relative_paths - boolean - Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
 #   aws_access_key - string - AWS Access Key.
 #   azure_blob_storage_account - string - Azure Blob Storage: Account name
 #   azure_blob_storage_container - string - Azure Blob Storage: Container name
@@ -1559,6 +1569,12 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: wasabi_secret_key must be an str"
         )
+    if "allow_relative_paths" in params and not isinstance(
+        params["allow_relative_paths"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_relative_paths must be an bool"
+        )
     if "aws_access_key" in params and not isinstance(
         params["aws_access_key"], str
     ):

files_com-1.6.277/files_sdk/models/zip_list_entry.py

@@ -0,0 +1,40 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class ZipListEntry:
+    default_attributes = {
+        "path": None,  # 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": None,  # int64 - Uncompressed size in bytes.
+    }
+
+    def __init__(self, attributes=None, options=None):
+        if not isinstance(attributes, dict):
+            attributes = {}
+        if not isinstance(options, dict):
+            options = {}
+        self.set_attributes(attributes)
+        self.options = options
+
+    def set_attributes(self, attributes):
+        for (
+            attribute,
+            default_value,
+        ) in ZipListEntry.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in ZipListEntry.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+def new(*args, **kwargs):
+    return ZipListEntry(*args, **kwargs)

{files_com-1.6.266 → files_com-1.6.277}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "files_com"
-version = "1.6.266"
+version = "1.6.277"
 description = "Python bindings for the Files.com API"
 readme = "README.md"
 license = { text = "MIT" }

{files_com-1.6.266 → files_com-1.6.277}/tests/test_file.py

@@ -35,6 +35,14 @@ class FileTest(TestBase):
     # Alias of delete
     def test_destroy(self):
         pass
+    @unittest.skipUnless(TestBase.mock_server_path_exists("GET", "/file_actions/zip_list/{path}"), "Mock path does not exist")
+    def test_zip_list_contents(self):
+        params = {
+            "path" : "foo",
+        }
+        file = File(params)
+        file.zip_list_contents(params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/copy/{path}"), "Mock path does not exist")
     def test_copy(self):
         params = {
@@ -53,6 +61,15 @@ class FileTest(TestBase):
         file = File(params)
         file.move(params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/unzip"), "Mock path does not exist")
+    def test_unzip(self):
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+        }
+        file = File(params)
+        file.unzip(params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/begin_upload/{path}"), "Mock path does not exist")
     def test_begin_upload(self):
         params = {
@@ -103,6 +120,14 @@ class FileTest(TestBase):
         }
         file.find(path, params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("GET", "/file_actions/zip_list/{path}"), "Mock path does not exist")
+    def test_zip_list_contents(self):
+        path = "foo"
+        params = {
+            "path" : "foo",
+        }
+        file.zip_list_contents(path, params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/copy/{path}"), "Mock path does not exist")
     def test_copy(self):
         path = "foo"
@@ -121,6 +146,23 @@ class FileTest(TestBase):
         }
         file.move(path, params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/unzip"), "Mock path does not exist")
+    def test_unzip(self):
+        path = "foo"
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+        }
+        file.unzip(path, params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/zip"), "Mock path does not exist")
+    def test_zip(self):
+        params = {
+            "paths" : ["foo1"],
+            "destination" : "foo",
+        }
+        file.zip(params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/begin_upload/{path}"), "Mock path does not exist")
     def test_begin_upload(self):
         path = "foo"

files_com-1.6.277/tests/test_zip_list_entry.py

@@ -0,0 +1,14 @@
+import unittest
+import inspect
+import files_sdk
+from tests.base import TestBase
+from files_sdk.models import ZipListEntry
+from files_sdk import zip_list_entry
+
+class ZipListEntryTest(TestBase):
+    pass 
+    # Instance Methods
+
+    # Static Methods
+if __name__ == '__main__':
+    unittest.main()

files_com-1.6.266/_VERSION

@@ -1 +0,0 @@
-1.6.266