@appwrite.io/console 18.4.0-rc.2 → 18.4.0

package/types/models.d.ts

@@ -229,58 +229,6 @@ export declare namespace Models {
          */
         tokens: ResourceToken[];
     };
-    /**
-     * Videos List
-     */
-    export type VideoList = {
-        /**
-         * Total number of videos that matched your query.
-         */
-        total: number;
-        /**
-         * List of videos.
-         */
-        videos: Video[];
-    };
-    /**
-     * Video Profiles List
-     */
-    export type VideoProfileList = {
-        /**
-         * Total number of profiles that matched your query.
-         */
-        total: number;
-        /**
-         * List of profiles.
-         */
-        profiles: VideoProfile[];
-    };
-    /**
-     * Video Renditions List
-     */
-    export type VideoRenditionList = {
-        /**
-         * Total number of renditions that matched your query.
-         */
-        total: number;
-        /**
-         * List of renditions.
-         */
-        renditions: VideoRendition[];
-    };
-    /**
-     * Video Subtitles List
-     */
-    export type VideoSubtitleList = {
-        /**
-         * Total number of subtitles that matched your query.
-         */
-        total: number;
-        /**
-         * List of subtitles.
-         */
-        subtitles: VideoSubtitle[];
-    };
     /**
      * Teams List
      */
@@ -650,7 +598,7 @@ export declare namespace Models {
         /**
          * List of policies.
          */
-        policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail | Models.PolicyPasskey)[];
+        policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail)[];
     };
     /**
      * Email Templates List
@@ -6838,27 +6786,6 @@ export declare namespace Models {
          */
         custom: boolean;
     };
-    /**
-     * Policy Passkey
-     */
-    export type PolicyPasskey = {
-        /**
-         * Policy ID.
-         */
-        $id: string;
-        /**
-         * Whether the passkey auth method is enabled. Toggle it with the update auth method endpoint.
-         */
-        enabled: boolean;
-        /**
-         * Relying party ID passkeys are bound to. Empty until configured.
-         */
-        rpId: string;
-        /**
-         * Web origins allowed to register and sign in with passkeys.
-         */
-        origins: string[];
-    };
     /**
      * Policy Deny Aliased Email
      */
@@ -6997,10 +6924,6 @@ export declare namespace Models {
          * Android application ID.
          */
         applicationId: string;
-        /**
-         * SHA-256 fingerprints of the certificates the app is signed with. Passkeys created in the app are accepted when its signature matches one.
-         */
-        fingerprints: string[];
     };
     /**
      * Platform Windows
@@ -7529,7 +7452,7 @@ export declare namespace Models {
          */
         deploymentId: string;
         /**
-         * Type of deployment resource: function, site, or dedicatedDatabase.
+         * Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
          */
         deploymentResourceType?: ProxyRuleDeploymentResourceType;
         /**
@@ -7920,6 +7843,35 @@ export declare namespace Models {
          */
         code: string;
     };
+    /**
+     * Token Secret
+     */
+    export type TokenSecret = {
+        /**
+         * Token ID.
+         */
+        $id: string;
+        /**
+         * Token creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * User ID.
+         */
+        userId: string;
+        /**
+         * Token secret key. Exchange it for a session with the create session endpoint.
+         */
+        secret: string;
+        /**
+         * Token expiration date in ISO 8601 format.
+         */
+        expire: string;
+        /**
+         * Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.
+         */
+        phrase: string;
+    };
     /**
      * Passkey
      */
@@ -7944,17 +7896,13 @@ export declare namespace Models {
          * Most recent sign-in with this passkey in ISO 8601 format. Empty until the passkey is used to sign in.
          */
         accessedAt: string;
-        /**
-         * Whether the passkey is synced to a cloud account, such as iCloud Keychain or Google Password Manager, rather than bound to one device.
-         */
-        backedUp: boolean;
     };
     /**
      * Passkey Challenge
      */
     export type PasskeyChallenge = {
         /**
-         * Challenge ID. Pass it back with the credential to complete the ceremony.
+         * Challenge ID. When signing in, pass it back with the credential to receive a token.
          */
         $id: string;
         /**
@@ -8641,274 +8589,6 @@ export declare namespace Models {
          */
         analyzedAt?: string;
     };
