node-appwrite 22.0.0 → 22.1.1

package/dist/models.d.ts

@@ -523,6 +523,14 @@ declare namespace Models {
          * Database type.
          */
         type: DatabaseType;
+        /**
+         * Database backup policies.
+         */
+        policies: Index[];
+        /**
+         * Database backup archives.
+         */
+        archives: Collection[];
     };
     /**
      * Collection
@@ -563,11 +571,19 @@ declare namespace Models {
         /**
          * Collection attributes.
          */
-        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
+        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeVarchar | Models.AttributeText | Models.AttributeMediumtext | Models.AttributeLongtext | Models.AttributeString)[];
         /**
          * 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;
     };
     /**
      * Attributes List
@@ -580,7 +596,7 @@ declare namespace Models {
         /**
          * List of attributes.
          */
-        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
+        attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeVarchar | Models.AttributeText | Models.AttributeMediumtext | Models.AttributeLongtext | Models.AttributeString)[];
     };
     /**
      * AttributeString
@@ -1227,6 +1243,10 @@ 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;
     };
     /**
      * AttributeText
@@ -1268,6 +1288,10 @@ 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;
     };
     /**
      * AttributeMediumtext
@@ -1309,6 +1333,10 @@ 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;
     };
     /**
      * AttributeLongtext
@@ -1350,6 +1378,10 @@ 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;
     };
     /**
      * Table
@@ -1390,11 +1422,19 @@ declare namespace Models {
         /**
          * Table columns.
          */
-        columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnString)[];
+        columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnVarchar | Models.ColumnText | Models.ColumnMediumtext | Models.ColumnLongtext | Models.ColumnString)[];
         /**
          * Table indexes.
          */
         indexes: ColumnIndex[];
+        /**
+         * Maximum row size in bytes. Returns 0 when no limit applies.
+         */
+        bytesMax: number;
+        /**
+         * Currently used row size in bytes based on defined columns.
+         */
+        bytesUsed: number;
     };
     /**
      * Columns List
@@ -1407,7 +1447,7 @@ declare namespace Models {
         /**
          * List of columns.
          */
-        columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnString)[];
+        columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnVarchar | Models.ColumnText | Models.ColumnMediumtext | Models.ColumnLongtext | Models.ColumnString)[];
     };
     /**
      * ColumnString
@@ -2054,6 +2094,10 @@ declare namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     };
     /**
      * ColumnText
@@ -2095,6 +2139,10 @@ declare namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     };
     /**
      * ColumnMediumtext
@@ -2136,6 +2184,10 @@ declare namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     };
     /**
      * ColumnLongtext
@@ -2177,6 +2229,10 @@ declare namespace Models {
          * Default value for column when not provided. Cannot be set when column is required.
          */
         default?: string;
+        /**
+         * Defines whether this column is encrypted or not.
+         */
+        encrypt?: boolean;
     };
     /**
      * Index
@@ -4184,6 +4240,342 @@ declare namespace Models {
          */
         expired: boolean;
     };
