@appwrite.io/console 5.0.0 → 7.0.0-rc.1

package/src/index.ts

@@ -1,7 +1,7 @@
 /**
  * Appwrite Console SDK
  *
- * This SDK is compatible with Appwrite server version 1.8.x. 
+ * This SDK is compatible with Appwrite server version 1.9.x. 
  * For older versions, please check
  * [previous releases](https://github.com/appwrite/sdk-for-console/releases).
  */
@@ -13,6 +13,7 @@ export { Backups } from './services/backups';
 export { Assistant } from './services/assistant';
 export { Console } from './services/console';
 export { Databases } from './services/databases';
+export { DocumentsDB } from './services/documents-db';
 export { Domains } from './services/domains';
 export { Functions } from './services/functions';
 export { Graphql } from './services/graphql';
@@ -31,6 +32,8 @@ export { Teams } from './services/teams';
 export { Tokens } from './services/tokens';
 export { Users } from './services/users';
 export { Vcs } from './services/vcs';
+export { VectorsDB } from './services/vectors-db';
+export { Webhooks } from './services/webhooks';
 export { Realtime } from './services/realtime';
 export type { Models, Payload, RealtimeResponseEvent, UploadProgress } from './client';
 export type { RealtimeSubscription } from './services/realtime';
@@ -57,8 +60,9 @@ export { ConsoleResourceType } from './enums/console-resource-type';
 export { UsageRange } from './enums/usage-range';
 export { RelationshipType } from './enums/relationship-type';
 export { RelationMutate } from './enums/relation-mutate';
-export { IndexType } from './enums/index-type';
+export { DatabasesIndexType } from './enums/databases-index-type';
 export { OrderBy } from './enums/order-by';
+export { DocumentsDBIndexType } from './enums/documents-db-index-type';
 export { RegistrationType } from './enums/registration-type';
 export { FilterType } from './enums/filter-type';
 export { Runtime } from './enums/runtime';
@@ -96,9 +100,12 @@ export { Adapter } from './enums/adapter';
 export { Frameworks } from './enums/frameworks';
 export { Compression } from './enums/compression';
 export { ImageGravity } from './enums/image-gravity';
+export { TablesDBIndexType } from './enums/tables-db-index-type';
 export { PasswordHash } from './enums/password-hash';
 export { MessagingProviderType } from './enums/messaging-provider-type';
 export { VCSDetectionType } from './enums/vcs-detection-type';
+export { Model } from './enums/model';
+export { VectorsDBIndexType } from './enums/vectors-db-index-type';
 export { DatabaseType } from './enums/database-type';
 export { AttributeStatus } from './enums/attribute-status';
 export { ColumnStatus } from './enums/column-status';
@@ -112,5 +119,5 @@ export { ProxyRuleDeploymentResourceType } from './enums/proxy-rule-deployment-r
 export { ProxyRuleStatus } from './enums/proxy-rule-status';
 export { MessageStatus } from './enums/message-status';
 export { BillingPlanGroup } from './enums/billing-plan-group';
-export { DomainPurchasePaymentStatus } from './enums/domain-purchase-payment-status';
-export { DomainTransferStatusStatus } from './enums/domain-transfer-status-status';
+export { DomainTransferStatusEnum } from './enums/domain-transfer-status-enum';
+export { DomainPurchaseStatus } from './enums/domain-purchase-status';

package/src/models.ts

@@ -12,8 +12,8 @@ import { ProxyRuleDeploymentResourceType } from "./enums/proxy-rule-deployment-r
 import { ProxyRuleStatus } from "./enums/proxy-rule-status"
 import { MessageStatus } from "./enums/message-status"
 import { BillingPlanGroup } from "./enums/billing-plan-group"
