appwrite-console 0.1.0__py3-none-any.whl

appwrite_console/models/console_region_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 .console_region import ConsoleRegion
+
+class ConsoleRegionList(AppwriteModel):
+    """
+    Regions list
+
+    Attributes
+    ----------
+    total : float
+        Total number of regions that matched your query.
+    regions : List[ConsoleRegion]
+        List of regions.
+    """
+    total: float = Field(..., alias='total')
+    regions: List[ConsoleRegion] = Field(..., alias='regions')

appwrite_console/models/console_variables.py

@@ -0,0 +1,96 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class ConsoleVariables(AppwriteModel):
+    """
+    Console Variables
+
+    Attributes
+    ----------
+    app_domain_target_cname : str
+        CNAME target for your Appwrite custom domains.
+    app_domain_target_a : str
+        A target for your Appwrite custom domains.
+    app_compute_build_timeout : float
+        Maximum build timeout in seconds.
+    app_domain_target_aaaa : str
+        AAAA target for your Appwrite custom domains.
+    app_domain_target_caa : str
+        CAA target for your Appwrite custom domains.
+    app_storage_limit : float
+        Maximum file size allowed for file upload in bytes.
+    app_compute_size_limit : float
+        Maximum file size allowed for deployment in bytes.
+    app_usage_stats : str
+        Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.
+    app_vcs_enabled : bool
+        Defines if VCS (Version Control System) is enabled.
+    app_vcs_providers : List[Any]
+        List of configured VCS providers.
+    app_domain_enabled : bool
+        Defines if main domain is configured. If so, custom domains can be created.
+    app_assistant_enabled : bool
+        Defines if AI assistant is enabled.
+    app_domain_sites : str
+        A comma separated list of domains to use for site URLs.
+    app_domain_functions : str
+        A domain to use for function URLs.
+    app_options_force_https : str
+        Defines if HTTPS is enforced for all requests.
+    app_domains_nameservers : str
+        Comma-separated list of nameservers.
+    app_db_adapter : str
+        Database adapter in use.
+    supportforrelationships : bool
+        Whether the database adapter supports relationships.
+    supportforoperators : bool
+        Whether the database adapter supports operators.
+    supportforspatials : bool
+        Whether the database adapter supports spatial attributes.
+    supportforspatialindexnull : bool
+        Whether the database adapter supports spatial indexes on nullable columns.
+    supportforfulltextwildcard : bool
+        Whether the database adapter supports fulltext wildcard search.
+    supportformultiplefulltextindexes : bool
+        Whether the database adapter supports multiple fulltext indexes per collection.
+    supportforattributeresizing : bool
+        Whether the database adapter supports resizing attributes.
+    supportforschemas : bool
+        Whether the database adapter supports fixed schemas with row width limits.
+    maxindexlength : float
+        Maximum index length supported by the database adapter.
+    supportforintegerids : bool
+        Whether the database adapter uses integer sequence IDs.
+    app_console_email_verification : str
+        Whether email verification for console users is required. Can be "true" or "false".
+    """
+    app_domain_target_cname: str = Field(..., alias='_APP_DOMAIN_TARGET_CNAME')
+    app_domain_target_a: str = Field(..., alias='_APP_DOMAIN_TARGET_A')
+    app_compute_build_timeout: float = Field(..., alias='_APP_COMPUTE_BUILD_TIMEOUT')
+    app_domain_target_aaaa: str = Field(..., alias='_APP_DOMAIN_TARGET_AAAA')
+    app_domain_target_caa: str = Field(..., alias='_APP_DOMAIN_TARGET_CAA')
+    app_storage_limit: float = Field(..., alias='_APP_STORAGE_LIMIT')
+    app_compute_size_limit: float = Field(..., alias='_APP_COMPUTE_SIZE_LIMIT')
+    app_usage_stats: str = Field(..., alias='_APP_USAGE_STATS')
+    app_vcs_enabled: bool = Field(..., alias='_APP_VCS_ENABLED')
+    app_vcs_providers: List[Any] = Field(..., alias='_APP_VCS_PROVIDERS')
+    app_domain_enabled: bool = Field(..., alias='_APP_DOMAIN_ENABLED')
+    app_assistant_enabled: bool = Field(..., alias='_APP_ASSISTANT_ENABLED')
+    app_domain_sites: str = Field(..., alias='_APP_DOMAIN_SITES')
+    app_domain_functions: str = Field(..., alias='_APP_DOMAIN_FUNCTIONS')
+    app_options_force_https: str = Field(..., alias='_APP_OPTIONS_FORCE_HTTPS')
+    app_domains_nameservers: str = Field(..., alias='_APP_DOMAINS_NAMESERVERS')
+    app_db_adapter: str = Field(..., alias='_APP_DB_ADAPTER')
+    supportforrelationships: bool = Field(..., alias='supportForRelationships')
+    supportforoperators: bool = Field(..., alias='supportForOperators')
+    supportforspatials: bool = Field(..., alias='supportForSpatials')
+    supportforspatialindexnull: bool = Field(..., alias='supportForSpatialIndexNull')
+    supportforfulltextwildcard: bool = Field(..., alias='supportForFulltextWildcard')
+    supportformultiplefulltextindexes: bool = Field(..., alias='supportForMultipleFulltextIndexes')
+    supportforattributeresizing: bool = Field(..., alias='supportForAttributeResizing')
+    supportforschemas: bool = Field(..., alias='supportForSchemas')
+    maxindexlength: float = Field(..., alias='maxIndexLength')
+    supportforintegerids: bool = Field(..., alias='supportForIntegerIds')
+    app_console_email_verification: str = Field(..., alias='_APP_CONSOLE_EMAIL_VERIFICATION')

