Files.com 1.6.402__tar.gz → 1.6.404__tar.gz

{files_com-1.6.402/files_com.egg-info → files_com-1.6.404}/PKG-INFO

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

files_com-1.6.404/_VERSION

@@ -0,0 +1 @@
+1.6.404

{files_com-1.6.402 → files_com-1.6.404/files_com.egg-info}/PKG-INFO

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

{files_com-1.6.402 → files_com-1.6.404}/files_sdk/__init__.py

@@ -294,7 +294,7 @@ source_ip = None
 workspace_id = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.402"
+version = "1.6.404"
 
 __version__ = version
 

{files_com-1.6.402 → files_com-1.6.404}/files_sdk/models/bundle.py

@@ -38,6 +38,7 @@ class Bundle:
         "deleted_at": None,  # date-time - Bundle deleted at date/time
         "dont_separate_submissions_by_folder": None,  # boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
         "max_uses": None,  # int64 - Maximum number of times bundle can be accessed
+        "internal_name": None,  # string - Internal name for identifying this Share Link.
         "note": None,  # string - Bundle internal note
         "path_template": None,  # string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
         "path_template_time_zone": None,  # string - Timezone to use when rendering timestamps in path templates.
@@ -135,6 +136,7 @@ class Bundle:
     #   inbox_id - int64 - ID of the associated inbox, if available.
     #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   group_id - int64 - Owning group ID. If set, members of this group can view, edit, and share this Share Link.
+    #   internal_name - string - Internal name for identifying this Share Link.
     #   note - string - Bundle internal note
     #   path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
     #   path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
@@ -209,6 +211,12 @@ class Bundle:
             raise InvalidParameterError(
                 "Bad parameter: group_id must be an int"
             )
