@appwrite.io/console 1.5.2 → 1.7.0

package/types/services/projects.d.ts

@@ -15,8 +15,6 @@ export declare class Projects {
     client: Client;
     constructor(client: Client);
     /**
-     * List projects
-     *
      * Get a list of all projects. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -26,8 +24,6 @@ export declare class Projects {
      */
     list(queries?: string[], search?: string): Promise<Models.ProjectList>;
     /**
-     * Create project
-     *
      * Create a new project. You can create a maximum of 100 projects per account.
      *
      * @param {string} projectId
@@ -48,8 +44,6 @@ export declare class Projects {
      */
     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
-     *
      * Get a project by its unique ID. This endpoint allows you to retrieve the project&#039;s details, including its name, description, team, region, and other metadata.
      *
      * @param {string} projectId
@@ -58,8 +52,6 @@ export declare class Projects {
      */
     get(projectId: string): Promise<Models.Project>;
     /**
-     * Update project
-     *
      * Update a project by its unique ID.
      *
      * @param {string} projectId
@@ -78,8 +70,6 @@ export declare class Projects {
      */
     update(projectId: string, name: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
     /**
-     * Delete project
-     *
      * Delete a project by its unique ID.
      *
      * @param {string} projectId
@@ -88,8 +78,6 @@ export declare class Projects {
      */
     delete(projectId: string): Promise<{}>;
     /**
-     * Update API status
-     *
      * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
      *
      * @param {string} projectId
@@ -100,8 +88,6 @@ export declare class Projects {
      */
     updateApiStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
     /**
-     * Update all API status
-     *
      * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
      *
      * @param {string} projectId
@@ -111,8 +97,6 @@ export declare class Projects {
      */
     updateApiStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
     /**
-     * Update project authentication duration
-     *
      * Update how long sessions created within a project should stay active for.
      *
      * @param {string} projectId
@@ -122,8 +106,6 @@ export declare class Projects {
      */
     updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
     /**
-     * Update project users limit
-     *
      * Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
      *
      * @param {string} projectId
@@ -133,8 +115,6 @@ export declare class Projects {
      */
     updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
     /**
-     * Update project user sessions limit
-     *
      * Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
      *
      * @param {string} projectId
@@ -144,8 +124,6 @@ export declare class Projects {
      */
     updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
     /**
-     * Update project memberships privacy attributes
-     *
      * Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
      *
      * @param {string} projectId
@@ -157,8 +135,6 @@ export declare class Projects {
      */
     updateMembershipsPrivacy(projectId: string, userName: boolean, userEmail: boolean, mfa: boolean): Promise<Models.Project>;
     /**
-     * Update the mock numbers for the project
-     *
      * Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
      *
      * @param {string} projectId
@@ -168,8 +144,6 @@ export declare class Projects {
      */
     updateMockNumbers(projectId: string, numbers: object[]): Promise<Models.Project>;
     /**
-     * Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password
-     *
      * Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don&#039;t use common and insecure passwords.
      *
      * @param {string} projectId
@@ -179,8 +153,6 @@ export declare class Projects {
      */
     updateAuthPasswordDictionary(projectId: string, enabled: boolean): Promise<Models.Project>;
     /**
-     * Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.
-     *
      * Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
      *
      * @param {string} projectId
@@ -190,8 +162,6 @@ export declare class Projects {
      */
     updateAuthPasswordHistory(projectId: string, limit: number): Promise<Models.Project>;
     /**
-     * Enable or disable checking user passwords for similarity with their personal data.
-     *
      * Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
      *
      * @param {string} projectId
@@ -201,8 +171,6 @@ export declare class Projects {
      */
     updatePersonalDataCheck(projectId: string, enabled: boolean): Promise<Models.Project>;
     /**
-     * Update project sessions emails
-     *
      * Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
      *
      * @param {string} projectId
@@ -212,8 +180,6 @@ export declare class Projects {
      */
     updateSessionAlerts(projectId: string, alerts: boolean): Promise<Models.Project>;
     /**
-     * Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.
-     *
      * Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
      *
      * @param {string} projectId
@@ -224,8 +190,54 @@ export declare class Projects {
      */
     updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
     /**
-     * Create JWT
+     * List all the project\&#039;s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.&#039;
+     *
+     * @param {string} projectId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKeyList>}
+     */
+    listDevKeys(projectId: string, queries?: string[]): Promise<Models.DevKeyList>;
+    /**
+     * Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
+     *
+     * @param {string} projectId
+     * @param {string} name
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    createDevKey(projectId: string, name: string, expire: string): Promise<Models.DevKey>;
+    /**
+     * Get a project\&#039;s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    getDevKey(projectId: string, keyId: string): Promise<Models.DevKey>;
+    /**
+     * Update a project\&#039;s dev key by its unique ID. Use this endpoint to update a project\&#039;s dev key name or expiration time.&#039;
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @param {string} name
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    updateDevKey(projectId: string, keyId: string, name: string, expire: string): Promise<Models.DevKey>;
+    /**
+     * Delete a project\&#039;s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
      *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteDevKey(projectId: string, keyId: string): Promise<{}>;
+    /**
      * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
      *
      * @param {string} projectId
@@ -236,8 +248,6 @@ export declare class Projects {
      */
     createJWT(projectId: string, scopes: string[], duration?: number): Promise<Models.Jwt>;
     /**
-     * List keys
-     *
      * Get a list of all API keys from the current project.
      *
      * @param {string} projectId
@@ -246,8 +256,6 @@ export declare class Projects {
      */
     listKeys(projectId: string): Promise<Models.KeyList>;
     /**
-     * Create key
-     *
      * Create a new API key. It&#039;s recommended to have multiple API keys with strict scopes for separate functions within your project.
      *
      * @param {string} projectId
@@ -259,8 +267,6 @@ export declare class Projects {
      */
     createKey(projectId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
     /**
-     * Get key
-     *
      * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it&#039;s scopes.
      *
      * @param {string} projectId
@@ -270,8 +276,6 @@ export declare class Projects {
      */
     getKey(projectId: string, keyId: string): Promise<Models.Key>;
     /**
-     * Update key
-     *
      * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
      *
      * @param {string} projectId
@@ -284,8 +288,6 @@ export declare class Projects {
      */
     updateKey(projectId: string, keyId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
     /**
-     * Delete key
-     *
      * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
      *
      * @param {string} projectId
@@ -295,8 +297,6 @@ export declare class Projects {
      */
     deleteKey(projectId: string, keyId: string): Promise<{}>;
     /**
-     * Update project OAuth2
-     *
      * Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
      *
      * @param {string} projectId
@@ -309,8 +309,6 @@ export declare class Projects {
      */
     updateOAuth2(projectId: string, provider: OAuthProvider, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
     /**
-     * List platforms
-     *
      * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
      *
      * @param {string} projectId
@@ -319,8 +317,6 @@ export declare class Projects {
      */
     listPlatforms(projectId: string): Promise<Models.PlatformList>;
     /**
-     * Create platform
-     *
      * Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
      *
      * @param {string} projectId
@@ -334,8 +330,6 @@ export declare class Projects {
      */
     createPlatform(projectId: string, type: PlatformType, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
-     * Get platform
-     *
      * Get a platform by its unique ID. This endpoint returns the platform&#039;s details, including its name, type, and key configurations.
      *
      * @param {string} projectId
@@ -345,8 +339,6 @@ export declare class Projects {
      */
     getPlatform(projectId: string, platformId: string): Promise<Models.Platform>;
     /**
-     * Update platform
-     *
      * Update a platform by its unique ID. Use this endpoint to update the platform&#039;s name, key, platform store ID, or hostname.
      *
      * @param {string} projectId
@@ -360,8 +352,6 @@ export declare class Projects {
      */
     updatePlatform(projectId: string, platformId: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
-     * Delete platform
-     *
      * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
      *
      * @param {string} projectId
@@ -371,8 +361,6 @@ export declare class Projects {
      */
     deletePlatform(projectId: string, platformId: string): Promise<{}>;
     /**
-     * Update service status
-     *
      * Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
      *
      * @param {string} projectId
@@ -383,8 +371,6 @@ export declare class Projects {
      */
     updateServiceStatus(projectId: string, service: ApiService, status: boolean): Promise<Models.Project>;
     /**
-     * Update all service status
-     *
      * Update the status of all services. Use this endpoint to enable or disable all optional services at once.
      *
      * @param {string} projectId
@@ -394,8 +380,6 @@ export declare class Projects {
      */
     updateServiceStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
     /**
-     * Update SMTP
-     *
      * Update the SMTP configuration for your project. Use this endpoint to configure your project&#039;s SMTP provider with your custom settings for sending transactional emails.
      *
      * @param {string} projectId
@@ -413,8 +397,6 @@ export declare class Projects {
      */
     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
-     *
      * Send a test email to verify SMTP configuration.
      *
      * @param {string} projectId
@@ -432,8 +414,6 @@ export declare class Projects {
      */
     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
-     *
      * Update the team ID of a project allowing for it to be transferred to another team.
      *
      * @param {string} projectId
@@ -443,8 +423,6 @@ export declare class Projects {
      */
     updateTeam(projectId: string, teamId: string): Promise<Models.Project>;
     /**
-     * Get custom email template
-     *
      * Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
      *
      * @param {string} projectId
@@ -455,8 +433,6 @@ export declare class Projects {
      */
     getEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
     /**
-     * Update custom email templates
-     *
      * Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
      *
      * @param {string} projectId
@@ -472,8 +448,6 @@ export declare class Projects {
      */
     updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.EmailTemplate>;
     /**
-     * Reset custom email template
-     *
      * Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
      *
      * @param {string} projectId
@@ -484,8 +458,6 @@ export declare class Projects {
      */
     deleteEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
     /**
-     * Get custom SMS template
-     *
      * Get a custom SMS template for the specified locale and type returning it&#039;s contents.
      *
      * @param {string} projectId
@@ -496,8 +468,6 @@ export declare class Projects {
      */
     getSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
     /**
-     * Update custom SMS template
-     *
      * Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
      *
      * @param {string} projectId
@@ -509,8 +479,6 @@ export declare class Projects {
      */
     updateSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
     /**
-     * Reset custom SMS template
-     *
      * Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
      *
      * @param {string} projectId
@@ -521,8 +489,6 @@ export declare class Projects {
      */
     deleteSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
     /**
-     * List webhooks
-     *
      * Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
      *
      * @param {string} projectId
@@ -531,8 +497,6 @@ export declare class Projects {
      */
     listWebhooks(projectId: string): Promise<Models.WebhookList>;
     /**
-     * Create webhook
-     *
      * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
      *
      * @param {string} projectId
@@ -548,8 +512,6 @@ export declare class Projects {
      */
     createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
-     * Get webhook
-     *
      * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
      *
      * @param {string} projectId
@@ -559,8 +521,6 @@ export declare class Projects {
      */
     getWebhook(projectId: string, webhookId: string): Promise<Models.Webhook>;
     /**
-     * Update webhook
-     *
      * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
      *
      * @param {string} projectId
@@ -577,8 +537,6 @@ export declare class Projects {
      */
     updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
-     * Delete webhook
-     *
      * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
      *
      * @param {string} projectId
@@ -588,8 +546,6 @@ export declare class Projects {
      */
     deleteWebhook(projectId: string, webhookId: string): Promise<{}>;
     /**
-     * Update webhook signature key
-     *
      * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
      *
      * @param {string} projectId

package/types/services/proxy.d.ts

@@ -1,12 +1,10 @@
 import { Client } from '../client';
 import type { Models } from '../models';
-import { ResourceType } from '../enums/resource-type';
+import { StatusCode } from '../enums/status-code';
 export declare class Proxy {
     client: Client;
     constructor(client: Client);
     /**
-     * List rules
-     *
      * Get a list of all the proxy rules. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -16,20 +14,44 @@ export declare class Proxy {
      */
     listRules(queries?: string[], search?: string): Promise<Models.ProxyRuleList>;
     /**
-     * Create rule
+     * Create a new proxy rule for serving Appwrite&#039;s API on custom domain.
      *
-     * Create a new proxy rule.
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createAPIRule(domain: string): Promise<Models.ProxyRule>;
+    /**
+     * Create a new proxy rule for executing Appwrite Function on custom domain.
      *
      * @param {string} domain
-     * @param {ResourceType} resourceType
-     * @param {string} resourceId
+     * @param {string} functionId
+     * @param {string} branch
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    createRule(domain: string, resourceType: ResourceType, resourceId?: string): Promise<Models.ProxyRule>;
+    createFunctionRule(domain: string, functionId: string, branch?: string): Promise<Models.ProxyRule>;
     /**
-     * Get rule
+     * Create a new proxy rule for to redirect from custom domain to another domain.
      *
+     * @param {string} domain
+     * @param {string} url
+     * @param {StatusCode} statusCode
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createRedirectRule(domain: string, url: string, statusCode: StatusCode): Promise<Models.ProxyRule>;
+    /**
+     * Create a new proxy rule for serving Appwrite Site on custom domain.
+     *
+     * @param {string} domain
+     * @param {string} siteId
+     * @param {string} branch
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createSiteRule(domain: string, siteId: string, branch?: string): Promise<Models.ProxyRule>;
+    /**
      * Get a proxy rule by its unique ID.
      *
      * @param {string} ruleId
@@ -38,8 +60,6 @@ export declare class Proxy {
      */
     getRule(ruleId: string): Promise<Models.ProxyRule>;
     /**
-     * Delete rule
-     *
      * Delete a proxy rule by its unique ID.
      *
      * @param {string} ruleId
@@ -48,8 +68,6 @@ export declare class Proxy {
      */
     deleteRule(ruleId: string): Promise<{}>;
     /**
-     * Update rule verification status
-     *
      * Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.
      *
      * @param {string} ruleId