appwrite_console/models/continent.py

@@ -0,0 +1,18 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Continent(AppwriteModel):
+    """
+    Continent
+
+    Attributes
+    ----------
+    name : str
+        Continent name.
+    code : str
+        Continent two letter code.
+    """
+    name: str = Field(..., alias='name')
+    code: str = Field(..., alias='code')

appwrite_console/models/continent_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 .continent import Continent
+
+class ContinentList(AppwriteModel):
+    """
+    Continents List
+
+    Attributes
+    ----------
+    total : float
+        Total number of continents that matched your query.
+    continents : List[Continent]
+        List of continents.
+    """
+    total: float = Field(..., alias='total')
+    continents: List[Continent] = Field(..., alias='continents')

appwrite_console/models/country.py

@@ -0,0 +1,18 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Country(AppwriteModel):
+    """
+    Country
+
+    Attributes
+    ----------
+    name : str
+        Country name.
+    code : str
+        Country two-character ISO 3166-1 alpha code.
+    """
+    name: str = Field(..., alias='name')
+    code: str = Field(..., alias='code')

appwrite_console/models/country_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 .country import Country
+
+class CountryList(AppwriteModel):
+    """
+    Countries List
+
+    Attributes
+    ----------
+    total : float
+        Total number of countries that matched your query.
+    countries : List[Country]
+        List of countries.
+    """
+    total: float = Field(..., alias='total')
+    countries: List[Country] = Field(..., alias='countries')

appwrite_console/models/coupon.py

@@ -0,0 +1,36 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Coupon(AppwriteModel):
+    """
+    Coupon
+
+    Attributes
+    ----------
+    id : str
+        coupon ID
+    code : str
+        coupon ID
+    credits : float
+        Provided credit amount
+    expiration : str
+        Coupon expiration time in ISO 8601 format.
+    validity : float
+        Credit validity in days.
+    campaign : str
+        Campaign the coupon is associated with`.
+    status : str
+        Status of the coupon. Can be one of `disabled`, `active` or `expired`.
+    onlyneworgs : bool
+        If the coupon is only valid for new organizations or not.
+    """
+    id: str = Field(..., alias='$id')
+    code: str = Field(..., alias='code')
+    credits: float = Field(..., alias='credits')
+    expiration: str = Field(..., alias='expiration')
+    validity: float = Field(..., alias='validity')
+    campaign: str = Field(..., alias='campaign')
+    status: str = Field(..., alias='status')
+    onlyneworgs: bool = Field(..., alias='onlyNewOrgs')

