@appwrite.io/console 1.4.5 → 1.4.7

package/src/services/projects.ts

@@ -23,6 +23,7 @@ export class Projects {
     /**
      * List projects
      *
+     * Get a list of all projects. You can use the query params to filter your results. 
      *
      * @param {string[]} queries
      * @param {string} search
@@ -55,6 +56,7 @@ export class Projects {
     /**
      * Create project
      *
+     * Create a new project. You can create a maximum of 100 projects per account. 
      *
      * @param {string} projectId
      * @param {string} name
@@ -140,6 +142,7 @@ export class Projects {
     /**
      * Get project
      *
+     * Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. 
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -168,6 +171,7 @@ export class Projects {
     /**
      * Update project
      *
+     * Update a project by its unique ID.
      *
      * @param {string} projectId
      * @param {string} name
@@ -239,6 +243,7 @@ export class Projects {
     /**
      * Delete project
      *
+     * Delete a project by its unique ID.
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -267,6 +272,7 @@ export class Projects {
     /**
      * 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
      * @param {Api} api
@@ -309,6 +315,7 @@ export class Projects {
     /**
      * 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
      * @param {boolean} status
@@ -344,6 +351,7 @@ export class Projects {
     /**
      * Update project authentication duration
      *
+     * Update how long sessions created within a project should stay active for.
      *
      * @param {string} projectId
      * @param {number} duration
@@ -379,6 +387,7 @@ export class Projects {
     /**
      * Update project users limit
      *
+     * Update the maximum number of users allowed in this project. Set to 0 for unlimited users. 
      *
      * @param {string} projectId
      * @param {number} limit
@@ -414,6 +423,7 @@ export class Projects {
     /**
      * 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
      * @param {number} limit
@@ -449,6 +459,7 @@ export class Projects {
     /**
      * 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
      * @param {boolean} userName
@@ -498,6 +509,7 @@ export class Projects {
     /**
      * 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
      * @param {object[]} numbers
@@ -533,6 +545,7 @@ export class Projects {
     /**
      * 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't use common and insecure passwords. 
      *
      * @param {string} projectId
      * @param {boolean} enabled
@@ -568,6 +581,7 @@ export class Projects {
     /**
      * 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
      * @param {number} limit
@@ -603,6 +617,7 @@ export class Projects {
     /**
      * 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
      * @param {boolean} enabled
@@ -638,6 +653,7 @@ export class Projects {
     /**
      * 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
      * @param {boolean} alerts
@@ -673,6 +689,7 @@ export class Projects {
     /**
      * 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
      * @param {AuthMethod} method
@@ -712,6 +729,7 @@ export class Projects {
     /**
      * Create JWT
      *
+     * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. 
      *
      * @param {string} projectId
      * @param {string[]} scopes
@@ -751,6 +769,7 @@ export class Projects {
     /**
      * List keys
      *
+     * Get a list of all API keys from the current project. 
      *
      * @param {string} projectId
      * @throws {AppwriteException}
@@ -779,6 +798,7 @@ export class Projects {
     /**
      * Create key
      *
+     * Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
      *
      * @param {string} projectId
      * @param {string} name
@@ -825,6 +845,7 @@ export class Projects {
     /**
      * Get key
      *
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
      *
      * @param {string} projectId
      * @param {string} keyId
@@ -857,6 +878,7 @@ export class Projects {
     /**
      * 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
      * @param {string} keyId
@@ -907,6 +929,7 @@ export class Projects {
     /**
      * 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
      * @param {string} keyId
@@ -939,6 +962,7 @@ export class Projects {
     /**
      * 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
      * @param {OAuthProvider} provider
@@ -986,6 +1010,7 @@ export class Projects {
     /**
      * 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
      * @throws {AppwriteException}
@@ -1014,6 +1039,7 @@ export class Projects {
     /**
      * 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
      * @param {PlatformType} type
@@ -1068,6 +1094,7 @@ export class Projects {
     /**
      * Get platform
      *
+     * Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations. 
      *
      * @param {string} projectId
      * @param {string} platformId
@@ -1100,6 +1127,7 @@ export class Projects {
     /**
      * Update platform
      *
+     * Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname. 
      *
      * @param {string} projectId
      * @param {string} platformId
@@ -1151,6 +1179,7 @@ export class Projects {
     /**
      * Delete platform
      *
+     * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project. 
      *
      * @param {string} projectId
      * @param {string} platformId
@@ -1183,6 +1212,7 @@ export class Projects {
     /**
      * 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
      * @param {ApiService} service
@@ -1225,6 +1255,7 @@ export class Projects {
     /**
      * 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
      * @param {boolean} status
@@ -1260,6 +1291,7 @@ export class Projects {
     /**
      * Update SMTP
      *
+     * Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails. 
      *
      * @param {string} projectId
      * @param {boolean} enabled
@@ -1327,6 +1359,7 @@ export class Projects {
     /**
      * Create SMTP test
      *
+     * Send a test email to verify SMTP configuration. 
      *
      * @param {string} projectId
      * @param {string[]} emails
@@ -1403,6 +1436,7 @@ export class Projects {
     /**
      * Update project team
      *
+     * Update the team ID of a project allowing for it to be transferred to another team.
      *
      * @param {string} projectId
      * @param {string} teamId
@@ -1438,6 +1472,7 @@ export class Projects {
     /**
      * 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
      * @param {EmailTemplateType} type
@@ -1474,6 +1509,7 @@ export class Projects {
     /**
      * 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
      * @param {EmailTemplateType} type
@@ -1484,9 +1520,9 @@ export class Projects {
      * @param {string} senderEmail
      * @param {string} replyTo
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Project>}
+     * @returns {Promise<Models.EmailTemplate>}
      */
-    async updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project> {
+    async updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.EmailTemplate> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }
@@ -1536,6 +1572,7 @@ export class Projects {
     /**
      * 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
      * @param {EmailTemplateType} type
@@ -1572,6 +1609,7 @@ export class Projects {
     /**
      * Get custom SMS template
      *
+     * Get a custom SMS template for the specified locale and type returning it&#039;s contents.
      *
      * @param {string} projectId
      * @param {SmsTemplateType} type
@@ -1608,6 +1646,7 @@ export class Projects {
     /**
      * 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
      * @param {SmsTemplateType} type
@@ -1651,6 +1690,7 @@ export class Projects {
     /**
      * 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
      * @param {SmsTemplateType} type
@@ -1687,6 +1727,7 @@ export class Projects {
     /**
      * 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
      * @throws {AppwriteException}
@@ -1715,6 +1756,7 @@ export class Projects {
     /**
      * 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
      * @param {string} name
@@ -1783,6 +1825,7 @@ export class Projects {
     /**
      * Get webhook
      *
+     * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. 
      *
      * @param {string} projectId
      * @param {string} webhookId
@@ -1815,6 +1858,7 @@ export class Projects {
     /**
      * 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
      * @param {string} webhookId
@@ -1887,6 +1931,7 @@ export class Projects {
     /**
      * Delete webhook
      *
+     * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. 
      *
      * @param {string} projectId
      * @param {string} webhookId
@@ -1919,6 +1964,7 @@ export class Projects {
     /**
      * 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
      * @param {string} webhookId

package/src/services/proxy.ts

@@ -147,6 +147,7 @@ export class Proxy {
     /**
      * 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
      * @throws {AppwriteException}

package/src/services/storage.ts

@@ -603,6 +603,8 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
     /**
      * Get storage usage stats
      *
+     * Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
+
      *
      * @param {StorageUsageRange} range
      * @throws {AppwriteException}
@@ -631,6 +633,8 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
     /**
      * Get bucket usage stats
      *
+     * Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
+
      *
      * @param {string} bucketId
      * @param {StorageUsageRange} range

package/src/services/users.ts

@@ -569,6 +569,8 @@ export class Users {
     /**
      * Get users usage stats
      *
+     * Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
+
      *
      * @param {UserUsageRange} range
      * @throws {AppwriteException}
@@ -869,9 +871,9 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @param {string} userId
      * @param {AuthenticatorType} type
      * @throws {AppwriteException}
-     * @returns {Promise<Models.User<Preferences>>}
+     * @returns {Promise<{}>}
      */
-    async deleteMfaAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType): Promise<Models.User<Preferences>> {
+    async deleteMfaAuthenticator(userId: string, type: AuthenticatorType): Promise<{}> {
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }

package/src/services/vcs.ts

@@ -12,6 +12,7 @@ export class Vcs {
     /**
      * List repositories
      *
+     * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} search
@@ -44,6 +45,7 @@ export class Vcs {
     /**
      * Create repository
      *
+     * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
      *
      * @param {string} installationId
      * @param {string} name
@@ -86,6 +88,7 @@ export class Vcs {
     /**
      * Get repository
      *
+     * Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -118,6 +121,8 @@ export class Vcs {
     /**
      * List repository branches
      *
+     * Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
+
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -150,6 +155,8 @@ export class Vcs {
     /**
      * Get files and directories of a VCS repository
      *
+     * Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
+
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -186,6 +193,7 @@ export class Vcs {
     /**
      * Detect runtime settings from source code
      *
+     * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} providerRepositoryId
@@ -222,6 +230,7 @@ export class Vcs {
     /**
      * Authorize external deployment
      *
+     * Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
      *
      * @param {string} installationId
      * @param {string} repositoryId
@@ -261,6 +270,8 @@ export class Vcs {
     /**
      * List installations
      *
+     * List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
+
      *
      * @param {string[]} queries
      * @param {string} search
@@ -293,6 +304,7 @@ export class Vcs {
     /**
      * Get installation
      *
+     * Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. 
      *
      * @param {string} installationId
      * @throws {AppwriteException}
@@ -321,6 +333,7 @@ export class Vcs {
     /**
      * Delete installation
      *
+     * Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
      *
      * @param {string} installationId
      * @throws {AppwriteException}

package/types/enums/message-priority.d.ts

@@ -0,0 +1,4 @@
+export declare enum MessagePriority {
+    Normal = "normal",
+    High = "high"
+}

package/types/index.d.ts

@@ -45,6 +45,7 @@ export { Runtime } from './enums/runtime';
 export { FunctionUsageRange } from './enums/function-usage-range';
 export { ExecutionMethod } from './enums/execution-method';
 export { Name } from './enums/name';
+export { MessagePriority } from './enums/message-priority';
 export { SmtpEncryption } from './enums/smtp-encryption';
 export { BillingPlan } from './enums/billing-plan';
 export { ProjectUsageRange } from './enums/project-usage-range';

package/types/models.d.ts

@@ -3097,7 +3097,7 @@ export declare namespace Models {
         /**
          * Resource ID.
          */
-        resourceId: string;
+        resourceId?: string;
         /**
          * Resource name.
          */
@@ -3106,6 +3106,10 @@ export declare namespace Models {
          * The value of this metric at the timestamp.
          */
         value: number;
+        /**
+         * The estimated value of this metric at the end of the period.
+         */
+        estimate?: number;
     };
     /**
      * UsageDatabases
@@ -3543,6 +3547,18 @@ export declare namespace Models {
          * Aggregated breakdown in totals of functions storage size (in bytes).
          */
         functionsStorageBreakdown: MetricBreakdown[];
+        /**
+         * Total aggregated number of phone auth.
+         */
+        authPhoneTotal: number;
+        /**
+         * Estimated total aggregated cost of phone auth.
+         */
+        authPhoneEstimate: number;
+        /**
+         * Aggregated breakdown in totals of phone auth by country.
+         */
+        authPhoneCountryBreakdown: MetricBreakdown[];
     };
     /**
      * Headers
@@ -5026,10 +5042,6 @@ export declare namespace Models {
          * Aggregated stats for function executions.
          */
         executions: Metric[];
-        /**
-         * Aggregated stats for phone authentication.
-         */
-        authPhone: Metric;
         /**
          * Aggregated stats for total users.
          */
@@ -5071,9 +5083,13 @@ export declare namespace Models {
          */
         storageTotal: number;
         /**
-         * Breakdown of phone authentication stats by country code.
+         * Aggregated stats for total phone authentication SMS.
+         */
+        authPhoneTotal: number;
+        /**
+         * Aggregated stats for estimated phone authentication SMS cost.
          */
-        authPhoneBreakdown: MetricBreakdown;
+        authPhoneEstimate: number;
         /**
          * Aggregated stats for each projects.
          */
@@ -5111,6 +5127,14 @@ export declare namespace Models {
          * Aggregated stats for number of documents.
          */
         storage: number;
+        /**
+         * Aggregated stats for phone authentication.
+         */
+        authPhoneTotal: number;
+        /**
+         * Aggregated stats for phone authentication estimated cost.
+         */
+        authPhoneEstimate: number;
     };
     /**
      * Aggregation team list