files-com 1.6.208__py3-none-any.whl

files_sdk/models/inbox_recipient.py

@@ -0,0 +1,124 @@
+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 InboxRecipient:
+    default_attributes = {
+        "company": None,  # string - The recipient's company.
+        "name": None,  # string - The recipient's name.
+        "note": None,  # string - A note sent to the recipient with the inbox.
+        "recipient": None,  # string - The recipient's email address.
+        "sent_at": None,  # date-time - When the Inbox was shared with this recipient.
+        "inbox_id": None,  # int64 - Inbox to share.
+        "share_after_create": None,  # boolean - Set to true to share the link with the recipient upon creation.
+    }
+
+    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 InboxRecipient.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in InboxRecipient.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            raise NotImplementedError(
+                "The InboxRecipient object doesn't support updates."
+            )
+        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).
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+#   inbox_id (required) - int64 - List recipients for the inbox with this ID.
+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 "inbox_id" in params and not isinstance(params["inbox_id"], int):
+        raise InvalidParameterError("Bad parameter: inbox_id must be an int")
+    if "inbox_id" not in params:
+        raise MissingParameterError("Parameter missing: inbox_id")
+    return ListObj(InboxRecipient, "GET", "/inbox_recipients", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   inbox_id (required) - int64 - Inbox to share.
+#   recipient (required) - string - Email address to share this inbox with.
+#   name - string - Name of recipient.
+#   company - string - Company of recipient.
+#   note - string - Note to include in email.
+#   share_after_create - boolean - Set to true to share the link with the recipient upon creation.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "inbox_id" in params and not isinstance(params["inbox_id"], int):
+        raise InvalidParameterError("Bad parameter: inbox_id must be an int")
+    if "recipient" in params and not isinstance(params["recipient"], str):
+        raise InvalidParameterError("Bad parameter: recipient must be an str")
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "company" in params and not isinstance(params["company"], str):
+        raise InvalidParameterError("Bad parameter: company must be an str")
+    if "note" in params and not isinstance(params["note"], str):
+        raise InvalidParameterError("Bad parameter: note must be an str")
+    if "share_after_create" in params and not isinstance(
+        params["share_after_create"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: share_after_create must be an bool"
+        )
+    if "inbox_id" not in params:
+        raise MissingParameterError("Parameter missing: inbox_id")
+    if "recipient" not in params:
+        raise MissingParameterError("Parameter missing: recipient")
+    response, options = Api.send_request(
+        "POST", "/inbox_recipients", params, options
+    )
+    return InboxRecipient(response.data, options)
+
+
+def new(*args, **kwargs):
+    return InboxRecipient(*args, **kwargs)

files_sdk/models/inbox_registration.py

@@ -0,0 +1,79 @@
+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 InboxRegistration:
+    default_attributes = {
+        "code": None,  # string - Registration cookie code
+        "name": None,  # string - Registrant name
+        "company": None,  # string - Registrant company name
+        "email": None,  # string - Registrant email address
+        "ip": None,  # string - Registrant IP Address
+        "clickwrap_body": None,  # string - Clickwrap text that was shown to the registrant
+        "form_field_set_id": None,  # int64 - Id of associated form field set
+        "form_field_data": None,  # object - Data for form field set with form field ids as keys and user data as values
+        "inbox_id": None,  # int64 - Id of associated inbox
+        "inbox_recipient_id": None,  # int64 - Id of associated inbox recipient
+        "inbox_title": None,  # string - Title of associated inbox
+        "created_at": None,  # date-time - Registration creation date/time
+    }
+
+    def __init__(self, attributes=None, options=None):
+        if not isinstance(attributes, dict):
+            attributes = {}
+        if not isinstance(options, dict):
+            options = {}
+        self.set_attributes(attributes)
+        self.options = options
+
+    def set_attributes(self, attributes):
+        for (
+            attribute,
+            default_value,
+        ) in InboxRegistration.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in InboxRegistration.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).
+#   folder_behavior_id - int64 - ID of the associated Inbox. This is required if the user is not a site admin.
+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 "folder_behavior_id" in params and not isinstance(
+        params["folder_behavior_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: folder_behavior_id must be an int"
+        )
+    return ListObj(
+        InboxRegistration, "GET", "/inbox_registrations", params, options
+    )
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+def new(*args, **kwargs):
+    return InboxRegistration(*args, **kwargs)

files_sdk/models/inbox_upload.py

@@ -0,0 +1,80 @@
+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 InboxUpload:
+    default_attributes = {
+        "inbox_registration": None,  # InboxRegistration
+        "path": None,  # string - Upload path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "created_at": None,  # date-time - Upload date/time
+    }
+
+    def __init__(self, attributes=None, options=None):
+        if not isinstance(attributes, dict):
+            attributes = {}
+        if not isinstance(options, dict):
+            options = {}
+        self.set_attributes(attributes)
+        self.options = options
+
+    def set_attributes(self, attributes):
+        for attribute, default_value in InboxUpload.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in InboxUpload.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 `created_at`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `folder_behavior_id` or `inbox_registration_id`. Valid field combinations are `[ folder_behavior_id, created_at ]`, `[ inbox_registration_id, created_at ]`, `[ folder_behavior_id, inbox_registration_id ]` or `[ folder_behavior_id, inbox_registration_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(InboxUpload, "GET", "/inbox_uploads", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+def new(*args, **kwargs):
+    return InboxUpload(*args, **kwargs)

files_sdk/models/invoice.py

@@ -0,0 +1,91 @@
+import builtins  # noqa: F401
+from files_sdk.models.account_line_item import AccountLineItem
+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 Invoice:
+    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 Invoice.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Invoice.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).
+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(AccountLineItem, "GET", "/invoices", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Invoice 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", "/invoices/{id}".format(id=params["id"]), params, options
+    )
+    return AccountLineItem(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+def new(*args, **kwargs):
+    return Invoice(*args, **kwargs)

files_sdk/models/invoice_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 InvoiceLineItem:
+    default_attributes = {
+        "id": None,  # int64 - Invoice Line item Id
+        "amount": None,  # double - Invoice line item amount
+        "created_at": None,  # date-time - Invoice line item created at date/time
+        "description": None,  # string - Invoice line item description
+        "type": None,  # string - Invoice line item type
+        "service_end_at": None,  # date-time - Invoice line item service end date/time
+        "service_start_at": None,  # date-time - Invoice line item service start date/time
+        "plan": None,  # string - Plan name
+        "site": None,  # string - Site name
+        "prepaid_bytes": None,  # int64 - Prepaid bytes purchased for this invoice line item
+        "prepaid_bytes_expire_at": None,  # date-time - When the prepaid bytes expire
+        "prepaid_bytes_used": None,  # int64 - Total prepaid bytes used for this invoice line item
+        "prepaid_bytes_available": None,  # int64 - Available prepaid bytes for this invoice line item
+    }
+
+    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 InvoiceLineItem.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in InvoiceLineItem.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+def new(*args, **kwargs):
+    return InvoiceLineItem(*args, **kwargs)

files_sdk/models/ip_address.py

@@ -0,0 +1,119 @@
+import builtins  # noqa: F401
+from files_sdk.models.public_ip_address import PublicIpAddress
+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 IpAddress:
+    default_attributes = {
+        "id": None,  # string - Unique label for list; used by Zapier and other integrations.
+        "associated_with": None,  # string - The object that this public IP address list is associated with.
+        "group_id": None,  # int64 - Group ID
+        "ip_addresses": None,  # array(string) - A list of IP addresses.
+    }
+
+    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 IpAddress.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in IpAddress.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).
+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(IpAddress, "GET", "/ip_addresses", params, options)
+
+
+def all(params=None, options=None):
+    list(params, 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).
+def get_smartfile_reserved(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(
+        PublicIpAddress,
+        "GET",
+        "/ip_addresses/smartfile-reserved",
+        params,
+        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).
+def get_exavault_reserved(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(
+        PublicIpAddress,
+        "GET",
+        "/ip_addresses/exavault-reserved",
+        params,
+        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).
+def get_reserved(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(
+        PublicIpAddress, "GET", "/ip_addresses/reserved", params, options
+    )
+
+
+def new(*args, **kwargs):
+    return IpAddress(*args, **kwargs)