appwrite-console 0.1.0__py3-none-any.whl

appwrite_console/models/session.py

@@ -0,0 +1,99 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Session(AppwriteModel):
+    """
+    Session
+
+    Attributes
+    ----------
+    id : str
+        Session ID.
+    createdat : str
+        Session creation date in ISO 8601 format.
+    updatedat : str
+        Session update date in ISO 8601 format.
+    userid : str
+        User ID.
+    expire : str
+        Session expiration date in ISO 8601 format.
+    provider : str
+        Session Provider.
+    provideruid : str
+        Session Provider User ID.
+    provideraccesstoken : str
+        Session Provider Access Token.
+    provideraccesstokenexpiry : str
+        The date of when the access token expires in ISO 8601 format.
+    providerrefreshtoken : str
+        Session Provider Refresh Token.
+    ip : str
+        IP in use when the session was created.
+    oscode : str
+        Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
+    osname : str
+        Operating system name.
+    osversion : str
+        Operating system version.
+    clienttype : str
+        Client type.
+    clientcode : str
+        Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
+    clientname : str
+        Client name.
+    clientversion : str
+        Client version.
+    clientengine : str
+        Client engine name.
+    clientengineversion : str
+        Client engine name.
+    devicename : str
+        Device name.
+    devicebrand : str
+        Device brand name.
+    devicemodel : str
+        Device model name.
+    countrycode : str
+        Country two-character ISO 3166-1 alpha code.
+    countryname : str
+        Country name.
+    current : bool
+        Returns true if this the current user session.
+    factors : List[Any]
+        Returns a list of active session factors.
+    secret : str
+        Secret used to authenticate the user. Only included if the request was made with an API key
+    mfaupdatedat : str
+        Most recent date in ISO 8601 format when the session successfully passed MFA challenge.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    userid: str = Field(..., alias='userId')
+    expire: str = Field(..., alias='expire')
+    provider: str = Field(..., alias='provider')
+    provideruid: str = Field(..., alias='providerUid')
+    provideraccesstoken: str = Field(..., alias='providerAccessToken')
+    provideraccesstokenexpiry: str = Field(..., alias='providerAccessTokenExpiry')
+    providerrefreshtoken: str = Field(..., alias='providerRefreshToken')
+    ip: str = Field(..., alias='ip')
+    oscode: str = Field(..., alias='osCode')
+    osname: str = Field(..., alias='osName')
+    osversion: str = Field(..., alias='osVersion')
+    clienttype: str = Field(..., alias='clientType')
+    clientcode: str = Field(..., alias='clientCode')
+    clientname: str = Field(..., alias='clientName')
+    clientversion: str = Field(..., alias='clientVersion')
+    clientengine: str = Field(..., alias='clientEngine')
+    clientengineversion: str = Field(..., alias='clientEngineVersion')
+    devicename: str = Field(..., alias='deviceName')
+    devicebrand: str = Field(..., alias='deviceBrand')
+    devicemodel: str = Field(..., alias='deviceModel')
+    countrycode: str = Field(..., alias='countryCode')
+    countryname: str = Field(..., alias='countryName')
+    current: bool = Field(..., alias='current')
+    factors: List[Any] = Field(..., alias='factors')
+    secret: str = Field(..., alias='secret')
+    mfaupdatedat: str = Field(..., alias='mfaUpdatedAt')

appwrite_console/models/session_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 .session import Session
+
+class SessionList(AppwriteModel):
+    """
+    Sessions List
+
+    Attributes
+    ----------
+    total : float
+        Total number of sessions that matched your query.
+    sessions : List[Session]
+        List of sessions.
+    """
+    total: float = Field(..., alias='total')
+    sessions: List[Session] = Field(..., alias='sessions')

appwrite_console/models/site.py

@@ -0,0 +1,115 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .variable import Variable
+
+class Site(AppwriteModel):
+    """
+    Site
+
+    Attributes
+    ----------
+    id : str
+        Site ID.
+    createdat : str
+        Site creation date in ISO 8601 format.
+    updatedat : str
+        Site update date in ISO 8601 format.
+    name : str
+        Site name.
+    enabled : bool
+        Site enabled.
+    live : bool
+        Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.
+    logging : bool
+        When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
+    framework : str
+        Site framework.
+    deploymentretention : float
+        How many days to keep the non-active deployments before they will be automatically deleted.
+    deploymentid : str
+        Site's active deployment ID.
+    deploymentcreatedat : str
+        Active deployment creation date in ISO 8601 format.
+    deploymentscreenshotlight : str
+        Screenshot of active deployment with light theme preference file ID.
+    deploymentscreenshotdark : str
+        Screenshot of active deployment with dark theme preference file ID.
+    latestdeploymentid : str
+        Site's latest deployment ID.
+    latestdeploymentcreatedat : str
+        Latest deployment creation date in ISO 8601 format.
+    latestdeploymentstatus : str
+        Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
+    vars : List[Variable]
+        Site variables.
+    timeout : float
+        Site request timeout in seconds.
+    installcommand : str
+        The install command used to install the site dependencies.
+    buildcommand : str
+        The build command used to build the site.
+    startcommand : str
+        Custom command to use when starting site runtime.
+    outputdirectory : str
+        The directory where the site build output is located.
+    installationid : str
+        Site VCS (Version Control System) installation id.
+    providerrepositoryid : str
+        VCS (Version Control System) Repository ID
+    providerbranch : str
+        VCS (Version Control System) branch name
+    providerrootdirectory : str
+        Path to site in VCS (Version Control System) repository
+    providersilentmode : bool
+        Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
+    providerbranches : List[Any]
+        List of branch name patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all branches.
+    providerpaths : List[Any]
+        List of file path patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all file changes.
+    buildspecification : str
+        Machine specification for deployment builds.
+    runtimespecification : str
+        Machine specification for SSR executions.
+    buildruntime : str
+        Site build runtime.
+    adapter : str
+        Site framework adapter.
+    fallbackfile : str
+        Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    name: str = Field(..., alias='name')
+    enabled: bool = Field(..., alias='enabled')
+    live: bool = Field(..., alias='live')
+    logging: bool = Field(..., alias='logging')
+    framework: str = Field(..., alias='framework')
+    deploymentretention: float = Field(..., alias='deploymentRetention')
+    deploymentid: str = Field(..., alias='deploymentId')
+    deploymentcreatedat: str = Field(..., alias='deploymentCreatedAt')
+    deploymentscreenshotlight: str = Field(..., alias='deploymentScreenshotLight')
+    deploymentscreenshotdark: str = Field(..., alias='deploymentScreenshotDark')
+    latestdeploymentid: str = Field(..., alias='latestDeploymentId')
+    latestdeploymentcreatedat: str = Field(..., alias='latestDeploymentCreatedAt')
+    latestdeploymentstatus: str = Field(..., alias='latestDeploymentStatus')
+    vars: List[Variable] = Field(..., alias='vars')
+    timeout: float = Field(..., alias='timeout')
+    installcommand: str = Field(..., alias='installCommand')
+    buildcommand: str = Field(..., alias='buildCommand')
+    startcommand: str = Field(..., alias='startCommand')
+    outputdirectory: str = Field(..., alias='outputDirectory')
+    installationid: str = Field(..., alias='installationId')
+    providerrepositoryid: str = Field(..., alias='providerRepositoryId')
+    providerbranch: str = Field(..., alias='providerBranch')
+    providerrootdirectory: str = Field(..., alias='providerRootDirectory')
+    providersilentmode: bool = Field(..., alias='providerSilentMode')
+    providerbranches: List[Any] = Field(..., alias='providerBranches')
+    providerpaths: List[Any] = Field(..., alias='providerPaths')
+    buildspecification: str = Field(..., alias='buildSpecification')
+    runtimespecification: str = Field(..., alias='runtimeSpecification')
+    buildruntime: str = Field(..., alias='buildRuntime')
+    adapter: str = Field(..., alias='adapter')
+    fallbackfile: str = Field(..., alias='fallbackFile')