+        if "internal_name" in params and not isinstance(
+            params["internal_name"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: internal_name must be an str"
+            )
         if "note" in params and not isinstance(params["note"], str):
             raise InvalidParameterError("Bad parameter: note must be an str")
         if "path_template" in params and not isinstance(
@@ -377,6 +385,7 @@ def get(id, params=None, options=None):
 #   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 #   max_uses - int64 - Maximum number of times bundle can be accessed
 #   group_id - int64 - Owning group ID. If set, members of this group can view, edit, and share this Share Link.
+#   internal_name - string - Internal name for identifying this Share Link.
 #   description - string - Public description
 #   note - string - Bundle internal note
 #   code - string - Bundle code.  This code forms the end part of the Public URL.
@@ -443,6 +452,12 @@ def create(params=None, options=None):
         raise InvalidParameterError("Bad parameter: max_uses must be an int")
     if "group_id" in params and not isinstance(params["group_id"], int):
         raise InvalidParameterError("Bad parameter: group_id must be an int")
+    if "internal_name" in params and not isinstance(
+        params["internal_name"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: internal_name must be an str"
+        )
     if "description" in params and not isinstance(params["description"], str):
         raise InvalidParameterError(
             "Bad parameter: description must be an str"
@@ -582,6 +597,7 @@ def share(id, params=None, options=None):
 #   inbox_id - int64 - ID of the associated inbox, if available.
 #   max_uses - int64 - Maximum number of times bundle can be accessed
 #   group_id - int64 - Owning group ID. If set, members of this group can view, edit, and share this Share Link.
+#   internal_name - string - Internal name for identifying this Share Link.
 #   note - string - Bundle internal note
 #   path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
 #   path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
@@ -660,6 +676,12 @@ def update(id, params=None, options=None):
         raise InvalidParameterError("Bad parameter: max_uses must be an int")
     if "group_id" in params and not isinstance(params["group_id"], int):
         raise InvalidParameterError("Bad parameter: group_id must be an int")
+    if "internal_name" in params and not isinstance(
+        params["internal_name"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: internal_name must be an str"
+        )
     if "note" in params and not isinstance(params["note"], str):
         raise InvalidParameterError("Bad parameter: note must be an str")
     if "path_template" in params and not isinstance(

{files_com-1.6.402 → files_com-1.6.404}/files_sdk/models/file.py

@@ -398,6 +398,63 @@ class File:
         )
         return response.data
 
+    # Transform a file and save the output to a destination path
+    #
+    # Parameters:
+    #   destination (required) - string - Destination file path for the transformed output.
+    #   transform_type (required) - string - Transform type. Supported values are `image_convert` and `document_convert`.
+    #   target_format (required) - string - Destination format to create.
+    #   width - int64 - Maximum output width for image_convert.
+    #   height - int64 - Maximum output height for image_convert.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def transform(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 "transform_type" not in params:
+            raise MissingParameterError("Parameter missing: transform_type")
+        if "target_format" not in params:
+            raise MissingParameterError("Parameter missing: target_format")
+        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 "transform_type" in params and not isinstance(
+            params["transform_type"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: transform_type must be an str"
+            )
+        if "target_format" in params and not isinstance(
+            params["target_format"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: target_format must be an str"
+            )
+        if "width" in params and not isinstance(params["width"], int):
+            raise InvalidParameterError("Bad parameter: width must be an int")
+        if "height" in params and not isinstance(params["height"], int):
+            raise InvalidParameterError("Bad parameter: height must be an int")
+        response, _options = Api.send_request(
+            "POST",
+            "/file_actions/transform/{path}".format(path=params["path"]),
+            params,
+            self.options,
+        )
+        return response.data
+
     # Decrypt a GPG-encrypted file and save it to a destination path
     #
     # Parameters:
@@ -909,6 +966,62 @@ def move(path, params=None, options=None):
     return FileAction(response.data, options)
 
 
+# Transform a file and save the output to a destination path
+#
+# Parameters:
+#   destination (required) - string - Destination file path for the transformed output.
+#   transform_type (required) - string - Transform type. Supported values are `image_convert` and `document_convert`.
+#   target_format (required) - string - Destination format to create.
+#   width - int64 - Maximum output width for image_convert.
+#   height - int64 - Maximum output height for image_convert.
+#   overwrite - boolean - Overwrite existing file in the destination?
+def transform(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 "transform_type" in params and not isinstance(
+        params["transform_type"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: transform_type must be an str"
+        )
+    if "target_format" in params and not isinstance(
+        params["target_format"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: target_format must be an str"
+        )
+    if "width" in params and not isinstance(params["width"], int):
+        raise InvalidParameterError("Bad parameter: width must be an int")
+    if "height" in params and not isinstance(params["height"], int):
+        raise InvalidParameterError("Bad parameter: height must be an int")
+    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")
+    if "transform_type" not in params:
+        raise MissingParameterError("Parameter missing: transform_type")
+    if "target_format" not in params:
+        raise MissingParameterError("Parameter missing: target_format")
+    response, options = Api.send_request(
+        "POST",
+        "/file_actions/transform/{path}".format(path=params["path"]),
+        params,
+        options,
+    )
+    return FileAction(response.data, options)
+
+
 # Decrypt a GPG-encrypted file and save it to a destination path
 #
 # Parameters:

{files_com-1.6.402 → files_com-1.6.404}/pyproject.toml

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

{files_com-1.6.402 → files_com-1.6.404}/tests/test_file.py

@@ -61,6 +61,17 @@ class FileTest(TestBase):
         file = File(params)
         file.move(params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/transform/{path}"), "Mock path does not exist")
+    def test_transform(self):
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+            "transform_type" : "foo",
+            "target_format" : "foo",
+        }
+        file = File(params)
+        file.transform(params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/gpg_decrypt/{path}"), "Mock path does not exist")
     def test_gpg_decrypt(self):
         params = {
@@ -164,6 +175,17 @@ class FileTest(TestBase):
         }
         file.move(path, params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/transform/{path}"), "Mock path does not exist")
+    def test_transform(self):
+        path = "foo"
+        params = {
+            "path" : "foo",
+            "destination" : "foo",
+            "transform_type" : "foo",
+            "target_format" : "foo",
+        }
+        file.transform(path, params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/gpg_decrypt/{path}"), "Mock path does not exist")
     def test_gpg_decrypt(self):
         path = "foo"

files_com-1.6.402/_VERSION

@@ -1 +0,0 @@
-1.6.402