appwrite-console 0.1.0__py3-none-any.whl

appwrite_console/models/attribute_list.py

@@ -0,0 +1,36 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .attribute_boolean import AttributeBoolean
+from .attribute_bigint import AttributeBigint
+from .attribute_integer import AttributeInteger
+from .attribute_float import AttributeFloat
+from .attribute_email import AttributeEmail
+from .attribute_enum import AttributeEnum
+from .attribute_url import AttributeUrl
+from .attribute_ip import AttributeIp
+from .attribute_datetime import AttributeDatetime
+from .attribute_relationship import AttributeRelationship
+from .attribute_point import AttributePoint
+from .attribute_line import AttributeLine
+from .attribute_polygon import AttributePolygon
+from .attribute_varchar import AttributeVarchar
+from .attribute_text import AttributeText
+from .attribute_mediumtext import AttributeMediumtext
+from .attribute_longtext import AttributeLongtext
+from .attribute_string import AttributeString
+
+class AttributeList(AppwriteModel):
+    """
+    Attributes List
+
+    Attributes
+    ----------
+    total : float
+        Total number of attributes in the given collection.
+    attributes : List[Union[AttributeBoolean, AttributeBigint, AttributeInteger, AttributeFloat, AttributeEmail, AttributeEnum, AttributeUrl, AttributeIp, AttributeDatetime, AttributeRelationship, AttributePoint, AttributeLine, AttributePolygon, AttributeVarchar, AttributeText, AttributeMediumtext, AttributeLongtext, AttributeString]]
+        List of attributes.
+    """
+    total: float = Field(..., alias='total')
+    attributes: List[Union[AttributeBoolean, AttributeBigint, AttributeInteger, AttributeFloat, AttributeEmail, AttributeEnum, AttributeUrl, AttributeIp, AttributeDatetime, AttributeRelationship, AttributePoint, AttributeLine, AttributePolygon, AttributeVarchar, AttributeText, AttributeMediumtext, AttributeLongtext, AttributeString]] = Field(..., alias='attributes')

appwrite_console/models/attribute_longtext.py

@@ -0,0 +1,43 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeLongtext(AppwriteModel):
+    """
+    AttributeLongtext
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    default : Optional[str]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    encrypt : Optional[bool]
+        Defines whether this attribute is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    default: Optional[str] = Field(default=None, alias='default')
+    encrypt: Optional[bool] = Field(default=None, alias='encrypt')

appwrite_console/models/attribute_mediumtext.py

@@ -0,0 +1,43 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeMediumtext(AppwriteModel):
+    """
+    AttributeMediumtext
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    default : Optional[str]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    encrypt : Optional[bool]
+        Defines whether this attribute is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    default: Optional[str] = Field(default=None, alias='default')
+    encrypt: Optional[bool] = Field(default=None, alias='encrypt')

appwrite_console/models/attribute_object.py

@@ -0,0 +1,37 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeObject(AppwriteModel):
+    """
+    AttributeObject
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')

appwrite_console/models/attribute_point.py

@@ -0,0 +1,40 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributePoint(AppwriteModel):
+    """
+    AttributePoint
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    default : Optional[List[Any]]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    default: Optional[List[Any]] = Field(default=None, alias='default')

appwrite_console/models/attribute_polygon.py

@@ -0,0 +1,40 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributePolygon(AppwriteModel):
+    """
+    AttributePolygon
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    default : Optional[List[Any]]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    default: Optional[List[Any]] = Field(default=None, alias='default')

appwrite_console/models/attribute_relationship.py

@@ -0,0 +1,55 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeRelationship(AppwriteModel):
+    """
+    AttributeRelationship
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    relatedcollection : str
+        The ID of the related collection.
+    relationtype : str
+        The type of the relationship.
+    twoway : bool
+        Is the relationship two-way?
+    twowaykey : str
+        The key of the two-way relationship.
+    ondelete : str
+        How deleting the parent document will propagate to child documents.
+    side : str
+        Whether this is the parent or child side of the relationship
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    relatedcollection: str = Field(..., alias='relatedCollection')
+    relationtype: str = Field(..., alias='relationType')
+    twoway: bool = Field(..., alias='twoWay')
+    twowaykey: str = Field(..., alias='twoWayKey')
+    ondelete: str = Field(..., alias='onDelete')
+    side: str = Field(..., alias='side')

appwrite_console/models/attribute_string.py

@@ -0,0 +1,46 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeString(AppwriteModel):
+    """
+    AttributeString
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    size : float
+        Attribute size.
+    default : Optional[str]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    encrypt : Optional[bool]
+        Defines whether this attribute is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    size: float = Field(..., alias='size')
+    default: Optional[str] = Field(default=None, alias='default')
+    encrypt: Optional[bool] = Field(default=None, alias='encrypt')

appwrite_console/models/attribute_text.py

@@ -0,0 +1,43 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeText(AppwriteModel):
+    """
+    AttributeText
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    default : Optional[str]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    encrypt : Optional[bool]
+        Defines whether this attribute is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    default: Optional[str] = Field(default=None, alias='default')
+    encrypt: Optional[bool] = Field(default=None, alias='encrypt')

appwrite_console/models/attribute_url.py

