Files.com 1.6.426__tar.gz → 1.6.428__tar.gz

{files_com-1.6.426/files_com.egg-info → files_com-1.6.428}/PKG-INFO

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

files_com-1.6.428/_VERSION

@@ -0,0 +1 @@
+1.6.428

{files_com-1.6.426 → files_com-1.6.428/files_com.egg-info}/PKG-INFO

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

{files_com-1.6.426 → files_com-1.6.428}/files_com.egg-info/SOURCES.txt

@@ -34,6 +34,7 @@ files_sdk/models/as2_station.py
 files_sdk/models/auto.py
 files_sdk/models/automation.py
 files_sdk/models/automation_authoring_schema.py
+files_sdk/models/automation_execution_node.py
 files_sdk/models/automation_log.py
 files_sdk/models/automation_run.py
 files_sdk/models/bandwidth_snapshot.py
@@ -176,6 +177,7 @@ tests/test_as2_station.py
 tests/test_auto.py
 tests/test_automation.py
 tests/test_automation_authoring_schema.py
+tests/test_automation_execution_node.py
 tests/test_automation_log.py
 tests/test_automation_run.py
 tests/test_bandwidth_snapshot.py

{files_com-1.6.426 → files_com-1.6.428}/files_sdk/__init__.py

@@ -17,6 +17,7 @@ import files_sdk.models.as2_station as as2_station
 import files_sdk.models.auto as auto
 import files_sdk.models.automation as automation
 import files_sdk.models.automation_authoring_schema as automation_authoring_schema
+import files_sdk.models.automation_execution_node as automation_execution_node
 import files_sdk.models.automation_log as automation_log
 import files_sdk.models.automation_run as automation_run
 import files_sdk.models.bandwidth_snapshot as bandwidth_snapshot
@@ -165,6 +166,7 @@ from files_sdk.models.automation import Automation
 from files_sdk.models.automation_authoring_schema import (
     AutomationAuthoringSchema,
 )
+from files_sdk.models.automation_execution_node import AutomationExecutionNode
 from files_sdk.models.automation_log import AutomationLog
 from files_sdk.models.automation_run import AutomationRun
 from files_sdk.models.bandwidth_snapshot import BandwidthSnapshot
@@ -310,7 +312,7 @@ source_ip = None
 workspace_id = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.426"
+version = "1.6.428"
 
 __version__ = version
 

{files_com-1.6.426 → files_com-1.6.428}/files_sdk/models/__init__.py

@@ -22,6 +22,7 @@ from files_sdk.models.automation import Automation
 from files_sdk.models.automation_authoring_schema import (
     AutomationAuthoringSchema,
 )
+from files_sdk.models.automation_execution_node import AutomationExecutionNode
 from files_sdk.models.automation_log import AutomationLog
 from files_sdk.models.automation_run import AutomationRun
 from files_sdk.models.bandwidth_snapshot import BandwidthSnapshot

{files_com-1.6.426 → files_com-1.6.428}/files_sdk/models/automation.py

@@ -28,6 +28,7 @@ class Automation:
         "disabled": None,  # boolean - If true, this automation will not run.
         "exclude_pattern": None,  # string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
         "import_urls": None,  # array(object) - List of URLs to be imported and names to be used.
+        "inbound_email_address": None,  # string - If trigger is `email`, this is the address that triggers the Automation.
         "flatten_destination_structure": None,  # boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
         "group_ids": None,  # array(int64) - IDs of Groups for the Automation (i.e. who to Request File from)
         "ignore_locked_folders": None,  # boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
@@ -80,7 +81,33 @@ class Automation:
         }
         return attrs
 
-    # Manually Run Automation
+    # Upgrade a legacy Automation to Automation v2
+    def upgrade(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "id") and self.id:
+            params["id"] = self.id
+        else:
+            raise MissingParameterError("Current object doesn't have a id")
+        if "id" not in params:
+            raise MissingParameterError("Parameter missing: id")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        response, _options = Api.send_request(
+            "POST",
+            "/automations/{id}/upgrade".format(
+                id=quote(str(params["id"]), safe="")
+            ),
+            params,
+            self.options,
+        )
+        return response.data
+
+    # Manually Run Automation. v2 Automations require Site or Workspace Admin permission
+    #
+    # Parameters:
+    #   items - array(object) - Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
     def manual_run(self, params=None):
         if not isinstance(params, dict):
             params = {}