+    /**
+     * ActivityEvent
+     */
+    export type ActivityEvent = {
+        /**
+         * Event ID.
+         */
+        $id: string;
+        /**
+         * User type.
+         */
+        userType: string;
+        /**
+         * User ID.
+         */
+        userId: string;
+        /**
+         * User Email.
+         */
+        userEmail: string;
+        /**
+         * User Name.
+         */
+        userName: string;
+        /**
+         * Resource parent.
+         */
+        resourceParent: string;
+        /**
+         * Resource type.
+         */
+        resourceType: string;
+        /**
+         * Resource ID.
+         */
+        resourceId: string;
+        /**
+         * Resource.
+         */
+        resource: string;
+        /**
+         * Event name.
+         */
+        event: string;
+        /**
+         * User agent.
+         */
+        userAgent: string;
+        /**
+         * IP address.
+         */
+        ip: string;
+        /**
+         * API mode when event triggered.
+         */
+        mode: string;
+        /**
+         * Location.
+         */
+        country: string;
+        /**
+         * Log creation date in ISO 8601 format.
+         */
+        time: string;
+        /**
+         * Project ID.
+         */
+        projectId: string;
+        /**
+         * Team ID.
+         */
+        teamId: string;
+        /**
+         * Hostname.
+         */
+        hostname: string;
+        /**
+         * Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
+         */
+        osCode: string;
+        /**
+         * Operating system name.
+         */
+        osName: string;
+        /**
+         * Operating system version.
+         */
+        osVersion: string;
+        /**
+         * Client type.
+         */
+        clientType: string;
+        /**
+         * Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
+         */
+        clientCode: string;
+        /**
+         * Client name.
+         */
+        clientName: string;
+        /**
+         * Client version.
+         */
+        clientVersion: string;
+        /**
+         * Client engine name.
+         */
+        clientEngine: string;
+        /**
+         * Client engine name.
+         */
+        clientEngineVersion: string;
+        /**
+         * Device name.
+         */
+        deviceName: string;
+        /**
+         * Device brand name.
+         */
+        deviceBrand: string;
+        /**
+         * Device model name.
+         */
+        deviceModel: string;
+        /**
+         * Country two-character ISO 3166-1 alpha code.
+         */
+        countryCode: string;
+        /**
+         * Country name.
+         */
+        countryName: string;
+    };
+    /**
+     * Archive
+     */
+    export type BackupArchive = {
+        /**
+         * Archive ID.
+         */
+        $id: string;
+        /**
+         * Archive creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Archive update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Archive policy ID.
+         */
+        policyId: string;
+        /**
+         * Archive size in bytes.
+         */
+        size: number;
+        /**
+         * The status of the archive creation. Possible values: pending, processing, uploading, completed, failed.
+         */
+        status: string;
+        /**
+         * The backup start time.
+         */
+        startedAt: string;
+        /**
+         * Migration ID.
+         */
+        migrationId: string;
+        /**
+         * The services that are backed up by this archive.
+         */
+        services: string[];
+        /**
+         * The resources that are backed up by this archive.
+         */
+        resources: string[];
+        /**
+         * The resource ID to backup. Set only if this archive should backup a single resource.
+         */
+        resourceId?: string;
+        /**
+         * The resource type to backup. Set only if this archive should backup a single resource.
+         */
+        resourceType?: string;
+    };
+    /**
+     * backup
+     */
+    export type BackupPolicy = {
+        /**
+         * Backup policy ID.
+         */
+        $id: string;
+        /**
+         * Backup policy name.
+         */
+        name: string;
+        /**
+         * Policy creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Policy update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * The services that are backed up by this policy.
+         */
+        services: string[];
+        /**
+         * The resources that are backed up by this policy.
+         */
+        resources: string[];
+        /**
+         * The resource ID to backup. Set only if this policy should backup a single resource.
+         */
+        resourceId?: string;
+        /**
+         * The resource type to backup. Set only if this policy should backup a single resource.
+         */
+        resourceType?: string;
+        /**
+         * How many days to keep the backup before it will be automatically deleted.
+         */
+        retention: number;
+        /**
+         * Policy backup schedule in CRON format.
+         */
+        schedule: string;
+        /**
+         * Is this policy enabled.
+         */
+        enabled: boolean;
+    };
+    /**
+     * Restoration
+     */
+    export type BackupRestoration = {
+        /**
+         * Restoration ID.
+         */
+        $id: string;
+        /**
+         * Restoration creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Restoration update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Backup archive ID.
+         */
+        archiveId: string;
+        /**
+         * Backup policy ID.
+         */
+        policyId: string;
+        /**
+         * The status of the restoration. Possible values: pending, downloading, processing, completed, failed.
+         */
+        status: string;
+        /**
+         * The backup start time.
+         */
+        startedAt: string;
+        /**
+         * Migration ID.
+         */
+        migrationId: string;
+        /**
+         * The services that are backed up by this policy.
+         */
+        services: string[];
+        /**
+         * The resources that are backed up by this policy.
+         */
+        resources: string[];
+        /**
+         * Optional data in key-value object.
+         */
+        options: string;
+    };
+    /**
+     * Activity event list
+     */
+    export type ActivityEventList = {
+        /**
+         * Total number of events that matched your query.
+         */
+        total: number;
+        /**
+         * List of events.
+         */
+        events: ActivityEvent[];
+    };
+    /**
+     * Backup archive list
+     */
+    export type BackupArchiveList = {
+        /**
+         * Total number of archives that matched your query.
+         */
+        total: number;
+        /**
+         * List of archives.
+         */
+        archives: BackupArchive[];
+    };
+    /**
+     * Backup policy list
+     */
+    export type BackupPolicyList = {
+        /**
+         * Total number of policies that matched your query.
+         */
+        total: number;
+        /**
+         * List of policies.
+         */
+        policies: BackupPolicy[];
+    };
+    /**
+     * Backup restoration list
+     */
+    export type BackupRestorationList = {
+        /**
+         * Total number of restorations that matched your query.
+         */
+        total: number;
+        /**
+         * List of restorations.
+         */
+        restorations: BackupRestoration[];
+    };
     export {};
 }
 

