appwrite-console 0.1.0__py3-none-any.whl

appwrite_console/models/framework.py

@@ -0,0 +1,28 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .framework_adapter import FrameworkAdapter
+
+class Framework(AppwriteModel):
+    """
+    Framework
+
+    Attributes
+    ----------
+    key : str
+        Framework key.
+    name : str
+        Framework Name.
+    buildruntime : str
+        Default runtime version.
+    runtimes : List[Any]
+        List of supported runtime versions.
+    adapters : List[FrameworkAdapter]
+        List of supported adapters.
+    """
+    key: str = Field(..., alias='key')
+    name: str = Field(..., alias='name')
+    buildruntime: str = Field(..., alias='buildRuntime')
+    runtimes: List[Any] = Field(..., alias='runtimes')
+    adapters: List[FrameworkAdapter] = Field(..., alias='adapters')

appwrite_console/models/framework_adapter.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 FrameworkAdapter(AppwriteModel):
+    """
+    Framework Adapter
+
+    Attributes
+    ----------
+    key : str
+        Adapter key.
+    installcommand : str
+        Default command to download dependencies.
+    buildcommand : str
+        Default command to build site into output directory.
+    outputdirectory : str
+        Default output directory of build.
+    fallbackfile : str
+        Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.
+    """
+    key: str = Field(..., alias='key')
+    installcommand: str = Field(..., alias='installCommand')
+    buildcommand: str = Field(..., alias='buildCommand')
+    outputdirectory: str = Field(..., alias='outputDirectory')
+    fallbackfile: str = Field(..., alias='fallbackFile')

appwrite_console/models/framework_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 .framework import Framework
+
+class FrameworkList(AppwriteModel):
+    """
+    Frameworks List
+
+    Attributes
+    ----------
+    total : float
+        Total number of frameworks that matched your query.
+    frameworks : List[Framework]
+        List of frameworks.
+    """
+    total: float = Field(..., alias='total')
+    frameworks: List[Framework] = Field(..., alias='frameworks')

appwrite_console/models/function.py

