Files.com 1.6.343__tar.gz → 1.6.345__tar.gz

{files_com-1.6.343/files_com.egg-info → files_com-1.6.345}/PKG-INFO

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

files_com-1.6.345/_VERSION

@@ -0,0 +1 @@
+1.6.345

{files_com-1.6.343 → files_com-1.6.345/files_com.egg-info}/PKG-INFO

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

{files_com-1.6.343 → files_com-1.6.345}/files_com.egg-info/SOURCES.txt

@@ -86,6 +86,7 @@ files_sdk/models/message.py
 files_sdk/models/message_comment.py
 files_sdk/models/message_comment_reaction.py
 files_sdk/models/message_reaction.py
+files_sdk/models/metadata_category.py
 files_sdk/models/notification.py
 files_sdk/models/outbound_connection_log.py
 files_sdk/models/partner.py
@@ -122,6 +123,7 @@ files_sdk/models/style.py
 files_sdk/models/sync.py
 files_sdk/models/sync_log.py
 files_sdk/models/sync_run.py
+files_sdk/models/sync_run_live_transfer.py
 files_sdk/models/usage_by_top_level_dir.py
 files_sdk/models/usage_daily_snapshot.py
 files_sdk/models/usage_snapshot.py
@@ -207,6 +209,7 @@ tests/test_message.py
 tests/test_message_comment.py
 tests/test_message_comment_reaction.py
 tests/test_message_reaction.py
+tests/test_metadata_category.py
 tests/test_notification.py
 tests/test_outbound_connection_log.py
 tests/test_partner.py
@@ -244,6 +247,7 @@ tests/test_style.py
 tests/test_sync.py
 tests/test_sync_log.py
 tests/test_sync_run.py
+tests/test_sync_run_live_transfer.py
 tests/test_usage_by_top_level_dir.py
 tests/test_usage_daily_snapshot.py
 tests/test_usage_snapshot.py

{files_com-1.6.343 → files_com-1.6.345}/files_sdk/__init__.py

@@ -69,6 +69,7 @@ import files_sdk.models.message as message
 import files_sdk.models.message_comment as message_comment
 import files_sdk.models.message_comment_reaction as message_comment_reaction
 import files_sdk.models.message_reaction as message_reaction
+import files_sdk.models.metadata_category as metadata_category
 import files_sdk.models.notification as notification
 import files_sdk.models.outbound_connection_log as outbound_connection_log
 import files_sdk.models.partner as partner
@@ -105,6 +106,7 @@ import files_sdk.models.style as style
 import files_sdk.models.sync as sync
 import files_sdk.models.sync_log as sync_log
 import files_sdk.models.sync_run as sync_run
+import files_sdk.models.sync_run_live_transfer as sync_run_live_transfer
 import files_sdk.models.usage_by_top_level_dir as usage_by_top_level_dir
 import files_sdk.models.usage_daily_snapshot as usage_daily_snapshot
 import files_sdk.models.usage_snapshot as usage_snapshot
@@ -196,6 +198,7 @@ from files_sdk.models.message import Message
 from files_sdk.models.message_comment import MessageComment
 from files_sdk.models.message_comment_reaction import MessageCommentReaction
 from files_sdk.models.message_reaction import MessageReaction
+from files_sdk.models.metadata_category import MetadataCategory
 from files_sdk.models.notification import Notification
 from files_sdk.models.outbound_connection_log import OutboundConnectionLog
 from files_sdk.models.partner import Partner
@@ -234,6 +237,7 @@ from files_sdk.models.style import Style
 from files_sdk.models.sync import Sync
 from files_sdk.models.sync_log import SyncLog
 from files_sdk.models.sync_run import SyncRun
+from files_sdk.models.sync_run_live_transfer import SyncRunLiveTransfer
 from files_sdk.models.usage_by_top_level_dir import UsageByTopLevelDir
 from files_sdk.models.usage_daily_snapshot import UsageDailySnapshot
 from files_sdk.models.usage_snapshot import UsageSnapshot
@@ -257,7 +261,7 @@ session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.343"
+version = "1.6.345"
 
 __version__ = version
 

{files_com-1.6.343 → files_com-1.6.345}/files_sdk/models/__init__.py

@@ -76,6 +76,7 @@ from files_sdk.models.message import Message
 from files_sdk.models.message_comment import MessageComment
 from files_sdk.models.message_comment_reaction import MessageCommentReaction
 from files_sdk.models.message_reaction import MessageReaction
+from files_sdk.models.metadata_category import MetadataCategory
 from files_sdk.models.notification import Notification
 from files_sdk.models.outbound_connection_log import OutboundConnectionLog
 from files_sdk.models.partner import Partner
