Files.com 1.6.520__tar.gz → 1.6.522__tar.gz

{files_com-1.6.520/files_com.egg-info → files_com-1.6.522}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.520
+Version: 1.6.522
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5
@@ -66,7 +66,7 @@ the method used in the examples on this site.
 
 To use an API Key, first generate an API key from the [web
 interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
-SDK](/python/resources/developers/api-keys).
+SDK](https://developers.files.com/python/resources/developers/api-keys).
 
 Note that when using a user-specific API key, if the user is an administrator, you will have full
 access to the entire API. If the user is not an administrator, you will only be able to access files

{files_com-1.6.520 → files_com-1.6.522}/README.md

@@ -54,7 +54,7 @@ the method used in the examples on this site.
 
 To use an API Key, first generate an API key from the [web
 interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
-SDK](/python/resources/developers/api-keys).
+SDK](https://developers.files.com/python/resources/developers/api-keys).
 
 Note that when using a user-specific API key, if the user is an administrator, you will have full
 access to the entire API. If the user is not an administrator, you will only be able to access files

files_com-1.6.522/_VERSION

@@ -0,0 +1 @@
+1.6.522

{files_com-1.6.520 → files_com-1.6.522/files_com.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.520
+Version: 1.6.522
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5
@@ -66,7 +66,7 @@ the method used in the examples on this site.
 
 To use an API Key, first generate an API key from the [web
 interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
-SDK](/python/resources/developers/api-keys).
+SDK](https://developers.files.com/python/resources/developers/api-keys).
 
 Note that when using a user-specific API key, if the user is an administrator, you will have full
 access to the entire API. If the user is not an administrator, you will only be able to access files

{files_com-1.6.520 → files_com-1.6.522}/files_sdk/__init__.py

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

{files_com-1.6.520 → files_com-1.6.522}/files_sdk/models/as2_partner.py

@@ -21,7 +21,7 @@ class As2Partner:
         "additional_http_headers": None,  # object - Additional HTTP Headers for outgoing message sent to this partner.
         "default_mime_type": None,  # string - Default mime type of the file attached to the encrypted message
         "mdn_validation_level": None,  # string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
-        "signature_validation_level": None,  # string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
+        "signature_validation_level": None,  # string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
         "enable_dedicated_ips": None,  # boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
         "hex_public_certificate_serial": None,  # string - Serial of public certificate used for message security in hex format.
         "public_certificate": None,  # string - Public certificate used for message security.
@@ -62,7 +62,7 @@ class As2Partner:
     #   http_auth_username - string - Username to send to server for HTTP Authentication.
     #   http_auth_password - string - Password to send to server for HTTP Authentication.
     #   mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
-    #   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
+    #   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
     #   server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
     #   default_mime_type - string - Default mime type of the file attached to the encrypted message
     #   additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.
@@ -233,7 +233,7 @@ def get(id, params=None, options=None):
 #   http_auth_username - string - Username to send to server for HTTP Authentication.
 #   http_auth_password - string - Password to send to server for HTTP Authentication.
 #   mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
-#   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
+#   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
 #   server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
 #   default_mime_type - string - Default mime type of the file attached to the encrypted message
 #   additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.
@@ -337,7 +337,7 @@ def create(params=None, options=None):
 #   http_auth_username - string - Username to send to server for HTTP Authentication.
 #   http_auth_password - string - Password to send to server for HTTP Authentication.
 #   mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
-#   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
+#   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: A one-time starting state. The next message received is always accepted and switches this to `normal` if it carries a valid signature, or `none` if it does not.
 #   server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
 #   default_mime_type - string - Default mime type of the file attached to the encrypted message
 #   additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.

{files_com-1.6.520 → files_com-1.6.522}/files_sdk/models/file.py

@@ -395,6 +395,32 @@ class File:
         )
         return response.data
 
+    # Delete File/Folder and return its File Action.  A pending or processing deletion continues in the background after this returns; check its File Migration for completion.  Waiting for the File Migration does not cancel the deletion
+    #
+    # Parameters:
+    #   recursive - boolean - If true, will recursively delete folders.  Otherwise, will error on non-empty folders.
+    def begin_delete(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(
+            "POST",
+            "/file_actions/delete/{path}".format(
+                path=quote(str(params["path"]), safe="")
+            ),
+            params,
+            self.options,
+        )
+        return response.data
+
     # Copy File/Folder
     #
     # Parameters:
@@ -1010,6 +1036,33 @@ def zip_list_contents(path, params=None, options=None):
     ]
 
 
+# Delete File/Folder and return its File Action.  A pending or processing deletion continues in the background after this returns; check its File Migration for completion.  Waiting for the File Migration does not cancel the deletion
+#
+# Parameters:
+#   recursive - boolean - If true, will recursively delete folders.  Otherwise, will error on non-empty folders.
+def begin_delete(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 "recursive" in params and not isinstance(params["recursive"], bool):
+        raise InvalidParameterError("Bad parameter: recursive must be an bool")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    response, options = Api.send_request(
+        "POST",
+        "/file_actions/delete/{path}".format(
+            path=quote(str(params["path"]), safe="")
+        ),
+        params,
+        options,
+    )
+    return FileAction(response.data, options)
+
+
 # Copy File/Folder
 #
 # Parameters:

{files_com-1.6.520 → files_com-1.6.522}/files_sdk/models/file_action.py

@@ -10,7 +10,7 @@ from files_sdk.error import (  # noqa: F401
 class FileAction:
     default_attributes = {
         "status": None,  # string - Status of file operation.
-        "file_migration_id": None,  # int64 - If status is pending, this is the id of the File Migration to check for status updates.
+        "file_migration_id": None,  # int64 - If status is pending, this is the id of the File Migration to check for status updates.  Delete actions include it whenever the deletion runs as a File Migration, including while it is processing.
         "path": None,
         "destination": None,
     }

{files_com-1.6.520 → files_com-1.6.522}/pyproject.toml

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

{files_com-1.6.520 → files_com-1.6.522}/tests/test_file.py

@@ -43,6 +43,14 @@ class FileTest(TestBase):
         file = File(params)
         file.zip_list_contents(params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/delete/{path}"), "Mock path does not exist")
+    def test_begin_delete(self):
+        params = {
+            "path" : "foo",
+        }
+        file = File(params)
+        file.begin_delete(params)
+
     @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/copy/{path}"), "Mock path does not exist")
     def test_copy(self):
         params = {
@@ -157,6 +165,14 @@ class FileTest(TestBase):
         }
         file.zip_list_contents(path, params)
 
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/file_actions/delete/{path}"), "Mock path does not exist")
+    def test_begin_delete(self):
+        path = "foo"
+        params = {
+            "path" : "foo",
+        }
+        file.begin_delete(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"

files_com-1.6.520/_VERSION

@@ -1 +0,0 @@
-1.6.520