files-com 1.6.74__tar.gz → 1.6.76__tar.gz

{files_com-1.6.74/files_com.egg-info → files_com-1.6.76}/PKG-INFO

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

files_com-1.6.76/_VERSION

@@ -0,0 +1 @@
+1.6.76

{files_com-1.6.74 → files_com-1.6.76/files_com.egg-info}/PKG-INFO

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

{files_com-1.6.74 → files_com-1.6.76}/files_com.egg-info/SOURCES.txt

@@ -80,6 +80,7 @@ files_sdk/models/message_comment_reaction.py
 files_sdk/models/message_reaction.py
 files_sdk/models/notification.py
 files_sdk/models/outbound_connection_log.py
+files_sdk/models/partner.py
 files_sdk/models/payment.py
 files_sdk/models/payment_line_item.py
 files_sdk/models/permission.py
@@ -187,6 +188,7 @@ tests/test_message_comment_reaction.py
 tests/test_message_reaction.py
 tests/test_notification.py
 tests/test_outbound_connection_log.py
+tests/test_partner.py
 tests/test_path_util.py
 tests/test_payment.py
 tests/test_payment_line_item.py

{files_com-1.6.74 → files_com-1.6.76}/files_sdk/__init__.py

@@ -63,6 +63,7 @@ import files_sdk.models.message_comment_reaction as message_comment_reaction
 import files_sdk.models.message_reaction as message_reaction
 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
 import files_sdk.models.payment as payment
 import files_sdk.models.payment_line_item as payment_line_item
 import files_sdk.models.permission as permission
@@ -175,6 +176,7 @@ from files_sdk.models.message_comment_reaction import MessageCommentReaction
 from files_sdk.models.message_reaction import MessageReaction
 from files_sdk.models.notification import Notification
 from files_sdk.models.outbound_connection_log import OutboundConnectionLog
+from files_sdk.models.partner import Partner
 from files_sdk.models.payment import Payment
 from files_sdk.models.payment_line_item import PaymentLineItem
 from files_sdk.models.permission import Permission
@@ -229,7 +231,7 @@ session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.74"
+version = "1.6.76"
 
 __version__ = version
 

{files_com-1.6.74 → files_com-1.6.76}/files_sdk/models/__init__.py

@@ -68,6 +68,7 @@ from files_sdk.models.message_comment_reaction import MessageCommentReaction
 from files_sdk.models.message_reaction import MessageReaction
 from files_sdk.models.notification import Notification
 from files_sdk.models.outbound_connection_log import OutboundConnectionLog
+from files_sdk.models.partner import Partner
 from files_sdk.models.payment import Payment
 from files_sdk.models.payment_line_item import PaymentLineItem
 from files_sdk.models.permission import Permission

files_com-1.6.76/files_sdk/models/partner.py

