@appwrite.io/console 1.4.6 → 1.5.0

package/src/services/migrations.ts

@@ -12,6 +12,7 @@ export class Migrations {
     /**
      * List migrations
      *
+     * List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
      *
      * @param {string[]} queries
      * @param {string} search
@@ -44,6 +45,7 @@ export class Migrations {
     /**
      * Migrate Appwrite data
      *
+     * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project. 
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -96,6 +98,7 @@ export class Migrations {
     /**
      * Generate a report on Appwrite data
      *
+     * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -148,6 +151,7 @@ export class Migrations {
     /**
      * Migrate Firebase data
      *
+     * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project. 
      *
      * @param {string[]} resources
      * @param {string} serviceAccount
@@ -186,6 +190,7 @@ export class Migrations {
     /**
      * Generate a report on Firebase data
      *
+     * Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
      * @param {string[]} resources
      * @param {string} serviceAccount
@@ -224,6 +229,7 @@ export class Migrations {
     /**
      * Migrate NHost data
      *
+     * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project. 
      *
      * @param {string[]} resources
      * @param {string} subdomain
@@ -301,6 +307,7 @@ export class Migrations {
     /**
      * Generate a report on NHost Data
      *
+     * Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. 
      *
      * @param {string[]} resources
      * @param {string} subdomain
@@ -378,6 +385,7 @@ export class Migrations {
     /**
      * Migrate Supabase data
      *
+     * Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project. 
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -448,6 +456,7 @@ export class Migrations {
     /**
      * Generate a report on Supabase Data
      *
+     * Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. 
      *
      * @param {string[]} resources
      * @param {string} endpoint
@@ -518,6 +527,7 @@ export class Migrations {
     /**
      * Get migration
      *
+     * Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process. 
      *
      * @param {string} migrationId
      * @throws {AppwriteException}
@@ -546,6 +556,7 @@ export class Migrations {
     /**
      * Retry migration
      *
+     * Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
      *
      * @param {string} migrationId
      * @throws {AppwriteException}
@@ -574,6 +585,7 @@ export class Migrations {
     /**
      * Delete migration
      *
+     * Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history. 
      *
      * @param {string} migrationId
      * @throws {AppwriteException}

package/src/services/organizations.ts

@@ -46,7 +46,8 @@ export class Organizations {
     /**
      * Create Organization
      *
-     * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
+     * Create a new organization.
+
      *
      * @param {string} organizationId
      * @param {string} name
@@ -100,7 +101,7 @@ export class Organizations {
     /**
      * Delete team
      *
-     * Delete a team using its ID. Only team members with the owner role can delete the team.
+     * Delete an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -129,6 +130,7 @@ export class Organizations {
     /**
      * List aggregations
      *
+     * Get a list of all aggregations for an organization.
      *
      * @param {string} organizationId
      * @param {string[]} queries
@@ -161,6 +163,7 @@ export class Organizations {
     /**
      * Get invoice
      *
+     * Get a specific aggregation using it's aggregation ID.
      *
      * @param {string} organizationId
      * @param {string} aggregationId
@@ -193,6 +196,7 @@ export class Organizations {
     /**
      * Set team's billing address
      *
+     * Set a billing address for an organization.
      *
      * @param {string} organizationId
      * @param {string} billingAddressId
@@ -228,6 +232,7 @@ export class Organizations {
     /**
      * Delete team's billing address
      *
+     * Delete a team's billing address.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -256,6 +261,7 @@ export class Organizations {
     /**
      * Get billing address
      *
+     * Get a billing address using it's ID.
      *
      * @param {string} organizationId
      * @param {string} billingAddressId
@@ -288,6 +294,7 @@ export class Organizations {
     /**
      * Set team's billing email
      *
+     * Set the current billing email for the organization.
      *
      * @param {string} organizationId
      * @param {string} billingEmail
@@ -323,6 +330,7 @@ export class Organizations {
     /**
      * Update organization budget
      *
+     * Update the budget limit for an organization.
      *
      * @param {string} organizationId
      * @param {number} budget
@@ -362,6 +370,8 @@ export class Organizations {
     /**
      * List credits
      *
+     * List all credits for an organization.
+
      *
      * @param {string} organizationId
      * @param {string[]} queries
@@ -394,6 +404,7 @@ export class Organizations {
     /**
      * Add credits from coupon
      *
+     * Add credit to an organization using a coupon.
      *
      * @param {string} organizationId
      * @param {string} couponId
@@ -429,6 +440,7 @@ export class Organizations {
     /**
      * Get credit details
      *
+     * Get credit details.
      *
      * @param {string} organizationId
      * @param {string} creditId
@@ -461,6 +473,7 @@ export class Organizations {
     /**
      * List invoices
      *
+     * List all invoices for an organization.
      *
      * @param {string} organizationId
      * @param {string[]} queries
@@ -493,6 +506,7 @@ export class Organizations {
     /**
      * Get invoice
      *
+     * Get an invoice by its unique ID.
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -525,6 +539,7 @@ export class Organizations {
     /**
      * Download invoice in PDF
      *
+     * Download invoice in PDF
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -557,6 +572,7 @@ export class Organizations {
     /**
      * Initiate payment for failed invoice to pay live from console
      *
+     * Initiate payment for failed invoice to pay live from console
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -596,6 +612,7 @@ export class Organizations {
     /**
      * View invoice in PDF
      *
+     * View invoice in PDF
      *
      * @param {string} organizationId
      * @param {string} invoiceId
@@ -628,6 +645,7 @@ export class Organizations {
     /**
      * Set team's payment method
      *
+     * Set a organization's default payment method.
      *
      * @param {string} organizationId
      * @param {string} paymentMethodId
@@ -663,6 +681,7 @@ export class Organizations {
     /**
      * Delete team's default payment method
      *
+     * Delete the default payment method for an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -691,6 +710,8 @@ export class Organizations {
     /**
      * Set team's backup payment method
      *
+     * Set an organization's backup payment method.
+
      *
      * @param {string} organizationId
      * @param {string} paymentMethodId
@@ -726,6 +747,7 @@ export class Organizations {
     /**
      * Delete team's backup payment method
      *
+     * Delete a backup payment method for an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -754,6 +776,7 @@ export class Organizations {
     /**
      * Get payment method
      *
+     * Get an organization's payment method using it's payment method ID.
      *
      * @param {string} organizationId
      * @param {string} paymentMethodId
@@ -786,6 +809,7 @@ export class Organizations {
     /**
      * Get organization billing plan details
      *
+     * Get the details of the current billing plan for an organization.
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -814,6 +838,7 @@ export class Organizations {
     /**
      * Update organization billing plan
      *
+     * Update the billing plan for an organization.
      *
      * @param {string} organizationId
      * @param {BillingPlan} billingPlan
@@ -857,6 +882,7 @@ export class Organizations {
     /**
      * Get Scopes
      *
+     * Get Scopes
      *
      * @param {string} organizationId
      * @throws {AppwriteException}
@@ -885,6 +911,7 @@ export class Organizations {
     /**
      * Set team's tax Id
      *
+     * Set an organization's billing tax ID.
      *
      * @param {string} organizationId
      * @param {string} taxId
@@ -920,6 +947,7 @@ export class Organizations {
     /**
      * Get team's usage data
      *
+     * Get the usage data for an organization.
      *
      * @param {string} organizationId
      * @param {string} startDate

package/src/services/project.ts

@@ -13,6 +13,7 @@ export class Project {
     /**
      * Get project usage stats
      *
+     * Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
      *
      * @param {string} startDate
      * @param {string} endDate

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