-import { DomainPurchasePaymentStatus } from "./enums/domain-purchase-payment-status"
-import { DomainTransferStatusStatus } from "./enums/domain-transfer-status-status"
+import { DomainTransferStatusEnum } from "./enums/domain-transfer-status-enum"
+import { DomainPurchaseStatus } from "./enums/domain-purchase-status"
 
 /**
  * Appwrite Models
@@ -750,6 +750,34 @@ export namespace Models {
         contents: VcsContent[];
     }
 
+    /**
+     * VectorsDB Collections List
+     */
+    export type VectorsdbCollectionList = {
+        /**
+         * Total number of collections that matched your query.
+         */
+        total: number;
+        /**
+         * List of collections.
+         */
+        collections: VectorsdbCollection[];
+    }
+
+    /**
+     * Embedding list
+     */
+    export type EmbeddingList = {
+        /**
+         * Total number of embeddings that matched your query.
+         */
+        total: number;
+        /**
+         * List of embeddings.
+         */
+        embeddings: Embedding[];
+    }
+
     /**
      * Database
      */
@@ -788,6 +816,28 @@ export namespace Models {
         archives: Collection[];
     }
 
+    /**
+     * Embedding
+     */
+    export type Embedding = {
+        /**
+         * Embedding model used to generate embeddings.
+         */
+        model: string;
+        /**
+         * Number of dimensions for each embedding vector.
+         */
+        dimension: number;
+        /**
+         * Embedding vector values. If an error occurs, this will be an empty array.
+         */
+        embedding: number[];
+        /**
+         * Error message if embedding generation fails. Empty string if no error.
+         */
+        error: string;
+    }
+
     /**
      * Collection
      */
@@ -1658,6 +1708,302 @@ export namespace Models {
         encrypt?: boolean;
     }
 