-    /**
-     * Video
-     */
-    export type Video = {
-        /**
-         * Video ID.
-         */
-        $id: string;
-        /**
-         * Video creation time in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * Video update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * Storage bucket ID holding the source file.
-         */
-        bucketId: string;
-        /**
-         * Source file ID.
-         */
-        fileId: string;
-        /**
-         * Video name.
-         */
-        name: string;
-        /**
-         * Preview image ID, taken from the sprite timeline.
-         */
-        previewId: string;
-        /**
-         * Source file size in bytes.
-         */
-        size: number;
-        /**
-         * Source status: one of `pending`, `downloading`, `ready`, `removed`, `error` or `aborted`.
-         */
-        status: string;
-        /**
-         * Total number of chunks in the source download.
-         */
-        chunksTotal: number;
-        /**
-         * Number of source chunks downloaded so far.
-         */
-        chunksUploaded: number;
-        /**
-         * Container format.
-         */
-        format: string;
-        /**
-         * Video duration in milliseconds.
-         */
-        duration: number;
-        /**
-         * Video width in pixels.
-         */
-        width: number;
-        /**
-         * Video height in pixels.
-         */
-        height: number;
-        /**
-         * Video aspect ratio.
-         */
-        aspectRatio: string;
-        /**
-         * Video codec.
-         */
-        videoCodec: string;
-        /**
-         * Video format.
-         */
-        videoFormat: string;
-        /**
-         * Video format profile.
-         */
-        videoFormatProfile: string;
-        /**
-         * Video bitrate in bits per second.
-         */
-        videoBitRate: number;
-        /**
-         * Video frame rate.
-         */
-        videoFrameRate: string;
-        /**
-         * Video frame rate mode.
-         */
-        videoFrameRateMode: string;
-        /**
-         * Audio codec.
-         */
-        audioCodec: string;
-        /**
-         * Audio format.
-         */
-        audioFormat: string;
-        /**
-         * Audio bitrate in bits per second.
-         */
-        audioBitRate: number;
-        /**
-         * Audio sample rate.
-         */
-        audioSampleRate: string;
-    };
-    /**
-     * Video profile
-     */
-    export type VideoProfile = {
-        /**
-         * Video profile ID.
-         */
-        $id: string;
-        /**
-         * Video profile creation time in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * Video profile update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * Video profile name.
-         */
-        name: string;
-        /**
-         * Target video bitrate in kilobits per second.
-         */
-        videoBitRate: number;
-        /**
-         * Target audio bitrate in kilobits per second.
-         */
-        audioBitRate: number;
-        /**
-         * Target video width in pixels.
-         */
-        width: number;
-        /**
-         * Target video height in pixels.
-         */
-        height: number;
-    };
-    /**
-     * Video rendition
-     */
-    export type VideoRendition = {
-        /**
-         * Rendition ID.
-         */
-        $id: string;
-        /**
-         * Rendition creation time in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * Rendition update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * Video ID.
-         */
-        videoId: string;
-        /**
-         * Video profile ID this rendition was encoded against.
-         */
-        profileId: string;
-        /**
-         * Rendition name, derived from its dimensions and bitrate.
-         */
-        name: string;
-        /**
-         * Transcoding start time in ISO 8601 format.
-         */
-        startedAt: string;
-        /**
-         * Transcoding end time in ISO 8601 format.
-         */
-        endedAt: string;
-        /**
-         * Rendition width in pixels.
-         */
-        width: number;
-        /**
-         * Rendition height in pixels.
-         */
-        height: number;
-        /**
-         * Video bitrate in kilobits per second.
-         */
-        videoBitRate: number;
-        /**
-         * Audio bitrate in kilobits per second.
-         */
-        audioBitRate: number;
-        /**
-         * Longest segment duration in seconds.
-         */
-        targetDuration: string;
-        /**
-         * Transcoding status: one of `pending`, `started`, `ended`, `uploading`, `ready`, `error` or `aborted`.
-         */
-        status: string;
-        /**
-         * Transcoding progress as a percentage.
-         */
-        progress: string;
-        /**
-         * Streaming output format: `hls`, `dash`, or `cmaf`.
-         */
-        output: string;
-    };
-    /**
-     * Video subtitle
-     */
-    export type VideoSubtitle = {
-        /**
-         * Subtitle ID.
-         */
-        $id: string;
-        /**
-         * Subtitle creation time in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * Subtitle update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * Video ID.
-         */
-        videoId: string;
-        /**
-         * Storage bucket ID holding the subtitle file.
-         */
-        bucketId: string;
-        /**
-         * Subtitle file ID.
-         */
-        fileId: string;
-        /**
-         * Subtitle display name.
-         */
-        name: string;
-        /**
-         * Subtitle ISO 639-2 language code.
-         */
-        code: string;
-        /**
-         * Is this the default subtitle track?
-         */
-        default: boolean;
-        /**
-         * Was this track auto-extracted from the source container? Extracted tracks have no backing file; extraction runs once per video, so a deleted extracted track is not re-created.
-         */
-        embedded: boolean;
-        /**
-         * Longest segment duration in seconds.
-         */
-        targetDuration: string;
-        /**
-         * Packaging status: one of `pending`, `started`, `ready` or `error`.
-         */
-        status: string;
-    };
     /**
      * ActivityEvent
      */
