@appwrite.io/console 15.7.0 → 16.0.0

package/types/models.d.ts

@@ -880,7 +880,7 @@ export declare namespace Models {
          */
         status?: DatabaseStatus;
         /**
-         * Underlying engine of the dedicated backing: postgresql, mysql, mariadb, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.
+         * Underlying engine of the dedicated backing: postgresql, mysql, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.
          */
         engine?: string;
         /**
@@ -7123,35 +7123,35 @@ export declare namespace Models {
         /**
          * Aggregated number of text embedding calls per period.
          */
-        embeddingsText: Metric;
+        embeddingsText: Metric[];
         /**
          * Aggregated number of tokens processed by text embeddings per period.
          */
-        embeddingsTextTokens: Metric;
+        embeddingsTextTokens: Metric[];
         /**
          * Aggregated duration spent generating text embeddings per period.
          */
-        embeddingsTextDuration: Metric;
+        embeddingsTextDuration: Metric[];
         /**
          * Aggregated number of errors while generating text embeddings per period.
          */
-        embeddingsTextErrors: Metric;
+        embeddingsTextErrors: Metric[];
         /**
          * Total aggregated number of text embedding calls.
          */
-        embeddingsTextTotal: Metric;
+        embeddingsTextTotal: number;
         /**
          * Total aggregated number of tokens processed by text.
          */
-        embeddingsTextTokensTotal: Metric;
+        embeddingsTextTokensTotal: number;
         /**
          * Total aggregated duration spent generating text embeddings.
          */
-        embeddingsTextDurationTotal: Metric;
+        embeddingsTextDurationTotal: number;
         /**
          * Total aggregated number of errors while generating text embeddings.
          */
-        embeddingsTextErrorsTotal: Metric;
+        embeddingsTextErrorsTotal: number;
         /**
          * Aggregated number of function executions per period.
          */
@@ -8512,6 +8512,164 @@ export declare namespace Models {
          */
         billingCycleEnd: string;
     };
+    /**
+     * AffiliateLink
+     */
+    export type AffiliateLink = {
+        /**
+         * Link ID. This is the shareable referral code.
+         */
+        $id: string;
+        /**
+         * Link creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Link update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * User ID of the link owner.
+         */
+        userId: string;
+        /**
+         * Optional link name.
+         */
+        name: string;
+        /**
+         * Link status. Can be one of `active` or `disabled`.
+         */
+        status: string;
+    };
+    /**
+     * Affiliate links list
+     */
+    export type AffiliateLinkList = {
+        /**
+         * Total number of links that matched your query.
+         */
+        total: number;
+        /**
+         * List of links.
+         */
+        links: AffiliateLink[];
+    };
+    /**
+     * AffiliateReferral
+     */
+    export type AffiliateReferral = {
+        /**
+         * Referral ID.
+         */
+        $id: string;
+        /**
+         * Referral creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Referral update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Affiliate link ID used for attribution.
+         */
+        linkId: string;
+        /**
+         * Privacy-safe truncated referred user ID.
+         */
+        referredUserMaskedId: string;
+        /**
+         * ISO 3166-1 alpha-2 country code of the referred user at signup, when available.
+         */
+        referredUserCountry: string;
+        /**
+         * Referral status. Can be one of `pending`, `converted`, or `expired`. `expired` is derived from `expiresAt` when still pending.
+         */
+        status: string;
+        /**
+         * Attribution time in ISO 8601 format.
+         */
+        attributedAt: string;
+        /**
+         * Attribution expiry time in ISO 8601 format.
+         */
+        expiresAt: string;
+        /**
+         * Conversion time in ISO 8601 format.
+         */
+        convertedAt?: string;
+    };
+    /**
+     * Affiliate referrals list
+     */
+    export type AffiliateReferralList = {
+        /**
+         * Total number of referrals that matched your query.
+         */
+        total: number;
+        /**
+         * List of referrals.
+         */
+        referrals: AffiliateReferral[];
+    };
+    /**
+     * AffiliateReward
+     */
+    export type AffiliateReward = {
+        /**
+         * Reward ID.
+         */
+        $id: string;
+        /**
+         * Reward creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Reward update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * User ID of the reward owner.
+         */
+        userId: string;
+        /**
+         * Affiliate link ID that earned this reward.
+         */
+        linkId: string;
+        /**
+         * Referral ID that earned this reward.
+         */
+        referralId: string;
+        /**
+         * Reward amount in USD.
+         */
+        amount: number;
+        /**
+         * Reward status. Can be one of `pending` or `claimed`.
+         */
+        status: string;
+        /**
+         * Organization ID the reward was claimed on.
+         */
+        teamId?: string;
+        /**
+         * Credit document ID created when the reward was claimed.
+         */
+        creditId?: string;
+    };
+    /**
+     * Affiliate rewards list
+     */
+    export type AffiliateRewardList = {
+        /**
+         * Total number of rewards that matched your query.
+         */
+        total: number;
+        /**
+         * List of rewards.
+         */
+        rewards: AffiliateReward[];
+    };
     /**
      * Breakdown
      */
@@ -8743,6 +8901,14 @@ export declare namespace Models {
          * Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup), wal (write-ahead log continuous archival).
          */
         type: string;
+        /**
+         * Backup type that was requested. Differs from `type` when the backend could not run the requested type and took a different one instead, in which case `fallbackReason` explains why. Empty for backups taken before the requested type was recorded.
+         */
+        requestedType: string;
+        /**
+         * Why the backend ran a different backup type than the one requested. Empty when the backup ran as requested.
+         */
+        fallbackReason: string;
         /**
          * Backup status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error), verified (integrity check passed).
          */
@@ -8935,7 +9101,7 @@ export declare namespace Models {
         /**
          * Members
          */
-        members: number;
+        members?: number;
         /**
          * Webhooks
          */
@@ -9031,7 +9197,7 @@ export declare namespace Models {
         /**
          * Activity log days
          */
-        activityLogs: number;
+        activityLogs?: number;
         /**
          * Usage history days
          */
@@ -9127,7 +9293,7 @@ export declare namespace Models {
         /**
          * Does plan support backup policies.
          */
-        backupsEnabled: boolean;
+        backupsEnabled?: boolean;
         /**
          * Whether usage addons are calculated per project.
          */
@@ -9139,7 +9305,7 @@ export declare namespace Models {
         /**
          * How many policies does plan support
          */
-        backupPolicies: number;
+        backupPolicies?: number;
         /**
          * Maximum function and site deployment size in MB
          */
@@ -9176,11 +9342,11 @@ export declare namespace Models {
         /**
          * Addon seats
          */
-        seats: BillingPlanAddonDetails;
+        seats?: BillingPlanAddonDetails;
         /**
          * Addon projects
          */
-        projects: BillingPlanAddonDetails;
+        projects?: BillingPlanAddonDetails;
     };
     /**
      * Details
@@ -9205,7 +9371,7 @@ export declare namespace Models {
         /**
          * Price currency
          */
-        currency: string;
+        currency?: string;
         /**
          * Price
          */
@@ -9417,7 +9583,7 @@ export declare namespace Models {
          */
         host: string;
         /**
-         * Branch port.
+         * Branch port. Null until the backing reports one.
          */
         port: number;
         /**
@@ -9437,7 +9603,7 @@ export declare namespace Models {
          */
         ssl: boolean;
         /**
-         * Database engine. Possible values: postgresql, mysql, mariadb, mongodb.
+         * Database engine. Possible values: postgresql, mysql, mongodb.
          */
         engine: string;
         /**
@@ -9651,6 +9817,14 @@ export declare namespace Models {
          * Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.
          */
         phase: string;
+        /**
+         * Number of times a migration step has failed and been recorded.
+         */
+        attempt: number;
+        /**
+         * Reason the most recent migration step failed, empty while none has.
+         */
+        lastError: string;
         /**
          * Number of documents still pending replication to the target.
          */
@@ -9705,7 +9879,7 @@ export declare namespace Models {
          */
         api: string;
         /**
-         * Database engine: postgresql, mysql, mariadb, or mongodb.
+         * Database engine: postgresql, mysql, or mongodb. Null until the backing reports one.
          */
         engine: string;
         /**
@@ -9725,7 +9899,7 @@ export declare namespace Models {
          */
         hostname: string;
         /**
-         * Database port for connections.
+         * Database port for connections. Derived from the engine when the backing has not reported one yet.
          */
         connectionPort: number;
         /**
@@ -9805,7 +9979,7 @@ export declare namespace Models {
          */
         crossRegionReplicas: number;
         /**
-         * Maximum concurrent connections.
+         * Maximum concurrent client connections. This is the limit a client pool may reach; the engine's own max_connections reported by the status endpoint is a smaller backend limit the pooler multiplexes onto and does not constrain a client pool.
          */
         networkMaxConnections: number;
         /**
@@ -9981,7 +10155,7 @@ export declare namespace Models {
          */
         ready: boolean;
         /**
-         * Database engine: postgresql, mysql, mariadb, or mongodb.
+         * Database engine: postgresql, mysql, or mongodb.
          */
         engine: string;
         /**
@@ -9997,7 +10171,31 @@ export declare namespace Models {
          */
         connections: DatabaseStatusConnections;
         /**
-         * List of database replicas and their status.
+         * Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
+         */
+        syncMode: string;
+        /**
+         * Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read.
+         */
+        effectiveSyncMode?: string;
+        /**
+         * Whether the enforced replication is weaker than the requested syncMode.
+         */
+        syncDegraded: boolean;
+        /**
+         * Number of standby acknowledgements the primary waits for before a write is committed.
+         */
+        syncAcknowledgements: number;
+        /**
+         * Number of standbys registered with the primary for synchronous replication.
+         */
+        syncStandbyCount: number;
+        /**
+         * Whether the reported sync state was read from the engine. When false the state could not be confirmed and the other sync fields carry no reading.
+         */
+        syncStateConfirmed: boolean;
+        /**
+         * List of database replicas and their status. Every configured member appears, including one the backend has not brought up, which is reported as not healthy.
          */
         replicas: DatabaseStatusReplica[];
         /**
@@ -10103,9 +10301,9 @@ export declare namespace Models {
          */
         renewalPrice: number;
         /**
-         * Transfer status for domains being transferred in.
+         * Transfer status for domains being transferred in. Null when the domain is not being transferred.
          */
-        transferStatus: DomainTransferStatusEnum;
+        transferStatus?: DomainTransferStatusEnum;
         /**
          * Team ID.
          */
@@ -10432,17 +10630,17 @@ export declare namespace Models {
          */
         $id: string;
         /**
-         * Member role. Possible values: primary (accepts reads and writes), replica (read-only follower).
+         * Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology and this member has not been probed, so no member can be named the write target).
          */
         role: string;
         /**
-         * Member pod status. Possible values: provisioning (pod missing or Pending), starting (Running but not Ready), active (Running and Ready), failed (Failed phase or CrashLoopBackOff container), or the lowercased pod phase reported by the cluster.
+         * Member pod status. Possible values: pending (configured but absent from the backend topology, so nothing is bringing it up), provisioning (pod missing or Pending), starting (Running but not Ready), active (Running and Ready), failed (Failed phase or CrashLoopBackOff container), or the lowercased pod phase reported by the cluster.
          */
         status: string;
         /**
-         * Replication lag in seconds.
+         * Replication lag in seconds. Null when the lag is not known: a primary has none to report, and a member the backend has not probed has none yet.
          */
-        lagSeconds: number;
+        lagSeconds?: number;
     };
     /**
      * Operation
@@ -10515,14 +10713,55 @@ export declare namespace Models {
          */
         replicas: number;
         /**
-         * Replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm).
+         * Requested replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm). This is what was asked for; compare it with effectiveSyncMode for what the primary is enforcing.
          */
         syncMode: string;
+        /**
+         * Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read. A value below the requested syncMode means writes are being acknowledged with weaker durability than configured.
+         */
+        effectiveSyncMode?: string;
+        /**
+         * Whether the enforced replication is weaker than the requested syncMode.
+         */
+        syncDegraded: boolean;
+        /**
+         * Number of standby acknowledgements the primary waits for before a write is committed. Zero means writes are acknowledged locally.
+         */
+        syncAcknowledgements: number;
+        /**
+         * Number of standbys registered with the primary for synchronous replication.
+         */
+        syncStandbyCount: number;
+        /**
+         * Whether the reported sync state was read from the engine. When false the state could not be confirmed and the other sync fields carry no reading.
+         */
+        syncStateConfirmed: boolean;
         /**
          * Per-pod statuses for the primary and every replica.
          */
         members: DedicatedDatabaseMember[];
     };
+    /**
+     * Invalidation
+     */
+    export type ProxyInvalidation = {
+        /**
+         * Domain name.
+         */
+        domain: string;
+        /**
+         * Invalidation type. Possible values are "tag", "path", or "all".
+         */
+        type: string;
+        /**
+         * Invalidated reference. Depending on type this is a cache tag name, a URL path, or empty when type is all.
+         */
+        reference: string;
+        /**
+         * Invalidation status.
+         */
+        status: string;
+    };
     /**
      * Invoice
      */
@@ -10649,9 +10888,9 @@ export declare namespace Models {
          */
         prefs: Preferences;
         /**
-         * Project budget limit
+         * Project budget limit. Null when no budget is set.
          */
-        billingBudget: number;
+        billingBudget?: number;
         /**
          * Project budget limit
          */
@@ -10687,7 +10926,7 @@ export declare namespace Models {
         /**
          * Start date of trial.
          */
-        billingTrialStartDate: string;
+        billingTrialStartDate?: string;
         /**
          * Number of trial days.
          */
@@ -10707,11 +10946,11 @@ export declare namespace Models {
         /**
          * Default payment method.
          */
-        billingAddressId: string;
+        billingAddressId?: string;
         /**
          * Backup payment method.
          */
-        backupPaymentMethodId: string;
+        backupPaymentMethodId?: string;
         /**
          * Team status.
          */
@@ -10719,27 +10958,27 @@ export declare namespace Models {
         /**
          * Remarks on team status.
          */
-        remarks: string;
+        remarks?: string;
         /**
          * Organization agreements
          */
-        agreementBAA: string;
+        agreementBAA?: string;
         /**
          * Program manager's name.
          */
-        programManagerName: string;
+        programManagerName?: string;
         /**
          * Program manager's calendar link.
          */
-        programManagerCalendar: string;
+        programManagerCalendar?: string;
         /**
          * Program's discord channel name.
          */
-        programDiscordChannelName: string;
+        programDiscordChannelName?: string;
         /**
          * Program's discord channel URL.
          */
-        programDiscordChannelUrl: string;
+        programDiscordChannelUrl?: string;
         /**
          * Billing limits reached
          */
@@ -10747,11 +10986,11 @@ export declare namespace Models {
         /**
          * Billing plan selected for downgrade.
          */
-        billingPlanDowngrade: string;
+        billingPlanDowngrade?: string;
         /**
          * Tax Id
          */
-        billingTaxId: string;
+        billingTaxId?: string;
         /**
          * Marked for deletion
          */
@@ -11130,7 +11369,7 @@ export declare namespace Models {
          */
         mode: string;
         /**
-         * Maximum number of pooled connections.
+         * Client-connection ceiling the pooler accepts. Enforced on MySQL and MariaDB; on PostgreSQL the pooler has no client cap, so this reports the database's advertised networkMaxConnections and cannot be set here.
          */
         maxConnections: number;
         /**
@@ -11237,9 +11476,9 @@ export declare namespace Models {
          */
         name: string;
         /**
-         * Does the organization have access to this region.
+         * Does the organization have access to this region. Null when access has not been resolved.
          */
-        available: boolean;
+        available?: boolean;
         /**
          * Does the backend support this region.
          */
@@ -11441,7 +11680,7 @@ export declare namespace Models {
          */
         current: number;
         /**
-         * Maximum allowed connections.
+         * The engine's own max_connections. On a pooled database this is the backend limit the pooler multiplexes onto, not the ceiling a client pool may reach — that is networkMaxConnections on the database resource.
          */
         max: number;
     };
@@ -11450,11 +11689,11 @@ export declare namespace Models {
      */
     export type DatabaseStatusReplica = {
         /**
-         * StatefulSet pod index (0 = primary, 1+ = replicas).
+         * Member index within the database. Read `role` for which member accepts writes: a failover moves the primary without renumbering the indexes.
          */
         index: number;
         /**
-         * Replica role: primary or replica.
+         * Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology, so no member can be named the write target).
          */
         role: string;
         /**
@@ -11502,7 +11741,7 @@ export declare namespace Models {
         /**
          * Member additional resources
          */
-        member: AdditionalResource;
+        member?: AdditionalResource;
         /**
          * Realtime additional resources
          */
@@ -11514,7 +11753,7 @@ export declare namespace Models {
         /**
          * Realtime bandwidth additional resources
          */
-        realtimeBandwidth: AdditionalResource;
+        realtimeBandwidth?: AdditionalResource;
         /**
          * Storage additional resources
          */
@@ -11534,7 +11773,7 @@ export declare namespace Models {
         /**
          * Credits additional resources
          */
-        credits: AdditionalResource;
+        credits?: AdditionalResource;
     };
     /**
      * usageDataPoint
@@ -11653,7 +11892,7 @@ export declare namespace Models {
          */
         resourceType?: string;
         /**
-         * Replica ordinal when broken down by `ordinal`. 0 is the primary; 1+ are replicas.
+         * Node ordinal when broken down by `ordinal`. A stable per-node identity, not a role: ordinal 0 is the first member created, and a failover can leave the primary on any ordinal. Read the role from the database's replicas endpoint.
          */
         ordinal?: string;
     };
@@ -12745,6 +12984,14 @@ export declare namespace Models {
          * Challenge type enforced when the rule matches.
          */
         challengeType: string;
+        /**
+         * Challenge difficulty from 1 (easiest) to 5 (hardest) enforced when the rule matches.
+         */
+        difficulty: number;
+        /**
+         * Seconds a visitor stays cleared after passing the challenge before being challenged again.
+         */
+        ttl: number;
     };
     /**
      * WafRuleRateLimit
@@ -12814,6 +13061,10 @@ export declare namespace Models {
          * Interval in seconds for the rate limit window.
          */
         interval: number;
+        /**
+         * Rate limit key: `ip` limits per client IP, `userId` limits per authenticated user.
+         */
+        key: string;
     };
     /**
      * WafRuleRedirect