@@ -0,0 +1,109 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .variable import Variable
+
+class Function(AppwriteModel):
+    """
+    Function
+
+    Attributes
+    ----------
+    id : str
+        Function ID.
+    createdat : str
+        Function creation date in ISO 8601 format.
+    updatedat : str
+        Function update date in ISO 8601 format.
+    execute : List[Any]
+        Execution permissions.
+    name : str
+        Function name.
+    enabled : bool
+        Function enabled.
+    live : bool
+        Is the function 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 function to update it with the latest configuration.
+    logging : bool
+        When disabled, executions will exclude logs and errors, and will be slightly faster.
+    runtime : str
+        Function execution and build runtime.
+    deploymentretention : float
+        How many days to keep the non-active deployments before they will be automatically deleted.
+    deploymentid : str
+        Function's active deployment ID.
+    deploymentcreatedat : str
+        Active deployment creation date in ISO 8601 format.
+    latestdeploymentid : str
+        Function'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".
+    scopes : List[Any]
+        Allowed permission scopes.
+    vars : List[Variable]
+        Function variables.
+    events : List[Any]
+        Function trigger events.
+    schedule : str
+        Function execution schedule in CRON format.
+    timeout : float
+        Function execution timeout in seconds.
+    entrypoint : str
+        The entrypoint file used to execute the deployment.
+    commands : str
+        The build command used to build the deployment.
+    version : str
+        Version of Open Runtimes used for the function.
+    installationid : str
+        Function 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 function 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 executions.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    execute: List[Any] = Field(..., alias='execute')
+    name: str = Field(..., alias='name')
+    enabled: bool = Field(..., alias='enabled')
+    live: bool = Field(..., alias='live')
+    logging: bool = Field(..., alias='logging')
+    runtime: str = Field(..., alias='runtime')
+    deploymentretention: float = Field(..., alias='deploymentRetention')
+    deploymentid: str = Field(..., alias='deploymentId')
+    deploymentcreatedat: str = Field(..., alias='deploymentCreatedAt')
+    latestdeploymentid: str = Field(..., alias='latestDeploymentId')
+    latestdeploymentcreatedat: str = Field(..., alias='latestDeploymentCreatedAt')
+    latestdeploymentstatus: str = Field(..., alias='latestDeploymentStatus')
+    scopes: List[Any] = Field(..., alias='scopes')
+    vars: List[Variable] = Field(..., alias='vars')
+    events: List[Any] = Field(..., alias='events')
+    schedule: str = Field(..., alias='schedule')
+    timeout: float = Field(..., alias='timeout')
+    entrypoint: str = Field(..., alias='entrypoint')
+    commands: str = Field(..., alias='commands')
+    version: str = Field(..., alias='version')
+    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')

appwrite_console/models/function_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 .function import Function
+
+class FunctionList(AppwriteModel):
+    """
+    Functions List
+
+    Attributes
+    ----------
+    total : float
+        Total number of functions that matched your query.
+    functions : List[Function]
+        List of functions.
+    """
+    total: float = Field(..., alias='total')
+    functions: List[Function] = Field(..., alias='functions')

appwrite_console/models/headers.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 Headers(AppwriteModel):
+    """
+    Headers
+
+    Attributes
+    ----------
+    name : str
+        Header name.
+    value : str
+        Header value.
+    """
+    name: str = Field(..., alias='name')
+    value: str = Field(..., alias='value')

appwrite_console/models/identity.py

@@ -0,0 +1,42 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Identity(AppwriteModel):
+    """
+    Identity
+
+    Attributes
+    ----------
+    id : str
+        Identity ID.
+    createdat : str
+        Identity creation date in ISO 8601 format.
+    updatedat : str
+        Identity update date in ISO 8601 format.
+    userid : str
+        User ID.
+    provider : str
+        Identity Provider.
+    provideruid : str
+        ID of the User in the Identity Provider.
+    provideremail : str
+        Email of the User in the Identity Provider.
+    provideraccesstoken : str
+        Identity Provider Access Token.
+    provideraccesstokenexpiry : str
+        The date of when the access token expires in ISO 8601 format.
+    providerrefreshtoken : str
+        Identity Provider Refresh Token.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    userid: str = Field(..., alias='userId')
+    provider: str = Field(..., alias='provider')
+    provideruid: str = Field(..., alias='providerUid')
+    provideremail: str = Field(..., alias='providerEmail')
+    provideraccesstoken: str = Field(..., alias='providerAccessToken')
+    provideraccesstokenexpiry: str = Field(..., alias='providerAccessTokenExpiry')
+    providerrefreshtoken: str = Field(..., alias='providerRefreshToken')

appwrite_console/models/identity_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 .identity import Identity
+
+class IdentityList(AppwriteModel):
+    """
+    Identities List
+
+    Attributes
+    ----------
+    total : float
+        Total number of identities that matched your query.
+    identities : List[Identity]
+        List of identities.
+    """
+    total: float = Field(..., alias='total')
+    identities: List[Identity] = Field(..., alias='identities')