@@ -9324,117 +9004,6 @@ export declare namespace Models {
          */
         resources: UsageResources[];
     };
-    /**
-     * AnalyticsMetric
-     */
-    export type AnalyticsMetric = {
-        /**
-         * Dimension value this row covers. Null when no dimension was requested, empty when the dimension could not be derived for those events.
-         */
-        value?: string;
-        /**
-         * Start of the time bucket this row covers, in ISO 8601. Null when no interval was requested.
-         */
-        date?: string;
-        /**
-         * Unique visitors in the requested range.
-         */
-        visitors: number;
-        /**
-         * Unique sessions in the requested range.
-         */
-        sessions: number;
-        /**
-         * Total pageview events (events with name="pageview") in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
-         */
-        pageviews?: number;
-        /**
-         * Total events in the requested range.
-         */
-        events: number;
-        /**
-         * Total sessions with activity in the requested range. Only the flat aggregate computes it; null on breakdown and time-series rows.
-         */
-        visits?: number;
-        /**
-         * Share of single-event sessions, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
-         */
-        bounceRate?: number;
-        /**
-         * 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.
-         */
-        visitDuration?: number;
-        /**
-         * Average pageviews per session (pageviews divided by visits). Only the flat aggregate computes it; null on breakdown and time-series rows.
-         */
-        viewsPerVisit?: number;
-        /**
-         * Average scroll depth across events, as a percentage. Only the flat aggregate computes it; null on breakdown and time-series rows.
-         */
-        scrollDepth?: number;
-        /**
-         * 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.
-         */
-        engagementTime?: number;
-    };
-    /**
-     * AnalyticsMetricList
-     */
-    export type AnalyticsMetricList = {
-        /**
-         * Total number of metric rows returned.
-         */
-        total: number;
-        /**
-         * Metric rows: one per time bucket, one per dimension value, or a single row for the flat aggregate.
-         */
-        metrics: AnalyticsMetric[];
-    };
-    /**
-     * AnalyticsProperty
-     */
-    export type AnalyticsProperty = {
-        /**
-         * Analytics property ID.
-         */
-        $id: string;
-        /**
-         * Property creation date in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * Property update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * Human-readable name of the tracked website or application.
-         */
-        name: string;
-        /**
-         * Primary domain being tracked (e.g. example.com). May be empty for native apps.
-         */
-        domain: string;
-        /**
-         * IANA timezone used to define the daily boundary for stats.
-         */
-        timezone: string;
-        /**
-         * Whether tracking is currently active.
-         */
-        enabled: boolean;
-        /**
-         * Whether stats for this property are publicly viewable.
-         */
-        public: boolean;
-        /**
-         * List of origins allowed to send tracking events. Use ["*"] to allow all.
-         */
-        allowedOrigins: string[];
-        /**
-         * Unique identifier for the tracking script snippet.
-         */
-        snippetId: string;
-    };
     /**
      * Team
      */
