files-com 1.5.0__py3-none-any.whl

files_sdk/list_obj.py

@@ -0,0 +1,42 @@
+from files_sdk.api import Api
+
+
+class ListObj:
+    def __init__(self, klass, path, method, params, options):
+        self.klass = klass
+        self.path = path
+        self.method = method
+        self.params = params
+        self.options = options
+        self.data = []
+        self.cursor = None
+
+        self.load_next_page()
+
+    def load_next_page(self):
+        if self.cursor is not None:
+            self.params["cursor"] = self.cursor
+        response, _options = Api.send_request(
+            self.path, self.method, self.params, self.options
+        )
+        self.data = [self.klass(d, self.options) for d in response.data]
+        self.cursor = response.headers.get("X-Files-Cursor", None)
+        return self
+
+    def __iter__(self):
+        return self.data.__iter__()
+
+    def __len__(self):
+        return self.data.__len__()
+
+    def auto_paging_iter(self):
+        while True:
+            for item in self.data:
+                yield item
+            if not self.has_next_page:
+                break
+            self.load_next_page()
+
+    @property
+    def has_next_page(self):
+        return True if self.cursor is not None else False

files_sdk/models/__init__.py

@@ -0,0 +1,104 @@
+from files_sdk.models.account_line_item import AccountLineItem
+from files_sdk.models.action import Action
+from files_sdk.models.action_notification_export import (
+    ActionNotificationExport,
+)
+from files_sdk.models.action_notification_export_result import (
+    ActionNotificationExportResult,
+)
+from files_sdk.models.api_key import ApiKey
+from files_sdk.models.api_request_log import ApiRequestLog
+from files_sdk.models.app import App
+from files_sdk.models.as2_incoming_message import As2IncomingMessage
+from files_sdk.models.as2_outgoing_message import As2OutgoingMessage
+from files_sdk.models.as2_partner import As2Partner
+from files_sdk.models.as2_station import As2Station
+from files_sdk.models.auto import Auto
+from files_sdk.models.automation import Automation
+from files_sdk.models.automation_log import AutomationLog
+from files_sdk.models.automation_run import AutomationRun
+from files_sdk.models.bandwidth_snapshot import BandwidthSnapshot
+from files_sdk.models.behavior import Behavior
+from files_sdk.models.bundle import Bundle
+from files_sdk.models.bundle_action import BundleAction
+from files_sdk.models.bundle_download import BundleDownload
+from files_sdk.models.bundle_notification import BundleNotification
+from files_sdk.models.bundle_path import BundlePath
+from files_sdk.models.bundle_recipient import BundleRecipient
+from files_sdk.models.bundle_registration import BundleRegistration
+from files_sdk.models.clickwrap import Clickwrap
+from files_sdk.models.dns_record import DnsRecord
+from files_sdk.models.email_incoming_message import EmailIncomingMessage
+from files_sdk.models.email_log import EmailLog
+from files_sdk.models.errors import Errors
+from files_sdk.models.exavault_api_request_log import ExavaultApiRequestLog
+from files_sdk.models.external_event import ExternalEvent
+from files_sdk.models.file import File
+from files_sdk.models.file_action import FileAction
+from files_sdk.models.file_comment import FileComment
+from files_sdk.models.file_comment_reaction import FileCommentReaction
+from files_sdk.models.file_migration import FileMigration
+from files_sdk.models.file_migration_log import FileMigrationLog
+from files_sdk.models.file_upload_part import FileUploadPart
+from files_sdk.models.folder import Folder
+from files_sdk.models.form_field import FormField
+from files_sdk.models.form_field_set import FormFieldSet
+from files_sdk.models.ftp_action_log import FtpActionLog
+from files_sdk.models.gpg_key import GpgKey
+from files_sdk.models.group import Group
+from files_sdk.models.group_user import GroupUser
+from files_sdk.models.history import History
+from files_sdk.models.history_export import HistoryExport
+from files_sdk.models.history_export_result import HistoryExportResult
+from files_sdk.models.image import Image
+from files_sdk.models.inbox_recipient import InboxRecipient
+from files_sdk.models.inbox_registration import InboxRegistration
+from files_sdk.models.inbox_upload import InboxUpload
+from files_sdk.models.invoice import Invoice
+from files_sdk.models.invoice_line_item import InvoiceLineItem
+from files_sdk.models.ip_address import IpAddress
+from files_sdk.models.lock import Lock
+from files_sdk.models.message import Message
+from files_sdk.models.message_comment import MessageComment
+from files_sdk.models.message_comment_reaction import MessageCommentReaction
+from files_sdk.models.message_reaction import MessageReaction
+from files_sdk.models.notification import Notification
+from files_sdk.models.outbound_connection_log import OutboundConnectionLog
+from files_sdk.models.payment import Payment
+from files_sdk.models.payment_line_item import PaymentLineItem
+from files_sdk.models.permission import Permission
+from files_sdk.models.preview import Preview
+from files_sdk.models.priority import Priority
+from files_sdk.models.project import Project
+from files_sdk.models.public_hosting_request_log import PublicHostingRequestLog
+from files_sdk.models.public_ip_address import PublicIpAddress
+from files_sdk.models.public_key import PublicKey
+from files_sdk.models.remote_bandwidth_snapshot import RemoteBandwidthSnapshot
+from files_sdk.models.remote_server import RemoteServer
+from files_sdk.models.remote_server_configuration_file import (
+    RemoteServerConfigurationFile,
+)
+from files_sdk.models.request import Request
+from files_sdk.models.restore import Restore
+from files_sdk.models.session import Session
+from files_sdk.models.settings_change import SettingsChange
+from files_sdk.models.sftp_action_log import SftpActionLog
+from files_sdk.models.sftp_host_key import SftpHostKey
+from files_sdk.models.share_group import ShareGroup
+from files_sdk.models.share_group_member import ShareGroupMember
+from files_sdk.models.siem_http_destination import SiemHttpDestination
+from files_sdk.models.site import Site
+from files_sdk.models.snapshot import Snapshot
+from files_sdk.models.sso_strategy import SsoStrategy
+from files_sdk.models.status import Status
+from files_sdk.models.style import Style
+from files_sdk.models.sync_log import SyncLog
+from files_sdk.models.usage_by_top_level_dir import UsageByTopLevelDir
+from files_sdk.models.usage_daily_snapshot import UsageDailySnapshot
+from files_sdk.models.usage_snapshot import UsageSnapshot
+from files_sdk.models.user import User
+from files_sdk.models.user_cipher_use import UserCipherUse
+from files_sdk.models.user_request import UserRequest
+from files_sdk.models.user_sftp_client_use import UserSftpClientUse
+from files_sdk.models.web_dav_action_log import WebDavActionLog
+from files_sdk.models.webhook_test import WebhookTest