appwrite_console/models/index.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.index_status import IndexStatus
+
+class Index(AppwriteModel):
+    """
+    Index
+
+    Attributes
+    ----------
+    id : str
+        Index ID.
+    createdat : str
+        Index creation date in ISO 8601 format.
+    updatedat : str
+        Index update date in ISO 8601 format.
+    key : str
+        Index key.
+    type : str
+        Index type.
+    status : IndexStatus
+        Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an index.
+    attributes : List[Any]
+        Index attributes.
+    lengths : List[Any]
+        Index attributes length.
+    orders : Optional[List[Any]]
+        Index orders.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: IndexStatus = Field(..., alias='status')
+    error: str = Field(..., alias='error')
+    attributes: List[Any] = Field(..., alias='attributes')
+    lengths: List[Any] = Field(..., alias='lengths')
+    orders: Optional[List[Any]] = Field(default=None, alias='orders')

appwrite_console/models/index_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 .index import Index
+
+class IndexList(AppwriteModel):
+    """
+    Indexes List
+
+    Attributes
+    ----------
+    total : float
+        Total number of indexes that matched your query.
+    indexes : List[Index]
+        List of indexes.
+    """
+    total: float = Field(..., alias='total')
+    indexes: List[Index] = Field(..., alias='indexes')

appwrite_console/models/insight.py

@@ -0,0 +1,64 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .insight_cta import InsightCTA
+
+class Insight(AppwriteModel):
+    """
+    Insight
+
+    Attributes
+    ----------
+    id : str
+        Insight ID.
+    createdat : str
+        Insight creation date in ISO 8601 format.
+    updatedat : str
+        Insight update date in ISO 8601 format.
+    reportid : str
+        Parent report ID. Insights always belong to a report.
+    type : str
+        Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).
+    severity : str
+        Insight severity. One of info, warning, critical.
+    status : str
+        Insight status. One of active, dismissed.
+    resourcetype : str
+        Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.
+    resourceid : str
+        ID of the resource the insight is about.
+    parentresourcetype : str
+        Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table → resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.
+    parentresourceid : str
+        ID of the parent resource. Empty when the resource has no parent.
+    title : str
+        Insight title.
+    summary : str
+        Short markdown summary describing the insight.
+    ctas : List[InsightCTA]
+        List of call-to-action buttons attached to this insight.
+    analyzedat : Optional[str]
+        Time the insight was analyzed in ISO 8601 format.
+    dismissedat : Optional[str]
+        Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.
+    dismissedby : Optional[str]
+        User ID that dismissed the insight. Empty when not dismissed.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    reportid: str = Field(..., alias='reportId')
+    type: str = Field(..., alias='type')
+    severity: str = Field(..., alias='severity')
+    status: str = Field(..., alias='status')
+    resourcetype: str = Field(..., alias='resourceType')
+    resourceid: str = Field(..., alias='resourceId')
+    parentresourcetype: str = Field(..., alias='parentResourceType')
+    parentresourceid: str = Field(..., alias='parentResourceId')
+    title: str = Field(..., alias='title')
+    summary: str = Field(..., alias='summary')
+    ctas: List[InsightCTA] = Field(..., alias='ctas')
+    analyzedat: Optional[str] = Field(default=None, alias='analyzedAt')
+    dismissedat: Optional[str] = Field(default=None, alias='dismissedAt')
+    dismissedby: Optional[str] = Field(default=None, alias='dismissedBy')

appwrite_console/models/insight_cta.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 InsightCTA(AppwriteModel):
+    """
+    InsightCTA
+
+    Attributes
+    ----------
+    label : str
+        Human-readable label for the CTA, used in UI.
+    service : str
+        Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource — for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.
+    method : str
+        Public API method on the chosen service the client should invoke when this CTA is triggered.
+    params : Dict[str, Any]
+        Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId/tableId/columns for tablesDB, databaseId/collectionId/attributes for the legacy Databases API).
+    """
+    label: str = Field(..., alias='label')
+    service: str = Field(..., alias='service')
+    method: str = Field(..., alias='method')
+    params: Dict[str, Any] = Field(..., alias='params')

appwrite_console/models/insight_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 .insight import Insight
+
+class InsightList(AppwriteModel):
+    """
+    Insights List
+
+    Attributes
+    ----------
+    total : float
+        Total number of insights that matched your query.
+    insights : List[Insight]
+        List of insights.
+    """
+    total: float = Field(..., alias='total')
+    insights: List[Insight] = Field(..., alias='insights')

appwrite_console/models/installation.py

