@appwrite.io/console 15.8.0 → 16.0.0

package/types/index.d.ts

@@ -8,6 +8,7 @@
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Activities } from './services/activities';
+export { Affiliates } from './services/affiliates';
 export { Apps } from './services/apps';
 export { Avatars } from './services/avatars';
 export { Backups } from './services/backups';
@@ -16,6 +17,7 @@ export { Console } from './services/console';
 export { Databases } from './services/databases';
 export { DocumentsDB } from './services/documents-db';
 export { Domains } from './services/domains';
+export { Embeddings } from './services/embeddings';
 export { Functions } from './services/functions';
 export { Graphql } from './services/graphql';
 export { Locale } from './services/locale';
@@ -78,6 +80,7 @@ export { OrderBy } from './enums/order-by';
 export { DocumentsDBIndexType } from './enums/documents-db-index-type';
 export { DomainRegistrationType } from './enums/domain-registration-type';
 export { DomainSuggestionType } from './enums/domain-suggestion-type';
+export { EmbeddingModel } from './enums/embedding-model';
 export { Runtime } from './enums/runtime';
 export { ProjectKeyScopes } from './enums/project-key-scopes';
 export { FunctionTemplateUseCase } from './enums/function-template-use-case';
@@ -111,6 +114,7 @@ export { ProjectSMTPSecure } from './enums/project-smtp-secure';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { ScheduleResourceType } from './enums/schedule-resource-type';
 export { Status } from './enums/status';
+export { InvalidationType } from './enums/invalidation-type';
 export { StatusCode } from './enums/status-code';
 export { ProxyResourceType } from './enums/proxy-resource-type';
 export { Framework } from './enums/framework';
@@ -120,10 +124,14 @@ export { SiteTemplateUseCase } from './enums/site-template-use-case';
 export { Compression } from './enums/compression';
 export { ImageGravity } from './enums/image-gravity';
 export { TablesDBIndexType } from './enums/tables-db-index-type';
+export { UsageInterval } from './enums/usage-interval';
+export { UsageEventDimension } from './enums/usage-event-dimension';
+export { UsageOrderBy } from './enums/usage-order-by';
+export { UsageOrderDirection } from './enums/usage-order-direction';
+export { UsageGaugeDimension } from './enums/usage-gauge-dimension';
 export { PasswordHash } from './enums/password-hash';
 export { MessagingProviderType } from './enums/messaging-provider-type';
 export { VCSDetectionType } from './enums/vcs-detection-type';
-export { EmbeddingModel } from './enums/embedding-model';
 export { VectorsDBIndexType } from './enums/vectors-db-index-type';
 export { DatabaseType } from './enums/database-type';
 export { DatabaseStatus } from './enums/database-status';

package/types/models.d.ts

@@ -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
      */
