appwrite-console 0.1.0__py3-none-any.whl

appwrite_console/models/column_ip.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.column_status import ColumnStatus
+
+class ColumnIp(AppwriteModel):
+    """
+    ColumnIP
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    format : str
+        String format.
+    default : Optional[str]
+        Default value for column when not provided. Cannot be set when column is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_line.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.column_status import ColumnStatus
+
+class ColumnLine(AppwriteModel):
+    """
+    ColumnLine
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    default : Optional[List[Any]]
+        Default value for column when not provided. Cannot be set when column is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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 .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
+
+class ColumnList(AppwriteModel):
+    """
+    Columns List
+
+    Attributes
+    ----------
+    total : float
+        Total number of columns in the given table.
+    columns : List[Union[ColumnBoolean, ColumnBigint, ColumnInteger, ColumnFloat, ColumnEmail, ColumnEnum, ColumnUrl, ColumnIp, ColumnDatetime, ColumnRelationship, ColumnPoint, ColumnLine, ColumnPolygon, ColumnVarchar, ColumnText, ColumnMediumtext, ColumnLongtext, ColumnString]]
+        List of columns.
+    """
+    total: float = Field(..., alias='total')
+    columns: List[Union[ColumnBoolean, ColumnBigint, ColumnInteger, ColumnFloat, ColumnEmail, ColumnEnum, ColumnUrl, ColumnIp, ColumnDatetime, ColumnRelationship, ColumnPoint, ColumnLine, ColumnPolygon, ColumnVarchar, ColumnText, ColumnMediumtext, ColumnLongtext, ColumnString]] = Field(..., alias='columns')

appwrite_console/models/column_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.column_status import ColumnStatus
+
+class ColumnLongtext(AppwriteModel):
+    """
+    ColumnLongtext
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    default : Optional[str]
+        Default value for column when not provided. Cannot be set when column is required.
+    encrypt : Optional[bool]
+        Defines whether this column is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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.column_status import ColumnStatus
+
+class ColumnMediumtext(AppwriteModel):
+    """
+    ColumnMediumtext
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    default : Optional[str]
+        Default value for column when not provided. Cannot be set when column is required.
+    encrypt : Optional[bool]
+        Defines whether this column is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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.column_status import ColumnStatus
+
+class ColumnPoint(AppwriteModel):
+    """
+    ColumnPoint
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    default : Optional[List[Any]]
+        Default value for column when not provided. Cannot be set when column is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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.column_status import ColumnStatus
+
+class ColumnPolygon(AppwriteModel):
+    """
+    ColumnPolygon
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    default : Optional[List[Any]]
+        Default value for column when not provided. Cannot be set when column is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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.column_status import ColumnStatus
+
+class ColumnRelationship(AppwriteModel):
+    """
+    ColumnRelationship
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    relatedtable : str
+        The ID of the related table.
+    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: ColumnStatus = 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')
+    relatedtable: str = Field(..., alias='relatedTable')
+    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/column_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.column_status import ColumnStatus
+
+class ColumnString(AppwriteModel):
+    """
+    ColumnString
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    size : float
+        Column size.
+    default : Optional[str]
+        Default value for column when not provided. Cannot be set when column is required.
+    encrypt : Optional[bool]
+        Defines whether this column is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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.column_status import ColumnStatus
+
+class ColumnText(AppwriteModel):
+    """
+    ColumnText
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    default : Optional[str]
+        Default value for column when not provided. Cannot be set when column is required.
+    encrypt : Optional[bool]
+        Defines whether this column is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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.column_status import ColumnStatus
+
+class ColumnUrl(AppwriteModel):
+    """
+    ColumnURL
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    format : str
+        String format.
+    default : Optional[str]
+        Default value for column when not provided. Cannot be set when column is required.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/column_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.column_status import ColumnStatus
+
+class ColumnVarchar(AppwriteModel):
+    """
+    ColumnVarchar
+
+    Attributes
+    ----------
+    key : str
+        Column Key.
+    type : str
+        Column type.
+    status : ColumnStatus
+        Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+    error : str
+        Error message. Displays error generated on failure of creating or deleting an column.
+    required : bool
+        Is column required?
+    array : Optional[bool]
+        Is column an array?
+    createdat : str
+        Column creation date in ISO 8601 format.
+    updatedat : str
+        Column update date in ISO 8601 format.
+    size : float
+        Column size.
+    default : Optional[str]
+        Default value for column when not provided. Cannot be set when column is required.
+    encrypt : Optional[bool]
+        Defines whether this column is encrypted or not.
+    """
+    key: str = Field(..., alias='key')
+    type: str = Field(..., alias='type')
+    status: ColumnStatus = 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/console_key_scope.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 ConsoleKeyScope(AppwriteModel):
+    """
+    Console Key Scope
+
+    Attributes
+    ----------
+    id : str
+        Scope ID.
+    description : str
+        Scope description.
+    category : str
+        Scope category.
+    deprecated : bool
+        Scope is deprecated.
+    """
+    id: str = Field(..., alias='$id')
+    description: str = Field(..., alias='description')
+    category: str = Field(..., alias='category')
+    deprecated: bool = Field(..., alias='deprecated')