@@ -0,0 +1,30 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+class Installation(AppwriteModel):
+    """
+    Installation
+
+    Attributes
+    ----------
+    id : str
+        Function ID.
+    createdat : str
+        Function creation date in ISO 8601 format.
+    updatedat : str
+        Function update date in ISO 8601 format.
+    provider : str
+        VCS (Version Control System) provider name.
+    organization : str
+        VCS (Version Control System) organization name.
+    providerinstallationid : str
+        VCS (Version Control System) installation ID.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    provider: str = Field(..., alias='provider')
+    organization: str = Field(..., alias='organization')
+    providerinstallationid: str = Field(..., alias='providerInstallationId')

appwrite_console/models/installation_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 .installation import Installation
+
+class InstallationList(AppwriteModel):
+    """
+    Installations List
+
+    Attributes
+    ----------
+    total : float
+        Total number of installations that matched your query.
+    installations : List[Installation]
+        List of installations.
+    """
+    total: float = Field(..., alias='total')
+    installations: List[Installation] = Field(..., alias='installations')

appwrite_console/models/invoice.py

@@ -0,0 +1,82 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .usage_resources import UsageResources
+
+class Invoice(AppwriteModel):
+    """
+    Invoice
+
+    Attributes
+    ----------
+    id : str
+        Invoice ID.
+    createdat : str
+        Invoice creation time in ISO 8601 format.
+    updatedat : str
+        Invoice update date in ISO 8601 format.
+    permissions : List[Any]
+        Invoice permissions. [Learn more about permissions](/docs/permissions).
+    teamid : str
+        Project ID
+    aggregationid : str
+        Aggregation ID
+    plan : str
+        Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.
+    usage : List[UsageResources]
+        Usage breakdown per resource
+    amount : float
+        Invoice Amount
+    tax : float
+        Tax percentage
+    taxamount : float
+        Tax amount
+    vat : float
+        VAT percentage
+    vatamount : float
+        VAT amount
+    grossamount : float
+        Gross amount after vat, tax, and discounts applied.
+    creditsused : float
+        Credits used.
+    currency : str
+        Currency the invoice is in
+    clientsecret : str
+        Client secret for processing failed payments in front-end
+    status : str
+        Invoice status
+    type : str
+        Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.
+    lasterror : str
+        Last payment error associated with the invoice
+    dueat : str
+        Invoice due date.
+    xfrom : str
+        Beginning date of the invoice
+    to : str
+        End date of the invoice
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    permissions: List[Any] = Field(..., alias='$permissions')
+    teamid: str = Field(..., alias='teamId')
+    aggregationid: str = Field(..., alias='aggregationId')
+    plan: str = Field(..., alias='plan')
+    usage: List[UsageResources] = Field(..., alias='usage')
+    amount: float = Field(..., alias='amount')
+    tax: float = Field(..., alias='tax')
+    taxamount: float = Field(..., alias='taxAmount')
+    vat: float = Field(..., alias='vat')
+    vatamount: float = Field(..., alias='vatAmount')
+    grossamount: float = Field(..., alias='grossAmount')
+    creditsused: float = Field(..., alias='creditsUsed')
+    currency: str = Field(..., alias='currency')
+    clientsecret: str = Field(..., alias='clientSecret')
+    status: str = Field(..., alias='status')
+    type: str = Field(..., alias='type')
+    lasterror: str = Field(..., alias='lastError')
+    dueat: str = Field(..., alias='dueAt')
+    xfrom: str = Field(..., alias='from')
+    to: str = Field(..., alias='to')

appwrite_console/models/invoice_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 .invoice import Invoice
+
+class InvoiceList(AppwriteModel):
+    """
+    Billing invoices list
+
+    Attributes
+    ----------
+    total : float
+        Total number of invoices that matched your query.
+    invoices : List[Invoice]
+        List of invoices.
+    """
+    total: float = Field(..., alias='total')
+    invoices: List[Invoice] = Field(..., alias='invoices')

appwrite_console/models/jwt.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 Jwt(AppwriteModel):
+    """
+    JWT
+
+    Attributes
+    ----------
+    jwt : str
+        JWT encoded string.
+    """
+    jwt: str = Field(..., alias='jwt')

appwrite_console/models/key.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 Key(AppwriteModel):
+    """
+    Key
+
+    Attributes
+    ----------
+    id : str
+        Key ID.
+    createdat : str
+        Key creation date in ISO 8601 format.
+    updatedat : str
+        Key update date in ISO 8601 format.
+    name : str
+        Key name.
+    expire : str
+        Key expiration date in ISO 8601 format.
+    scopes : List[Any]
+        Allowed permission scopes.
+    secret : str
+        Secret key.
+    accessedat : str
+        Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
+    sdks : List[Any]
+        List of SDK user agents that used this key.
+    """
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    name: str = Field(..., alias='name')
+    expire: str = Field(..., alias='expire')
+    scopes: List[Any] = Field(..., alias='scopes')
+    secret: str = Field(..., alias='secret')
+    accessedat: str = Field(..., alias='accessedAt')
+    sdks: List[Any] = Field(..., alias='sdks')