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

package/types/permission.d.ts

@@ -0,0 +1,7 @@
+export declare class Permission {
+    static read: (role: string) => string;
+    static write: (role: string) => string;
+    static create: (role: string) => string;
+    static update: (role: string) => string;
+    static delete: (role: string) => string;
+}

package/types/query.d.ts

@@ -0,0 +1,21 @@
+declare type QueryTypesSingle = string | number | boolean;
+export declare type QueryTypesList = string[] | number[] | boolean[];
+export declare type QueryTypes = QueryTypesSingle | QueryTypesList;
+export declare class Query {
+    static equal: (attribute: string, value: QueryTypes) => string;
+    static notEqual: (attribute: string, value: QueryTypes) => string;
+    static lessThan: (attribute: string, value: QueryTypes) => string;
+    static lessThanEqual: (attribute: string, value: QueryTypes) => string;
+    static greaterThan: (attribute: string, value: QueryTypes) => string;
+    static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
+    static search: (attribute: string, value: string) => string;
+    static orderDesc: (attribute: string) => string;
+    static orderAsc: (attribute: string) => string;
+    static cursorAfter: (documentId: string) => string;
+    static cursorBefore: (documentId: string) => string;
+    static limit: (limit: number) => string;
+    static offset: (offset: number) => string;
+    private static addQuery;
+    private static parseValues;
+}
+export {};

package/types/role.d.ts

@@ -0,0 +1,8 @@
+export declare class Role {
+    static any(): string;
+    static user(id: string, status?: string): string;
+    static users(status?: string): string;
+    static guests(): string;
+    static team(id: string, role?: string): string;
+    static member(id: string): string;
+}

package/types/service.d.ts

@@ -0,0 +1,8 @@
+import { Client } from './client';
+import type { Payload } from './client';
+export declare class Service {
+    static CHUNK_SIZE: number;
+    client: Client;
+    constructor(client: Client);
+    static flatten(data: Payload, prefix?: string): Payload;
+}

package/types/services/account.d.ts

