files-com 1.6.208__py3-none-any.whl

files_sdk/models/app.py

@@ -0,0 +1,89 @@
+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 App:
+    default_attributes = {
+        "app_type": None,  # string - The type of the App
+        "documentation_links": None,  # object - Collection of named links to documentation
+        "extended_description": None,  # string - Long description for the in-App landing page
+        "extended_description_for_marketing_site": None,  # string - Long form description of the App
+        "external_homepage_url": None,  # string - Link to external homepage
+        "featured": None,  # boolean - Is featured on the App listing?
+        "folder_behavior_type": None,  # string - Associated Folder Behavior type, if any
+        "icon_url": None,  # string - App icon
+        "logo_thumbnail_url": None,  # string - Logo thumbnail for the App
+        "logo_url": None,  # string - Full size logo for the App
+        "marketing_intro": None,  # string - Marketing introdution of the App
+        "marketing_youtube_url": None,  # string - Marketing video page
+        "name": None,  # string - Name of the App
+        "package_manager_install_command": None,  # string - Package manager install command
+        "remote_server_type": None,  # string - Associated Remote Server type, if any
+        "screenshot_list_urls": None,  # array(string) - Screenshots of the App
+        "sdk_installation_instructions_link": None,  # string - Link to SDK installation instructions
+        "short_description": None,  # string - Short description of the App
+        "sso_strategy_type": None,  # string - Associated SSO Strategy type, if any
+        "siem_type": None,  # string - Associated SIEM type, if any
+        "tutorial_youtube_url": None,  # string - Tutorial video page
+    }
+
+    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 App.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in App.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+# Parameters:
+#   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+#   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name` and `app_type`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]`.
+#   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(App, "GET", "/apps", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+def new(*args, **kwargs):
+    return App(*args, **kwargs)

files_sdk/models/as2_incoming_message.py