appwrite_console/models/site_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 .site import Site
+
+class SiteList(AppwriteModel):
+    """
+    Sites List
+
+    Attributes
+    ----------
+    total : float
+        Total number of sites that matched your query.
+    sites : List[Site]
+        List of sites.
+    """
+    total: float = Field(..., alias='total')
+    sites: List[Site] = Field(..., alias='sites')

appwrite_console/models/specification.py

@@ -0,0 +1,24 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Specification(AppwriteModel):
+    """
+    Specification
+
+    Attributes
+    ----------
+    memory : float
+        Memory size in MB.
+    cpus : float
+        Number of CPUs.
+    enabled : bool
+        Is size enabled.
+    slug : str
+        Size slug.
+    """
+    memory: float = Field(..., alias='memory')
+    cpus: float = Field(..., alias='cpus')
+    enabled: bool = Field(..., alias='enabled')
+    slug: str = Field(..., alias='slug')

appwrite_console/models/specification_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 .specification import Specification
+
+class SpecificationList(AppwriteModel):
+    """
+    Specifications List
+
+    Attributes
+    ----------
+    total : float
+        Total number of specifications that matched your query.
+    specifications : List[Specification]
+        List of specifications.
+    """
+    total: float = Field(..., alias='total')
+    specifications: List[Specification] = Field(..., alias='specifications')