@@ -93,6 +120,10 @@ class Automation:
             raise MissingParameterError("Parameter missing: id")
         if "id" in params and not isinstance(params["id"], int):
             raise InvalidParameterError("Bad parameter: id must be an int")
+        if "items" in params and not isinstance(
+            params["items"], builtins.list
+        ):
+            raise InvalidParameterError("Bad parameter: items must be an list")
         Api.send_request(
             "POST",
             "/automations/{id}/manual_run".format(
@@ -603,7 +634,32 @@ def create(params=None, options=None):
     return Automation(response.data, options)
 
 
-# Manually Run Automation
+# Upgrade a legacy Automation to Automation v2
+def upgrade(id, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["id"] = id
+    if "id" in params and not isinstance(params["id"], int):
+        raise InvalidParameterError("Bad parameter: id must be an int")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "POST",
+        "/automations/{id}/upgrade".format(
+            id=quote(str(params["id"]), safe="")
+        ),
+        params,
+        options,
+    )
+    return Automation(response.data, options)
+
+
+# Manually Run Automation. v2 Automations require Site or Workspace Admin permission
+#
+# Parameters:
+#   items - array(object) - Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
 def manual_run(id, params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -612,6 +668,8 @@ def manual_run(id, params=None, options=None):
     params["id"] = id
     if "id" in params and not isinstance(params["id"], int):
         raise InvalidParameterError("Bad parameter: id must be an int")
+    if "items" in params and not isinstance(params["items"], builtins.list):
+        raise InvalidParameterError("Bad parameter: items must be an list")
     if "id" not in params:
         raise MissingParameterError("Parameter missing: id")
     Api.send_request(

{files_com-1.6.426 → files_com-1.6.428}/files_sdk/models/automation_authoring_schema.py

@@ -12,6 +12,7 @@ class AutomationAuthoringSchema:
         "definition_schema": None,  # object - JSON Schema for active Automation v2 graph definitions.
         "error_families": None,  # array(object) - Typed error families accepted by Automation v2 on_error rules.
         "nodes": None,  # array(object) - Active Automation v2 node authoring metadata.
+        "schema_url": None,  # string - Stable public URL for the Automation v2 graph definition JSON Schema.
     }
 
     def __init__(self, attributes=None, options=None):

files_com-1.6.428/files_sdk/models/automation_execution_node.py

@@ -0,0 +1,54 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class AutomationExecutionNode:
+    default_attributes = {
+        "node_id": None,  # string - Node ID from the pinned Automation definition.
+        "node_type": None,  # string - Node type.
+        "status": None,  # string - Node status.
+        "run_stage": None,  # string - Current node execution stage.
+        "reused": None,  # boolean - Whether this node reused persisted output from an earlier run.
+        "successful_operations": None,  # int64 - Count of successful operations in this node.
+        "failed_operations": None,  # int64 - Count of failed operations in this node.
+        "started_at": None,  # date-time - When this node started.
+        "completed_at": None,  # date-time - When this node completed.
+        "duration_ms": None,  # int64 - Node runtime in milliseconds.
+        "inputs": None,  # array(object) - Ordered inbound edge references.
+        "outputs": None,  # object - Output counts, item kinds, and typed-error summaries by outlet.
+        "input_items": None,  # object - Materialized input items currently available, grouped by inlet.
+        "output_items": None,  # object - Materialized output items grouped by outlet.
+    }
+
+    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 AutomationExecutionNode.default_attributes.items():
+            value = attributes.get(attribute, default_value)
+            setattr(self, attribute, value)
+
+    def get_attributes(self):
+        attrs = {
+            k: getattr(self, k, None)
+            for k in AutomationExecutionNode.default_attributes
+            if getattr(self, k, None) is not None
+        }
+        return attrs
+
+
+def new(*args, **kwargs):
+    return AutomationExecutionNode(*args, **kwargs)