package/dist/query.d.mts

@@ -198,12 +198,34 @@ declare class Query {
     static offset: (offset: number) => string;
     /**
      * Filter resources where attribute contains the specified value.
+     * For string attributes, checks if the string contains the substring.
      *
+     * Note: For array attributes, use {@link containsAny} or {@link containsAll} instead.
      * @param {string} attribute
      * @param {string | string[]} value
      * @returns {string}
      */
     static contains: (attribute: string, value: string | any[]) => string;
+    /**
+     * Filter resources where attribute contains ANY of the specified values.
+     * For array and relationship attributes, matches documents where the attribute
+     * contains at least one of the given values.
+     *
+     * @param {string} attribute
+     * @param {any[]} value
+     * @returns {string}
+     */
+    static containsAny: (attribute: string, value: any[]) => string;
+    /**
+     * Filter resources where attribute contains ALL of the specified values.
+     * For array and relationship attributes, matches documents where the attribute
+     * contains every one of the given values.
+     *
+     * @param {string} attribute
+     * @param {any[]} value
+     * @returns {string}
+     */
+    static containsAll: (attribute: string, value: any[]) => string;
     /**
      * Filter resources where attribute does not contain the specified value.
      *

package/dist/query.d.ts

@@ -198,12 +198,34 @@ declare class Query {
     static offset: (offset: number) => string;
     /**
      * Filter resources where attribute contains the specified value.
+     * For string attributes, checks if the string contains the substring.
      *
+     * Note: For array attributes, use {@link containsAny} or {@link containsAll} instead.
      * @param {string} attribute
      * @param {string | string[]} value
      * @returns {string}
      */
     static contains: (attribute: string, value: string | any[]) => string;
+    /**
+     * Filter resources where attribute contains ANY of the specified values.
+     * For array and relationship attributes, matches documents where the attribute
+     * contains at least one of the given values.
+     *
+     * @param {string} attribute
+     * @param {any[]} value
+     * @returns {string}
+     */
+    static containsAny: (attribute: string, value: any[]) => string;
+    /**
+     * Filter resources where attribute contains ALL of the specified values.
+     * For array and relationship attributes, matches documents where the attribute
+     * contains every one of the given values.
+     *
+     * @param {string} attribute
+     * @param {any[]} value
+     * @returns {string}
+     */
+    static containsAll: (attribute: string, value: any[]) => string;
     /**
      * Filter resources where attribute does not contain the specified value.
      *

package/dist/query.js

@@ -214,12 +214,34 @@ _Query.limit = (limit) => new _Query("limit", void 0, limit).toString();
 _Query.offset = (offset) => new _Query("offset", void 0, offset).toString();
 /**
  * Filter resources where attribute contains the specified value.
+ * For string attributes, checks if the string contains the substring.
  *
+ * Note: For array attributes, use {@link containsAny} or {@link containsAll} instead.
  * @param {string} attribute
  * @param {string | string[]} value
  * @returns {string}
  */
 _Query.contains = (attribute, value) => new _Query("contains", attribute, value).toString();
+/**
+ * Filter resources where attribute contains ANY of the specified values.
+ * For array and relationship attributes, matches documents where the attribute
+ * contains at least one of the given values.
+ *
+ * @param {string} attribute
+ * @param {any[]} value
+ * @returns {string}
+ */
+_Query.containsAny = (attribute, value) => new _Query("containsAny", attribute, value).toString();
+/**
+ * Filter resources where attribute contains ALL of the specified values.
+ * For array and relationship attributes, matches documents where the attribute
+ * contains every one of the given values.
+ *
+ * @param {string} attribute
+ * @param {any[]} value
+ * @returns {string}
+ */
+_Query.containsAll = (attribute, value) => new _Query("containsAll", attribute, value).toString();
 /**
  * Filter resources where attribute does not contain the specified value.
  *