Files.com 1.6.417__tar.gz → 1.6.418__tar.gz

{files_com-1.6.417/files_com.egg-info → files_com-1.6.418}/PKG-INFO

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

files_com-1.6.418/_VERSION

@@ -0,0 +1 @@
+1.6.418

{files_com-1.6.417 → files_com-1.6.418/files_com.egg-info}/PKG-INFO

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

{files_com-1.6.417 → files_com-1.6.418}/files_com.egg-info/SOURCES.txt

@@ -121,6 +121,7 @@ files_sdk/models/request.py
 files_sdk/models/restore.py
 files_sdk/models/scheduled_export.py
 files_sdk/models/scim_log.py
+files_sdk/models/secret.py
 files_sdk/models/session.py
 files_sdk/models/settings_change.py
 files_sdk/models/sftp_action_log.py
@@ -264,6 +265,7 @@ tests/test_request.py
 tests/test_restore.py
 tests/test_scheduled_export.py
 tests/test_scim_log.py
+tests/test_secret.py
 tests/test_session.py
 tests/test_settings_change.py
 tests/test_sftp_action_log.py

{files_com-1.6.417 → files_com-1.6.418}/files_sdk/__init__.py

@@ -104,6 +104,7 @@ import files_sdk.models.request as request
 import files_sdk.models.restore as restore
 import files_sdk.models.scheduled_export as scheduled_export
 import files_sdk.models.scim_log as scim_log
+import files_sdk.models.secret as secret
 import files_sdk.models.session as session
 import files_sdk.models.settings_change as settings_change
 import files_sdk.models.sftp_action_log as sftp_action_log
@@ -252,6 +253,7 @@ from files_sdk.models.request import Request
 from files_sdk.models.restore import Restore
 from files_sdk.models.scheduled_export import ScheduledExport
 from files_sdk.models.scim_log import ScimLog
+from files_sdk.models.secret import Secret
 from files_sdk.models.session import Session
 from files_sdk.models.settings_change import SettingsChange
 from files_sdk.models.sftp_action_log import SftpActionLog
@@ -298,7 +300,7 @@ source_ip = None
 workspace_id = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.417"
+version = "1.6.418"
 
 __version__ = version
 

{files_com-1.6.417 → files_com-1.6.418}/files_sdk/models/__init__.py

@@ -113,6 +113,7 @@ from files_sdk.models.request import Request
 from files_sdk.models.restore import Restore
 from files_sdk.models.scheduled_export import ScheduledExport
 from files_sdk.models.scim_log import ScimLog
+from files_sdk.models.secret import Secret
 from files_sdk.models.session import Session
 from files_sdk.models.settings_change import SettingsChange
 from files_sdk.models.sftp_action_log import SftpActionLog

{files_com-1.6.417 → files_com-1.6.418}/files_sdk/models/behavior.py

@@ -18,6 +18,7 @@ class Behavior:
         "name": None,  # string - Name for this behavior.
         "description": None,  # string - Description for this behavior.
         "value": None,  # object - Settings for this behavior.  See the section above for an example value to provide here.  Formatting is different for each Behavior type.  May be sent as nested JSON or a single JSON-encoded string.  If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
+        "public_hosting_url": None,  # string - Public URL for this publicly hosted folder when the `Serve Publicly` behavior has a key configured.  When a Custom Domain with `public_hosting` destination is attached to this behavior, the URL uses that domain.  Otherwise it uses the site's `subdomain.hosted-by-files.com` host.
         "disable_parent_folder_behavior": None,  # boolean - If true, the parent folder's behavior will be disabled for this folder and its children.
         "recursive": None,  # boolean - Whether this behavior is recursive for this record. `always` behaviors are always `true`, `never` behaviors are always `false`, and `sometimes` behaviors may be either value.
         "attachment_file": None,  # file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.

{files_com-1.6.417 → files_com-1.6.418}/files_sdk/models/custom_domain.py

@@ -13,11 +13,11 @@ class CustomDomain:
     default_attributes = {
         "id": None,  # int64 - Custom Domain ID.
         "domain": None,  # string - Customer-owned domain name.
-        "destination": None,  # string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
+        "destination": None,  # string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
         "dns_status": None,  # string - Current DNS verification status.
         "ssl_certificate_id": None,  # int64 - Current SSL certificate ID.
         "brick_managed": None,  # boolean - Is this domain's SSL certificate automatically managed and renewed by Files.com?
-        "folder_behavior_id": None,  # int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+        "folder_behavior_id": None,  # int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.  Preserved as historical context when `destination` becomes `unassigned`.
         "created_at": None,  # date-time - When this Custom Domain was created.
         "updated_at": None,  # date-time - When this Custom Domain was last updated.
     }
@@ -47,8 +47,8 @@ class CustomDomain:
         return attrs
 
     # Parameters:
-    #   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
-    #   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+    #   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
+    #   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.  Preserved as historical context when `destination` becomes `unassigned`.
     #   ssl_certificate_id - int64 - Current SSL certificate ID.
     #   domain - string - Customer-owned domain name.
     def update(self, params=None):
@@ -176,8 +176,8 @@ def get(id, params=None, options=None):
 
 
 # Parameters:
-#   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
-#   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+#   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
+#   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.  Preserved as historical context when `destination` becomes `unassigned`.
 #   ssl_certificate_id - int64 - Current SSL certificate ID.
 #   domain (required) - string - Customer-owned domain name.
 def create(params=None, options=None):
