files-com 1.5.0__py3-none-any.whl

files_sdk/models/lock.py

@@ -0,0 +1,158 @@
+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 Lock:
+    default_attributes = {
+        "path": None,  # string - Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "timeout": None,  # int64 - Lock timeout in seconds
+        "depth": None,  # string
+        "recursive": None,  # boolean - Does lock apply to subfolders?
+        "owner": None,  # string - Owner of the lock.  This can be any arbitrary string.
+        "scope": None,  # string
+        "exclusive": None,  # boolean - Is lock exclusive?
+        "token": None,  # string - Lock token.  Use to release lock.
+        "type": None,  # string
+        "allow_access_by_any_user": None,  # boolean - Can lock be modified by users other than its creator?
+        "user_id": None,  # int64 - Lock creator user ID
+        "username": None,  # string - Lock creator username
+    }
+
+    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 Lock.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Lock.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Parameters:
+    #   token (required) - string - Lock token
+    def 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 "token" not in params:
+            raise MissingParameterError("Parameter missing: token")
+        if "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        if "token" in params and not isinstance(params["token"], str):
+            raise InvalidParameterError("Bad parameter: token must be an str")
+        Api.send_request(
+            "DELETE",
+            "/locks/{path}".format(path=params["path"]),
+            params,
+            self.options,
+        )
+
+    def destroy(self, params=None):
+        self.delete(params)
+
+    def save(self):
+        new_obj = create(self.path, 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).
+#   path (required) - string - Path to operate on.
+#   include_children - boolean - Include locks from children objects?
+def list_for(path, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["path"] = path
+    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 "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    return ListObj(
+        Lock,
+        "GET",
+        "/locks/{path}".format(path=params["path"]),
+        params,
+        options,
+    )
+
+
+# Parameters:
+#   path (required) - string - Path
+#   allow_access_by_any_user - boolean - Can lock be modified by users other than its creator?
+#   exclusive - boolean - Is lock exclusive?
+#   recursive - boolean - Does lock apply to subfolders?
+#   timeout - int64 - Lock timeout in seconds
+def create(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 "timeout" in params and not isinstance(params["timeout"], int):
+        raise InvalidParameterError("Bad parameter: timeout must be an int")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    response, options = Api.send_request(
+        "POST", "/locks/{path}".format(path=params["path"]), params, options
+    )
+    return Lock(response.data, options)
+
+
+# Parameters:
+#   token (required) - string - Lock token
+def 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 "token" in params and not isinstance(params["token"], str):
+        raise InvalidParameterError("Bad parameter: token must be an str")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    if "token" not in params:
+        raise MissingParameterError("Parameter missing: token")
+    Api.send_request(
+        "DELETE", "/locks/{path}".format(path=params["path"]), params, options
+    )
+
+
+def destroy(path, params=None, options=None):
+    delete(path, params, options)
+
+
+def new(*args, **kwargs):
+    return Lock(*args, **kwargs)

files_sdk/models/message.py

@@ -0,0 +1,244 @@
+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 Message:
+    default_attributes = {
+        "id": None,  # int64 - Message ID
+        "subject": None,  # string - Message subject.
+        "body": None,  # string - Message body.
+        "comments": None,  # array(object) - Comments.
+        "user_id": None,  # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+        "project_id": None,  # int64 - Project to which the message should be attached.
+    }
+
+    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 Message.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Message.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Parameters:
+    #   project_id (required) - int64 - Project to which the message should be attached.
+    #   subject (required) - string - Message subject.
+    #   body (required) - string - Message body.
+    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 "project_id" not in params:
+            raise MissingParameterError("Parameter missing: project_id")
+        if "subject" not in params:
+            raise MissingParameterError("Parameter missing: subject")
+        if "body" not in params:
+            raise MissingParameterError("Parameter missing: body")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        if "project_id" in params and not isinstance(
+            params["project_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: project_id must be an int"
+            )
+        if "subject" in params and not isinstance(params["subject"], str):
+            raise InvalidParameterError(
+                "Bad parameter: subject must be an str"
+            )
+        if "body" in params and not isinstance(params["body"], str):
+            raise InvalidParameterError("Bad parameter: body must be an str")
+        response, _options = Api.send_request(
+            "PATCH",
+            "/messages/{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",
+            "/messages/{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:
+#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+#   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).
+#   project_id (required) - int64 - Project for which to return messages.
+def list(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "user_id" in params and not isinstance(params["user_id"], int):
+        raise InvalidParameterError("Bad parameter: user_id must be an int")
+    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 "project_id" in params and not isinstance(params["project_id"], int):
+        raise InvalidParameterError("Bad parameter: project_id must be an int")
+    if "project_id" not in params:
+        raise MissingParameterError("Parameter missing: project_id")
+    return ListObj(Message, "GET", "/messages", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Message 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", "/messages/{id}".format(id=params["id"]), params, options
+    )
+    return Message(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+#   project_id (required) - int64 - Project to which the message should be attached.
+#   subject (required) - string - Message subject.
+#   body (required) - string - Message body.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "user_id" in params and not isinstance(params["user_id"], int):
+        raise InvalidParameterError("Bad parameter: user_id must be an int")
+    if "project_id" in params and not isinstance(params["project_id"], int):
+        raise InvalidParameterError("Bad parameter: project_id must be an int")
+    if "subject" in params and not isinstance(params["subject"], str):
+        raise InvalidParameterError("Bad parameter: subject must be an str")
+    if "body" in params and not isinstance(params["body"], str):
+        raise InvalidParameterError("Bad parameter: body must be an str")
+    if "project_id" not in params:
+        raise MissingParameterError("Parameter missing: project_id")
+    if "subject" not in params:
+        raise MissingParameterError("Parameter missing: subject")
+    if "body" not in params:
+        raise MissingParameterError("Parameter missing: body")
+    response, options = Api.send_request("POST", "/messages", params, options)
+    return Message(response.data, options)
+
+
+# Parameters:
+#   project_id (required) - int64 - Project to which the message should be attached.
+#   subject (required) - string - Message subject.
+#   body (required) - string - Message body.
+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 "project_id" in params and not isinstance(params["project_id"], int):
+        raise InvalidParameterError("Bad parameter: project_id must be an int")
+    if "subject" in params and not isinstance(params["subject"], str):
+        raise InvalidParameterError("Bad parameter: subject must be an str")
+    if "body" in params and not isinstance(params["body"], str):
+        raise InvalidParameterError("Bad parameter: body must be an str")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    if "project_id" not in params:
+        raise MissingParameterError("Parameter missing: project_id")
+    if "subject" not in params:
+        raise MissingParameterError("Parameter missing: subject")
+    if "body" not in params:
+        raise MissingParameterError("Parameter missing: body")
+    response, options = Api.send_request(
+        "PATCH", "/messages/{id}".format(id=params["id"]), params, options
+    )
+    return Message(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", "/messages/{id}".format(id=params["id"]), params, options
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return Message(*args, **kwargs)

files_sdk/models/message_comment.py

@@ -0,0 +1,223 @@
+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 MessageComment:
+    default_attributes = {
+        "id": None,  # int64 - Message Comment ID
+        "body": None,  # string - Comment body.
+        "reactions": None,  # array(object) - Reactions to this comment.
+        "user_id": None,  # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    }
+
+    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 MessageComment.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in MessageComment.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Parameters:
+    #   body (required) - string - Comment body.
+    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 "body" not in params:
+            raise MissingParameterError("Parameter missing: body")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        if "body" in params and not isinstance(params["body"], str):
+            raise InvalidParameterError("Bad parameter: body must be an str")
+        response, _options = Api.send_request(
+            "PATCH",
+            "/message_comments/{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",
+            "/message_comments/{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:
+#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+#   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 .
+#   message_id (required) - int64 - Message comment to return comments for.
+def list(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "user_id" in params and not isinstance(params["user_id"], int):
+        raise InvalidParameterError("Bad parameter: user_id must be an int")
+    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 "message_id" in params and not isinstance(params["message_id"], int):
+        raise InvalidParameterError("Bad parameter: message_id must be an int")
+    if "message_id" not in params:
+        raise MissingParameterError("Parameter missing: message_id")
+    return ListObj(MessageComment, "GET", "/message_comments", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Message Comment 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",
+        "/message_comments/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return MessageComment(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+#   body (required) - string - Comment body.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "user_id" in params and not isinstance(params["user_id"], int):
+        raise InvalidParameterError("Bad parameter: user_id must be an int")
+    if "body" in params and not isinstance(params["body"], str):
+        raise InvalidParameterError("Bad parameter: body must be an str")
+    if "body" not in params:
+        raise MissingParameterError("Parameter missing: body")
+    response, options = Api.send_request(
+        "POST", "/message_comments", params, options
+    )
+    return MessageComment(response.data, options)
+
+
+# Parameters:
+#   body (required) - string - Comment body.
+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 "body" in params and not isinstance(params["body"], str):
+        raise InvalidParameterError("Bad parameter: body must be an str")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    if "body" not in params:
+        raise MissingParameterError("Parameter missing: body")
+    response, options = Api.send_request(
+        "PATCH",
+        "/message_comments/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return MessageComment(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",
+        "/message_comments/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return MessageComment(*args, **kwargs)