@@ -0,0 +1,266 @@
+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 Partner:
+    default_attributes = {
+        "allow_bypassing_2fa_policies": None,  # boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
+        "allow_credential_changes": None,  # boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
+        "allow_user_creation": None,  # boolean - Allow Partner Admins to create users.
+        "id": None,  # int64 - The unique ID of the Partner.
+        "name": None,  # string - The name of the Partner.
+        "notes": None,  # string - Notes about this Partner.
+        "root_folder": None,  # string - The root folder path for this Partner.
+    }
+
+    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 Partner.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Partner.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Parameters:
+    #   allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
+    #   allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
+    #   allow_user_creation - boolean - Allow Partner Admins to create users.
+    #   name - string - The name of the Partner.
+    #   notes - string - Notes about this Partner.
+    #   root_folder - string - The root folder path for this Partner.
+    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 "notes" in params and not isinstance(params["notes"], str):
+            raise InvalidParameterError("Bad parameter: notes must be an str")
+        if "root_folder" in params and not isinstance(
+            params["root_folder"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: root_folder must be an str"
+            )
+        response, _options = Api.send_request(
+            "PATCH",
+            "/partners/{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",
+            "/partners/{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 `name`.
+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(Partner, "GET", "/partners", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Partner 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", "/partners/{id}".format(id=params["id"]), params, options
+    )
+    return Partner(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
+#   allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
+#   allow_user_creation - boolean - Allow Partner Admins to create users.
+#   name - string - The name of the Partner.
+#   notes - string - Notes about this Partner.
+#   root_folder - string - The root folder path for this Partner.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "allow_bypassing_2fa_policies" in params and not isinstance(
+        params["allow_bypassing_2fa_policies"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_bypassing_2fa_policies must be an bool"
+        )
+    if "allow_credential_changes" in params and not isinstance(
+        params["allow_credential_changes"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_credential_changes must be an bool"
+        )
+    if "allow_user_creation" in params and not isinstance(
+        params["allow_user_creation"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_user_creation must be an bool"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "notes" in params and not isinstance(params["notes"], str):
+        raise InvalidParameterError("Bad parameter: notes must be an str")
+    if "root_folder" in params and not isinstance(params["root_folder"], str):
+        raise InvalidParameterError(
+            "Bad parameter: root_folder must be an str"
+        )
+    response, options = Api.send_request("POST", "/partners", params, options)
+    return Partner(response.data, options)
+
+
+# Parameters:
+#   allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
+#   allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
+#   allow_user_creation - boolean - Allow Partner Admins to create users.
+#   name - string - The name of the Partner.
+#   notes - string - Notes about this Partner.
+#   root_folder - string - The root folder path for this Partner.
+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 "allow_bypassing_2fa_policies" in params and not isinstance(
+        params["allow_bypassing_2fa_policies"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_bypassing_2fa_policies must be an bool"
+        )
+    if "allow_credential_changes" in params and not isinstance(
+        params["allow_credential_changes"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_credential_changes must be an bool"
+        )
+    if "allow_user_creation" in params and not isinstance(
+        params["allow_user_creation"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: allow_user_creation must be an bool"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "notes" in params and not isinstance(params["notes"], str):
+        raise InvalidParameterError("Bad parameter: notes must be an str")
+    if "root_folder" in params and not isinstance(params["root_folder"], str):
+        raise InvalidParameterError(
+            "Bad parameter: root_folder must be an str"
+        )
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "PATCH", "/partners/{id}".format(id=params["id"]), params, options
+    )
+    return Partner(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", "/partners/{id}".format(id=params["id"]), params, options
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return Partner(*args, **kwargs)

{files_com-1.6.74 → files_com-1.6.76}/files_sdk/models/permission.py

@@ -16,6 +16,7 @@ class Permission:
         "username": None,  # string - Username (if applicable)
         "group_id": None,  # int64 - Group ID
         "group_name": None,  # string - Group name (if applicable)
+        "partner_id": None,  # int64 - Partner ID (if applicable)
         "permission": None,  # string - Permission type.  See the table referenced in the documentation for an explanation of each permission.
         "recursive": None,  # boolean - Recursive: does this permission apply to subfolders?
         "site_id": None,  # int64 - Site ID
@@ -76,12 +77,13 @@ class Permission:
 # 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 `site_id`, `group_id`, `path`, `user_id` or `id`.
-#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]` or `[ user_id, group_id, path ]`.
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path`, `user_id`, `partner_id` or `id`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id`, `partner_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ partner_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]`, `[ user_id, group_id, path ]`, `[ user_id, group_id, partner_id ]` or `[ user_id, group_id, partner_id, path ]`.
 #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
 #   path - string - Permission path.  If provided, will scope all permissions(including upward) to this path.
 #   include_groups - boolean - If searching by user or group, also include user's permissions that are inherited from its groups?
 #   group_id - string
+#   partner_id - string
 #   user_id - string
 def list(params=None, options=None):
     if not isinstance(params, dict):
@@ -112,6 +114,8 @@ def list(params=None, options=None):
         )
     if "group_id" in params and not isinstance(params["group_id"], str):
         raise InvalidParameterError("Bad parameter: group_id must be an str")
+    if "partner_id" in params and not isinstance(params["partner_id"], str):
+        raise InvalidParameterError("Bad parameter: partner_id must be an str")
     if "user_id" in params and not isinstance(params["user_id"], str):
         raise InvalidParameterError("Bad parameter: user_id must be an str")
     return ListObj(Permission, "GET", "/permissions", params, options)
@@ -126,6 +130,7 @@ def all(params=None, options=None):
 #   group_id - int64 - Group ID. Provide `group_name` or `group_id`
 #   permission - string - Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
 #   recursive - boolean - Apply to subfolders recursively?
+#   partner_id - int64 - Partner ID if this Permission belongs to a partner.
 #   user_id - int64 - User ID.  Provide `username` or `user_id`
 #   username - string - User username.  Provide `username` or `user_id`
 #   group_name - string - Group name.  Provide `group_name` or `group_id`
@@ -143,6 +148,8 @@ def create(params=None, options=None):
         raise InvalidParameterError("Bad parameter: permission must be an str")
     if "recursive" in params and not isinstance(params["recursive"], bool):
         raise InvalidParameterError("Bad parameter: recursive must be an bool")
+    if "partner_id" in params and not isinstance(params["partner_id"], int):
+        raise InvalidParameterError("Bad parameter: partner_id must be an int")
     if "user_id" in params and not isinstance(params["user_id"], int):
         raise InvalidParameterError("Bad parameter: user_id must be an int")
     if "username" in params and not isinstance(params["username"], str):

{files_com-1.6.74 → files_com-1.6.76}/files_sdk/models/user.py

@@ -50,6 +50,8 @@ class User:
         "notes": None,  # string - Any internal notes on the user
         "notification_daily_send_time": None,  # int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
         "office_integration_enabled": None,  # boolean - Enable integration with Office for the web?
+        "partner_admin": None,  # boolean - Is this user a Partner administrator?
+        "partner_id": None,  # int64 - Partner ID if this user belongs to a Partner
         "password_set_at": None,  # date-time - Last time the user's password was set
         "password_validity_days": None,  # int64 - Number of days to allow user to use the same password
         "public_keys_count": None,  # int64 - Number of public keys associated with this user
@@ -200,6 +202,7 @@ class User:
     #   company - string - User's company
     #   notes - string - Any internal notes on the user
     #   office_integration_enabled - boolean - Enable integration with Office for the web?
+    #   partner_id - int64 - Partner ID if this user belongs to a Partner
     #   password_validity_days - int64 - Number of days to allow user to use the same password
     #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
     #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -323,6 +326,12 @@ class User:
             )
         if "notes" in params and not isinstance(params["notes"], str):
             raise InvalidParameterError("Bad parameter: notes must be an str")
+        if "partner_id" in params and not isinstance(
+            params["partner_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: partner_id must be an int"
+            )
         if "password_validity_days" in params and not isinstance(
             params["password_validity_days"], int
         ):
@@ -532,6 +541,7 @@ def get(id, params=None, options=None):
 #   company - string - User's company
 #   notes - string - Any internal notes on the user
 #   office_integration_enabled - boolean - Enable integration with Office for the web?
+#   partner_id - int64 - Partner ID if this user belongs to a Partner
 #   password_validity_days - int64 - Number of days to allow user to use the same password
 #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
 #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -689,6 +699,8 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: office_integration_enabled must be an bool"
         )
+    if "partner_id" in params and not isinstance(params["partner_id"], int):
+        raise InvalidParameterError("Bad parameter: partner_id must be an int")
     if "password_validity_days" in params and not isinstance(
         params["password_validity_days"], int
     ):
@@ -868,6 +880,7 @@ def user_2fa_reset(id, params=None, options=None):
 #   company - string - User's company
 #   notes - string - Any internal notes on the user
 #   office_integration_enabled - boolean - Enable integration with Office for the web?
+#   partner_id - int64 - Partner ID if this user belongs to a Partner
 #   password_validity_days - int64 - Number of days to allow user to use the same password
 #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
 #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -1029,6 +1042,8 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: office_integration_enabled must be an bool"
         )
+    if "partner_id" in params and not isinstance(params["partner_id"], int):
+        raise InvalidParameterError("Bad parameter: partner_id must be an int")
     if "password_validity_days" in params and not isinstance(
         params["password_validity_days"], int
     ):

{files_com-1.6.74 → files_com-1.6.76}/pyproject.toml

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

files_com-1.6.76/tests/test_partner.py

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

files_com-1.6.74/_VERSION

@@ -1 +0,0 @@
-1.6.74