@appwrite.io/console 1.5.2 → 1.7.0

package/types/services/users.d.ts

@@ -8,8 +8,6 @@ export declare class Users {
     client: Client;
     constructor(client: Client);
     /**
-     * List users
-     *
      * Get a list of all the project's users. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -19,8 +17,6 @@ export declare class Users {
      */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
     /**
-     * Create user
-     *
      * Create a new user.
      *
      * @param {string} userId
@@ -33,8 +29,6 @@ export declare class Users {
      */
     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 a new user. Password provided must be hashed with the [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -46,8 +40,6 @@ export declare class Users {
      */
     createArgon2User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * 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](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -59,8 +51,6 @@ export declare class Users {
      */
     createBcryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * List identities
-     *
      * Get identities for all users.
      *
      * @param {string[]} queries
@@ -70,8 +60,6 @@ export declare class Users {
      */
     listIdentities(queries?: string[], search?: string): Promise<Models.IdentityList>;
     /**
-     * Delete identity
-     *
      * Delete an identity by its unique ID.
      *
      * @param {string} identityId
@@ -80,8 +68,6 @@ export declare class Users {
      */
     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](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -93,8 +79,6 @@ export declare class Users {
      */
     createMD5User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * 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](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -106,8 +90,6 @@ export declare class Users {
      */
     createPHPassUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * 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](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -124,8 +106,6 @@ export declare class Users {
      */
     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 a new user. Password provided must be hashed with the [Scrypt Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -140,8 +120,6 @@ export declare class Users {
      */
     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 a new user. Password provided must be hashed with the [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -154,8 +132,6 @@ export declare class Users {
      */
     createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Get users usage stats
-     *
      * Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
 
      *
@@ -165,8 +141,6 @@ export declare class Users {
      */
     getUsage(range?: UserUsageRange): Promise<Models.UsageUsers>;
     /**
-     * Get user
-     *
      * Get a user by its unique ID.
      *
      * @param {string} userId
@@ -175,8 +149,6 @@ export declare class Users {
      */
     get<Preferences extends Models.Preferences>(userId: string): Promise<Models.User<Preferences>>;
     /**
-     * Delete user
-     *
      * Delete a user by its unique ID, thereby releasing it&#039;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](https://appwrite.io/docs/server/users#usersUpdateStatus) endpoint instead.
      *
      * @param {string} userId
@@ -185,8 +157,6 @@ export declare class Users {
      */
     delete(userId: string): Promise<{}>;
     /**
-     * Update email
-     *
      * Update the user email by its unique ID.
      *
      * @param {string} userId
@@ -196,8 +166,6 @@ export declare class Users {
      */
     updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
     /**
-     * Create user JWT
-     *
      * Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.
      *
      * @param {string} userId
@@ -208,8 +176,6 @@ export declare class Users {
      */
     createJWT(userId: string, sessionId?: string, duration?: number): Promise<Models.Jwt>;
     /**
-     * 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&#039;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.
@@ -221,8 +187,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     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.
      *
      * @param {string} userId
@@ -232,18 +196,16 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List user memberships
-     *
      * Get the user membership list by its unique ID.
      *
      * @param {string} userId
+     * @param {string[]} queries
+     * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise<Models.MembershipList>}
      */
-    listMemberships(userId: string): Promise<Models.MembershipList>;
+    listMemberships(userId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
     /**
-     * Update MFA
-     *
      * Enable or disable MFA on a user account.
      *
      * @param {string} userId
@@ -253,8 +215,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updateMfa<Preferences extends Models.Preferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Delete authenticator
-     *
      * Delete an authenticator app.
      *
      * @param {string} userId
@@ -264,8 +224,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     deleteMfaAuthenticator(userId: string, type: AuthenticatorType): Promise<{}>;
     /**
-     * List factors
-     *
      * List the factors available on the account to be used as a MFA challange.
      *
      * @param {string} userId
@@ -274,8 +232,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     listMfaFactors(userId: string): Promise<Models.MfaFactors>;
     /**
-     * Get MFA recovery codes
-     *
      * Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
      *
      * @param {string} userId
@@ -284,8 +240,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     getMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Regenerate MFA recovery codes
-     *
      * Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
      *
      * @param {string} userId
@@ -294,8 +248,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updateMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Create MFA recovery codes
-     *
      * Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
      *
      * @param {string} userId
@@ -304,8 +256,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     createMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Update name
-     *
      * Update the user name by its unique ID.
      *
      * @param {string} userId
@@ -315,8 +265,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updateName<Preferences extends Models.Preferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
     /**
-     * Update password
-     *
      * Update the user password by its unique ID.
      *
      * @param {string} userId
@@ -326,8 +274,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
     /**
-     * Update phone
-     *
      * Update the user phone by its unique ID.
      *
      * @param {string} userId
@@ -337,8 +283,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
     /**
-     * Get user preferences
-     *
      * Get the user preferences by its unique ID.
      *
      * @param {string} userId
@@ -347,8 +291,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     getPrefs<Preferences extends Models.Preferences>(userId: string): Promise<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 64kB and throws error if exceeded.
      *
      * @param {string} userId
@@ -358,8 +300,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
     /**
-     * List user sessions
-     *
      * Get the user sessions list by its unique ID.
      *
      * @param {string} userId
@@ -368,8 +308,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     listSessions(userId: string): Promise<Models.SessionList>;
     /**
-     * Create session
-     *
      * Creates a session for a user. Returns an immediately usable session object.
 
 If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
@@ -380,8 +318,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     createSession(userId: string): Promise<Models.Session>;
     /**
-     * Delete user sessions
-     *
      * Delete all user&#039;s sessions by using the user&#039;s unique ID.
      *
      * @param {string} userId
@@ -390,8 +326,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     deleteSessions(userId: string): Promise<{}>;
     /**
-     * Delete user session
-     *
      * Delete a user sessions by its unique ID.
      *
      * @param {string} userId
@@ -401,8 +335,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     deleteSession(userId: string, sessionId: string): Promise<{}>;
     /**
-     * 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&#039;s ID reserved.
      *
      * @param {string} userId
@@ -412,8 +344,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
     /**
-     * List user targets
-     *
      * List the messaging targets that are associated with a user.
      *
      * @param {string} userId
@@ -423,8 +353,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     listTargets(userId: string, queries?: string[]): Promise<Models.TargetList>;
     /**
-     * Create user target
-     *
      * Create a messaging target.
      *
      * @param {string} userId
@@ -438,8 +366,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     createTarget(userId: string, targetId: string, providerType: MessagingProviderType, identifier: string, providerId?: string, name?: string): Promise<Models.Target>;
     /**
-     * Get user target
-     *
      * Get a user&#039;s push notification target by ID.
      *
      * @param {string} userId
@@ -449,8 +375,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     getTarget(userId: string, targetId: string): Promise<Models.Target>;
     /**
-     * Update user target
-     *
      * Update a messaging target.
      *
      * @param {string} userId
@@ -463,8 +387,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     updateTarget(userId: string, targetId: string, identifier?: string, providerId?: string, name?: string): Promise<Models.Target>;
     /**
-     * Delete user target
-     *
      * Delete a messaging target.
      *
      * @param {string} userId
@@ -474,8 +396,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     deleteTarget(userId: string, targetId: string): Promise<{}>;
     /**
-     * Create token
-     *
      * Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.
 
      *
@@ -487,8 +407,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     createToken(userId: string, length?: number, expire?: number): Promise<Models.Token>;
     /**
-     * Update email verification
-     *
      * Update the user email verification status by its unique ID.
      *
      * @param {string} userId
@@ -498,8 +416,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Update phone verification
-     *
      * Update the user phone verification status by its unique ID.
      *
      * @param {string} userId

package/types/services/vcs.d.ts

@@ -1,22 +1,31 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { VCSDetectionType } from '../enums/v-c-s-detection-type';
 export declare class Vcs {
     client: Client;
     constructor(client: Client);
     /**
-     * List repositories
+     * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
      *
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {VCSDetectionType} type
+     * @param {string} providerRootDirectory
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DetectionFramework>}
+     */
+    createRepositoryDetection(installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string): Promise<Models.DetectionFramework>;
+    /**
      * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository&#039;s runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
      *
      * @param {string} installationId
+     * @param {VCSDetectionType} type
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise<Models.ProviderRepositoryList>}
+     * @returns {Promise<Models.ProviderRepositoryFrameworkList>}
      */
-    listRepositories(installationId: string, search?: string): Promise<Models.ProviderRepositoryList>;
+    listRepositories(installationId: string, type: VCSDetectionType, search?: string): Promise<Models.ProviderRepositoryFrameworkList>;
     /**
-     * Create repository
-     *
      * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
      *
      * @param {string} installationId
@@ -27,8 +36,6 @@ export declare class Vcs {
      */
     createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository>;
     /**
-     * Get repository
-     *
      * Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
      *
      * @param {string} installationId
@@ -38,8 +45,6 @@ export declare class Vcs {
      */
     getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository>;
     /**
-     * List repository branches
-     *
      * Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
 
      *
@@ -50,8 +55,6 @@ export declare class Vcs {
      */
     listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList>;
     /**
-     * Get files and directories of a VCS repository
-     *
      * Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
 
      *
@@ -63,20 +66,6 @@ export declare class Vcs {
      */
     getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList>;
     /**
-     * Detect runtime settings from source code
-     *
-     * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository&#039;s files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
-     *
-     * @param {string} installationId
-     * @param {string} providerRepositoryId
-     * @param {string} providerRootDirectory
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.Detection>}
-     */
-    createRepositoryDetection(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.Detection>;
-    /**
-     * Authorize external deployment
-     *
      * Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
      *
      * @param {string} installationId
@@ -87,8 +76,6 @@ export declare class Vcs {
      */
     updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}>;
     /**
-     * List installations
-     *
      * List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
 
      *
@@ -99,8 +86,6 @@ export declare class Vcs {
      */
     listInstallations(queries?: string[], search?: string): Promise<Models.InstallationList>;
     /**
-     * Get installation
-     *
      * Get a VCS installation by its unique ID. This endpoint returns the installation&#039;s details including its provider, organization, and configuration.
      *
      * @param {string} installationId
@@ -109,8 +94,6 @@ export declare class Vcs {
      */
     getInstallation(installationId: string): Promise<Models.Installation>;
     /**
-     * Delete installation
-     *
      * Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
      *
      * @param {string} installationId