@appwrite.io/console 0.6.0-rc.1 → 0.6.0-rc.10

package/types/services/projects.d.ts

@@ -1,6 +1,16 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Region } from '../enums/region';
+import { AuthMethod } from '../enums/auth-method';
+import { OAuthProvider } from '../enums/o-auth-provider';
+import { PlatformType } from '../enums/platform-type';
+import { APIService } from '../enums/a-p-i-service';
+import { SMTPSecure } from '../enums/s-m-t-p-secure';
+import { EmailTemplateType } from '../enums/email-template-type';
+import { EmailTemplateLocale } from '../enums/email-template-locale';
+import { SMSTemplateType } from '../enums/s-m-s-template-type';
+import { SMSTemplateLocale } from '../enums/s-m-s-template-locale';
 export declare class Projects extends Service {
     constructor(client: Client);
     /**
@@ -20,7 +30,7 @@ export declare class Projects extends Service {
      * @param {string} projectId
      * @param {string} name
      * @param {string} teamId
-     * @param {string} region
+     * @param {Region} region
      * @param {string} description
      * @param {string} logo
      * @param {string} url
@@ -33,7 +43,7 @@ export declare class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    create(projectId: string, name: string, teamId: string, region?: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
+    create(projectId: string, name: string, teamId: string, region?: Region, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
     /**
      * Get project
      *
@@ -101,16 +111,6 @@ export declare class Projects extends Service {
      * @returns {Promise}
     */
     updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
-    /**
-     * Update Project user minimum sessions factors
-     *
-     *
-     * @param {string} projectId
-     * @param {number} factors
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    updateAuthMfaFactors(projectId: string, factors: number): Promise<Models.Project>;
     /**
      * Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password
      *
@@ -146,12 +146,12 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} method
+     * @param {AuthMethod} method
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateAuthStatus(projectId: string, method: string, status: boolean): Promise<Models.Project>;
+    updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
     /**
      * List keys
      *
@@ -211,14 +211,14 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} provider
+     * @param {OAuthProvider} provider
      * @param {string} appId
      * @param {string} secret
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateOAuth2(projectId: string, provider: string, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
+    updateOAuth2(projectId: string, provider: OAuthProvider, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
     /**
      * List platforms
      *
@@ -233,7 +233,7 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} type
+     * @param {PlatformType} type
      * @param {string} name
      * @param {string} key
      * @param {string} store
@@ -241,7 +241,7 @@ export declare class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createPlatform(projectId: string, type: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
+    createPlatform(projectId: string, type: PlatformType, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
      * Get platform
      *
@@ -281,12 +281,12 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} service
+     * @param {APIService} service
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateServiceStatus(projectId: string, service: string, status: boolean): Promise<Models.Project>;
+    updateServiceStatus(projectId: string, service: APIService, status: boolean): Promise<Models.Project>;
     /**
      * Update all service status
      *
@@ -298,7 +298,7 @@ export declare class Projects extends Service {
     */
     updateServiceStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
     /**
-     * Update SMTP configuration
+     * Update SMTP
      *
      *
      * @param {string} projectId
@@ -310,11 +310,29 @@ export declare class Projects extends Service {
      * @param {number} port
      * @param {string} username
      * @param {string} password
-     * @param {string} secure
+     * @param {SMTPSecure} secure
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
+    /**
+     * Create SMTP test
+     *
+     *
+     * @param {string} projectId
+     * @param {string[]} emails
+     * @param {string} senderName
+     * @param {string} senderEmail
+     * @param {string} host
+     * @param {string} replyTo
+     * @param {number} port
+     * @param {string} username
+     * @param {string} password
+     * @param {SMTPSecure} secure
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSmtpConfiguration(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: string): Promise<Models.Project>;
+    createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
     /**
      * Update Project Team
      *
@@ -330,19 +348,19 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getEmailTemplate(projectId: string, type: string, locale: string): Promise<Models.EmailTemplate>;
+    getEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
     /**
      * Update custom email templates
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @param {string} subject
      * @param {string} message
      * @param {string} senderName
@@ -351,62 +369,52 @@ export declare class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateEmailTemplate(projectId: string, type: string, locale: string, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project>;
+    updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project>;
     /**
      * Reset custom email template
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteEmailTemplate(projectId: string, type: string, locale: string): Promise<Models.EmailTemplate>;
+    deleteEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
     /**
      * Get custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {SMSTemplateType} type
+     * @param {SMSTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getSmsTemplate(projectId: string, type: string, locale: string): Promise<Models.SmsTemplate>;
+    getSmsTemplate(projectId: string, type: SMSTemplateType, locale: SMSTemplateLocale): Promise<Models.SmsTemplate>;
     /**
      * Update custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {SMSTemplateType} type
+     * @param {SMSTemplateLocale} locale
      * @param {string} message
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSmsTemplate(projectId: string, type: string, locale: string, message: string): Promise<Models.SmsTemplate>;
+    updateSmsTemplate(projectId: string, type: SMSTemplateType, locale: SMSTemplateLocale, message: string): Promise<Models.SmsTemplate>;
     /**
      * Reset custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {string} type
-     * @param {string} locale
+     * @param {SMSTemplateType} type
+     * @param {SMSTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteSmsTemplate(projectId: string, type: string, locale: string): Promise<Models.SmsTemplate>;
-    /**
-     * Get usage stats for a project
-     *
-     *
-     * @param {string} projectId
-     * @param {string} range
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    getUsage(projectId: string, range?: string): Promise<Models.UsageProject>;
+    deleteSmsTemplate(projectId: string, type: SMSTemplateType, locale: SMSTemplateLocale): Promise<Models.SmsTemplate>;
     /**
      * List webhooks
      *
@@ -425,12 +433,13 @@ export declare class Projects extends Service {
      * @param {string[]} events
      * @param {string} url
      * @param {boolean} security
+     * @param {boolean} enabled
      * @param {string} httpUser
      * @param {string} httpPass
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
+    createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
      * Get webhook
      *
@@ -451,12 +460,13 @@ export declare class Projects extends Service {
      * @param {string[]} events
      * @param {string} url
      * @param {boolean} security
+     * @param {boolean} enabled
      * @param {string} httpUser
      * @param {string} httpPass
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
+    updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
      * Delete webhook
      *

package/types/services/proxy.d.ts

@@ -1,6 +1,7 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { ResourceType } from '../enums/resource-type';
 export declare class Proxy extends Service {
     constructor(client: Client);
     /**
@@ -21,12 +22,12 @@ export declare class Proxy extends Service {
      * Create a new proxy rule.
      *
      * @param {string} domain
-     * @param {string} resourceType
+     * @param {ResourceType} resourceType
      * @param {string} resourceId
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createRule(domain: string, resourceType: string, resourceId?: string): Promise<Models.ProxyRule>;
+    createRule(domain: string, resourceType: ResourceType, resourceId?: string): Promise<Models.ProxyRule>;
     /**
      * Get Rule
      *

package/types/services/storage.d.ts

@@ -2,6 +2,10 @@ import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress } from '../client';
+import { Compression } from '../enums/compression';
+import { ImageGravity } from '../enums/image-gravity';
+import { ImageFormat } from '../enums/image-format';
+import { StorageUsageRange } from '../enums/storage-usage-range';
 export declare class Storage extends Service {
     constructor(client: Client);
     /**
@@ -28,13 +32,13 @@ export declare class Storage extends Service {
      * @param {boolean} enabled
      * @param {number} maximumFileSize
      * @param {string[]} allowedFileExtensions
-     * @param {string} compression
+     * @param {Compression} compression
      * @param {boolean} encryption
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
     /**
      * Get bucket
      *
@@ -58,13 +62,13 @@ export declare class Storage extends Service {
      * @param {boolean} enabled
      * @param {number} maximumFileSize
      * @param {string[]} allowedFileExtensions
-     * @param {string} compression
+     * @param {Compression} compression
      * @param {boolean} encryption
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
     /**
      * Delete bucket
      *
@@ -182,7 +186,7 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @param {number} width
      * @param {number} height
-     * @param {string} gravity
+     * @param {ImageGravity} gravity
      * @param {number} quality
      * @param {number} borderWidth
      * @param {string} borderColor
@@ -190,11 +194,11 @@ export declare class Storage extends Service {
      * @param {number} opacity
      * @param {number} rotation
      * @param {string} background
-     * @param {string} output
+     * @param {ImageFormat} output
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): URL;
+    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat): URL;
     /**
      * Get file for view
      *
@@ -212,19 +216,19 @@ export declare class Storage extends Service {
      * Get usage stats for storage
      *
      *
-     * @param {string} range
+     * @param {StorageUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string): Promise<Models.UsageStorage>;
+    getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage>;
     /**
-     * Get usage stats for a storage bucket
+     * Get usage stats for storage bucket
      *
      *
      * @param {string} bucketId
-     * @param {string} range
+     * @param {StorageUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getBucketUsage(bucketId: string, range?: string): Promise<Models.UsageBuckets>;
+    getBucketUsage(bucketId: string, range?: StorageUsageRange): Promise<Models.UsageBuckets>;
 }

package/types/services/users.d.ts

@@ -1,6 +1,10 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { PasswordHash } from '../enums/password-hash';
+import { UserUsageRange } from '../enums/user-usage-range';
+import { Type } from '../enums/type';
+import { MessagingProviderType } from '../enums/messaging-provider-type';
 export declare class Users extends Service {
     constructor(client: Client);
     /**
@@ -66,14 +70,14 @@ export declare class Users extends Service {
      *
      * Get identities for all users.
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listIdentities(queries?: string, search?: string): Promise<Models.IdentityList>;
+    listIdentities(queries?: string[], search?: string): Promise<Models.IdentityList>;
     /**
-     * Delete Identity
+     * Delete identity
      *
      * Delete an identity by its unique ID.
      *
@@ -166,22 +170,21 @@ export declare class Users extends Service {
      * @param {string} userId
      * @param {string} email
      * @param {string} password
-     * @param {string} passwordVersion
+     * @param {PasswordHash} 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>>;
+    createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Get usage stats for the users API
      *
      *
-     * @param {string} range
-     * @param {string} provider
+     * @param {UserUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string, provider?: string): Promise<Models.UsageUsers>;
+    getUsage(range?: UserUsageRange): Promise<Models.UsageUsers>;
     /**
      * Get user
      *
@@ -255,6 +258,36 @@ export declare class Users extends Service {
      * @returns {Promise}
     */
     listMemberships(userId: string): Promise<Models.MembershipList>;
+    /**
+     * Update MFA
+     *
+     *
+     * @param {string} userId
+     * @param {boolean} mfa
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateMfa<Preferences extends Models.Preferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
+    /**
+     * List Factors
+     *
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listFactors(userId: string): Promise<Models.MfaFactors>;
+    /**
+     * Delete Authenticator
+     *
+     *
+     * @param {string} userId
+     * @param {Type} type
+     * @param {string} otp
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: Type, otp: string): Promise<Models.User<Preferences>>;
     /**
      * Update name
      *
@@ -321,6 +354,21 @@ export declare class Users extends Service {
      * @returns {Promise}
     */
     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.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSession(userId: string): Promise<Models.Session>;
     /**
      * Delete user sessions
      *
@@ -359,25 +407,25 @@ export declare class Users extends Service {
      *
      *
      * @param {string} userId
-     * @param {string} queries
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listTargets(userId: string, queries?: string): Promise<Models.TargetList>;
+    listTargets(userId: string, queries?: string[]): Promise<Models.TargetList>;
     /**
      * Create User Target
      *
      *
      * @param {string} userId
      * @param {string} targetId
-     * @param {string} providerType
+     * @param {MessagingProviderType} providerType
      * @param {string} identifier
      * @param {string} providerId
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createTarget(userId: string, targetId: string, providerType: string, identifier: string, providerId?: string, name?: string): Promise<Models.Target>;
+    createTarget(userId: string, targetId: string, providerType: MessagingProviderType, identifier: string, providerId?: string, name?: string): Promise<Models.Target>;
     /**
      * Get User Target
      *
@@ -411,6 +459,22 @@ export declare class Users extends Service {
      * @returns {Promise}
     */
     deleteTarget(userId: string, targetId: string): Promise<{}>;
+    /**
+     * Create token
+     *
+     * Returns a token 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/custom](https://appwrite.io/docs/references/cloud/client-web/account#updateCustomSession)
+     * endpoint to complete the login process.
+     *
+     * @param {string} userId
+     * @param {number} length
+     * @param {number} expire
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createToken(userId: string, length?: number, expire?: number): Promise<Models.Token>;
     /**
      * Update email verification
      *

package/docs/examples/messaging/create-email-message.md

@@ -1,18 +0,0 @@
-import { Client, Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.createEmailMessage('[MESSAGE_ID]', '[SUBJECT]', '[CONTENT]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/projects/update-smtp-configuration.md

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