appwrite-console 0.7.1__tar.gz → 0.8.0__tar.gz

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: appwrite-console
-Version: 0.7.1
+Version: 0.8.0
 Summary: Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API
 Home-page: https://appwrite.io/support
-Download-URL: https://github.com/appwrite/sdk-for-console-python/archive/0.7.1.tar.gz
+Download-URL: https://github.com/appwrite/sdk-for-console-python/archive/0.8.0.tar.gz
 Author: Appwrite Team
 Author-email: Appwrite Team <team@appwrite.io>
 Maintainer: Appwrite Team

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/client.py

@@ -18,11 +18,11 @@ class Client:
         self._endpoint = 'https://cloud.appwrite.io/v1'
         self._global_headers = {
             'content-type': '',
-            'user-agent': f'AppwritePythonSDK/0.7.1 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
+            'user-agent': f'AppwritePythonSDK/0.8.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
             'x-sdk-name': 'Console Python',
             'x-sdk-platform': 'console',
             'x-sdk-language': 'python',
-            'x-sdk-version': '0.7.1',
+            'x-sdk-version': '0.8.0',
             'X-Appwrite-Response-Format': '2.3.0',
         }
         self._config = {}
@@ -225,9 +225,10 @@ class Client:
         on_progress=None,
         upload_id='',
         response_type='json',
+        method='post',
     ):
         if params.get(param_name) is None:
-            return self.call('post', path, headers, params, response_type=response_type)
+            return self.call(method, path, headers, params, response_type=response_type)
 
         input_file = params[param_name]
 
@@ -244,7 +245,7 @@ class Client:
                     input_file.data = input.read()
 
             params[param_name] = input_file
-            return self.call('post', path, headers, params, response_type=response_type)
+            return self.call(method, path, headers, params, response_type=response_type)
 
         offset = 0
         counter = 0