appwrite_console/models/stage.py

@@ -0,0 +1,27 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Stage(AppwriteModel):
+    """
+    Stage
+
+    Attributes
+    ----------
+    id : str
+        Stage ID.
+    sdk : str
+        SDK method key (namespace.name) for this stage.
+    status : str
+        Stage status.
+    at : str
+        When the stage was completed or skipped, in ISO 8601 format.
+    actortype : str
+        Actor type when the stage was recorded.
+    """
+    id: str = Field(..., alias='id')
+    sdk: str = Field(..., alias='sdk')
+    status: str = Field(..., alias='status')
+    at: str = Field(..., alias='at')
+    actortype: str = Field(..., alias='actorType')

appwrite_console/models/stage_list.py

@@ -0,0 +1,16 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .stage import Stage
+
+class StageList(AppwriteModel):
+    """
+    Stages List
+
+    Attributes
+    ----------
+    stages : List[Stage]
+        List of stages.
+    """
+    stages: List[Stage] = Field(..., alias='stages')

appwrite_console/models/subscriber.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 .target import Target
+
+class Subscriber(AppwriteModel):
+    """
+    Subscriber
+
+    Attributes
+    ----------
+    id : str
+        Subscriber ID.
+    createdat : str
+        Subscriber creation time in ISO 8601 format.
+    updatedat : str
+        Subscriber update date in ISO 8601 format.
+    targetid : str
+        Target ID.
+    target : Target
+        Target.
+    userid : str
+        Topic ID.
+    username : str
+        User Name.
+    topicid : str
+        Topic ID.
+    providertype : str
+        The target provider type. Can be one of the following: `email`, `sms` or `push`.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    targetid: str = Field(..., alias='targetId')
+    target: Target = Field(..., alias='target')
+    userid: str = Field(..., alias='userId')
+    username: str = Field(..., alias='userName')
+    topicid: str = Field(..., alias='topicId')
+    providertype: str = Field(..., alias='providerType')

appwrite_console/models/subscriber_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 .subscriber import Subscriber
+
+class SubscriberList(AppwriteModel):
+    """
+    Subscriber list
+
+    Attributes
+    ----------
+    total : float
+        Total number of subscribers that matched your query.
+    subscribers : List[Subscriber]
+        List of subscribers.
+    """
+    total: float = Field(..., alias='total')
+    subscribers: List[Subscriber] = Field(..., alias='subscribers')

appwrite_console/models/table.py

@@ -0,0 +1,67 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .column_boolean import ColumnBoolean
+from .column_bigint import ColumnBigint
+from .column_integer import ColumnInteger
+from .column_float import ColumnFloat
+from .column_email import ColumnEmail
+from .column_enum import ColumnEnum
+from .column_url import ColumnUrl
+from .column_ip import ColumnIp
+from .column_datetime import ColumnDatetime
+from .column_relationship import ColumnRelationship
+from .column_point import ColumnPoint
+from .column_line import ColumnLine
+from .column_polygon import ColumnPolygon
+from .column_varchar import ColumnVarchar
+from .column_text import ColumnText
+from .column_mediumtext import ColumnMediumtext
+from .column_longtext import ColumnLongtext
+from .column_string import ColumnString
+from .column_index import ColumnIndex
+
+class Table(AppwriteModel):
+    """
+    Table
+
+    Attributes
+    ----------
+    id : str
+        Table ID.
+    createdat : str
+        Table creation date in ISO 8601 format.
+    updatedat : str
+        Table update date in ISO 8601 format.
+    permissions : List[Any]
+        Table permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+    databaseid : str
+        Database ID.
+    name : str
+        Table name.
+    enabled : bool
+        Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.
+    rowsecurity : bool
+        Whether row-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
+    columns : List[Union[ColumnBoolean, ColumnBigint, ColumnInteger, ColumnFloat, ColumnEmail, ColumnEnum, ColumnUrl, ColumnIp, ColumnDatetime, ColumnRelationship, ColumnPoint, ColumnLine, ColumnPolygon, ColumnVarchar, ColumnText, ColumnMediumtext, ColumnLongtext, ColumnString]]
+        Table columns.
+    indexes : List[ColumnIndex]
+        Table indexes.
+    bytesmax : float
+        Maximum row size in bytes. Returns 0 when no limit applies.
+    bytesused : float
+        Currently used row size in bytes based on defined columns.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    permissions: List[Any] = Field(..., alias='$permissions')
+    databaseid: str = Field(..., alias='databaseId')
+    name: str = Field(..., alias='name')
+    enabled: bool = Field(..., alias='enabled')
+    rowsecurity: bool = Field(..., alias='rowSecurity')
+    columns: List[Union[ColumnBoolean, ColumnBigint, ColumnInteger, ColumnFloat, ColumnEmail, ColumnEnum, ColumnUrl, ColumnIp, ColumnDatetime, ColumnRelationship, ColumnPoint, ColumnLine, ColumnPolygon, ColumnVarchar, ColumnText, ColumnMediumtext, ColumnLongtext, ColumnString]] = Field(..., alias='columns')
+    indexes: List[ColumnIndex] = Field(..., alias='indexes')
+    bytesmax: float = Field(..., alias='bytesMax')
+    bytesused: float = Field(..., alias='bytesUsed')