@@ -0,0 +1,117 @@
+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 As2IncomingMessage:
+    default_attributes = {
+        "id": None,  # int64 - Id of the AS2 Partner.
+        "workspace_id": None,  # int64 - ID of the Workspace associated with this AS2 Incoming Message.
+        "as2_partner_id": None,  # int64 - Id of the AS2 Partner associated with this message.
+        "as2_station_id": None,  # int64 - Id of the AS2 Station associated with this message.
+        "uuid": None,  # string - UUID assigned to this message.
+        "content_type": None,  # string - Content Type header of the incoming message.
+        "http_headers": None,  # object - HTTP Headers sent with this message.
+        "processing_result": None,  # string - Result of processing.
+        "processing_result_description": None,  # string - Result of processing description.
+        "mic": None,  # string - AS2 Message Integrity Check
+        "mic_algo": None,  # string - AS2 Message Integrity Check Algorithm Used
+        "as2_to": None,  # string - AS2 TO header of message
+        "as2_from": None,  # string - AS2 FROM header of message
+        "message_id": None,  # string - AS2 Message Id
+        "subject": None,  # string - AS2 Subject Header
+        "date": None,  # string - Date Header
+        "body_size": None,  # string - Encrypted Payload Body Size
+        "attachment_filename": None,  # string - Filename of the file being received.
+        "ip": None,  # string - IP Address of the Sender
+        "created_at": None,  # date-time - Message creation date/time
+        "http_response_code": None,  # string - HTTP Response Code sent for this message
+        "http_response_headers": None,  # object - HTTP Headers sent for this message.
+        "recipient_serial": None,  # string - Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial
+        "hex_recipient_serial": None,  # string - Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format.
+        "recipient_issuer": None,  # string - Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer
+        "message_received": None,  # boolean - Message body received?
+        "message_decrypted": None,  # boolean - Message decrypted successfully?
+        "message_signature_verified": None,  # boolean - Message signature verified?
+        "message_processing_success": None,  # boolean - Message processed successfully?
+        "message_mdn_returned": None,  # boolean - MDN returned?
+        "encrypted_uri": None,  # string - URL to download the encrypted signed smime that is to sent as AS2 body
+        "smime_signed_uri": None,  # string - URL to download the file contents as smime with signature
+        "smime_uri": None,  # string - URL to download the file contents encoded as smime
+        "raw_uri": None,  # string - URL to download the original file contents
+        "mdn_response_uri": None,  # string - URL to download the http response 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 As2IncomingMessage.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in As2IncomingMessage.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+# 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 `workspace_id`, `created_at` or `as2_partner_id`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id`, `workspace_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]`, `[ workspace_id, created_at ]`, `[ as2_partner_id, created_at ]`, `[ workspace_id, as2_station_id ]`, `[ workspace_id, as2_partner_id ]`, `[ workspace_id, as2_station_id, created_at ]` or `[ workspace_id, as2_partner_id, created_at ]`.
+#   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+#   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+#   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+#   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+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_gt" in params and not isinstance(params["filter_gt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_gt must be an dict")
+    if "filter_gteq" in params and not isinstance(params["filter_gteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_gteq must be an dict"
+        )
+    if "filter_lt" in params and not isinstance(params["filter_lt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_lt must be an dict")
+    if "filter_lteq" in params and not isinstance(params["filter_lteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_lteq must be an dict"
+        )
+    return ListObj(
+        As2IncomingMessage, "GET", "/as2_incoming_messages", params, options
+    )
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+def new(*args, **kwargs):
+    return As2IncomingMessage(*args, **kwargs)

files_sdk/models/as2_outgoing_message.py

@@ -0,0 +1,113 @@
+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 As2OutgoingMessage:
+    default_attributes = {
+        "id": None,  # int64 - Id of the AS2 Partner.
+        "workspace_id": None,  # int64 - ID of the Workspace associated with this AS2 Outgoing Message.
+        "as2_partner_id": None,  # int64 - Id of the AS2 Partner associated with this message.
+        "as2_station_id": None,  # int64 - Id of the AS2 Station associated with this message.
+        "uuid": None,  # string - UUID assigned to this message.
+        "http_headers": None,  # object - HTTP Headers sent with this message.
+        "processing_result": None,  # string - Result of processing.
+        "processing_result_description": None,  # string - Result of processing description.
+        "mic": None,  # string - AS2 Message Integrity Check SHA1
+        "mic_sha_256": None,  # string - AS2 Message Integrity Check SHA256
+        "as2_to": None,  # string - AS2 TO
+        "as2_from": None,  # string - AS2 FROM
+        "date": None,  # string - Date Header
+        "message_id": None,  # string - AS2 Message Id
+        "body_size": None,  # string - Encrypted Payload Body Size
+        "attachment_filename": None,  # string - Filename of the file being sent.
+        "created_at": None,  # date-time - Message creation date/time
+        "http_response_code": None,  # string - HTTP Response Code received for this message
+        "http_response_headers": None,  # object - HTTP Headers received for this message.
+        "http_transmission_duration": None,  # double - HTTP transmission duration in seceonds
+        "mdn_received": None,  # boolean - Did the partner give a response body?
+        "mdn_valid": None,  # boolean - Is the response in MDN format?
+        "mdn_signature_verified": None,  # boolean - MDN signature verified?
+        "mdn_message_id_matched": None,  # boolean - MDN message id matched?
+        "mdn_mic_matched": None,  # boolean - MDN MIC matched?
+        "mdn_processing_success": None,  # boolean - MDN disposition indicate a successful processing?
+        "raw_uri": None,  # string - URL to download the original file contents
+        "smime_uri": None,  # string - URL to download the file contents encoded as smime
+        "smime_signed_uri": None,  # string - URL to download the file contents as smime with signature
+        "encrypted_uri": None,  # string - URL to download the encrypted signed smime that is to sent as AS2 body
+        "mdn_response_uri": None,  # string - URL to download the http response 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 As2OutgoingMessage.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in As2OutgoingMessage.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+# 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 `workspace_id`, `created_at` or `as2_partner_id`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id`, `workspace_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]`, `[ workspace_id, created_at ]`, `[ as2_partner_id, created_at ]`, `[ workspace_id, as2_station_id ]`, `[ workspace_id, as2_partner_id ]`, `[ workspace_id, as2_station_id, created_at ]` or `[ workspace_id, as2_partner_id, created_at ]`.
+#   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+#   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+#   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+#   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+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_gt" in params and not isinstance(params["filter_gt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_gt must be an dict")
+    if "filter_gteq" in params and not isinstance(params["filter_gteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_gteq must be an dict"
+        )
+    if "filter_lt" in params and not isinstance(params["filter_lt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_lt must be an dict")
+    if "filter_lteq" in params and not isinstance(params["filter_lteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_lteq must be an dict"
+        )
+    return ListObj(
+        As2OutgoingMessage, "GET", "/as2_outgoing_messages", params, options
+    )
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+def new(*args, **kwargs):
+    return As2OutgoingMessage(*args, **kwargs)