@appwrite.io/console 0.0.1 → 0.0.2-preview-0.0

package/types/services/teams.d.ts

@@ -0,0 +1,183 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Teams extends Service {
+    constructor(client: Client);
+    /**
+     * List Teams
+     *
+     * Get a list of all the teams in which the current user is a member. You can
+     * use the parameters to filter your results.
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    list(queries?: string[], search?: string): Promise<Models.TeamList>;
+    /**
+     * Create Team
+     *
+     * Create a new team. The user who creates the team will automatically be
+     * assigned as the owner of the team. Only the users with the owner role can
+     * invite new members, add new owners and delete or update the team.
+     *
+     * @param {string} teamId
+     * @param {string} name
+     * @param {string[]} roles
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    create(teamId: string, name: string, roles?: string[]): Promise<Models.Team>;
+    /**
+     * Get Team
+     *
+     * Get a team by its ID. All team members have read access for this resource.
+     *
+     * @param {string} teamId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get(teamId: string): Promise<Models.Team>;
+    /**
+     * Update Team
+     *
+     * Update a team using its ID. Only members with the owner role can update the
+     * team.
+     *
+     * @param {string} teamId
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    update(teamId: string, name: string): Promise<Models.Team>;
+    /**
+     * Delete Team
+     *
+     * Delete a team using its ID. Only team members with the owner role can
+     * delete the team.
+     *
+     * @param {string} teamId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    delete(teamId: string): Promise<{}>;
+    /**
+     * List Team Logs
+     *
+     * Get the team activity logs list by its unique ID.
+     *
+     * @param {string} teamId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listLogs(teamId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * List Team Memberships
+     *
+     * Use this endpoint to list a team's members using the team's ID. All team
+     * members have read access to this endpoint.
+     *
+     * @param {string} teamId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
+    /**
+     * Create Team Membership
+     *
+     * Invite a new member to join your team. Provide an ID for existing users, or
+     * invite unregistered users using an email or phone number. If initiated from
+     * a Client SDK, Appwrite will send an email or sms with a link to join the
+     * team to the invited user, and an account will be created for them if one
+     * doesn't exist. If initiated from a Server SDK, the new member will be added
+     * automatically to the team.
+     *
+     * You only need to provide one of a user ID, email, or phone number. Appwrite
+     * will prioritize accepting the user ID > email > phone number if you provide
+     * more than one of these parameters.
+     *
+     * Use the `url` parameter to redirect the user from the invitation email to
+     * your app. After the user is redirected, use the [Update Team Membership
+     * Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow
+     * the user to accept the invitation to the team.
+     *
+     * Please note that to avoid a [Redirect
+     * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
+     * Appwrite will accept the only redirect URLs under the domains you have
+     * added as a platform on the Appwrite Console.
+     *
+     *
+     * @param {string} teamId
+     * @param {string[]} roles
+     * @param {string} url
+     * @param {string} email
+     * @param {string} userId
+     * @param {string} phone
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createMembership(teamId: string, roles: string[], url: string, email?: string, userId?: string, phone?: string, name?: string): Promise<Models.Membership>;
+    /**
+     * Get Team Membership
+     *
+     * Get a team member by the membership unique id. All team members have read
+     * access for this resource.
+     *
+     * @param {string} teamId
+     * @param {string} membershipId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
+    /**
+     * Update Membership Roles
+     *
+     * Modify the roles of a team member. Only team members with the owner role
+     * have access to this endpoint. Learn more about [roles and
+     * permissions](/docs/permissions).
+     *
+     * @param {string} teamId
+     * @param {string} membershipId
+     * @param {string[]} roles
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateMembershipRoles(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
+    /**
+     * Delete Team Membership
+     *
+     * This endpoint allows a user to leave a team or for a team owner to delete
+     * the membership of any other team member. You can also use this endpoint to
+     * delete a user membership even if it is not accepted.
+     *
+     * @param {string} teamId
+     * @param {string} membershipId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteMembership(teamId: string, membershipId: string): Promise<{}>;
+    /**
+     * Update Team Membership Status
+     *
+     * Use this endpoint to allow a user to accept an invitation to join a team
+     * after being redirected back to your app from the invitation email received
+     * by the user.
+     *
+     * If the request is successful, a session for the user is automatically
+     * created.
+     *
+     *
+     * @param {string} teamId
+     * @param {string} membershipId
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
+}

package/types/services/users.d.ts

@@ -0,0 +1,340 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Users extends Service {
+    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
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
+    /**
+     * Create User
+     *
+     * Create a new user.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} phone
+     * @param {string} password
+     * @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 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.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @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 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.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @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
+     *
+     * 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.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @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 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.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @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 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.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @param {string} passwordSalt
+     * @param {number} passwordCpu
+     * @param {number} passwordMemory
+     * @param {number} passwordParallel
+     * @param {number} passwordLength
+     * @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 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.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @param {string} passwordSalt
+     * @param {string} passwordSaltSeparator
+     * @param {string} passwordSignerKey
+     * @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 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.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @param {string} passwordVersion
+     * @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
+     *
+     *
+     * @param {string} range
+     * @param {string} provider
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getUsage(range?: string, provider?: string): Promise<Models.UsageUsers>;
+    /**
+     * 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 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)
+     * endpoint instead.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    delete(userId: string): Promise<{}>;
+    /**
+     * Update Email
+     *
+     * Update the user email by its unique ID.
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
+    /**
+     * List User Logs
+     *
+     * Get the user activity logs list by its unique ID.
+     *
+     * @param {string} userId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * 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 the user name by its unique ID.
+     *
+     * @param {string} userId
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    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
+     * @param {string} password
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    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
+     * @param {string} number
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    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
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    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
+     * @param {object} prefs
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    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
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listSessions(userId: string): Promise<Models.SessionList>;
+    /**
+     * 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 a user sessions by its unique ID.
+     *
+     * @param {string} userId
+     * @param {string} sessionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    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's ID reserved.
+     *
+     * @param {string} userId
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
+    /**
+     * Update Email Verification
+     *
+     * Update the user email verification status by its unique ID.
+     *
+     * @param {string} userId
+     * @param {boolean} emailVerification
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    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
+     * @param {boolean} phoneVerification
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhoneVerification<Preferences extends Models.Preferences>(userId: string, phoneVerification: boolean): Promise<Models.User<Preferences>>;
+}