appwrite_console/models/table_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 .table import Table
+
+class TableList(AppwriteModel):
+    """
+    Tables List
+
+    Attributes
+    ----------
+    total : float
+        Total number of tables that matched your query.
+    tables : List[Table]
+        List of tables.
+    """
+    total: float = Field(..., alias='total')
+    tables: List[Table] = Field(..., alias='tables')

appwrite_console/models/target.py

@@ -0,0 +1,39 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Target(AppwriteModel):
+    """
+    Target
+
+    Attributes
+    ----------
+    id : str
+        Target ID.
+    createdat : str
+        Target creation time in ISO 8601 format.
+    updatedat : str
+        Target update date in ISO 8601 format.
+    name : str
+        Target Name.
+    userid : str
+        User ID.
+    providerid : Optional[str]
+        Provider ID.
+    providertype : str
+        The target provider type. Can be one of the following: `email`, `sms` or `push`.
+    identifier : str
+        The target identifier.
+    expired : bool
+        Is the target expired.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    name: str = Field(..., alias='name')
+    userid: str = Field(..., alias='userId')
+    providerid: Optional[str] = Field(default=None, alias='providerId')
+    providertype: str = Field(..., alias='providerType')
+    identifier: str = Field(..., alias='identifier')
+    expired: bool = Field(..., alias='expired')

appwrite_console/models/target_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 .target import Target
+
+class TargetList(AppwriteModel):
+    """
+    Target list
+
+    Attributes
+    ----------
+    total : float
+        Total number of targets that matched your query.
+    targets : List[Target]
+        List of targets.
+    """
+    total: float = Field(..., alias='total')
+    targets: List[Target] = Field(..., alias='targets')

appwrite_console/models/team.py

@@ -0,0 +1,43 @@
+from typing import Any, Dict, List, Optional, Union, cast, Generic, TypeVar, Type
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .preferences import Preferences
+
+T = TypeVar('T')
+
+class Team(AppwriteModel, Generic[T]):
+    """
+    Team
+
+    Attributes
+    ----------
+    id : str
+        Team ID.
+    createdat : str
+        Team creation date in ISO 8601 format.
+    updatedat : str
+        Team update date in ISO 8601 format.
+    name : str
+        Team name.
+    total : float
+        Total number of team members.
+    prefs : Preferences[T]
+        Team preferences as a key-value object
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    name: str = Field(..., alias='name')
+    total: float = Field(..., alias='total')
+    prefs: Preferences[T] = Field(..., alias='prefs')
+
+    @classmethod
+    def with_data(cls, data: Dict[str, Any], model_type: Type[T] = dict) -> 'Team[T]':
+        """Create Team instance with typed data."""
+        instance = cls.model_validate(data)
+        if 'prefs' in data and data['prefs'] is not None:
+            instance.prefs = Preferences.with_data(
+                data['prefs'], model_type
+            )
+        return instance