@@ -9585,17 +9154,17 @@ export declare namespace Models {
          */
         policyId: string;
         /**
-         * Archive size in bytes. Null until the size is known.
+         * Archive size in bytes.
          */
-        size?: number;
+        size: number;
         /**
          * The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.
          */
         status: string;
         /**
-         * The backup start time. Null until the backup starts.
+         * The backup start time.
          */
-        startedAt?: string;
+        startedAt: string;
         /**
          * Migration ID.
          */
@@ -9747,7 +9316,7 @@ export declare namespace Models {
         /**
          * Address line 2
          */
-        addressLine2?: string;
+        addressLine2: string;
         /**
          * Address country
          */
@@ -9759,11 +9328,11 @@ export declare namespace Models {
         /**
          * state
          */
-        state?: string;
+        state: string;
         /**
          * postal code
          */
-        postalCode?: string;
+        postalCode: string;
     };
     /**
      * Limits
@@ -9967,9 +9536,9 @@ export declare namespace Models {
          */
         alertLimit: number;
         /**
-         * Additional resources. Null when the plan does not support usage billing.
+         * Additional resources
          */
-        usage?: UsageBillingPlan;
+        usage: UsageBillingPlan;
         /**
          * Addons
          */
@@ -10316,7 +9885,7 @@ export declare namespace Models {
         /**
          * Branch port. Null until the backing reports one.
          */
-        port?: number;
+        port: number;
         /**
          * Advertised catalog the client connects to. MySQL/MariaDB use default; Postgres uses the routing label.
          */
@@ -10620,11 +10189,11 @@ export declare namespace Models {
         /**
          * Product API that owns this database: tablesdb, documentsdb, vectorsdb, mysql, postgresql, or mongodb.
          */
-        api?: string;
+        api: string;
         /**
          * Database engine: postgresql, mysql, or mongodb. Null until the backing reports one.
          */
-        engine?: string;
+        engine: string;
         /**
          * Database engine version.
          */
@@ -10644,7 +10213,7 @@ export declare namespace Models {
         /**
          * Database port for connections. Derived from the engine when the backing has not reported one yet.
          */
-        connectionPort?: number;
+        connectionPort: number;
         /**
          * Database username for connections.
          */
@@ -10656,7 +10225,7 @@ export declare namespace Models {
         /**
          * Committed generation of the primary connection credentials. Null until the rotation contract has been initialized.
          */
-        credentialGeneration?: number;
+        credentialGeneration: number;
         /**
          * Full database connection string (URI format).
          */
@@ -10867,7 +10436,7 @@ export declare namespace Models {
         /**
          * Source database ID when restoring a backup into another database.
          */
-        sourceDatabaseId?: string;
+        sourceDatabaseId: string;
         /**
          * Project ID.
          */
@@ -10875,7 +10444,7 @@ export declare namespace Models {
         /**
          * Backup ID used for restoration (null for PITR).
          */
-        backupId?: string;
+        backupId: string;
         /**
          * Restoration type. Possible values: backup (restore from a specific backup snapshot), pitr (point-in-time recovery to a specific timestamp).
          */
@@ -10887,15 +10456,15 @@ export declare namespace Models {
         /**
          * Target time for PITR restoration in ISO 8601 format.
          */
-        targetTime?: string;
+        targetTime: string;
         /**
          * Restoration start time in ISO 8601 format.
          */
-        startedAt?: string;
+        startedAt: string;
         /**
          * Restoration completion time in ISO 8601 format.
          */
-        completedAt?: string;
+        completedAt: string;
         /**
          * Error message if restoration failed.
          */
@@ -10926,9 +10495,9 @@ export declare namespace Models {
          */
         uptime: number;
         /**
-         * Connection statistics. Null when the database has not been probed.
+         * Connection statistics.
          */
-        connections?: DatabaseStatusConnections;
+        connections: DatabaseStatusConnections;
         /**
          * Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
          */
@@ -11261,7 +10830,7 @@ export declare namespace Models {
         /**
          * Discount amount
          */
-        discount?: number;
+        discount: number;
         /**
          * Credits amount
          */
@@ -11345,7 +10914,7 @@ export declare namespace Models {
         /**
          * Discount amount
          */
-        discount?: number;
+        discount: number;
         /**
          * Credits amount
          */
@@ -11621,7 +11190,7 @@ export declare namespace Models {
         /**
          * Client secret for processing failed payments in front-end
          */
-        clientSecret?: string;
+        clientSecret: string;
         /**
          * Invoice status
          */
@@ -11633,7 +11202,7 @@ export declare namespace Models {
         /**
          * Last payment error associated with the invoice
          */
-        lastError?: string;
+        lastError: string;
         /**
          * Invoice due date.
          */
@@ -11764,15 +11333,15 @@ export declare namespace Models {
         /**
          * Billing cycle start date.
          */
-        billingStartDate?: string;
+        billingStartDate: string;
         /**
          * Current invoice cycle start date.
          */
-        billingCurrentInvoiceDate?: string;
+        billingCurrentInvoiceDate: string;
         /**
          * Next invoice cycle start date.
          */
-        billingNextInvoiceDate?: string;
+        billingNextInvoiceDate: string;
         /**
          * Start date of trial.
          */
@@ -11780,19 +11349,19 @@ export declare namespace Models {
         /**
          * Number of trial days.
          */
-        billingTrialDays?: number;
+        billingTrialDays: number;
         /**
          * Current active aggregation id.
          */
-        billingAggregationId?: string;
+        billingAggregationId: string;
         /**
          * Current active aggregation id.
          */
-        billingInvoiceId?: string;
+        billingInvoiceId: string;
         /**
          * Default payment method.
          */
-        paymentMethodId?: string;
+        paymentMethodId: string;
         /**
          * Default payment method.
          */
@@ -11922,39 +11491,39 @@ export declare namespace Models {
         /**
          * Expiry month of the payment method.
          */
-        expiryMonth?: number;
+        expiryMonth: number;
         /**
          * Expiry year of the payment method.
          */
-        expiryYear?: number;
+        expiryYear: number;
         /**
          * Last 4 digit of the payment method
          */
-        last4?: string;
+        last4: string;
         /**
          * Payment method brand
          */
-        brand?: string;
+        brand: string;
         /**
          * Name of the owner
          */
-        name?: string;
+        name: string;
         /**
          * Mandate ID of the payment method
          */
-        mandateId?: string;
+        mandateId: string;
         /**
          * Country of the payment method
          */
-        country?: string;
+        country: string;
         /**
          * State of the payment method
          */
-        state?: string;
+        state: string;
         /**
          * Last payment error associated with the payment method.
          */
-        lastError?: string;
+        lastError: string;
         /**
          * True when it's the default payment method.
          */
@@ -12327,9 +11896,9 @@ export declare namespace Models {
          */
         status: string;
         /**
-         * The restoration start time. Null until the restoration starts.
+         * The backup start time.
          */
-        startedAt?: string;
+        startedAt: string;
         /**
          * Migration ID.
          */
@@ -12343,9 +11912,9 @@ export declare namespace Models {
          */
         resources: string[];
         /**
-         * Restoration options as a key-value object.
+         * Optional data in key-value object.
          */
-        options: object;
+        options: string;
     };
     /**
      * Dedicated database restorations list
@@ -12530,11 +12099,11 @@ export declare namespace Models {
         /**
          * Bandwidth additional resources
          */
-        bandwidth?: AdditionalResource;
+        bandwidth: AdditionalResource;
         /**
          * Executions additional resources
          */
-        executions?: AdditionalResource;
+        executions: AdditionalResource;
         /**
          * Member additional resources
          */
@@ -12542,11 +12111,11 @@ export declare namespace Models {
         /**
          * Realtime additional resources
          */
-        realtime?: AdditionalResource;
+        realtime: AdditionalResource;
         /**
          * Realtime messages additional resources
          */
-        realtimeMessages?: AdditionalResource;
+        realtimeMessages: AdditionalResource;
         /**
          * Realtime bandwidth additional resources
          */
@@ -12554,19 +12123,19 @@ export declare namespace Models {
         /**
          * Storage additional resources
          */
-        storage?: AdditionalResource;
+        storage: AdditionalResource;
         /**
          * User additional resources
          */
-        users?: AdditionalResource;
+        users: AdditionalResource;
         /**
          * GBHour additional resources
          */
-        GBHours?: AdditionalResource;
+        GBHours: AdditionalResource;
         /**
          * Image transformation additional resources
          */
-        imageTransformations?: AdditionalResource;
+        imageTransformations: AdditionalResource;
         /**
          * Credits additional resources
          */
@@ -12656,10 +12225,6 @@ export declare namespace Models {
          * Aggregated stats for total backups storage.
          */
         backupsStorageTotal: number;
-        /**
-         * Aggregated stats for total custom user photos storage.
-         */
-        avatarsStorageTotal: number;
         /**
          * Aggregated stats for total storage.
          */
@@ -13901,19 +13466,6 @@ export declare namespace Models {
          */
         addons: Addon[];
     };
-    /**
-     * Analytics properties list
-     */
-    export type AnalyticsPropertyList = {
-        /**
-         * Total number of properties that matched your query.
-         */
-        total: number;
-        /**
-         * List of properties.
-         */
-        properties: AnalyticsProperty[];
-    };
     /**
      * Aggregation team list
      */