+    /**
+     * UsageDocumentsDB
+     */
+    export type UsageDocumentsDB = {
+        /**
+         * Time range of the usage stats.
+         */
+        range: string;
+        /**
+         * Total aggregated number of collections.
+         */
+        collectionsTotal: number;
+        /**
+         * Total aggregated number of documents.
+         */
+        documentsTotal: number;
+        /**
+         * Total aggregated storage used in bytes.
+         */
+        storageTotal: number;
+        /**
+         * Total number of database reads.
+         */
+        databaseReadsTotal: number;
+        /**
+         * Total number of database writes.
+         */
+        databaseWritesTotal: number;
+        /**
+         * Aggregated number of collections per period.
+         */
+        collections: Metric[];
+        /**
+         * Aggregated number of documents per period.
+         */
+        documents: Metric[];
+        /**
+         * Aggregated storage used in bytes per period.
+         */
+        storage: Metric[];
+        /**
+         * An array of aggregated number of database reads.
+         */
+        databaseReads: Metric[];
+        /**
+         * An array of aggregated number of database writes.
+         */
+        databaseWrites: Metric[];
+    }
+
+    /**
+     * VectorsDB Collection
+     */
+    export type VectorsdbCollection = {
+        /**
+         * Collection ID.
+         */
+        $id: string;
+        /**
+         * Collection creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Collection update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+         */
+        $permissions: string[];
+        /**
+         * Database ID.
+         */
+        databaseId: string;
+        /**
+         * Collection name.
+         */
+        name: string;
+        /**
+         * Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.
+         */
+        enabled: boolean;
+        /**
+         * Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
+         */
+        documentSecurity: boolean;
+        /**
+         * Collection attributes.
+         */
+        attributes: (Models.AttributeObject | Models.AttributeVector)[];
+        /**
+         * Collection indexes.
+         */
+        indexes: Index[];
+        /**
+         * Maximum document size in bytes. Returns 0 when no limit applies.
+         */
+        bytesMax: number;
+        /**
+         * Currently used document size in bytes based on defined attributes.
+         */
+        bytesUsed: number;
+        /**
+         * Embedding dimension.
+         */
+        dimension: number;
+    }
+
+    /**
+     * AttributeObject
+     */
+    export type AttributeObject = {
+        /**
+         * Attribute Key.
+         */
+        key: string;
+        /**
+         * Attribute type.
+         */
+        type: string;
+        /**
+         * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+         */
+        status: AttributeStatus;
+        /**
+         * Error message. Displays error generated on failure of creating or deleting an attribute.
+         */
+        error: string;
+        /**
+         * Is attribute required?
+         */
+        required: boolean;
+        /**
+         * Is attribute an array?
+         */
+        array?: boolean;
+        /**
+         * Attribute creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Attribute update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+    }
+
+    /**
+     * AttributeVector
+     */
+    export type AttributeVector = {
+        /**
+         * Attribute Key.
+         */
+        key: string;
+        /**
+         * Attribute type.
+         */
+        type: string;
+        /**
+         * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+         */
+        status: AttributeStatus;
+        /**
+         * Error message. Displays error generated on failure of creating or deleting an attribute.
+         */
+        error: string;
+        /**
+         * Is attribute required?
+         */
+        required: boolean;
+        /**
+         * Is attribute an array?
+         */
+        array?: boolean;
+        /**
+         * Attribute creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Attribute update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Vector dimensions.
+         */
+        size: number;
+    }
+
+    /**
+     * UsageVectorsDBs
+     */
+    export type UsageVectorsDBs = {
+        /**
+         * Time range of the usage stats.
+         */
+        range: string;
+        /**
+         * Total aggregated number of VectorsDB databases.
+         */
+        databasesTotal: number;
+        /**
+         * Total aggregated number of collections.
+         */
+        collectionsTotal: number;
+        /**
+         * Total aggregated number of documents.
+         */
+        documentsTotal: number;
+        /**
+         * Total aggregated storage in bytes.
+         */
+        storageTotal: number;
+        /**
+         * Total number of database reads.
+         */
+        databasesReadsTotal: number;
+        /**
+         * Total number of database writes.
+         */
+        databasesWritesTotal: number;
+        /**
+         * Aggregated number of databases per period.
+         */
+        databases: Metric[];
+        /**
+         * Aggregated number of collections per period.
+         */
+        collections: Metric[];
+        /**
+         * Aggregated number of documents per period.
+         */
+        documents: Metric[];
+        /**
+         * Aggregated storage in bytes per period.
+         */
+        storage: Metric[];
+        /**
+         * An array of aggregated number of database reads.
+         */
+        databasesReads: Metric[];
+        /**
+         * An array of aggregated number of database writes.
+         */
+        databasesWrites: Metric[];
+    }
+
+    /**
+     * UsageVectorsDB
+     */
+    export type UsageVectorsDB = {
+        /**
+         * Time range of the usage stats.
+         */
+        range: string;
+        /**
+         * Total aggregated number of collections.
+         */
+        collectionsTotal: number;
+        /**
+         * Total aggregated number of documents.
+         */
+        documentsTotal: number;
+        /**
+         * Total aggregated storage used in bytes.
+         */
+        storageTotal: number;
+        /**
+         * Total number of database reads.
+         */
+        databaseReadsTotal: number;
+        /**
+         * Total number of database writes.
+         */
+        databaseWritesTotal: number;
+        /**
+         * Aggregated number of collections per period.
+         */
+        collections: Metric[];
+        /**
+         * Aggregated number of documents per period.
+         */
+        documents: Metric[];
+        /**
+         * Aggregated storage used in bytes per period.
+         */
+        storage: Metric[];
+        /**
+         * An array of aggregated number of database reads.
+         */
+        databaseReads: Metric[];
+        /**
+         * An array of aggregated number of database writes.
+         */
+        databaseWrites: Metric[];
+    }
+
     /**
      * Table
      */
@@ -2631,7 +2977,7 @@ export namespace Models {
         /**
          * Row sequence ID.
          */
-        $sequence: number;
+        $sequence: string;
         /**
          * Table ID.
          */
@@ -2670,7 +3016,7 @@ export namespace Models {
         /**
          * Document sequence ID.
          */
-        $sequence: number;
+        $sequence: string;
         /**
          * Collection ID.
          */
@@ -6034,9 +6380,13 @@ export namespace Models {
          */
         executionsTotal: number;
         /**
-         * Total aggregated  number of documents.
+         * Total aggregated  number of documents in legacy/tablesdb.
          */
         documentsTotal: number;
+        /**
+         * Total aggregated  number of documents in documentsdb.
+         */
+        documentsdbDocumentsTotal: number;
         /**
          * Total aggregated  number of rows.
          */
@@ -6045,10 +6395,18 @@ export namespace Models {
          * Total aggregated number of databases.
          */
         databasesTotal: number;
+        /**
+         * Total aggregated number of documentsdb.
+         */
+        documentsdbTotal: number;
         /**
          * Total aggregated sum of databases storage size (in bytes).
          */
         databasesStorageTotal: number;
+        /**
+         * Total aggregated sum of documentsdb databases storage size (in bytes).
+         */
+        documentsdbDatabasesStorageTotal: number;
         /**
          * Total aggregated number of users.
          */
@@ -6089,6 +6447,14 @@ export namespace Models {
          * Aggregated stats for total databases writes.
          */
         databasesWritesTotal: number;
+        /**
+         * Total number of documentsdb databases reads.
+         */
+        documentsdbDatabasesReadsTotal: number;
+        /**
+         * Total number of documentsdb databases writes.
+         */
+        documentsdbDatabasesWritesTotal: number;
         /**
          * Aggregated  number of requests per period.
          */
@@ -6149,6 +6515,18 @@ export namespace Models {
          * Aggregated stats for database writes.
          */
         databasesWrites: Metric[];
+        /**
+         * An array of aggregated number of documentsdb database reads.
+         */
+        documentsdbDatabasesReads: Metric[];
+        /**
+         * An array of aggregated number of documentsdb database writes.
+         */
+        documentsdbDatabasesWrites: Metric[];
+        /**
+         * An array of aggregated sum of documentsdb databases storage size (in bytes) per period.
+         */
+        documentsdbDatabasesStorage: Metric[];
         /**
          * An array of aggregated number of image transformations.
          */
@@ -6157,6 +6535,86 @@ export namespace Models {
          * Total aggregated number of image transformations.
          */
         imageTransformationsTotal: number;
+        /**
+         * Total aggregated number of VectorsDB databases.
+         */
+        vectorsdbDatabasesTotal: number;
+        /**
+         * Total aggregated number of VectorsDB collections.
+         */
+        vectorsdbCollectionsTotal: number;
+        /**
+         * Total aggregated number of VectorsDB documents.
+         */
+        vectorsdbDocumentsTotal: number;
+        /**
+         * Total aggregated VectorsDB storage (bytes).
+         */
+        vectorsdbDatabasesStorageTotal: number;
+        /**
+         * Total aggregated number of VectorsDB reads.
+         */
+        vectorsdbDatabasesReadsTotal: number;
+        /**
+         * Total aggregated number of VectorsDB writes.
+         */
+        vectorsdbDatabasesWritesTotal: number;
+        /**
+         * Aggregated VectorsDB databases per period.
+         */
+        vectorsdbDatabases: Metric[];
+        /**
+         * Aggregated VectorsDB collections per period.
+         */
+        vectorsdbCollections: Metric[];
+        /**
+         * Aggregated VectorsDB documents per period.
+         */
+        vectorsdbDocuments: Metric[];
+        /**
+         * Aggregated VectorsDB storage per period.
+         */
+        vectorsdbDatabasesStorage: Metric[];
+        /**
+         * Aggregated VectorsDB reads per period.
+         */
+        vectorsdbDatabasesReads: Metric[];
+        /**
+         * Aggregated VectorsDB writes per period.
+         */
+        vectorsdbDatabasesWrites: Metric[];
+        /**
+         * Aggregated number of text embedding calls per period.
+         */
+        embeddingsText: Metric;
+        /**
+         * Aggregated number of tokens processed by text embeddings per period.
+         */
+        embeddingsTextTokens: Metric;
+        /**
+         * Aggregated duration spent generating text embeddings per period.
+         */
+        embeddingsTextDuration: Metric;
+        /**
+         * Aggregated number of errors while generating text embeddings per period.
+         */
+        embeddingsTextErrors: Metric;
+        /**
+         * Total aggregated number of text embedding calls.
+         */
+        embeddingsTextTotal: Metric;
+        /**
+         * Total aggregated number of tokens processed by text.
+         */
+        embeddingsTextTokensTotal: Metric;
+        /**
+         * Total aggregated duration spent generating text embeddings.
+         */
+        embeddingsTextDurationTotal: Metric;
+        /**
+         * Total aggregated number of errors while generating text embeddings.
+         */
+        embeddingsTextErrorsTotal: Metric;
         /**
          * Aggregated number of function executions per period.
          */
@@ -7206,9 +7664,17 @@ export namespace Models {
          */
         usageBandwidth: number;
         /**
-         * Total realtime usage for the billing period
+         * Peak concurrent realtime connections for the billing period
          */
         usageRealtime: number;
+        /**
+         * Total realtime messages sent for the billing period
+         */
+        usageRealtimeMessages: number;
+        /**
+         * Total realtime bandwidth usage for the billing period
+         */
+        usageRealtimeBandwidth: number;
         /**
          * Additional members
          */
@@ -8725,14 +9191,6 @@ export namespace Models {
          * Domain registrar (e.g. "appwrite" or "third_party").
          */
         registrar: string;
-        /**
-         * Payment status for domain purchase.
-         */
-        paymentStatus: DomainPurchasePaymentStatus;
-        /**
-         * Client secret for payment confirmation. Present only when paymentStatus is pending_confirmation.
-         */
-        clientSecret: string;
         /**
          * Nameservers setting. "Appwrite" or empty string.
          */
@@ -8753,6 +9211,10 @@ export namespace Models {
          * Renewal price (in cents).
          */
         renewalPrice: number;
+        /**
+         * Transfer status for domains being transferred in.
+         */
+        transferStatus: DomainTransferStatusEnum;
         /**
          * Team ID.
          */
@@ -8761,14 +9223,52 @@ export namespace Models {
          * Dns records
          */
         dnsRecords: DnsRecord[];
+    }
+
+    /**
+     * DomainPurchase
+     */
+    export type DomainPurchase = {
         /**
-         * Domain transfer status (e.g., "pending", "completed", "failed").
+         * Purchase/invoice ID.
          */
-        transferStatus: string;
+        $id: string;
         /**
-         * Retry attempts for the current domain payment flow. Development only.
+         * Purchase creation time in ISO 8601 format.
          */
-        attempts: number;
+        $createdAt: string;
+        /**
+         * Purchase update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Domain document ID.
+         */
+        domainId: string;
+        /**
+         * Domain name.
+         */
+        domain: string;
+        /**
+         * Team ID that owns the domain.
+         */
+        organizationId: string;
+        /**
+         * Domain purchase status.
+         */
+        status: DomainPurchaseStatus;
+        /**
+         * Stripe client secret for 3DS; empty when not applicable.
+         */
+        clientSecret: string;
+        /**
+         * Purchase amount.
+         */
+        amount: number;
+        /**
+         * Currency code.
+         */
+        currency: string;
     }
 
     /**
@@ -9070,7 +9570,7 @@ export namespace Models {
         /**
          * Transfer status.
          */
-        status: DomainTransferStatusStatus;
+        status: DomainTransferStatusEnum;
         /**
          * Additional transfer status information.
          */