files_sdk/models/account_line_item.py

@@ -0,0 +1,51 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class AccountLineItem:
+    default_attributes = {
+        "id": None,  # int64 - Line item Id
+        "amount": None,  # double - Line item amount
+        "balance": None,  # double - Line item balance
+        "created_at": None,  # date-time - Line item created at
+        "currency": None,  # string - Line item currency
+        "download_uri": None,  # string - Line item download uri
+        "invoice_line_items": None,  # array(object) - Associated invoice line items
+        "method": None,  # string - Line item payment method
+        "payment_line_items": None,  # array(object) - Associated payment line items
+        "payment_reversed_at": None,  # date-time - Date/time payment was reversed if applicable
+        "payment_type": None,  # string - Type of payment if applicable
+        "site_name": None,  # string - Site name this line item is for
+        "type": None,  # string - Type of line item, either payment or invoice
+    }
+
+    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 AccountLineItem.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in AccountLineItem.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+def new(*args, **kwargs):
+    return AccountLineItem(*args, **kwargs)

files_sdk/models/action.py

@@ -0,0 +1,49 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class Action:
+    default_attributes = {
+        "id": None,  # int64 - Action ID
+        "path": None,  # string - Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "when": None,  # date-time - Action occurrence date/time
+        "destination": None,  # string - The destination path for this action, if applicable
+        "display": None,  # string - Friendly displayed output
+        "ip": None,  # string - IP Address that performed this action
+        "source": None,  # string - The source path for this action, if applicable
+        "targets": None,  # object - Targets
+        "user_id": None,  # int64 - User ID
+        "username": None,  # string - Username
+        "user_is_from_parent_site": None,  # boolean - true if this change was performed by a user on a parent site.
+        "action": None,  # string - Type of action
+        "failure_type": None,  # string - Failure type.  If action was a user login or session failure, why did it fail?
+        "interface": None,  # string - Interface on which this action occurred.
+    }
+
+    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 Action.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Action.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+def new(*args, **kwargs):
+    return Action(*args, **kwargs)

files_sdk/models/action_notification_export.py