@@ -8943,7 +9101,7 @@ export declare namespace Models {
         /**
          * Members
          */
-        members: number;
+        members?: number;
         /**
          * Webhooks
          */
@@ -9039,7 +9197,7 @@ export declare namespace Models {
         /**
          * Activity log days
          */
-        activityLogs: number;
+        activityLogs?: number;
         /**
          * Usage history days
          */
@@ -9135,7 +9293,7 @@ export declare namespace Models {
         /**
          * Does plan support backup policies.
          */
-        backupsEnabled: boolean;
+        backupsEnabled?: boolean;
         /**
          * Whether usage addons are calculated per project.
          */
@@ -9147,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
          */
@@ -9184,11 +9342,11 @@ export declare namespace Models {
         /**
          * Addon seats
          */
-        seats: BillingPlanAddonDetails;
+        seats?: BillingPlanAddonDetails;
         /**
          * Addon projects
          */
-        projects: BillingPlanAddonDetails;
+        projects?: BillingPlanAddonDetails;
     };
     /**
      * Details
@@ -9213,7 +9371,7 @@ export declare namespace Models {
         /**
          * Price currency
          */
-        currency: string;
+        currency?: string;
         /**
          * Price
          */
@@ -9721,7 +9879,7 @@ export declare namespace Models {
          */
         api: string;
         /**
-         * Database engine: postgresql, mysql, or mongodb.
+         * Database engine: postgresql, mysql, or mongodb. Null until the backing reports one.
          */
         engine: string;
         /**
@@ -10143,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.
          */
@@ -10480,9 +10638,9 @@ export declare namespace Models {
          */
         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
@@ -10583,6 +10741,27 @@ export declare namespace Models {
          */
         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
      */
@@ -10709,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
          */
@@ -10747,7 +10926,7 @@ export declare namespace Models {
         /**
          * Start date of trial.
          */
-        billingTrialStartDate: string;
+        billingTrialStartDate?: string;
         /**
          * Number of trial days.
          */
@@ -10767,11 +10946,11 @@ export declare namespace Models {
         /**
          * Default payment method.
          */
-        billingAddressId: string;
+        billingAddressId?: string;
         /**
          * Backup payment method.
          */
-        backupPaymentMethodId: string;
+        backupPaymentMethodId?: string;
         /**
          * Team status.
          */
@@ -10779,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
          */
@@ -10807,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
          */
@@ -11297,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.
          */
@@ -11562,7 +11741,7 @@ export declare namespace Models {
         /**
          * Member additional resources
          */
-        member: AdditionalResource;
+        member?: AdditionalResource;
         /**
          * Realtime additional resources
          */
@@ -11574,7 +11753,7 @@ export declare namespace Models {
         /**
          * Realtime bandwidth additional resources
          */
-        realtimeBandwidth: AdditionalResource;
+        realtimeBandwidth?: AdditionalResource;
         /**
          * Storage additional resources
          */
@@ -11594,7 +11773,7 @@ export declare namespace Models {
         /**
          * Credits additional resources
          */
-        credits: AdditionalResource;
+        credits?: AdditionalResource;
     };
     /**
      * usageDataPoint
@@ -11713,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;
     };

package/types/services/account.d.ts

@@ -1283,7 +1283,7 @@ export declare class Account {
     /**
      * Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.
      *
-     * @param {string} params.sessionId - Session ID. Use the string 'current' to get the current device session.
+     * @param {string} params.sessionId - Session ID. Use the string 'current' to get the current device session. Defaults to 'current'.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Session>}
      */
@@ -1293,7 +1293,7 @@ export declare class Account {
     /**
      * Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.
      *
-     * @param {string} sessionId - Session ID. Use the string 'current' to get the current device session.
+     * @param {string} sessionId - Session ID. Use the string 'current' to get the current device session. Defaults to 'current'.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Session>}
      * @deprecated Use the object parameter style method for a better developer experience.
@@ -1302,7 +1302,7 @@ export declare class Account {
     /**
      * Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.
      *
-     * @param {string} params.sessionId - Session ID. Use the string 'current' to update the current device session.
+     * @param {string} params.sessionId - Session ID. Use the string 'current' to update the current device session. Defaults to 'current'.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Session>}
      */
@@ -1312,7 +1312,7 @@ export declare class Account {
     /**
      * Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.
      *
-     * @param {string} sessionId - Session ID. Use the string 'current' to update the current device session.
+     * @param {string} sessionId - Session ID. Use the string 'current' to update the current device session. Defaults to 'current'.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Session>}
      * @deprecated Use the object parameter style method for a better developer experience.
@@ -1321,7 +1321,7 @@ export declare class Account {
     /**
      * Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) instead.
      *
-     * @param {string} params.sessionId - Session ID. Use the string 'current' to delete the current device session.
+     * @param {string} params.sessionId - Session ID. Use the string 'current' to delete the current device session. Defaults to 'current'.
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
@@ -1331,7 +1331,7 @@ export declare class Account {
     /**
      * Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) instead.
      *
-     * @param {string} sessionId - Session ID. Use the string 'current' to delete the current device session.
+     * @param {string} sessionId - Session ID. Use the string 'current' to delete the current device session. Defaults to 'current'.
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.