appwrite_console/models/credit.py

@@ -0,0 +1,45 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Credit(AppwriteModel):
+    """
+    Credit
+
+    Attributes
+    ----------
+    id : str
+        Credit ID.
+    createdat : str
+        Credit creation time in ISO 8601 format.
+    updatedat : str
+        Credit update date in ISO 8601 format.
+    permissions : List[Any]
+        Credit permissions. [Learn more about permissions](/docs/permissions).
+    couponid : str
+        coupon ID
+    userid : str
+        ID of the User.
+    teamid : str
+        ID of the Team.
+    credits : float
+        Provided credit amount
+    total : float
+        Provided credit amount
+    expiration : str
+        Credit expiration time in ISO 8601 format.
+    status : str
+        Status of the credit. Can be one of `disabled`, `active` or `expired`.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    permissions: List[Any] = Field(..., alias='$permissions')
+    couponid: str = Field(..., alias='couponId')
+    userid: str = Field(..., alias='userId')
+    teamid: str = Field(..., alias='teamId')
+    credits: float = Field(..., alias='credits')
+    total: float = Field(..., alias='total')
+    expiration: str = Field(..., alias='expiration')
+    status: str = Field(..., alias='status')

appwrite_console/models/credit_available.py

@@ -0,0 +1,15 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class CreditAvailable(AppwriteModel):
+    """
+    CreditAvailable
+
+    Attributes
+    ----------
+    available : float
+        Total available credits for the organization.
+    """
+    available: float = Field(..., alias='available')

appwrite_console/models/credit_list.py

@@ -0,0 +1,22 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .credit import Credit
+
+class CreditList(AppwriteModel):
+    """
+    CreditList
+
+    Attributes
+    ----------
+    credits : List[Credit]
+        Credits
+    total : float
+        Total number of credits
+    available : float
+        Total available credit balance in USD
+    """
+    credits: List[Credit] = Field(..., alias='credits')
+    total: float = Field(..., alias='total')
+    available: float = Field(..., alias='available')

appwrite_console/models/currency.py

@@ -0,0 +1,33 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Currency(AppwriteModel):
+    """
+    Currency
+
+    Attributes
+    ----------
+    symbol : str
+        Currency symbol.
+    name : str
+        Currency name.
+    symbolnative : str
+        Currency native symbol.
+    decimaldigits : float
+        Number of decimal digits.
+    rounding : float
+        Currency digit rounding.
+    code : str
+        Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format.
+    nameplural : str
+        Currency plural name
+    """
+    symbol: str = Field(..., alias='symbol')
+    name: str = Field(..., alias='name')
+    symbolnative: str = Field(..., alias='symbolNative')
+    decimaldigits: float = Field(..., alias='decimalDigits')
+    rounding: float = Field(..., alias='rounding')
+    code: str = Field(..., alias='code')
+    nameplural: str = Field(..., alias='namePlural')

appwrite_console/models/currency_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 .currency import Currency
+
+class CurrencyList(AppwriteModel):
+    """
+    Currencies List
+
+    Attributes
+    ----------
+    total : float
+        Total number of currencies that matched your query.
+    currencies : List[Currency]
+        List of currencies.
+    """
+    total: float = Field(..., alias='total')
+    currencies: List[Currency] = Field(..., alias='currencies')

appwrite_console/models/database.py

@@ -0,0 +1,52 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from ..enums.database_type import DatabaseType
+from ..enums.database_status import DatabaseStatus
+from .backup_policy import BackupPolicy
+from .backup_archive import BackupArchive
+
+class Database(AppwriteModel):
+    """
+    Database
+
+    Attributes
+    ----------
+    id : str
+        Database ID.
+    name : str
+        Database name.
+    createdat : str
+        Database creation date in ISO 8601 format.
+    updatedat : str
+        Database update date in ISO 8601 format.
+    enabled : bool
+        If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.
+    type : DatabaseType
+        Database type.
+    status : Optional[DatabaseStatus]
+        Dedicated database lifecycle status. Null when the database has no valid dedicated backing.
+    engine : Optional[str]
+        Underlying engine of the dedicated backing: postgresql, mysql, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.
+    specification : Optional[str]
+        Compute specification identifier of the dedicated backing, e.g. s-2vcpu-2gb. Null when the database has no dedicated backing.
+    replicas : Optional[float]
+        Number of secondary high availability replicas, excluding the primary. Null when backing configuration is unavailable.
+    policies : Optional[List[BackupPolicy]]
+        Database backup policies.
+    archives : Optional[List[BackupArchive]]
+        Database backup archives.
+    """
+    id: str = Field(..., alias='$id')
+    name: str = Field(..., alias='name')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    enabled: bool = Field(..., alias='enabled')
+    type: DatabaseType = Field(..., alias='type')
+    status: Optional[DatabaseStatus] = Field(default=None, alias='status')
+    engine: Optional[str] = Field(default=None, alias='engine')
+    specification: Optional[str] = Field(default=None, alias='specification')
+    replicas: Optional[float] = Field(default=None, alias='replicas')
+    policies: Optional[List[BackupPolicy]] = Field(default=None, alias='policies')
+    archives: Optional[List[BackupArchive]] = Field(default=None, alias='archives')

appwrite_console/models/database_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 .database import Database
+
+class DatabaseList(AppwriteModel):
+    """
+    Databases List
+
+    Attributes
+    ----------
+    total : float
+        Total number of databases that matched your query.
+    databases : List[Database]
+        List of databases.
+    """
+    total: float = Field(..., alias='total')
+    databases: List[Database] = Field(..., alias='databases')

appwrite_console/models/database_migration.py

@@ -0,0 +1,57 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class DatabaseMigration(AppwriteModel):
+    """
+    Database Migration
+
+    Attributes
+    ----------
+    id : str
+        Database migration ID.
+    createdat : str
+        Migration creation time in ISO 8601 format.
+    updatedat : str
+        Migration update time in ISO 8601 format.
+    projectid : str
+        Project ID that owns the migrating database.
+    databaseid : str
+        Logical database ID being migrated.
+    specification : str
+        Dedicated compute specification provisioned for the migration target.
+    phase : str
+        Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.
+    attempt : float
+        Number of times a migration step has failed and been recorded.
+    lasterror : str
+        Reason the most recent migration step failed, empty while none has.
+    lagdocuments : float
+        Number of documents still pending replication to the target.
+    verifiedat : str
+        Time the migrated data was verified against the source in ISO 8601 format.
+    cutoverat : str
+        Time routing was flipped to the target in ISO 8601 format.
+    soakuntil : str
+        Time the post-cutover soak window ends in ISO 8601 format.
+    autocutover : bool
+        Whether the migration cuts over automatically once ready.
+    paused : bool
+        Whether the migration is paused.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    projectid: str = Field(..., alias='projectId')
+    databaseid: str = Field(..., alias='databaseId')
+    specification: str = Field(..., alias='specification')
+    phase: str = Field(..., alias='phase')
+    attempt: float = Field(..., alias='attempt')
+    lasterror: str = Field(..., alias='lastError')
+    lagdocuments: float = Field(..., alias='lagDocuments')
+    verifiedat: str = Field(..., alias='verifiedAt')
+    cutoverat: str = Field(..., alias='cutoverAt')
+    soakuntil: str = Field(..., alias='soakUntil')
+    autocutover: bool = Field(..., alias='autoCutover')
+    paused: bool = Field(..., alias='paused')

