@appwrite.io/console 0.1.0-preview-0.1 → 0.1.1

package/types/models.d.ts

@@ -746,11 +746,11 @@ export declare namespace Models {
          */
         array?: boolean;
         /**
-         * The Id of the related collection
+         * The ID of the related collection.
          */
         relatedCollection: string;
         /**
-         * The type of the relationship
+         * The type of the relationship.
          */
         relationType: string;
         /**
@@ -758,13 +758,17 @@ export declare namespace Models {
          */
         twoWay: boolean;
         /**
-         * The key of the two-way relationship
+         * The key of the two-way relationship.
          */
         twoWayKey: string;
         /**
-         * Action to take on related documents when parent document is deleted
+         * How deleting the parent document will propagate to child documents.
          */
         onDelete: string;
+        /**
+         * Whether this is the parent or child side of the relationship
+         */
+        side: string;
     };
     /**
      * Index
@@ -933,15 +937,15 @@ export declare namespace Models {
         /**
          * Hashed user password.
          */
-        password: string;
+        password?: string;
         /**
          * Password hashing algorithm.
          */
-        hash: string;
+        hash?: string;
         /**
          * Password hashing algorithm configuration.
          */
-        hashOptions: object;
+        hashOptions?: object;
         /**
          * User registration date in ISO 8601 format.
          */
@@ -1078,59 +1082,6 @@ export declare namespace Models {
          */
         threads: number;
     };
-    /**
-     * Account
-     */
-    type Account<Preferences extends Models.Preferences> = {
-        /**
-         * User ID.
-         */
-        $id: string;
-        /**
-         * User creation date in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * User update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * User name.
-         */
-        name: string;
-        /**
-         * User registration date in ISO 8601 format.
-         */
-        registration: string;
-        /**
-         * User status. Pass `true` for enabled and `false` for disabled.
-         */
-        status: boolean;
-        /**
-         * Password update time in ISO 8601 format.
-         */
-        passwordUpdate: string;
-        /**
-         * User email address.
-         */
-        email: string;
-        /**
-         * User phone number in E.164 format.
-         */
-        phone: string;
-        /**
-         * Email verification status.
-         */
-        emailVerification: boolean;
-        /**
-         * Phone verification status.
-         */
-        phoneVerification: boolean;
-        /**
-         * User preferences as a key-value object
-         */
-        prefs: Preferences;
-    };
     /**
      * Preferences
      */
@@ -2594,4 +2545,25 @@ export declare namespace Models {
          */
         buckets: Metric[];
     };
+    /**
+     * Console Variables
+     */
+    type ConsoleVariables = {
+        /**
+         * CNAME target for your Appwrite custom domains.
+         */
+        _APP_DOMAIN_TARGET: string;
+        /**
+         * Maximum file size allowed for file upload in bytes.
+         */
+        _APP_STORAGE_LIMIT: number;
+        /**
+         * Maximum file size allowed for deployment in bytes.
+         */
+        _APP_FUNCTIONS_SIZE_LIMIT: number;
+        /**
+         * Defines if usage stats are enabled. This value is set to &#039;enabled&#039; by default, to disable the usage stats set the value to &#039;disabled&#039;.
+         */
+        _APP_USAGE_STATS: string;
+    };
 }

package/types/query.d.ts

@@ -8,6 +8,12 @@ export declare class Query {
     static lessThanEqual: (attribute: string, value: QueryTypes) => string;
     static greaterThan: (attribute: string, value: QueryTypes) => string;
     static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
+    static isNull: (attribute: string) => string;
+    static isNotNull: (attribute: string) => string;
+    static between: (attribute: string, start: string | number, end: string | number) => string;
+    static startsWith: (attribute: string, value: string) => string;
+    static endsWith: (attribute: string, value: string) => string;
+    static select: (attributes: string[]) => string;
     static search: (attribute: string, value: string) => string;
     static orderDesc: (attribute: string) => string;
     static orderAsc: (attribute: string) => string;

package/types/services/account.d.ts

@@ -94,7 +94,7 @@ export declare class Account extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.Account<Preferences>>;
+    updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
     /**
      * Update Phone
      *
@@ -211,7 +211,7 @@ export declare class Account extends Service {
      * password combination. This route will create a new session for the user.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication#limits).
+     * about session limits](/docs/authentication-security#limits).
      *
      * @param {string} email
      * @param {string} password
@@ -235,7 +235,7 @@ export declare class Account extends Service {
      * your Appwrite instance by default.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication#limits).
+     * about session limits](/docs/authentication-security#limits).
      *
      * @param {string} userId
      * @param {string} email
@@ -281,7 +281,7 @@ export declare class Account extends Service {
      * user.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication#limits).
+     * about session limits](/docs/authentication-security#limits).
      *
      *
      * @param {string} provider
@@ -303,7 +303,7 @@ export declare class Account extends Service {
      * is valid for 15 minutes.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication#limits).
+     * about session limits](/docs/authentication-security#limits).
      *
      * @param {string} userId
      * @param {string} phone
@@ -372,7 +372,7 @@ export declare class Account extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateStatus<Preferences extends Models.Preferences>(): Promise<Models.Account<Preferences>>;
+    updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
      * Create Email Verification
      *

package/types/services/console.d.ts

@@ -0,0 +1,15 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Console extends Service {
+    constructor(client: Client);
+    /**
+     * Get Variables
+     *
+     * Get all Environment Variables that are relevant for the console.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    variables(): Promise<Models.ConsoleVariables>;
+}

package/types/services/databases.d.ts

@@ -176,7 +176,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: boolean): Promise<Models.AttributeBoolean>;
+    updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean>;
     /**
      * Create DateTime Attribute
      *
@@ -203,7 +203,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeDatetime>;
+    updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime>;
     /**
      * Create Email Attribute
      *
@@ -235,7 +235,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeEmail>;
+    updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail>;
     /**
      * Create Enum Attribute
      *
@@ -267,7 +267,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault: string): Promise<Models.AttributeEnum>;
+    updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum>;
     /**
      * Create Float Attribute
      *
@@ -304,7 +304,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeFloat>;
+    updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat>;
     /**
      * Create Integer Attribute
      *
@@ -341,7 +341,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeInteger>;
+    updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger>;
     /**
      * Create IP Address Attribute
      *
@@ -373,9 +373,12 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeIp>;
+    updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp>;
     /**
-     * Create relationship Attribute
+     * Create Relationship Attribute
+     *
+     * Create relationship attribute. [Learn more about relationship
+     * attributes](/docs/databases-relationships#relationship-attributes).
      *
      *
      * @param {string} databaseId
@@ -422,7 +425,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeString>;
+    updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString>;
     /**
      * Create URL Attribute
      *
@@ -454,7 +457,7 @@ export declare class Databases extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeUrl>;
+    updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl>;
     /**
      * Get Attribute
      *
@@ -480,16 +483,18 @@ export declare class Databases extends Service {
     /**
      * Update Relationship Attribute
      *
+     * Update relationship attribute. [Learn more about relationship
+     * attributes](/docs/databases-relationships#relationship-attributes).
+     *
      *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {boolean} twoWay
      * @param {string} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, twoWay?: boolean, onDelete?: string): Promise<Models.AttributeRelationship>;
+    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship>;
     /**
      * List Documents
      *