@@ -212,8 +212,8 @@ def create(params=None, options=None):
 
 
 # Parameters:
-#   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, or `s3_endpoint`.
-#   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.
+#   destination - string - Where this custom domain routes. Can be `site_alias`, `public_hosting`, `s3_endpoint`, or `unassigned` (not routing traffic). Set to `unassigned` automatically when a bound `public_hosting` folder behavior is deleted, and can be set manually via the API for any reason.
+#   folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior.  Preserved as historical context when `destination` becomes `unassigned`.
 #   ssl_certificate_id - int64 - Current SSL certificate ID.
 #   domain - string - Customer-owned domain name.
 def update(id, params=None, options=None):

files_com-1.6.418/files_sdk/models/secret.py

@@ -0,0 +1,271 @@
+import builtins  # noqa: F401
+from urllib.parse import quote
+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 Secret:
+    default_attributes = {
+        "id": None,  # int64 - Secret ID.
+        "workspace_id": None,  # int64 - Workspace ID. 0 means the default workspace.
+        "name": None,  # string - Secret name.
+        "description": None,  # string - Internal description for your reference.
+        "secret_type": None,  # string - Secret type.
+        "metadata": None,  # object - Non-secret metadata for the Secret type.
+        "value_field_names": None,  # array(string) - Names of configured secret value fields. Secret values are never returned.
+        "created_at": None,  # date-time - Secret create date/time.
+        "updated_at": None,  # date-time - Secret update date/time.
+    }
+
+    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 Secret.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 Secret.default_attributes
+            if getattr(self, k, None) is not None
+        }
+        return attrs
+
+    # Parameters:
+    #   name - string - Secret name.
+    #   description - string - Internal description for your reference.
+    #   secret_type - string - Secret type.
+    #   metadata - object - Non-secret metadata for the Secret type.
+    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 "description" in params and not isinstance(
+            params["description"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: description must be an str"
+            )
+        if "secret_type" in params and not isinstance(
+            params["secret_type"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: secret_type must be an str"
+            )
+        response, _options = Api.send_request(
+            "PATCH",
+            "/secrets/{id}".format(id=quote(str(params["id"]), safe="")),
+            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",
+            "/secrets/{id}".format(id=quote(str(params["id"]), safe="")),
+            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: 10000, 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 `workspace_id`, `name` or `secret_type`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `name` or `secret_type`. Valid field combinations are `[ workspace_id, name ]`, `[ workspace_id, secret_type ]`, `[ secret_type, name ]` or `[ workspace_id, secret_type, name ]`.
+#   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. 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")
+    if "filter" in params and not isinstance(params["filter"], dict):
+        raise InvalidParameterError("Bad parameter: filter must be an dict")
+    if "filter_prefix" in params and not isinstance(
+        params["filter_prefix"], dict
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: filter_prefix must be an dict"
+        )
+    return ListObj(Secret, "GET", "/secrets", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Secret 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",
+        "/secrets/{id}".format(id=quote(str(params["id"]), safe="")),
+        params,
+        options,
+    )
+    return Secret(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   name (required) - string - Secret name.
+#   description - string - Internal description for your reference.
+#   secret_type (required) - string - Secret type.
+#   metadata - object - Non-secret metadata for the Secret type.
+#   workspace_id - int64 - Workspace ID. 0 means the default workspace.
+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 "description" in params and not isinstance(params["description"], str):
+        raise InvalidParameterError(
+            "Bad parameter: description must be an str"
+        )
+    if "secret_type" in params and not isinstance(params["secret_type"], str):
+        raise InvalidParameterError(
+            "Bad parameter: secret_type must be an str"
+        )
+    if "metadata" in params and not isinstance(params["metadata"], dict):
+        raise InvalidParameterError("Bad parameter: metadata must be an dict")
+    if "workspace_id" in params and not isinstance(
+        params["workspace_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: workspace_id must be an int"
+        )
+    if "name" not in params:
+        raise MissingParameterError("Parameter missing: name")
+    if "secret_type" not in params:
+        raise MissingParameterError("Parameter missing: secret_type")
+    response, options = Api.send_request("POST", "/secrets", params, options)
+    return Secret(response.data, options)
+
+
+# Parameters:
+#   name - string - Secret name.
+#   description - string - Internal description for your reference.
+#   secret_type - string - Secret type.
+#   metadata - object - Non-secret metadata for the Secret type.
+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 "description" in params and not isinstance(params["description"], str):
+        raise InvalidParameterError(
+            "Bad parameter: description must be an str"
+        )
+    if "secret_type" in params and not isinstance(params["secret_type"], str):
+        raise InvalidParameterError(
+            "Bad parameter: secret_type must be an str"
+        )
+    if "metadata" in params and not isinstance(params["metadata"], dict):
+        raise InvalidParameterError("Bad parameter: metadata must be an dict")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "PATCH",
+        "/secrets/{id}".format(id=quote(str(params["id"]), safe="")),
+        params,
+        options,
+    )
+    return Secret(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",
+        "/secrets/{id}".format(id=quote(str(params["id"]), safe="")),
+        params,
+        options,
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return Secret(*args, **kwargs)

{files_com-1.6.417 → files_com-1.6.418}/pyproject.toml

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

files_com-1.6.418/tests/test_secret.py

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

files_com-1.6.417/_VERSION

@@ -1 +0,0 @@
-1.6.417