appwrite_console/models/database_migration_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 .database_migration import DatabaseMigration
+
+class DatabaseMigrationList(AppwriteModel):
+    """
+    Database Migrations List
+
+    Attributes
+    ----------
+    total : float
+        Total number of migrations that matched your query.
+    migrations : List[DatabaseMigration]
+        List of migrations.
+    """
+    total: float = Field(..., alias='total')
+    migrations: List[DatabaseMigration] = Field(..., alias='migrations')

appwrite_console/models/database_status.py

@@ -0,0 +1,57 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .database_status_connections import DatabaseStatusConnections
+from .database_status_replica import DatabaseStatusReplica
+from .database_status_volume import DatabaseStatusVolume
+
+class DatabaseStatus(AppwriteModel):
+    """
+    Status
+
+    Attributes
+    ----------
+    health : str
+        Overall health status: healthy, degraded, or unhealthy.
+    ready : bool
+        Whether the database is ready to accept connections.
+    engine : str
+        Database engine: postgresql, mysql, or mongodb.
+    version : str
+        Database engine version.
+    uptime : float
+        Database uptime in seconds.
+    connections : DatabaseStatusConnections
+        Connection statistics.
+    syncmode : str
+        Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
+    effectivesyncmode : Optional[str]
+        Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read.
+    syncdegraded : bool
+        Whether the enforced replication is weaker than the requested syncMode.
+    syncacknowledgements : float
+        Number of standby acknowledgements the primary waits for before a write is committed.
+    syncstandbycount : float
+        Number of standbys registered with the primary for synchronous replication.
+    syncstateconfirmed : bool
+        Whether the reported sync state was read from the engine. When false the state could not be confirmed and the other sync fields carry no reading.
+    replicas : List[DatabaseStatusReplica]
+        List of database replicas and their status. Every configured member appears, including one the backend has not brought up, which is reported as not healthy.
+    volumes : List[DatabaseStatusVolume]
+        Storage volume information.
+    """
+    health: str = Field(..., alias='health')
+    ready: bool = Field(..., alias='ready')
+    engine: str = Field(..., alias='engine')
+    version: str = Field(..., alias='version')
+    uptime: float = Field(..., alias='uptime')
+    connections: DatabaseStatusConnections = Field(..., alias='connections')
+    syncmode: str = Field(..., alias='syncMode')
+    effectivesyncmode: Optional[str] = Field(default=None, alias='effectiveSyncMode')
+    syncdegraded: bool = Field(..., alias='syncDegraded')
+    syncacknowledgements: float = Field(..., alias='syncAcknowledgements')
+    syncstandbycount: float = Field(..., alias='syncStandbyCount')
+    syncstateconfirmed: bool = Field(..., alias='syncStateConfirmed')
+    replicas: List[DatabaseStatusReplica] = Field(..., alias='replicas')
+    volumes: List[DatabaseStatusVolume] = Field(..., alias='volumes')

