node-appwrite 17.0.0 → 17.2.0

package/dist/models.d.ts

@@ -2,10 +2,11 @@
  * Appwrite Models
  */
 declare namespace Models {
+    const __default: unique symbol;
     /**
      * Documents List
      */
-    type DocumentList<Document extends Models.Document> = {
+    export type DocumentList<Document extends Models.Document = Models.DefaultDocument> = {
         /**
          * Total number of documents documents that matched your query.
          */
@@ -18,7 +19,7 @@ declare namespace Models {
     /**
      * Collections List
      */
-    type CollectionList = {
+    export type CollectionList = {
         /**
          * Total number of collections documents that matched your query.
          */
@@ -31,7 +32,7 @@ declare namespace Models {
     /**
      * Databases List
      */
-    type DatabaseList = {
+    export type DatabaseList = {
         /**
          * Total number of databases documents that matched your query.
          */
@@ -44,7 +45,7 @@ declare namespace Models {
     /**
      * Indexes List
      */
-    type IndexList = {
+    export type IndexList = {
         /**
          * Total number of indexes documents that matched your query.
          */
@@ -57,7 +58,7 @@ declare namespace Models {
     /**
      * Users List
      */
-    type UserList<Preferences extends Models.Preferences> = {
+    export type UserList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
         /**
          * Total number of users documents that matched your query.
          */
@@ -70,7 +71,7 @@ declare namespace Models {
     /**
      * Sessions List
      */
-    type SessionList = {
+    export type SessionList = {
         /**
          * Total number of sessions documents that matched your query.
          */
@@ -83,7 +84,7 @@ declare namespace Models {
     /**
      * Identities List
      */
-    type IdentityList = {
+    export type IdentityList = {
         /**
          * Total number of identities documents that matched your query.
          */
@@ -96,7 +97,7 @@ declare namespace Models {
     /**
      * Logs List
      */
-    type LogList = {
+    export type LogList = {
         /**
          * Total number of logs documents that matched your query.
          */
@@ -109,7 +110,7 @@ declare namespace Models {
     /**
      * Files List
      */
-    type FileList = {
+    export type FileList = {
         /**
          * Total number of files documents that matched your query.
          */
@@ -122,7 +123,7 @@ declare namespace Models {
     /**
      * Buckets List
      */
-    type BucketList = {
+    export type BucketList = {
         /**
          * Total number of buckets documents that matched your query.
          */
@@ -135,7 +136,7 @@ declare namespace Models {
     /**
      * Resource Tokens List
      */
-    type ResourceTokenList = {
+    export type ResourceTokenList = {
         /**
          * Total number of tokens documents that matched your query.
          */
@@ -148,7 +149,7 @@ declare namespace Models {
     /**
      * Teams List
      */
-    type TeamList<Preferences extends Models.Preferences> = {
+    export type TeamList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
         /**
          * Total number of teams documents that matched your query.
          */
@@ -161,7 +162,7 @@ declare namespace Models {
     /**
      * Memberships List
      */
-    type MembershipList = {
+    export type MembershipList = {
         /**
          * Total number of memberships documents that matched your query.
          */
@@ -174,7 +175,7 @@ declare namespace Models {
     /**
      * Sites List
      */
-    type SiteList = {
+    export type SiteList = {
         /**
          * Total number of sites documents that matched your query.
          */
@@ -187,7 +188,7 @@ declare namespace Models {
     /**
      * Functions List
      */
-    type FunctionList = {
+    export type FunctionList = {
         /**
          * Total number of functions documents that matched your query.
          */
@@ -200,7 +201,7 @@ declare namespace Models {
     /**
      * Frameworks List
      */
-    type FrameworkList = {
+    export type FrameworkList = {
         /**
          * Total number of frameworks documents that matched your query.
          */
@@ -213,7 +214,7 @@ declare namespace Models {
     /**
      * Runtimes List
      */
-    type RuntimeList = {
+    export type RuntimeList = {
         /**
          * Total number of runtimes documents that matched your query.
          */
@@ -226,7 +227,7 @@ declare namespace Models {
     /**
      * Deployments List
      */
-    type DeploymentList = {
+    export type DeploymentList = {
         /**
          * Total number of deployments documents that matched your query.
          */
@@ -239,7 +240,7 @@ declare namespace Models {
     /**
      * Executions List
      */
-    type ExecutionList = {
+    export type ExecutionList = {
         /**
          * Total number of executions documents that matched your query.
          */
@@ -252,7 +253,7 @@ declare namespace Models {
     /**
      * Countries List
      */
-    type CountryList = {
+    export type CountryList = {
         /**
          * Total number of countries documents that matched your query.
          */
@@ -265,7 +266,7 @@ declare namespace Models {
     /**
      * Continents List
      */
-    type ContinentList = {
+    export type ContinentList = {
         /**
          * Total number of continents documents that matched your query.
          */
@@ -278,7 +279,7 @@ declare namespace Models {
     /**
      * Languages List
      */
-    type LanguageList = {
+    export type LanguageList = {
         /**
          * Total number of languages documents that matched your query.
          */
@@ -291,7 +292,7 @@ declare namespace Models {
     /**
      * Currencies List
      */
-    type CurrencyList = {
+    export type CurrencyList = {
         /**
          * Total number of currencies documents that matched your query.
          */
@@ -304,7 +305,7 @@ declare namespace Models {
     /**
      * Phones List
      */
-    type PhoneList = {
+    export type PhoneList = {
         /**
          * Total number of phones documents that matched your query.
          */
@@ -317,7 +318,7 @@ declare namespace Models {
     /**
      * Variables List
      */
-    type VariableList = {
+    export type VariableList = {
         /**
          * Total number of variables documents that matched your query.
          */
@@ -330,7 +331,7 @@ declare namespace Models {
     /**
      * Locale codes list
      */
-    type LocaleCodeList = {
+    export type LocaleCodeList = {
         /**
          * Total number of localeCodes documents that matched your query.
          */
@@ -343,7 +344,7 @@ declare namespace Models {
     /**
      * Provider list
      */
-    type ProviderList = {
+    export type ProviderList = {
         /**
          * Total number of providers documents that matched your query.
          */
@@ -356,7 +357,7 @@ declare namespace Models {
     /**
      * Message list
      */
-    type MessageList = {
+    export type MessageList = {
         /**
          * Total number of messages documents that matched your query.
          */
@@ -369,7 +370,7 @@ declare namespace Models {
     /**
      * Topic list
      */
-    type TopicList = {
+    export type TopicList = {
         /**
          * Total number of topics documents that matched your query.
          */
@@ -382,7 +383,7 @@ declare namespace Models {
     /**
      * Subscriber list
      */
-    type SubscriberList = {
+    export type SubscriberList = {
         /**
          * Total number of subscribers documents that matched your query.
          */
@@ -395,7 +396,7 @@ declare namespace Models {
     /**
      * Target list
      */
-    type TargetList = {
+    export type TargetList = {
         /**
          * Total number of targets documents that matched your query.
          */
@@ -408,7 +409,7 @@ declare namespace Models {
     /**
      * Specifications List
      */
-    type SpecificationList = {
+    export type SpecificationList = {
         /**
          * Total number of specifications documents that matched your query.
          */
@@ -421,7 +422,7 @@ declare namespace Models {
     /**
      * Database
      */
-    type Database = {
+    export type Database = {
         /**
          * Database ID.
          */
@@ -446,7 +447,7 @@ declare namespace Models {
     /**
      * Collection
      */
-    type Collection = {
+    export type Collection = {
         /**
          * Collection ID.
          */
@@ -491,7 +492,7 @@ declare namespace Models {
     /**
      * Attributes List
      */
-    type AttributeList = {
+    export type AttributeList = {
         /**
          * Total number of attributes in the given collection.
          */
@@ -504,7 +505,7 @@ declare namespace Models {
     /**
      * AttributeString
      */
-    type AttributeString = {
+    export type AttributeString = {
         /**
          * Attribute Key.
          */
@@ -545,11 +546,15 @@ declare namespace Models {
          * Default value for attribute when not provided. Cannot be set when attribute is required.
          */
         default?: string;
+        /**
+         * Defines whether this attribute is encrypted or not.
+         */
+        encrypt?: boolean;
     };
     /**
      * AttributeInteger
      */
-    type AttributeInteger = {
+    export type AttributeInteger = {
         /**
          * Attribute Key.
          */
@@ -598,7 +603,7 @@ declare namespace Models {
     /**
      * AttributeFloat
      */
-    type AttributeFloat = {
+    export type AttributeFloat = {
         /**
          * Attribute Key.
          */
@@ -647,7 +652,7 @@ declare namespace Models {
     /**
      * AttributeBoolean
      */
-    type AttributeBoolean = {
+    export type AttributeBoolean = {
         /**
          * Attribute Key.
          */
@@ -688,7 +693,7 @@ declare namespace Models {
     /**
      * AttributeEmail
      */
-    type AttributeEmail = {
+    export type AttributeEmail = {
         /**
          * Attribute Key.
          */
@@ -733,7 +738,7 @@ declare namespace Models {
     /**
      * AttributeEnum
      */
-    type AttributeEnum = {
+    export type AttributeEnum = {
         /**
          * Attribute Key.
          */
@@ -782,7 +787,7 @@ declare namespace Models {
     /**
      * AttributeIP
      */
-    type AttributeIp = {
+    export type AttributeIp = {
         /**
          * Attribute Key.
          */
@@ -827,7 +832,7 @@ declare namespace Models {
     /**
      * AttributeURL
      */
-    type AttributeUrl = {
+    export type AttributeUrl = {
         /**
          * Attribute Key.
          */
@@ -872,7 +877,7 @@ declare namespace Models {
     /**
      * AttributeDatetime
      */
-    type AttributeDatetime = {
+    export type AttributeDatetime = {
         /**
          * Attribute Key.
          */
@@ -917,7 +922,7 @@ declare namespace Models {
     /**
      * AttributeRelationship
      */
-    type AttributeRelationship = {
+    export type AttributeRelationship = {
         /**
          * Attribute Key.
          */
@@ -978,7 +983,7 @@ declare namespace Models {
     /**
      * Index
      */
-    type Index = {
+    export type Index = {
         /**
          * Index Key.
          */
@@ -1019,11 +1024,15 @@ declare namespace Models {
     /**
      * Document
      */
-    type Document = {
+    export type Document = {
         /**
          * Document ID.
          */
         $id: string;
+        /**
+         * Document automatically incrementing ID.
+         */
+        $sequence: number;
         /**
          * Collection ID.
          */
@@ -1044,12 +1053,20 @@ declare namespace Models {
          * Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
          */
         $permissions: string[];
+    };
+    export type DefaultDocument = Document & {
         [key: string]: any;
+        [__default]: true;
+    };
+    export type DataWithoutDocumentKeys = {
+        [K in string]: any;
+    } & {
+        [K in keyof Document]?: never;
     };
     /**
      * Log
      */
-    type Log = {
+    export type Log = {
         /**
          * Event name.
          */
@@ -1138,7 +1155,7 @@ declare namespace Models {
     /**
      * User
      */
-    type User<Preferences extends Models.Preferences> = {
+    export type User<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
         /**
          * User ID.
          */
@@ -1219,7 +1236,7 @@ declare namespace Models {
     /**
      * AlgoMD5
      */
-    type AlgoMd5 = {
+    export type AlgoMd5 = {
         /**
          * Algo type.
          */
@@ -1228,7 +1245,7 @@ declare namespace Models {
     /**
      * AlgoSHA
      */
-    type AlgoSha = {
+    export type AlgoSha = {
         /**
          * Algo type.
          */
@@ -1237,7 +1254,7 @@ declare namespace Models {
     /**
      * AlgoPHPass
      */
-    type AlgoPhpass = {
+    export type AlgoPhpass = {
         /**
          * Algo type.
          */
@@ -1246,7 +1263,7 @@ declare namespace Models {
     /**
      * AlgoBcrypt
      */
-    type AlgoBcrypt = {
+    export type AlgoBcrypt = {
         /**
          * Algo type.
          */
@@ -1255,7 +1272,7 @@ declare namespace Models {
     /**
      * AlgoScrypt
      */
-    type AlgoScrypt = {
+    export type AlgoScrypt = {
         /**
          * Algo type.
          */
@@ -1280,7 +1297,7 @@ declare namespace Models {
     /**
      * AlgoScryptModified
      */
-    type AlgoScryptModified = {
+    export type AlgoScryptModified = {
         /**
          * Algo type.
          */
@@ -1301,7 +1318,7 @@ declare namespace Models {
     /**
      * AlgoArgon2
      */
-    type AlgoArgon2 = {
+    export type AlgoArgon2 = {
         /**
          * Algo type.
          */
@@ -1322,13 +1339,20 @@ declare namespace Models {
     /**
      * Preferences
      */
-    type Preferences = {
+    export type Preferences = {};
+    export type DefaultPreferences = Preferences & {
         [key: string]: any;
+        [__default]: true;
+    };
+    export type DataWithoutPreferencesKeys = {
+        [K in string]: any;
+    } & {
+        [K in keyof Preferences]?: never;
     };
     /**
      * Session
      */
-    type Session = {
+    export type Session = {
         /**
          * Session ID.
          */
@@ -1449,7 +1473,7 @@ declare namespace Models {
     /**
      * Identity
      */
-    type Identity = {
+    export type Identity = {
         /**
          * Identity ID.
          */
@@ -1494,7 +1518,7 @@ declare namespace Models {
     /**
      * Token
      */
-    type Token = {
+    export type Token = {
         /**
          * Token ID.
          */
@@ -1523,7 +1547,7 @@ declare namespace Models {
     /**
      * JWT
      */
-    type Jwt = {
+    export type Jwt = {
         /**
          * JWT encoded string.
          */
@@ -1532,7 +1556,7 @@ declare namespace Models {
     /**
      * Locale
      */
-    type Locale = {
+    export type Locale = {
         /**
          * User IP address.
          */
@@ -1565,7 +1589,7 @@ declare namespace Models {
     /**
      * LocaleCode
      */
-    type LocaleCode = {
+    export type LocaleCode = {
         /**
          * Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
          */
@@ -1578,7 +1602,7 @@ declare namespace Models {
     /**
      * File
      */
-    type File = {
+    export type File = {
         /**
          * File ID.
          */
@@ -1627,7 +1651,7 @@ declare namespace Models {
     /**
      * Bucket
      */
-    type Bucket = {
+    export type Bucket = {
         /**
          * Bucket ID.
          */
@@ -1680,7 +1704,7 @@ declare namespace Models {
     /**
      * ResourceToken
      */
-    type ResourceToken = {
+    export type ResourceToken = {
         /**
          * Token ID.
          */
@@ -1713,7 +1737,7 @@ declare namespace Models {
     /**
      * Team
      */
-    type Team<Preferences extends Models.Preferences> = {
+    export type Team<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
         /**
          * Team ID.
          */
@@ -1742,7 +1766,7 @@ declare namespace Models {
     /**
      * Membership
      */
-    type Membership = {
+    export type Membership = {
         /**
          * Membership ID.
          */
@@ -1799,7 +1823,7 @@ declare namespace Models {
     /**
      * Site
      */
-    type Site = {
+    export type Site = {
         /**
          * Site ID.
          */
@@ -1920,7 +1944,7 @@ declare namespace Models {
     /**
      * Function
      */
-    type Function = {
+    export type Function = {
         /**
          * Function ID.
          */
@@ -2037,7 +2061,7 @@ declare namespace Models {
     /**
      * Runtime
      */
-    type Runtime = {
+    export type Runtime = {
         /**
          * Runtime ID.
          */
@@ -2074,7 +2098,7 @@ declare namespace Models {
     /**
      * Framework
      */
-    type Framework = {
+    export type Framework = {
         /**
          * Framework key.
          */
@@ -2099,7 +2123,7 @@ declare namespace Models {
     /**
      * Framework Adapter
      */
-    type FrameworkAdapter = {
+    export type FrameworkAdapter = {
         /**
          * Adapter key.
          */
@@ -2124,7 +2148,7 @@ declare namespace Models {
     /**
      * Deployment
      */
-    type Deployment = {
+    export type Deployment = {
         /**
          * Deployment ID.
          */
@@ -2237,7 +2261,7 @@ declare namespace Models {
     /**
      * Execution
      */
-    type Execution = {
+    export type Execution = {
         /**
          * Execution ID.
          */
@@ -2310,7 +2334,7 @@ declare namespace Models {
     /**
      * Variable
      */
-    type Variable = {
+    export type Variable = {
         /**
          * Variable ID.
          */
@@ -2347,7 +2371,7 @@ declare namespace Models {
     /**
      * Country
      */
-    type Country = {
+    export type Country = {
         /**
          * Country name.
          */
@@ -2360,7 +2384,7 @@ declare namespace Models {
     /**
      * Continent
      */
-    type Continent = {
+    export type Continent = {
         /**
          * Continent name.
          */
@@ -2373,7 +2397,7 @@ declare namespace Models {
     /**
      * Language
      */
-    type Language = {
+    export type Language = {
         /**
          * Language name.
          */
@@ -2390,7 +2414,7 @@ declare namespace Models {
     /**
      * Currency
      */
-    type Currency = {
+    export type Currency = {
         /**
          * Currency symbol.
          */
@@ -2423,7 +2447,7 @@ declare namespace Models {
     /**
      * Phone
      */
-    type Phone = {
+    export type Phone = {
         /**
          * Phone code.
          */
@@ -2440,7 +2464,7 @@ declare namespace Models {
     /**
      * Health Antivirus
      */
-    type HealthAntivirus = {
+    export type HealthAntivirus = {
         /**
          * Antivirus version.
          */
@@ -2453,7 +2477,7 @@ declare namespace Models {
     /**
      * Health Queue
      */
-    type HealthQueue = {
+    export type HealthQueue = {
         /**
          * Amount of actions in the queue.
          */
@@ -2462,7 +2486,7 @@ declare namespace Models {
     /**
      * Health Status
      */
-    type HealthStatus = {
+    export type HealthStatus = {
         /**
          * Name of the service.
          */
@@ -2479,7 +2503,7 @@ declare namespace Models {
     /**
      * Health Certificate
      */
-    type HealthCertificate = {
+    export type HealthCertificate = {
         /**
          * Certificate name
          */
@@ -2508,7 +2532,7 @@ declare namespace Models {
     /**
      * Health Time
      */
-    type HealthTime = {
+    export type HealthTime = {
         /**
          * Current unix timestamp on trustful remote server.
          */
@@ -2525,7 +2549,7 @@ declare namespace Models {
     /**
      * Headers
      */
-    type Headers = {
+    export type Headers = {
         /**
          * Header name.
          */
@@ -2538,7 +2562,7 @@ declare namespace Models {
     /**
      * Specification
      */
-    type Specification = {
+    export type Specification = {
         /**
          * Memory size in MB.
          */
@@ -2559,7 +2583,7 @@ declare namespace Models {
     /**
      * MFA Challenge
      */
-    type MfaChallenge = {
+    export type MfaChallenge = {
         /**
          * Token ID.
          */
@@ -2580,7 +2604,7 @@ declare namespace Models {
     /**
      * MFA Recovery Codes
      */
-    type MfaRecoveryCodes = {
+    export type MfaRecoveryCodes = {
         /**
          * Recovery codes.
          */
@@ -2589,7 +2613,7 @@ declare namespace Models {
     /**
      * MFAType
      */
-    type MfaType = {
+    export type MfaType = {
         /**
          * Secret token used for TOTP factor.
          */
@@ -2602,7 +2626,7 @@ declare namespace Models {
     /**
      * MFAFactors
      */
-    type MfaFactors = {
+    export type MfaFactors = {
         /**
          * Can TOTP be used for MFA challenge for this account.
          */
@@ -2623,7 +2647,7 @@ declare namespace Models {
     /**
      * Provider
      */
-    type Provider = {
+    export type Provider = {
         /**
          * Provider ID.
          */
@@ -2664,7 +2688,7 @@ declare namespace Models {
     /**
      * Message
      */
-    type Message = {
+    export type Message = {
         /**
          * Message ID.
          */
@@ -2721,7 +2745,7 @@ declare namespace Models {
     /**
      * Topic
      */
-    type Topic = {
+    export type Topic = {
         /**
          * Topic ID.
          */
@@ -2758,7 +2782,7 @@ declare namespace Models {
     /**
      * Subscriber
      */
-    type Subscriber = {
+    export type Subscriber = {
         /**
          * Subscriber ID.
          */
@@ -2799,7 +2823,7 @@ declare namespace Models {
     /**
      * Target
      */
-    type Target = {
+    export type Target = {
         /**
          * Target ID.
          */
@@ -2837,6 +2861,7 @@ declare namespace Models {
          */
         expired: boolean;
     };
+    export {};
 }
 
 export { Models };