@@ -0,0 +1,442 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Account extends Service {
+    constructor(client: Client);
+    /**
+     * Get Account
+     *
+     * Get currently logged in user data as JSON object.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get<Preferences extends Models.Preferences>(): Promise<Models.Account<Preferences>>;
+    /**
+     * Create Account
+     *
+     * Use this endpoint to allow a new user to register a new account in your
+     * project. After the user registration completes successfully, you can use
+     * the [/account/verfication](/docs/client/account#accountCreateVerification)
+     * route to start verifying the user email address. To allow the new user to
+     * login to their new account, you need to create a new [account
+     * session](/docs/client/account#accountCreateSession).
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    create<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.Account<Preferences>>;
+    /**
+     * Update Email
+     *
+     * Update currently logged in user account email address. After changing user
+     * address, the user confirmation status will get reset. A new confirmation
+     * email is not sent automatically however you can use the send confirmation
+     * email endpoint again to send the confirmation email. For security measures,
+     * user password is required to complete this request.
+     * This endpoint can also be used to convert an anonymous account to a normal
+     * one, by passing an email address and a new password.
+     *
+     *
+     * @param {string} email
+     * @param {string} password
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateEmail<Preferences extends Models.Preferences>(email: string, password: string): Promise<Models.Account<Preferences>>;
+    /**
+     * Create JWT
+     *
+     * Use this endpoint to create a JSON Web Token. You can use the resulting JWT
+     * to authenticate on behalf of the current user when working with the
+     * Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes
+     * from its creation and will be invalid if the user will logout in that time
+     * frame.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createJWT(): Promise<Models.Jwt>;
+    /**
+     * List Logs
+     *
+     * Get currently logged in user list of latest security activity logs. Each
+     * log returns user IP address, location and date and time of log.
+     *
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listLogs(queries?: string[]): Promise<Models.LogList>;
+    /**
+     * Update Name
+     *
+     * Update currently logged in user account name.
+     *
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateName<Preferences extends Models.Preferences>(name: string): Promise<Models.Account<Preferences>>;
+    /**
+     * Update Password
+     *
+     * Update currently logged in user password. For validation, user is required
+     * to pass in the new password, and the old password. For users created with
+     * OAuth, Team Invites and Magic URL, oldPassword is optional.
+     *
+     * @param {string} password
+     * @param {string} oldPassword
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.Account<Preferences>>;
+    /**
+     * Update Phone
+     *
+     * Update the currently logged in user's phone number. After updating the
+     * phone number, the phone verification status will be reset. A confirmation
+     * SMS is not sent automatically, however you can use the [POST
+     * /account/verification/phone](/docs/client/account#accountCreatePhoneVerification)
+     * endpoint to send a confirmation SMS.
+     *
+     * @param {string} phone
+     * @param {string} password
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhone<Preferences extends Models.Preferences>(phone: string, password: string): Promise<Models.Account<Preferences>>;
+    /**
+     * Get Account Preferences
+     *
+     * Get currently logged in user preferences as a key-value object.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getPrefs<Preferences extends Models.Preferences>(): Promise<Preferences>;
+    /**
+     * Update Preferences
+     *
+     * Update currently logged in user account preferences. 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 {object} prefs
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePrefs<Preferences extends Models.Preferences>(prefs: object): Promise<Models.Account<Preferences>>;
+    /**
+     * Create Password Recovery
+     *
+     * Sends the user an email with a temporary secret key for password reset.
+     * When the user clicks the confirmation link he is redirected back to your
+     * app password reset URL with the secret key and email address values
+     * attached to the URL query string. Use the query string params to submit a
+     * request to the [PUT
+     * /account/recovery](/docs/client/account#accountUpdateRecovery) endpoint to
+     * complete the process. The verification link sent to the user's email
+     * address is valid for 1 hour.
+     *
+     * @param {string} email
+     * @param {string} url
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createRecovery(email: string, url: string): Promise<Models.Token>;
+    /**
+     * Create Password Recovery (confirmation)
+     *
+     * Use this endpoint to complete the user account password reset. Both the
+     * **userId** and **secret** arguments will be passed as query parameters to
+     * the redirect URL you have provided when sending your request to the [POST
+     * /account/recovery](/docs/client/account#accountCreateRecovery) endpoint.
+     *
+     * Please note that in order to avoid a [Redirect
+     * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
+     * the only valid redirect URLs are the ones from domains you have set when
+     * adding your platforms in the console interface.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @param {string} password
+     * @param {string} passwordAgain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateRecovery(userId: string, secret: string, password: string, passwordAgain: string): Promise<Models.Token>;
+    /**
+     * List Sessions
+     *
+     * Get currently logged in user list of active sessions across different
+     * devices.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listSessions(): Promise<Models.SessionList>;
+    /**
+     * Delete Sessions
+     *
+     * Delete all sessions from the user account and remove any sessions cookies
+     * from the end client.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteSessions(): Promise<{}>;
+    /**
+     * Create Anonymous Session
+     *
+     * Use this endpoint to allow a new user to register an anonymous account in
+     * your project. This route will also create a new session for the user. To
+     * allow the new user to convert an anonymous account to a normal account, you
+     * need to update its [email and
+     * password](/docs/client/account#accountUpdateEmail) or create an [OAuth2
+     * session](/docs/client/account#accountCreateOAuth2Session).
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createAnonymousSession(): Promise<Models.Session>;
+    /**
+     * Create Email Session
+     *
+     * Allow the user to login into their account by providing a valid email and
+     * 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).
+     *
+     * @param {string} email
+     * @param {string} password
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createEmailSession(email: string, password: string): Promise<Models.Session>;
+    /**
+     * Create Magic URL session
+     *
+     * Sends the user an email with a secret key for creating a session. If the
+     * provided user ID has not be registered, a new user will be created. When
+     * the user clicks the link in the email, the user is redirected back to the
+     * URL you provided with the secret key and userId values attached to the URL
+     * query string. Use the query string parameters to submit a request to the
+     * [PUT
+     * /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession)
+     * endpoint to complete the login process. The link sent to the user's email
+     * address is valid for 1 hour. If you are on a mobile device you can leave
+     * the URL parameter empty, so that the login completion will be handled by
+     * 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).
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} url
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createMagicURLSession(userId: string, email: string, url?: string): Promise<Models.Token>;
+    /**
+     * Create Magic URL session (confirmation)
+     *
+     * Use this endpoint to complete creating the session with the Magic URL. Both
+     * the **userId** and **secret** arguments will be passed as query parameters
+     * to the redirect URL you have provided when sending your request to the
+     * [POST
+     * /account/sessions/magic-url](/docs/client/account#accountCreateMagicURLSession)
+     * endpoint.
+     *
+     * Please note that in order to avoid a [Redirect
+     * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
+     * the only valid redirect URLs are the ones from domains you have set when
+     * adding your platforms in the console interface.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateMagicURLSession(userId: string, secret: string): Promise<Models.Session>;
+    /**
+     * Create OAuth2 Session
+     *
+     * Allow the user to login to their account using the OAuth2 provider of their
+     * choice. Each OAuth2 provider should be enabled from the Appwrite console
+     * first. Use the success and failure arguments to provide a redirect URL's
+     * back to your app when login is completed.
+     *
+     * If there is already an active session, the new session will be attached to
+     * the logged-in account. If there are no active sessions, the server will
+     * attempt to look for a user with the same email address as the email
+     * received from the OAuth2 provider and attach the new session to the
+     * existing user. If no matching user is found - the server will create a new
+     * user.
+     *
+     * A user is limited to 10 active sessions at a time by default. [Learn more
+     * about session limits](/docs/authentication#limits).
+     *
+     *
+     * @param {string} provider
+     * @param {string} success
+     * @param {string} failure
+     * @param {string[]} scopes
+     * @throws {AppwriteException}
+     * @returns {void|string}
+     */
+    createOAuth2Session(provider: string, success?: string, failure?: string, scopes?: string[]): void | URL;
+    /**
+     * Create Phone session
+     *
+     * Sends the user an SMS with a secret key for creating a session. If the
+     * provided user ID has not be registered, a new user will be created. Use the
+     * returned user ID and secret and submit a request to the [PUT
+     * /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession)
+     * endpoint to complete the login process. The secret sent to the user's phone
+     * 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).
+     *
+     * @param {string} userId
+     * @param {string} phone
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createPhoneSession(userId: string, phone: string): Promise<Models.Token>;
+    /**
+     * Create Phone Session (confirmation)
+     *
+     * Use this endpoint to complete creating a session with SMS. Use the
+     * **userId** from the
+     * [createPhoneSession](/docs/client/account#accountCreatePhoneSession)
+     * endpoint and the **secret** received via SMS to successfully update and
+     * confirm the phone session.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
+    /**
+     * Get Session
+     *
+     * Use this endpoint to get a logged in user's session using a Session ID.
+     * Inputting 'current' will return the current session being used.
+     *
+     * @param {string} sessionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getSession(sessionId: string): Promise<Models.Session>;
+    /**
+     * Update OAuth Session (Refresh Tokens)
+     *
+     * Access tokens have limited lifespan and expire to mitigate security risks.
+     * If session was created using an OAuth provider, this route can be used to
+     * "refresh" the access token.
+     *
+     * @param {string} sessionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateSession(sessionId: string): Promise<Models.Session>;
+    /**
+     * Delete Session
+     *
+     * Use this endpoint to log out the currently logged in user from all their
+     * account sessions across all of their different devices. When using the
+     * Session ID argument, only the unique session ID provided is deleted.
+     *
+     *
+     * @param {string} sessionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteSession(sessionId: string): Promise<{}>;
+    /**
+     * Update Status
+     *
+     * Block the currently logged in user account. Behind the scene, the user
+     * record is not deleted but permanently blocked from any access. To
+     * completely delete a user, use the Users API instead.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateStatus<Preferences extends Models.Preferences>(): Promise<Models.Account<Preferences>>;
+    /**
+     * Create Email Verification
+     *
+     * Use this endpoint to send a verification message to your user email address
+     * to confirm they are the valid owners of that address. Both the **userId**
+     * and **secret** arguments will be passed as query parameters to the URL you
+     * have provided to be attached to the verification email. The provided URL
+     * should redirect the user back to your app and allow you to complete the
+     * verification process by verifying both the **userId** and **secret**
+     * parameters. Learn more about how to [complete the verification
+     * process](/docs/client/account#accountUpdateEmailVerification). The
+     * verification link sent to the user's email address is valid for 7 days.
+     *
+     * Please note that in order to avoid a [Redirect
+     * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
+     * the only valid redirect URLs are the ones from domains you have set when
+     * adding your platforms in the console interface.
+     *
+     *
+     * @param {string} url
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createVerification(url: string): Promise<Models.Token>;
+    /**
+     * Create Email Verification (confirmation)
+     *
+     * Use this endpoint to complete the user email verification process. Use both
+     * the **userId** and **secret** parameters that were attached to your app URL
+     * to verify the user email ownership. If confirmed this route will return a
+     * 200 status code.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateVerification(userId: string, secret: string): Promise<Models.Token>;
+    /**
+     * Create Phone Verification
+     *
+     * Use this endpoint to send a verification SMS to the currently logged in
+     * user. This endpoint is meant for use after updating a user's phone number
+     * using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone)
+     * endpoint. Learn more about how to [complete the verification
+     * process](/docs/client/account#accountUpdatePhoneVerification). The
+     * verification code sent to the user's phone number is valid for 15 minutes.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createPhoneVerification(): Promise<Models.Token>;
+    /**
+     * Create Phone Verification (confirmation)
+     *
+     * Use this endpoint to complete the user phone verification process. Use the
+     * **userId** and **secret** that were sent to your user's phone number to
+     * verify the user email ownership. If confirmed this route will return a 200
+     * status code.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePhoneVerification(userId: string, secret: string): Promise<Models.Token>;
+}

package/types/services/avatars.d.ts

@@ -0,0 +1,145 @@
+import { Service } from '../service';
+import { Client } from '../client';
+export declare class Avatars extends Service {
+    constructor(client: Client);
+    /**
+     * Get Browser Icon
+     *
+     * You can use this endpoint to show different browser icons to your users.
+     * The code argument receives the browser code as it appears in your user [GET
+     * /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
+     * width, height and quality arguments to change the output settings.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     * @param {string} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getBrowser(code: string, width?: number, height?: number, quality?: number): URL;
+    /**
+     * Get Credit Card Icon
+     *
+     * The credit card endpoint will return you the icon of the credit card
+     * provider you need. Use width, height and quality arguments to change the
+     * output settings.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     *
+     * @param {string} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getCreditCard(code: string, width?: number, height?: number, quality?: number): URL;
+    /**
+     * Get Favicon
+     *
+     * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
+     * website URL.
+     *
+     *
+     * @param {string} url
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getFavicon(url: string): URL;
+    /**
+     * Get Country Flag
+     *
+     * You can use this endpoint to show different country flags icons to your
+     * users. The code argument receives the 2 letter country code. Use width,
+     * height and quality arguments to change the output settings. Country codes
+     * follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     *
+     * @param {string} code
+     * @param {number} width
+     * @param {number} height
+     * @param {number} quality
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getFlag(code: string, width?: number, height?: number, quality?: number): URL;
+    /**
+     * Get Image from URL
+     *
+     * Use this endpoint to fetch a remote image URL and crop it to any image size
+     * you want. This endpoint is very useful if you need to crop and display
+     * remote images in your app or in case you want to make sure a 3rd party
+     * image is properly served using a TLS protocol.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 400x400px.
+     *
+     *
+     * @param {string} url
+     * @param {number} width
+     * @param {number} height
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getImage(url: string, width?: number, height?: number): URL;
+    /**
+     * Get User Initials
+     *
+     * Use this endpoint to show your user initials avatar icon on your website or
+     * app. By default, this route will try to print your logged-in user name or
+     * email initials. You can also overwrite the user name if you pass the 'name'
+     * parameter. If no name is given and no user is logged, an empty avatar will
+     * be returned.
+     *
+     * You can use the color and background params to change the avatar colors. By
+     * default, a random theme will be selected. The random theme will persist for
+     * the user's initials when reloading the same theme will always return for
+     * the same initials.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     *
+     *
+     * @param {string} name
+     * @param {number} width
+     * @param {number} height
+     * @param {string} background
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getInitials(name?: string, width?: number, height?: number, background?: string): URL;
+    /**
+     * Get QR Code
+     *
+     * Converts a given plain text to a QR code image. You can use the query
+     * parameters to change the size and style of the resulting image.
+     *
+     *
+     * @param {string} text
+     * @param {number} size
+     * @param {number} margin
+     * @param {boolean} download
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getQR(text: string, size?: number, margin?: number, download?: boolean): URL;
+}