appwrite_console/models/database_status_connections.py

@@ -0,0 +1,18 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class DatabaseStatusConnections(AppwriteModel):
+    """
+    Connections
+
+    Attributes
+    ----------
+    current : float
+        Current number of active connections.
+    max : float
+        The engine's own max_connections. On a pooled database this is the backend limit the pooler multiplexes onto, not the ceiling a client pool may reach — that is networkMaxConnections on the database resource.
+    """
+    current: float = Field(..., alias='current')
+    max: float = Field(..., alias='max')

appwrite_console/models/database_status_replica.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 DatabaseStatusReplica(AppwriteModel):
+    """
+    Replica
+
+    Attributes
+    ----------
+    index : float
+        Member index within the database. Read `role` for which member accepts writes: a failover moves the primary without renumbering the indexes.
+    role : str
+        Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology, so no member can be named the write target).
+    healthy : bool
+        Whether the replica is healthy.
+    lagseconds : Optional[float]
+        Replication lag in seconds (null for primary).
+    """
+    index: float = Field(..., alias='index')
+    role: str = Field(..., alias='role')
+    healthy: bool = Field(..., alias='healthy')
+    lagseconds: Optional[float] = Field(default=None, alias='lagSeconds')

appwrite_console/models/database_status_volume.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 DatabaseStatusVolume(AppwriteModel):
+    """
+    Volume
+
+    Attributes
+    ----------
+    path : str
+        Mount path of the volume.
+    usedpercent : str
+        Percentage of storage used.
+    available : str
+        Available storage space.
+    mounted : bool
+        Whether the volume is mounted.
+    """
+    path: str = Field(..., alias='path')
+    usedpercent: str = Field(..., alias='usedPercent')
+    available: str = Field(..., alias='available')
+    mounted: bool = Field(..., alias='mounted')