@@ -0,0 +1,43 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeUrl(AppwriteModel):
+    """
+    AttributeURL
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    format : str
+        String format.
+    default : Optional[str]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    format: str = Field(..., alias='format')
+    default: Optional[str] = Field(default=None, alias='default')

appwrite_console/models/attribute_varchar.py

@@ -0,0 +1,46 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeVarchar(AppwriteModel):
+    """
+    AttributeVarchar
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    size : float
+        Attribute size.
+    default : Optional[str]
+        Default value for attribute when not provided. Cannot be set when attribute is required.
+    encrypt : Optional[bool]
+        Defines whether this attribute is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    size: float = Field(..., alias='size')
+    default: Optional[str] = Field(default=None, alias='default')
+    encrypt: Optional[bool] = Field(default=None, alias='encrypt')

appwrite_console/models/attribute_vector.py

@@ -0,0 +1,40 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.attribute_status import AttributeStatus
+
+class AttributeVector(AppwriteModel):
+    """
+    AttributeVector
+
+    Attributes
+    ----------
+    key : str
+        Attribute Key.
+    type : str
+        Attribute type.
+    status : AttributeStatus
+        Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an attribute.
+    required : bool
+        Is attribute required?
+    array : Optional[bool]
+        Is attribute an array?
+    createdat : str
+        Attribute creation date in ISO 8601 format.
+    updatedat : str
+        Attribute update date in ISO 8601 format.
+    size : float
+        Vector dimensions.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: AttributeStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    required: bool = Field(..., alias='required')
+    array: Optional[bool] = Field(default=None, alias='array')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    size: float = Field(..., alias='size')

appwrite_console/models/backup_archive.py

@@ -0,0 +1,48 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class BackupArchive(AppwriteModel):
+    """
+    Archive
+
+    Attributes
+    ----------
+    id : str
+        Archive ID.
+    createdat : str
+        Archive creation time in ISO 8601 format.
+    updatedat : str
+        Archive update date in ISO 8601 format.
+    policyid : str
+        Archive policy ID.
+    size : float
+        Archive size in bytes.
+    status : str
+        The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.
+    startedat : str
+        The backup start time.
+    migrationid : str
+        Migration ID.
+    services : List[Any]
+        The services that are backed up by this archive.
+    resources : List[Any]
+        The resources that are backed up by this archive.
+    resourceid : Optional[str]
+        The resource ID to backup. Set only if this archive should backup a single resource.
+    resourcetype : Optional[str]
+        The resource type to backup. Set only if this archive should backup a single resource.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    policyid: str = Field(..., alias='policyId')
+    size: float = Field(..., alias='size')
+    status: str = Field(..., alias='status')
+    startedat: str = Field(..., alias='startedAt')
+    migrationid: str = Field(..., alias='migrationId')
+    services: List[Any] = Field(..., alias='services')
+    resources: List[Any] = Field(..., alias='resources')
+    resourceid: Optional[str] = Field(default=None, alias='resourceId')
+    resourcetype: Optional[str] = Field(default=None, alias='resourceType')

appwrite_console/models/backup_archive_list.py

@@ -0,0 +1,19 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .backup_archive import BackupArchive
+
+class BackupArchiveList(AppwriteModel):
+    """
+    Backup archive list
+
+    Attributes
+    ----------
+    total : float
+        Total number of archives that matched your query.
+    archives : List[BackupArchive]
+        List of archives.
+    """
+    total: float = Field(..., alias='total')
+    archives: List[BackupArchive] = Field(..., alias='archives')

appwrite_console/models/backup_policy.py

@@ -0,0 +1,48 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class BackupPolicy(AppwriteModel):
+    """
+    backup
+
+    Attributes
+    ----------
+    id : str
+        Backup policy ID.
+    name : str
+        Backup policy name.
+    createdat : str
+        Policy creation date in ISO 8601 format.
+    updatedat : str
+        Policy update date in ISO 8601 format.
+    services : List[Any]
+        The services that are backed up by this policy.
+    resources : List[Any]
+        The resources that are backed up by this policy.
+    resourceid : Optional[str]
+        The resource ID to backup. Set only if this policy should backup a single resource.
+    resourcetype : Optional[str]
+        The resource type to backup. Set only if this policy should backup a single resource.
+    retention : float
+        How many days to keep the backup before it will be automatically deleted.
+    schedule : str
+        Policy backup schedule in CRON format.
+    type : str
+        Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).
+    enabled : bool
+        Is this policy enabled.
+    """
+    id: str = Field(..., alias='$id')
+    name: str = Field(..., alias='name')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    services: List[Any] = Field(..., alias='services')
+    resources: List[Any] = Field(..., alias='resources')
+    resourceid: Optional[str] = Field(default=None, alias='resourceId')
+    resourcetype: Optional[str] = Field(default=None, alias='resourceType')
+    retention: float = Field(..., alias='retention')
+    schedule: str = Field(..., alias='schedule')
+    type: str = Field(..., alias='type')
+    enabled: bool = Field(..., alias='enabled')

appwrite_console/models/backup_policy_list.py

@@ -0,0 +1,19 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .backup_policy import BackupPolicy
+
+class BackupPolicyList(AppwriteModel):
+    """
+    Backup policy list
+
+    Attributes
+    ----------
+    total : float
+        Total number of policies that matched your query.
+    policies : List[BackupPolicy]
+        List of policies.
+    """
+    total: float = Field(..., alias='total')
+    policies: List[BackupPolicy] = Field(..., alias='policies')