@@ -312,7 +313,7 @@ class Client:
                 chunk_headers["x-appwrite-id"] = current_upload_id
 
             return self.call(
-                'post',
+                method,
                 path,
                 chunk_headers,
                 chunk_params,

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/encoders/value_class_encoder.py

@@ -5,6 +5,8 @@ from ..enums.authenticator_type import AuthenticatorType
 from ..enums.authentication_factor import AuthenticationFactor
 from ..enums.id_token_provider import IdTokenProvider
 from ..enums.o_auth_provider import OAuthProvider
+from ..enums.analytics_interval import AnalyticsInterval
+from ..enums.analytics_dimension import AnalyticsDimension
 from ..enums.browser import Browser
 from ..enums.credit_card import CreditCard
 from ..enums.flag import Flag
@@ -135,6 +137,12 @@ class ValueClassEncoder(json.JSONEncoder):
         if isinstance(o, OAuthProvider):
             return o.value
 
+        if isinstance(o, AnalyticsInterval):
+            return o.value
+
+        if isinstance(o, AnalyticsDimension):
+            return o.value
+
         if isinstance(o, Browser):
             return o.value
 

appwrite_console-0.8.0/appwrite_console/enums/analytics_dimension.py

@@ -0,0 +1,26 @@
+from enum import Enum
+
+
+class AnalyticsDimension(Enum):
+    COUNTRY = "country"
+    REGION = "region"
+    CITY = "city"
+    BROWSER = "browser"
+    OPERATINGSYSTEM = "operatingSystem"
+    DEVICE = "device"
+    SCREENSIZE = "screenSize"
+    REFERRERSOURCE = "referrerSource"
+    CHANNEL = "channel"
+    UTMSOURCE = "utmSource"
+    UTMMEDIUM = "utmMedium"
+    UTMCAMPAIGN = "utmCampaign"
+    UTMCONTENT = "utmContent"
+    UTMTERM = "utmTerm"
+    PAGE = "page"
+    HOSTNAME = "hostname"
+    ENTRYPAGE = "entryPage"
+    EXITPAGE = "exitPage"
+    TRAFFICTYPE = "trafficType"
+    BOTNAME = "botName"
+    BOTCATEGORY = "botCategory"
+    EVENTNAME = "eventName"

appwrite_console-0.8.0/appwrite_console/enums/analytics_interval.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class AnalyticsInterval(Enum):
+    ONE_HOUR = "1h"
+    ONE_DAY = "1d"
+    ONE_WEEK = "1w"
+    ONE_MONTH = "1m"

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/enums/project_key_scopes.py

@@ -125,3 +125,5 @@ class ProjectKeyScopes(Enum):
     OAUTH2_READ = "oauth2.read"
     OAUTH2_WRITE = "oauth2.write"
     OAUTH2_INTROSPECT = "oauth2.introspect"
+    ANALYTICS_READ = "analytics.read"
+    ANALYTICS_WRITE = "analytics.write"

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/enums/query_suggestion_resource.py

@@ -91,6 +91,7 @@ class QuerySuggestionResource(Enum):
     RESOURCE_TOKENS = "resourcetokens"
     TRANSACTIONS = "transactions"
     TRANSACTION_LOGS = "transactionlogs"
+    ANALYTICS_PROPERTIES = "analyticsproperties"
     DEDICATED_DATABASES = "dedicateddatabases"
     DEDICATED_DATABASE_CONFIGS = "dedicateddatabaseconfigs"
     DEDICATED_DATABASE_RUNTIMES = "dedicateddatabaseruntimes"

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/enums/usage_event_metric.py

@@ -1,4 +1,7 @@
 class UsageEventMetric:
+    ANALYTICS_EVENTS = "analytics.events"
+    ANALYTICS_PAGEVIEWS = "analytics.pageviews"
+    ANALYTICS_BOTS_EVENTS = "analytics.bots.events"
     NETWORK_REQUESTS = "network.requests"
     NETWORK_INBOUND = "network.inbound"
     NETWORK_OUTBOUND = "network.outbound"

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/enums/usage_gauge_metric.py

@@ -1,4 +1,5 @@
 class UsageGaugeMetric:
+    ANALYTICS_PROPERTIES = "analytics.properties"
     TEAMS = "teams"
     USERS = "users"
     MESSAGES = "messages"

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/models/__init__.py

@@ -117,6 +117,7 @@ from .algo_bcrypt import AlgoBcrypt
 from .algo_scrypt import AlgoScrypt
 from .algo_scrypt_modified import AlgoScryptModified
 from .algo_argon2 import AlgoArgon2
+from .account import Account
 from .preferences import Preferences
 from .session import Session
 from .identity import Identity
@@ -281,6 +282,9 @@ from .affiliate_referral_list import AffiliateReferralList
 from .affiliate_reward import AffiliateReward
 from .affiliate_reward_list import AffiliateRewardList
 from .aggregation_breakdown import AggregationBreakdown
+from .analytics_metric import AnalyticsMetric
+from .analytics_metric_list import AnalyticsMetricList
+from .analytics_property import AnalyticsProperty
 from .aggregation_team import AggregationTeam
 from .backup_archive import BackupArchive
 from .dedicated_database_backup import DedicatedDatabaseBackup
@@ -385,6 +389,7 @@ from .oauth2_consent_list import Oauth2ConsentList
 from .oauth2_consent_token_list import Oauth2ConsentTokenList
 from .activity_event_list import ActivityEventList
 from .addon_list import AddonList
+from .analytics_property_list import AnalyticsPropertyList
 from .aggregation_team_list import AggregationTeamList
 from .backup_archive_list import BackupArchiveList
 from .backup_policy_list import BackupPolicyList
@@ -528,6 +533,7 @@ __all__ = [
     'AlgoScrypt',
     'AlgoScryptModified',
     'AlgoArgon2',
+    'Account',
     'Preferences',
     'Session',
     'Identity',
@@ -692,6 +698,9 @@ __all__ = [
     'AffiliateReward',
     'AffiliateRewardList',
     'AggregationBreakdown',
+    'AnalyticsMetric',
+    'AnalyticsMetricList',
+    'AnalyticsProperty',
     'AggregationTeam',
     'BackupArchive',
     'DedicatedDatabaseBackup',
@@ -796,6 +805,7 @@ __all__ = [
     'Oauth2ConsentTokenList',
     'ActivityEventList',
     'AddonList',
+    'AnalyticsPropertyList',
     'AggregationTeamList',
     'BackupArchiveList',
     'BackupPolicyList',

appwrite_console-0.8.0/appwrite_console/models/account.py

@@ -0,0 +1,98 @@
+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
+from .target import Target
+
+T = TypeVar('T')
+
+
+class Account(AppwriteModel, Generic[T]):
+    """
+    Account
+
+    Attributes
+    ----------
+    id : str
+        User ID.
+    createdat : str
+        User creation date in ISO 8601 format.
+    updatedat : str
+        User update date in ISO 8601 format.
+    name : str
+        User name.
+    registration : str
+        User registration date in ISO 8601 format.
+    status : bool
+        User status. Pass `true` for enabled and `false` for disabled.
+    labels : List[Any]
+        Labels for the user.
+    passwordupdate : str
+        Password update time in ISO 8601 format.
+    email : str
+        User email address.
+    phone : str
+        User phone number in E.164 format.
+    emailverification : bool
+        Email verification status.
+    emailcanonical : Optional[str]
+        Canonical form of the user email address.
+    emailisfree : Optional[bool]
+        Whether the user email is from a free email provider.
+    emailisdisposable : Optional[bool]
+        Whether the user email is from a disposable email provider.
+    emailiscorporate : Optional[bool]
+        Whether the user email is from a corporate domain.
+    emailiscanonical : Optional[bool]
+        Whether the user email is in its canonical form.
+    passwordpwned : Optional[bool]
+        Whether the password was found in a known data breach the last time it was checked. Null when the password has never been checked.
+    phoneverification : bool
+        Phone verification status.
+    mfa : bool
+        Multi factor authentication status.
+    prefs : Preferences[T]
+        User preferences as a key-value object
+    targets : List[Target]
+        A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.
+    accessedat : str
+        Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
+    impersonator : Optional[bool]
+        Whether the user can impersonate other users.
+    impersonatoruserid : Optional[str]
+        ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.
+    """
+
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    name: str = Field(..., alias='name')
+    registration: str = Field(..., alias='registration')
+    status: bool = Field(..., alias='status')
+    labels: List[Any] = Field(..., alias='labels')
+    passwordupdate: str = Field(..., alias='passwordUpdate')
+    email: str = Field(..., alias='email')
+    phone: str = Field(..., alias='phone')
+    emailverification: bool = Field(..., alias='emailVerification')
+    emailcanonical: Optional[str] = Field(default=None, alias='emailCanonical')
+    emailisfree: Optional[bool] = Field(default=None, alias='emailIsFree')
+    emailisdisposable: Optional[bool] = Field(default=None, alias='emailIsDisposable')
+    emailiscorporate: Optional[bool] = Field(default=None, alias='emailIsCorporate')
+    emailiscanonical: Optional[bool] = Field(default=None, alias='emailIsCanonical')
+    passwordpwned: Optional[bool] = Field(default=None, alias='passwordPwned')
+    phoneverification: bool = Field(..., alias='phoneVerification')
+    mfa: bool = Field(..., alias='mfa')
+    prefs: Preferences[T] = Field(..., alias='prefs')
+    targets: List[Target] = Field(..., alias='targets')
+    accessedat: str = Field(..., alias='accessedAt')
+    impersonator: Optional[bool] = Field(default=None, alias='impersonator')
+    impersonatoruserid: Optional[str] = Field(default=None, alias='impersonatorUserId')
+
+    @classmethod
+    def with_data(cls, data: Dict[str, Any], model_type: Type[T] = dict) -> 'Account[T]':
+        """Create Account 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-0.8.0/appwrite_console/models/analytics_metric.py

@@ -0,0 +1,50 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+
+class AnalyticsMetric(AppwriteModel):
+    """
+    AnalyticsMetric
+
+    Attributes
+    ----------
+    value : Optional[str]
+        Dimension value this row covers. Null when no dimension was requested, empty when the dimension could not be derived for those events.
+    date : Optional[str]
+        Start of the time bucket this row covers, in ISO 8601. Null when no interval was requested.
+    visitors : float
+        Unique visitors in the requested range.
+    sessions : float
+        Unique sessions in the requested range.
+    pageviews : Optional[float]
+        Total pageview events (events with name="pageview") in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
+    events : float
+        Total events in the requested range.
+    visits : Optional[float]
+        Total sessions with activity in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
+    bouncerate : Optional[float]
+        Share of single-event sessions, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
+    visitduration : Optional[float]
+        Average session length in seconds, measured first event to last event. Single-event sessions count as 0. Only the flat aggregate computes it; null on breakdown and time-series rows.
+    viewspervisit : Optional[float]
+        Average pageviews per session (pageviews divided by visits). Only the flat aggregate computes it; null on breakdown and time-series rows.
+    scrolldepth : Optional[float]
+        Average scroll depth across events, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
+    engagementtime : Optional[float]
+        Average engaged time per session in seconds, counting only foreground time. Sessions that reported no engagement are excluded. Only the flat aggregate computes it; null on breakdown and time-series rows.
+    """
+
+    value: Optional[str] = Field(default=None, alias='value')
+    date: Optional[str] = Field(default=None, alias='date')
+    visitors: float = Field(..., alias='visitors')
+    sessions: float = Field(..., alias='sessions')
+    pageviews: Optional[float] = Field(default=None, alias='pageviews')
+    events: float = Field(..., alias='events')
+    visits: Optional[float] = Field(default=None, alias='visits')
+    bouncerate: Optional[float] = Field(default=None, alias='bounceRate')
+    visitduration: Optional[float] = Field(default=None, alias='visitDuration')
+    viewspervisit: Optional[float] = Field(default=None, alias='viewsPerVisit')
+    scrolldepth: Optional[float] = Field(default=None, alias='scrollDepth')
+    engagementtime: Optional[float] = Field(default=None, alias='engagementTime')

appwrite_console-0.8.0/appwrite_console/models/analytics_metric_list.py

@@ -0,0 +1,21 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .analytics_metric import AnalyticsMetric
+
+
+class AnalyticsMetricList(AppwriteModel):
+    """
+    AnalyticsMetricList
+
+    Attributes
+    ----------
+    total : float
+        Total number of metric rows returned.
+    metrics : List[AnalyticsMetric]
+        Metric rows: one per time bucket, one per dimension value, or a single row for the flat aggregate.
+    """
+
+    total: float = Field(..., alias='total')
+    metrics: List[AnalyticsMetric] = Field(..., alias='metrics')

appwrite_console-0.8.0/appwrite_console/models/analytics_property.py

@@ -0,0 +1,44 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+
+
+class AnalyticsProperty(AppwriteModel):
+    """
+    AnalyticsProperty
+
+    Attributes
+    ----------
+    id : str
+        Analytics property ID.
+    createdat : str
+        Property creation date in ISO 8601 format.
+    updatedat : str
+        Property update date in ISO 8601 format.
+    name : str
+        Human-readable name of the tracked website or application.
+    domain : str
+        Primary domain being tracked (e.g. example.com). May be empty for native apps.
+    timezone : str
+        IANA timezone used to define the daily boundary for stats.
+    enabled : bool
+        Whether tracking is currently active.
+    public : bool
+        Whether stats for this property are publicly viewable.
+    allowedorigins : List[Any]
+        List of origins allowed to send tracking events. Use ["*"] to allow all.
+    snippetid : str
+        Unique identifier for the tracking script snippet.
+    """
+
+    id: str = Field(..., alias='$id')
+    createdat: str = Field(..., alias='$createdAt')
+    updatedat: str = Field(..., alias='$updatedAt')
+    name: str = Field(..., alias='name')
+    domain: str = Field(..., alias='domain')
+    timezone: str = Field(..., alias='timezone')
+    enabled: bool = Field(..., alias='enabled')
+    public: bool = Field(..., alias='public')
+    allowedorigins: List[Any] = Field(..., alias='allowedOrigins')
+    snippetid: str = Field(..., alias='snippetId')

appwrite_console-0.8.0/appwrite_console/models/analytics_property_list.py

@@ -0,0 +1,21 @@
+from typing import Any, Dict, List, Optional, Union, cast
+from pydantic import Field, PrivateAttr
+
+from .base_model import AppwriteModel
+from .analytics_property import AnalyticsProperty
+
+
+class AnalyticsPropertyList(AppwriteModel):
+    """
+    Analytics properties list
+
+    Attributes
+    ----------
+    total : float
+        Total number of properties that matched your query.
+    properties : List[AnalyticsProperty]
+        List of properties.
+    """
+
+    total: float = Field(..., alias='total')
+    properties: List[AnalyticsProperty] = Field(..., alias='properties')

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/models/usage_organization.py

@@ -52,6 +52,8 @@ class UsageOrganization(AppwriteModel):
         Aggregated stats for total databases  writes.
     backupsstoragetotal : float
         Aggregated stats for total backups storage.
+    avatarsstoragetotal : float
+        Aggregated stats for total custom user photos storage.
     storagetotal : float
         Aggregated stats for total storage.
     authphonetotal : float
@@ -94,6 +96,7 @@ class UsageOrganization(AppwriteModel):
     databasesreadstotal: float = Field(..., alias='databasesReadsTotal')
     databaseswritestotal: float = Field(..., alias='databasesWritesTotal')
     backupsstoragetotal: float = Field(..., alias='backupsStorageTotal')
+    avatarsstoragetotal: float = Field(..., alias='avatarsStorageTotal')
     storagetotal: float = Field(..., alias='storageTotal')
     authphonetotal: float = Field(..., alias='authPhoneTotal')
     authphoneestimate: float = Field(..., alias='authPhoneEstimate')

{appwrite_console-0.7.1 → appwrite_console-0.8.0}/appwrite_console/services/account.py

@@ -2324,9 +2324,15 @@ class Account(Service):
 
     def list_sessions(
         self,
+        total: Optional[bool] = None,
     ) -> SessionList:
         """
         Get the list of active sessions across different devices for the currently logged in user.
+
+        Parameters
+        ----------
+        total : Optional[bool]
+            When set to false, the total count returned will be 0 and will not be calculated.
         Returns
         -------
         SessionList
@@ -2340,6 +2346,8 @@ class Account(Service):
 
         api_path = '/account/sessions'
         api_params = {}
+        if total is not None:
+            api_params['total'] = self._normalize_value(total)
 
         response = self.client.call(
             'get',