@@ -114,6 +115,7 @@ from files_sdk.models.style import Style
 from files_sdk.models.sync import Sync
 from files_sdk.models.sync_log import SyncLog
 from files_sdk.models.sync_run import SyncRun
+from files_sdk.models.sync_run_live_transfer import SyncRunLiveTransfer
 from files_sdk.models.usage_by_top_level_dir import UsageByTopLevelDir
 from files_sdk.models.usage_daily_snapshot import UsageDailySnapshot
 from files_sdk.models.usage_snapshot import UsageSnapshot

files_com-1.6.345/files_sdk/models/metadata_category.py

@@ -0,0 +1,233 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.list_obj import ListObj
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class MetadataCategory:
+    default_attributes = {
+        "id": None,  # int64 - Metadata Category ID
+        "name": None,  # string - Name of the metadata category.
+        "definitions": None,  # hash(string,array(string)) - Map of key names to arrays of allowed values. An empty array means free-form text.
+        "default_columns": None,  # array(string) - Metadata keys that should appear as columns in the UI by default.
+    }
+
+    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 MetadataCategory.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 MetadataCategory.default_attributes
+            if getattr(self, k, None) is not None
+        }
+        return attrs
+
+    # Parameters:
+    #   name - string - Name of the metadata category.
+    #   default_columns - array(string) - Metadata keys that should appear as columns in the UI by default.
+    def update(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")
+        if "name" in params and not isinstance(params["name"], str):
+            raise InvalidParameterError("Bad parameter: name must be an str")
+        if "default_columns" in params and not isinstance(
+            params["default_columns"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: default_columns must be an list"
+            )
+        response, _options = Api.send_request(
+            "PATCH",
+            "/metadata_categories/{id}".format(id=params["id"]),
+            params,
+            self.options,
+        )
+        return response.data
+
+    def delete(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")
+        Api.send_request(
+            "DELETE",
+            "/metadata_categories/{id}".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    def destroy(self, params=None):
+        self.delete(params)
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            new_obj = self.update(self.get_attributes())
+            self.set_attributes(new_obj.get_attributes())
+            return True
+        else:
+            new_obj = create(self.get_attributes(), self.options)
+            self.set_attributes(new_obj.get_attributes())
+            return True
+
+
+# Parameters:
+#   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 .
+def list(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "cursor" in params and not isinstance(params["cursor"], str):
+        raise InvalidParameterError("Bad parameter: cursor must be an str")
+    if "per_page" in params and not isinstance(params["per_page"], int):
+        raise InvalidParameterError("Bad parameter: per_page must be an int")
+    if "sort_by" in params and not isinstance(params["sort_by"], dict):
+        raise InvalidParameterError("Bad parameter: sort_by must be an dict")
+    return ListObj(
+        MetadataCategory, "GET", "/metadata_categories", params, options
+    )
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Metadata Category ID.
+def find(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(
+        "GET",
+        "/metadata_categories/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return MetadataCategory(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   name (required) - string - Name of the metadata category.
+#   default_columns - array(string) - Metadata keys that should appear as columns in the UI by default.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "default_columns" in params and not isinstance(
+        params["default_columns"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: default_columns must be an list"
+        )
+    if "name" not in params:
+        raise MissingParameterError("Parameter missing: name")
+    response, options = Api.send_request(
+        "POST", "/metadata_categories", params, options
+    )
+    return MetadataCategory(response.data, options)
+
+
+# Parameters:
+#   name - string - Name of the metadata category.
+#   default_columns - array(string) - Metadata keys that should appear as columns in the UI by default.
+def update(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 "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "default_columns" in params and not isinstance(
+        params["default_columns"], builtins.list
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: default_columns must be an list"
+        )
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "PATCH",
+        "/metadata_categories/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return MetadataCategory(response.data, options)
+
+
+def delete(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")
+    Api.send_request(
+        "DELETE",
+        "/metadata_categories/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return MetadataCategory(*args, **kwargs)

{files_com-1.6.343 → files_com-1.6.345}/files_sdk/models/notification.py

@@ -14,6 +14,8 @@ class Notification:
         "path": None,  # string - Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
         "group_id": None,  # int64 - ID of Group to receive notifications
         "group_name": None,  # string - Group name, if a Group ID is set
+        "group_ids": None,  # array(int64) - Group IDs when the notification requires multiple groups
+        "group_names": None,  # array(string) - Group names when the notification requires multiple groups
         "triggering_group_ids": None,  # array(int64) - If set, will only notify on actions made by a member of one of the specified groups
         "triggering_user_ids": None,  # array(int64) - If set, will only notify on actions made one of the specified users
         "trigger_by_share_recipients": None,  # boolean - Notify when actions are performed by a share recipient?
@@ -236,6 +238,7 @@ def get(id, params=None, options=None):
 #   triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
 #   trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
 #   group_id - int64 - The ID of the group to notify.  Provide `user_id`, `username` or `group_id`.
+#   group_ids - string - Group IDs when the notification requires multiple groups. If sent as a string, it should be comma-delimited.
 #   path - string - Path
 #   username - string - The username of the user to notify.  Provide `user_id`, `username` or `group_id`.
 def create(params=None, options=None):
@@ -317,6 +320,8 @@ def create(params=None, options=None):
         )
     if "group_id" in params and not isinstance(params["group_id"], int):
         raise InvalidParameterError("Bad parameter: group_id must be an int")
+    if "group_ids" in params and not isinstance(params["group_ids"], str):
+        raise InvalidParameterError("Bad parameter: group_ids must be an str")
     if "path" in params and not isinstance(params["path"], str):
         raise InvalidParameterError("Bad parameter: path must be an str")
     if "username" in params and not isinstance(params["username"], str):

{files_com-1.6.343 → files_com-1.6.345}/files_sdk/models/sync_run.py

@@ -32,6 +32,7 @@ class SyncRun:
         "sync_id": None,  # int64 - ID of the Sync this run belongs to
         "sync_name": None,  # string - Name of the Sync this run belongs to
         "updated_at": None,  # date-time - When this run was last updated
+        "live_transfers": None,  # array(object) - Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
     }
 
     def __init__(self, attributes=None, options=None):

files_com-1.6.345/files_sdk/models/sync_run_live_transfer.py

@@ -0,0 +1,47 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class SyncRunLiveTransfer:
+    default_attributes = {
+        "path": None,  # string - The file path being transferred. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "status": None,  # string - Status of this individual transfer
+        "bytes_copied": None,  # int64 - Bytes transferred so far
+        "bytes_total": None,  # int64 - Total bytes of the file being transferred
+        "percentage": None,  # double - Transfer progress from 0.0 to 1.0
+        "eta": None,  # string - Estimated time remaining (human-readable)
+        "started_at": None,  # string - When this individual transfer started
+    }
+
+    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 SyncRunLiveTransfer.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 SyncRunLiveTransfer.default_attributes
+            if getattr(self, k, None) is not None
+        }
+        return attrs
+
+
+def new(*args, **kwargs):
+    return SyncRunLiveTransfer(*args, **kwargs)

{files_com-1.6.343 → files_com-1.6.345}/pyproject.toml

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

files_com-1.6.345/tests/test_metadata_category.py

@@ -0,0 +1,68 @@
+import unittest
+import inspect
+import files_sdk
+from tests.base import TestBase
+from files_sdk.models import MetadataCategory
+from files_sdk import metadata_category
+
+class MetadataCategoryTest(TestBase):
+    pass 
+    # Instance Methods
+    @unittest.skipUnless(TestBase.mock_server_path_exists("PATCH", "/metadata_categories/{id}"), "Mock path does not exist")
+    def test_update(self):
+        params = {
+            "id" : 12345,
+        }
+        metadata_category = MetadataCategory(params)
+        metadata_category.update(params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("DELETE", "/metadata_categories/{id}"), "Mock path does not exist")
+    def test_delete(self):
+        params = {
+            "id" : 12345,
+        }
+        metadata_category = MetadataCategory(params)
+        metadata_category.delete(params)
+
+    # Alias of delete
+    def test_destroy(self):
+        pass
+
+    # Static Methods
+    @unittest.skipUnless(TestBase.mock_server_path_exists("GET", "/metadata_categories"), "Mock path does not exist")
+    def test_list(self):
+        resp = metadata_category.list()
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("GET", "/metadata_categories/{id}"), "Mock path does not exist")
+    def test_find(self):
+        id = 12345
+        params = {
+            "id" : 12345,
+        }
+        metadata_category.find(id, params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/metadata_categories"), "Mock path does not exist")
+    def test_create(self):
+        params = {
+            "name" : "foo",
+        }
+        metadata_category.create(params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("PATCH", "/metadata_categories/{id}"), "Mock path does not exist")
+    def test_update(self):
+        id = 12345
+        params = {
+            "id" : 12345,
+        }
+        metadata_category.update(id, params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("DELETE", "/metadata_categories/{id}"), "Mock path does not exist")
+    def test_delete(self):
+        id = 12345
+        params = {
+            "id" : 12345,
+        }
+        metadata_category.delete(id, params)
+
+if __name__ == '__main__':
+    unittest.main()

files_com-1.6.345/tests/test_sync_run_live_transfer.py

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

files_com-1.6.343/_VERSION

@@ -1 +0,0 @@
-1.6.343