appwrite_console/models/console_key_scope_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_key_scope import ConsoleKeyScope
+
+class ConsoleKeyScopeList(AppwriteModel):
+    """
+    Console Key Scopes List
+
+    Attributes
+    ----------
+    total : float
+        Total number of key scopes exposed by the server.
+    scopes : List[ConsoleKeyScope]
+        List of key scopes, each with its ID and description.
+    """
+    total: float = Field(..., alias='total')
+    scopes: List[ConsoleKeyScope] = Field(..., alias='scopes')

appwrite_console/models/console_o_auth2_provider.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_o_auth2_provider_parameter import ConsoleOAuth2ProviderParameter
+
+class ConsoleOAuth2Provider(AppwriteModel):
+    """
+    Console OAuth2 Provider
+
+    Attributes
+    ----------
+    id : str
+        OAuth2 provider ID.
+    parameters : List[ConsoleOAuth2ProviderParameter]
+        List of parameters required to configure this OAuth2 provider.
+    """
+    id: str = Field(..., alias='$id')
+    parameters: List[ConsoleOAuth2ProviderParameter] = Field(..., alias='parameters')

appwrite_console/models/console_o_auth2_provider_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_o_auth2_provider import ConsoleOAuth2Provider
+
+class ConsoleOAuth2ProviderList(AppwriteModel):
+    """
+    Console OAuth2 Providers List
+
+    Attributes
+    ----------
+    total : float
+        Total number of OAuth2 providers exposed by the server.
+    oauth2providers : List[ConsoleOAuth2Provider]
+        List of OAuth2 providers, each with the parameters required to configure it.
+    """
+    total: float = Field(..., alias='total')
+    oauth2providers: List[ConsoleOAuth2Provider] = Field(..., alias='oAuth2Providers')

appwrite_console/models/console_o_auth2_provider_parameter.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 ConsoleOAuth2ProviderParameter(AppwriteModel):
+    """
+    Console OAuth2 Provider Parameter
+
+    Attributes
+    ----------
+    id : str
+        Parameter ID. Maps to the request body field used by the project OAuth2 update endpoint (e.g. `clientId`, `appKey`, `tenant`).
+    name : str
+        Verbose, user-facing parameter name as shown in the provider's own dashboard. Includes alternate names when the provider exposes more than one.
+    example : str
+        Example value for this parameter.
+    hint : str
+        Optional hint for this parameter, typically calling out a common wrong value. Empty string when no hint is set.
+    """
+    id: str = Field(..., alias='$id')
+    name: str = Field(..., alias='name')
+    example: str = Field(..., alias='example')
+    hint: str = Field(..., alias='hint')

appwrite_console/models/console_region.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 ConsoleRegion(AppwriteModel):
+    """
+    Region
+
+    Attributes
+    ----------
+    id : str
+        Region ID
+    name : str
+        Region name
+    available : bool
+        Does the organization have access to this region.
+    disabled : bool
+        Does the backend support this region.
+    default : bool
+        Is this the region default.
+    flag : str
+        Region flag code.
+    """
+    id: str = Field(..., alias='$id')
+    name: str = Field(..., alias='name')
+    available: bool = Field(..., alias='available')
+    disabled: bool = Field(..., alias='disabled')
+    default: bool = Field(..., alias='default')
+    flag: str = Field(..., alias='flag')