appwrite_console/models/team_list.py

@@ -0,0 +1,32 @@
+from typing import Any, Dict, List, Optional, Union, cast, Generic, TypeVar, Type
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .team import Team
+
+T = TypeVar('T')
+
+class TeamList(AppwriteModel, Generic[T]):
+    """
+    Teams List
+
+    Attributes
+    ----------
+    total : float
+        Total number of teams that matched your query.
+    teams : List[Team[T]]
+        List of teams.
+    """
+    total: float = Field(..., alias='total')
+    teams: List[Team[T]] = Field(..., alias='teams')
+
+    @classmethod
+    def with_data(cls, data: Dict[str, Any], model_type: Type[T] = dict) -> 'TeamList[T]':
+        """Create TeamList instance with typed data."""
+        instance = cls.model_validate(data)
+        if 'teams' in data and data['teams'] is not None:
+            instance.teams = [
+                Team.with_data(row, model_type) 
+                for row in data['teams']
+            ]
+        return instance

appwrite_console/models/template_framework.py

@@ -0,0 +1,39 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class TemplateFramework(AppwriteModel):
+    """
+    Template Framework
+
+    Attributes
+    ----------
+    key : str
+        Parent framework key.
+    name : str
+        Framework Name.
+    installcommand : str
+        The install command used to install the dependencies.
+    buildcommand : str
+        The build command used to build the deployment.
+    outputdirectory : str
+        The output directory to store the build output.
+    providerrootdirectory : str
+        Path to site in VCS (Version Control System) repository
+    buildruntime : str
+        Runtime used during build step of template.
+    adapter : str
+        Site framework runtime
+    fallbackfile : str
+        Fallback file for SPA. Only relevant for static serve runtime.
+    """
+    key: str = Field(..., alias='key')
+    name: str = Field(..., alias='name')
+    installcommand: str = Field(..., alias='installCommand')
+    buildcommand: str = Field(..., alias='buildCommand')
+    outputdirectory: str = Field(..., alias='outputDirectory')
+    providerrootdirectory: str = Field(..., alias='providerRootDirectory')
+    buildruntime: str = Field(..., alias='buildRuntime')
+    adapter: str = Field(..., alias='adapter')
+    fallbackfile: str = Field(..., alias='fallbackFile')