@@ -0,0 +1,147 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class ActionNotificationExport:
+    default_attributes = {
+        "id": None,  # int64 - History Export ID
+        "export_version": None,  # string - Version of the underlying records for the export.
+        "start_at": None,  # date-time - Start date/time of export range.
+        "end_at": None,  # date-time - End date/time of export range.
+        "status": None,  # string - Status of export.  Valid values: `building`, `ready`, or `failed`
+        "query_path": None,  # string - Return notifications that were triggered by actions on this specific path.
+        "query_folder": None,  # string - Return notifications that were triggered by actions in this folder.
+        "query_message": None,  # string - Error message associated with the request, if any.
+        "query_request_method": None,  # string - The HTTP request method used by the webhook.
+        "query_request_url": None,  # string - The target webhook URL.
+        "query_status": None,  # string - The HTTP status returned from the server in response to the webhook request.
+        "query_success": None,  # boolean - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+        "results_url": None,  # string - If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
+        "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 ActionNotificationExport.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in ActionNotificationExport.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            raise NotImplementedError(
+                "The ActionNotificationExport object doesn't support updates."
+            )
+        else:
+            new_obj = create(self.get_attributes(), self.options)
+            self.set_attributes(new_obj.get_attributes())
+            return True
+
+
+# Parameters:
+#   id (required) - int64 - Action Notification Export 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",
+        "/action_notification_exports/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return ActionNotificationExport(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.
+#   start_at - string - Start date/time of export range.
+#   end_at - string - End date/time of export range.
+#   query_message - string - Error message associated with the request, if any.
+#   query_request_method - string - The HTTP request method used by the webhook.
+#   query_request_url - string - The target webhook URL.
+#   query_status - string - The HTTP status returned from the server in response to the webhook request.
+#   query_success - boolean - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+#   query_path - string - Return notifications that were triggered by actions on this specific path.
+#   query_folder - string - Return notifications that were triggered by actions in this folder.
+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 "start_at" in params and not isinstance(params["start_at"], str):
+        raise InvalidParameterError("Bad parameter: start_at must be an str")
+    if "end_at" in params and not isinstance(params["end_at"], str):
+        raise InvalidParameterError("Bad parameter: end_at must be an str")
+    if "query_message" in params and not isinstance(
+        params["query_message"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: query_message must be an str"
+        )
+    if "query_request_method" in params and not isinstance(
+        params["query_request_method"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: query_request_method must be an str"
+        )
+    if "query_request_url" in params and not isinstance(
+        params["query_request_url"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: query_request_url must be an str"
+        )
+    if "query_status" in params and not isinstance(
+        params["query_status"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: query_status must be an str"
+        )
+    if "query_path" in params and not isinstance(params["query_path"], str):
+        raise InvalidParameterError("Bad parameter: query_path must be an str")
+    if "query_folder" in params and not isinstance(
+        params["query_folder"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: query_folder must be an str"
+        )
+    response, options = Api.send_request(
+        "POST", "/action_notification_exports", params, options
+    )
+    return ActionNotificationExport(response.data, options)
+
+
+def new(*args, **kwargs):
+    return ActionNotificationExport(*args, **kwargs)

files_sdk/models/action_notification_export_result.py

@@ -0,0 +1,88 @@
+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 ActionNotificationExportResult:
+    default_attributes = {
+        "id": None,  # int64 - Notification ID
+        "created_at": None,  # int64 - When the notification was sent.
+        "status": None,  # int64 - HTTP status code returned in the webhook response.
+        "message": None,  # string - A message indicating the overall status of the webhook notification.
+        "success": None,  # boolean - `true` if the webhook succeeded by receiving a 200 or 204 response.
+        "request_headers": None,  # string - A JSON-encoded string with headers that were sent with the webhook.
+        "request_method": None,  # string - The HTTP verb used to perform the webhook.
+        "request_url": None,  # string - The webhook request URL.
+        "path": None,  # string - The path to the actual file that triggered this notification. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "folder": None,  # string - The folder associated with the triggering action for this notification.
+    }
+
+    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 ActionNotificationExportResult.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in ActionNotificationExportResult.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+# 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).
+#   action_notification_export_id (required) - int64 - ID of the associated action notification export.
+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 "action_notification_export_id" in params and not isinstance(
+        params["action_notification_export_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: action_notification_export_id must be an int"
+        )
+    if "action_notification_export_id" not in params:
+        raise MissingParameterError(
+            "Parameter missing: action_notification_export_id"
+        )
+    return ListObj(
+        ActionNotificationExportResult,
+        "GET",
+        "/action_notification_export_results",
+        params,
+        options,
+    )
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+def new(*args, **kwargs):
+    return ActionNotificationExportResult(*args, **kwargs)