@appwrite.io/console 0.2.0 → 0.4.0

package/types/services/users.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Users extends Service {
     constructor(client: Client);
     /**
-     * List Users
+     * List users
      *
      * Get a list of all the project's users. You can use the query params to
      * filter your results.
@@ -13,10 +13,10 @@ export declare class Users extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
     /**
-     * Create User
+     * Create user
      *
      * Create a new user.
      *
@@ -27,15 +27,15 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     create<Preferences extends Models.Preferences>(userId: string, email?: string, phone?: string, password?: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with Argon2 Password
+     * Create user with Argon2 password
      *
      * Create a new user. Password provided must be hashed with the
      * [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST
-     * /users](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -43,15 +43,15 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createArgon2User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with Bcrypt Password
+     * Create user with bcrypt password
      *
      * Create a new user. Password provided must be hashed with the
      * [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST
-     * /users](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -59,15 +59,36 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createBcryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with MD5 Password
+     * List Identities
+     *
+     * Get identities for all users.
+     *
+     * @param {string} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listIdentities(queries?: string, search?: string): Promise<Models.IdentityList>;
+    /**
+     * Delete Identity
+     *
+     * Delete an identity by its unique ID.
+     *
+     * @param {string} identityId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteIdentity(identityId: string): Promise<{}>;
+    /**
+     * Create user with MD5 password
      *
      * Create a new user. Password provided must be hashed with the
      * [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST
-     * /users](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -75,15 +96,15 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createMD5User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with PHPass Password
+     * Create user with PHPass password
      *
      * Create a new user. Password provided must be hashed with the
      * [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST
-     * /users](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -91,15 +112,15 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createPHPassUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with Scrypt Password
+     * Create user with Scrypt password
      *
      * Create a new user. Password provided must be hashed with the
      * [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST
-     * /users](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -112,15 +133,16 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createScryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordCpu: number, passwordMemory: number, passwordParallel: number, passwordLength: number, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with Scrypt Modified Password
+     * Create user with Scrypt modified password
      *
      * Create a new user. Password provided must be hashed with the [Scrypt
      * Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc)
-     * algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint
-     * to create users with a plain text password.
+     * algorithm. Use the [POST
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -131,15 +153,15 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createScryptModifiedUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordSaltSeparator: string, passwordSignerKey: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with SHA Password
+     * Create user with SHA password
      *
      * Create a new user. Password provided must be hashed with the
      * [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use
-     * the [POST /users](/docs/server/users#usersCreate) endpoint to create users
-     * with a plain text password.
+     * the [POST /users](https://appwrite.io/docs/server/users#usersCreate)
+     * endpoint to create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -148,7 +170,7 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: string, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Get usage stats for the users API
@@ -157,34 +179,35 @@ export declare class Users extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getUsage(range?: string): Promise<Models.UsageUsers>;
     /**
-     * Get User
+     * Get user
      *
      * Get a user by its unique ID.
      *
      * @param {string} userId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get<Preferences extends Models.Preferences>(userId: string): Promise<Models.User<Preferences>>;
     /**
-     * Delete User
+     * Delete user
      *
      * Delete a user by its unique ID, thereby releasing it's ID. Since ID is
      * released and can be reused, all user-related resources like documents or
      * storage files should be deleted before user deletion. If you want to keep
-     * ID reserved, use the [updateStatus](/docs/server/users#usersUpdateStatus)
+     * ID reserved, use the
+     * [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus)
      * endpoint instead.
      *
      * @param {string} userId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     delete(userId: string): Promise<{}>;
     /**
-     * Update Email
+     * Update email
      *
      * Update the user email by its unique ID.
      *
@@ -192,10 +215,26 @@ export declare class Users extends Service {
      * @param {string} email
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
     /**
-     * List User Logs
+     * Update user labels
+     *
+     * Update the user labels by its unique ID.
+     *
+     * Labels can be used to grant access to resources. While teams are a way for
+     * user's to share access to a resource, labels can be defined by the
+     * developer to grant access without an invitation. See the [Permissions
+     * docs](https://appwrite.io/docs/permissions) for more info.
+     *
+     * @param {string} userId
+     * @param {string[]} labels
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateLabels<Preferences extends Models.Preferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
+    /**
+     * List user logs
      *
      * Get the user activity logs list by its unique ID.
      *
@@ -203,20 +242,20 @@ export declare class Users extends Service {
      * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List User Memberships
+     * List user memberships
      *
      * Get the user membership list by its unique ID.
      *
      * @param {string} userId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listMemberships(userId: string): Promise<Models.MembershipList>;
     /**
-     * Update Name
+     * Update name
      *
      * Update the user name by its unique ID.
      *
@@ -224,10 +263,10 @@ export declare class Users extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateName<Preferences extends Models.Preferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
     /**
-     * Update Password
+     * Update password
      *
      * Update the user password by its unique ID.
      *
@@ -235,10 +274,10 @@ export declare class Users extends Service {
      * @param {string} password
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
     /**
-     * Update Phone
+     * Update phone
      *
      * Update the user phone by its unique ID.
      *
@@ -246,20 +285,20 @@ export declare class Users extends Service {
      * @param {string} number
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
     /**
-     * Get User Preferences
+     * Get user preferences
      *
      * Get the user preferences by its unique ID.
      *
      * @param {string} userId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getPrefs<Preferences extends Models.Preferences>(userId: string): Promise<Preferences>;
     /**
-     * Update User Preferences
+     * Update user preferences
      *
      * Update the user preferences by its unique ID. The object you pass is stored
      * as is, and replaces any previous value. The maximum allowed prefs size is
@@ -269,30 +308,30 @@ export declare class Users extends Service {
      * @param {object} prefs
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
     /**
-     * List User Sessions
+     * List user sessions
      *
      * Get the user sessions list by its unique ID.
      *
      * @param {string} userId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listSessions(userId: string): Promise<Models.SessionList>;
     /**
-     * Delete User Sessions
+     * Delete user sessions
      *
      * Delete all user's sessions by using the user's unique ID.
      *
      * @param {string} userId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteSessions(userId: string): Promise<{}>;
     /**
-     * Delete User Session
+     * Delete user session
      *
      * Delete a user sessions by its unique ID.
      *
@@ -300,10 +339,10 @@ export declare class Users extends Service {
      * @param {string} sessionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteSession(userId: string, sessionId: string): Promise<{}>;
     /**
-     * Update User Status
+     * Update user status
      *
      * Update the user status by its unique ID. Use this endpoint as an
      * alternative to deleting a user if you want to keep user's ID reserved.
@@ -312,10 +351,10 @@ export declare class Users extends Service {
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Update Email Verification
+     * Update email verification
      *
      * Update the user email verification status by its unique ID.
      *
@@ -323,10 +362,10 @@ export declare class Users extends Service {
      * @param {boolean} emailVerification
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Update Phone Verification
+     * Update phone verification
      *
      * Update the user phone verification status by its unique ID.
      *
@@ -334,6 +373,6 @@ export declare class Users extends Service {
      * @param {boolean} phoneVerification
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updatePhoneVerification<Preferences extends Models.Preferences>(userId: string, phoneVerification: boolean): Promise<Models.User<Preferences>>;
 }

package/types/services/vcs.d.ts

@@ -0,0 +1,97 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Vcs extends Service {
+    constructor(client: Client);
+    /**
+     * List Repositories
+     *
+     *
+     * @param {string} installationId
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listRepositories(installationId: string, search?: string): Promise<Models.ProviderRepositoryList>;
+    /**
+     * Create repository
+     *
+     *
+     * @param {string} installationId
+     * @param {string} name
+     * @param {boolean} xprivate
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository>;
+    /**
+     * Get repository
+     *
+     *
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository>;
+    /**
+     * List Repository Branches
+     *
+     *
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList>;
+    /**
+     * Detect runtime settings from source code
+     *
+     *
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerRootDirectory
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createRepositoryDetection(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.Detection>;
+    /**
+     * Authorize external deployment
+     *
+     *
+     * @param {string} installationId
+     * @param {string} repositoryId
+     * @param {string} providerPullRequestId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}>;
+    /**
+     * List installations
+     *
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listInstallations(queries?: string[], search?: string): Promise<Models.InstallationList>;
+    /**
+     * Get installation
+     *
+     *
+     * @param {string} installationId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getInstallation(installationId: string): Promise<Models.Installation>;
+    /**
+     * Delete Installation
+     *
+     *
+     * @param {string} installationId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteInstallation(installationId: string): Promise<{}>;
+}

package/docs/examples/projects/update-domain-verification.md

@@ -1,18 +0,0 @@
-import { Client, Projects } from "@appwrite.io/console";
-
-const client = new Client();
-
-const projects = new Projects(client);
-
-client
-    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateDomainVerification('[PROJECT_ID]', '[DOMAIN_ID]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});