files-com 1.6.208__py3-none-any.whl

files_sdk/models/snapshot.py

@@ -0,0 +1,255 @@
+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 Snapshot:
+    default_attributes = {
+        "id": None,  # int64 - The snapshot's unique ID.
+        "expires_at": None,  # date-time - When the snapshot expires.
+        "finalized_at": None,  # date-time - When the snapshot was finalized.
+        "name": None,  # string - A name for the snapshot.
+        "user_id": None,  # int64 - The user that created this snapshot, if applicable.
+        "bundle_id": None,  # int64 - The bundle using this snapshot, if applicable.
+        "paths": None,  # array(string) - An array of paths to add to the snapshot.
+    }
+
+    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 Snapshot.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Snapshot.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Finalize Snapshot
+    def finalize(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(
+            "POST",
+            "/snapshots/{id}/finalize".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    # Parameters:
+    #   expires_at - string - When the snapshot expires.
+    #   name - string - A name for the snapshot.
+    #   paths - array(string) - An array of paths to add to the snapshot.
+    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 "expires_at" in params and not isinstance(
+            params["expires_at"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: expires_at must be an str"
+            )
+        if "name" in params and not isinstance(params["name"], str):
+            raise InvalidParameterError("Bad parameter: name must be an str")
+        if "paths" in params and not isinstance(
+            params["paths"], builtins.list
+        ):
+            raise InvalidParameterError("Bad parameter: paths must be an list")
+        response, _options = Api.send_request(
+            "PATCH",
+            "/snapshots/{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",
+            "/snapshots/{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).
+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")
+    return ListObj(Snapshot, "GET", "/snapshots", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Snapshot 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", "/snapshots/{id}".format(id=params["id"]), params, options
+    )
+    return Snapshot(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   expires_at - string - When the snapshot expires.
+#   name - string - A name for the snapshot.
+#   paths - array(string) - An array of paths to add to the snapshot.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "expires_at" in params and not isinstance(params["expires_at"], str):
+        raise InvalidParameterError("Bad parameter: expires_at must be an str")
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "paths" in params and not isinstance(params["paths"], builtins.list):
+        raise InvalidParameterError("Bad parameter: paths must be an list")
+    response, options = Api.send_request("POST", "/snapshots", params, options)
+    return Snapshot(response.data, options)
+
+
+# Finalize Snapshot
+def finalize(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(
+        "POST",
+        "/snapshots/{id}/finalize".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+# Parameters:
+#   expires_at - string - When the snapshot expires.
+#   name - string - A name for the snapshot.
+#   paths - array(string) - An array of paths to add to the snapshot.
+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 "expires_at" in params and not isinstance(params["expires_at"], str):
+        raise InvalidParameterError("Bad parameter: expires_at must be an str")
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "paths" in params and not isinstance(params["paths"], builtins.list):
+        raise InvalidParameterError("Bad parameter: paths must be an list")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "PATCH", "/snapshots/{id}".format(id=params["id"]), params, options
+    )
+    return Snapshot(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", "/snapshots/{id}".format(id=params["id"]), params, options
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return Snapshot(*args, **kwargs)

files_sdk/models/sso_strategy.py

@@ -0,0 +1,168 @@
+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 SsoStrategy:
+    default_attributes = {
+        "protocol": None,  # string - SSO Protocol
+        "provider": None,  # string - Provider name
+        "label": None,  # string - Custom label for the SSO provider on the login page.
+        "logo_url": None,  # string - URL holding a custom logo for the SSO provider on the login page.
+        "id": None,  # int64 - ID
+        "user_count": None,  # int64 - Count of users with this SSO Strategy
+        "saml_provider_cert_fingerprint": None,  # string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
+        "saml_provider_issuer_url": None,  # string - Identity provider issuer url
+        "saml_provider_metadata_content": None,  # string - Custom identity provider metadata
+        "saml_provider_metadata_url": None,  # string - Metadata URL for the SAML identity provider
+        "saml_provider_slo_target_url": None,  # string - Identity provider SLO endpoint
+        "saml_provider_sso_target_url": None,  # string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
+        "scim_authentication_method": None,  # string - SCIM authentication type.
+        "scim_username": None,  # string - SCIM username.
+        "scim_oauth_access_token": None,  # string - SCIM OAuth Access Token.
+        "scim_oauth_access_token_expires_at": None,  # string - SCIM OAuth Access Token Expiration Time.
+        "subdomain": None,  # string - Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`
+        "provision_users": None,  # boolean - Auto-provision users?
+        "provision_groups": None,  # boolean - Auto-provision group membership based on group memberships on the SSO side?
+        "deprovision_users": None,  # boolean - Auto-deprovision users?
+        "deprovision_groups": None,  # boolean - Auto-deprovision group membership based on group memberships on the SSO side?
+        "deprovision_behavior": None,  # string - Method used for deprovisioning users.
+        "provision_group_default": None,  # string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
+        "provision_group_exclusion": None,  # string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
+        "provision_group_inclusion": None,  # string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
+        "provision_group_required": None,  # string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
+        "provision_email_signup_groups": None,  # string - Comma-separated list of group names whose members will be created with email_signup authentication.
+        "provision_readonly_site_admin_groups": None,  # string - Comma-separated list of group names whose members will be created as Read-Only Site Admins.
+        "provision_site_admin_groups": None,  # string - Comma-separated list of group names whose members will be created as Site Admins.
+        "provision_group_admin_groups": None,  # string - Comma-separated list of group names whose members will be provisioned as Group Admins.
+        "provision_attachments_permission": None,  # boolean
+        "provision_dav_permission": None,  # boolean - Auto-provisioned users get WebDAV permission?
+        "provision_ftp_permission": None,  # boolean - Auto-provisioned users get FTP permission?
+        "provision_sftp_permission": None,  # boolean - Auto-provisioned users get SFTP permission?
+        "provision_time_zone": None,  # string - Default time zone for auto provisioned users.
+        "provision_company": None,  # string - Default company for auto provisioned users.
+        "provision_require_2fa": None,  # string - 2FA required setting for auto provisioned users.
+        "provision_filesystem_layout": None,  # string - File System layout to use for auto provisioned users.
+        "provider_identifier": None,  # string - URL-friendly, unique identifier for Azure SAML configuration
+        "ldap_base_dn": None,  # string - Base DN for looking up users in LDAP server
+        "ldap_domain": None,  # string - Domain name that will be appended to LDAP usernames
+        "enabled": None,  # boolean - Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
+        "ldap_host": None,  # string - LDAP host
+        "ldap_host_2": None,  # string - LDAP backup host
+        "ldap_host_3": None,  # string - LDAP backup host
+        "ldap_port": None,  # int64 - LDAP port
+        "ldap_secure": None,  # boolean - Use secure LDAP?
+        "ldap_username": None,  # string - Username for signing in to LDAP server.
+        "ldap_username_field": None,  # string - LDAP username field
+    }
+
+    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 SsoStrategy.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in SsoStrategy.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Synchronize provisioning data with the SSO remote server
+    def sync(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(
+            "POST",
+            "/sso_strategies/{id}/sync".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+
+# 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(SsoStrategy, "GET", "/sso_strategies", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Sso Strategy 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", "/sso_strategies/{id}".format(id=params["id"]), params, options
+    )
+    return SsoStrategy(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Synchronize provisioning data with the SSO remote server
+def sync(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(
+        "POST",
+        "/sso_strategies/{id}/sync".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+def new(*args, **kwargs):
+    return SsoStrategy(*args, **kwargs)

files_sdk/models/status.py

@@ -0,0 +1,42 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class Status:
+    default_attributes = {
+        "code": None,  # int64 - Status HTTP code
+        "message": None,  # string - Error message
+        "status": None,  # string - Status message
+        "data": None,  # Auto - Additional data
+        "errors": None,  # array(object) - A list of api errors
+        "clickwrap_id": None,  # int64 - Required Clickwrap id
+        "clickwrap_body": None,  # string - Required Clickwrap body
+    }
+
+    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 Status.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Status.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+def new(*args, **kwargs):
+    return Status(*args, **kwargs)

files_sdk/models/style.py

@@ -0,0 +1,152 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class Style:
+    default_attributes = {
+        "id": None,  # int64 - Style ID
+        "path": None,  # string - Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "logo": None,  # Image - Logo
+        "thumbnail": None,  # Image - Logo thumbnail
+        "file": None,  # file - Logo for custom branding.
+    }
+
+    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 Style.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Style.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Parameters:
+    #   file (required) - file - Logo for custom branding.
+    def update(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 "file" not in params:
+            raise MissingParameterError("Parameter missing: file")
+        if "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        response, _options = Api.send_request(
+            "PATCH",
+            "/styles/{path}".format(path=params["path"]),
+            params,
+            self.options,
+        )
+        return response.data
+
+    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 "path" in params and not isinstance(params["path"], str):
+            raise InvalidParameterError("Bad parameter: path must be an str")
+        Api.send_request(
+            "DELETE",
+            "/styles/{path}".format(path=params["path"]),
+            params,
+            self.options,
+        )
+
+    def destroy(self, params=None):
+        self.delete(params)
+
+    def save(self):
+        new_obj = self.update(self.get_attributes())
+        self.set_attributes(new_obj.get_attributes())
+        return True
+
+
+# Parameters:
+#   path (required) - string - Style path.
+def find(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 "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    response, options = Api.send_request(
+        "GET", "/styles/{path}".format(path=params["path"]), params, options
+    )
+    return Style(response.data, options)
+
+
+def get(path, params=None, options=None):
+    find(path, params, options)
+
+
+# Parameters:
+#   file (required) - file - Logo for custom branding.
+def update(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 "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    if "file" not in params:
+        raise MissingParameterError("Parameter missing: file")
+    response, options = Api.send_request(
+        "PATCH", "/styles/{path}".format(path=params["path"]), params, options
+    )
+    return Style(response.data, options)
+
+
+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 "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    Api.send_request(
+        "DELETE", "/styles/{path}".format(path=params["path"]), params, options
+    )
+
+
+def destroy(path, params=None, options=None):
+    delete(path, params, options)
+
+
+def new(*args, **kwargs):
+    return Style(*args, **kwargs)