diff --git a/README.md b/README.md index 575083b..eebb064 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console"; To install with a CDN (content delivery network) add the following scripts to the bottom of your tag, but before you use any Appwrite services: ```html - + ``` diff --git a/docs/examples/health/get-queue-usage-count.md b/docs/examples/health/get-queue-usage-count.md new file mode 100644 index 0000000..b576acf --- /dev/null +++ b/docs/examples/health/get-queue-usage-count.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject(''); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueUsageCount( + null // threshold (optional) +); + +console.log(result); diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md index fe8eac6..9a4fd42 100644 --- a/docs/examples/messaging/create-push.md +++ b/docs/examples/messaging/create-push.md @@ -1,4 +1,4 @@ -import { Client, Messaging } from "@appwrite.io/console"; +import { Client, Messaging, MessagePriority } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint @@ -8,8 +8,8 @@ const messaging = new Messaging(client); const result = await messaging.createPush( '', // messageId - '', // title - '<BODY>', // body + '<TITLE>', // title (optional) + '<BODY>', // body (optional) [], // topics (optional) [], // users (optional) [], // targets (optional) @@ -20,9 +20,12 @@ const result = await messaging.createPush( '<SOUND>', // sound (optional) '<COLOR>', // color (optional) '<TAG>', // tag (optional) - '<BADGE>', // badge (optional) + null, // badge (optional) false, // draft (optional) - '' // scheduledAt (optional) + '', // scheduledAt (optional) + false, // contentAvailable (optional) + false, // critical (optional) + MessagePriority.Normal // priority (optional) ); console.log(result); diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md index 9fbb230..fa2220d 100644 --- a/docs/examples/messaging/update-push.md +++ b/docs/examples/messaging/update-push.md @@ -1,4 +1,4 @@ -import { Client, Messaging } from "@appwrite.io/console"; +import { Client, Messaging, MessagePriority } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint @@ -22,7 +22,10 @@ const result = await messaging.updatePush( '<TAG>', // tag (optional) null, // badge (optional) false, // draft (optional) - '' // scheduledAt (optional) + '', // scheduledAt (optional) + false, // contentAvailable (optional) + false, // critical (optional) + MessagePriority.Normal // priority (optional) ); console.log(result); diff --git a/package.json b/package.json index f3966e0..b5c3ac0 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@appwrite.io/console", "homepage": "https://appwrite.io/support", "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API", - "version": "1.4.6", + "version": "1.4.7", "license": "BSD-3-Clause", "main": "dist/cjs/sdk.js", "exports": { diff --git a/src/client.ts b/src/client.ts index 6166a2d..acfbad3 100644 --- a/src/client.ts +++ b/src/client.ts @@ -316,7 +316,7 @@ class Client { 'x-sdk-name': 'Console', 'x-sdk-platform': 'console', 'x-sdk-language': 'web', - 'x-sdk-version': '1.4.6', + 'x-sdk-version': '1.4.7', 'X-Appwrite-Response-Format': '1.6.0', }; diff --git a/src/enums/message-priority.ts b/src/enums/message-priority.ts new file mode 100644 index 0000000..f3113a8 --- /dev/null +++ b/src/enums/message-priority.ts @@ -0,0 +1,4 @@ +export enum MessagePriority { + Normal = 'normal', + High = 'high', +} \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index ed9bb06..68c8a9e 100644 --- a/src/index.ts +++ b/src/index.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'; diff --git a/src/services/account.ts b/src/services/account.ts index 6d0f141..b625e88 100644 --- a/src/services/account.ts +++ b/src/services/account.ts @@ -115,6 +115,7 @@ export class Account { /** * List billing addresses * + * List all billing addresses for a user. * * @param {string[]} queries * @throws {AppwriteException} @@ -143,6 +144,7 @@ export class Account { /** * Create new billing address * + * Add a new billing address to a user's account. * * @param {string} country * @param {string} streetAddress @@ -203,6 +205,7 @@ export class Account { /** * Get billing address * + * Get a specific billing address for a user using it's ID. * * @param {string} billingAddressId * @throws {AppwriteException} @@ -231,6 +234,7 @@ export class Account { /** * Update billing address * + * Update a specific billing address using it's ID. * * @param {string} billingAddressId * @param {string} country @@ -295,6 +299,7 @@ export class Account { /** * Delete billing address * + * Delete a specific billing address using it's ID. * * @param {string} billingAddressId * @throws {AppwriteException} @@ -323,6 +328,7 @@ export class Account { /** * Get coupon details * + * Get coupon details for an account. * * @param {string} couponId * @throws {AppwriteException} @@ -450,6 +456,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * List invoices * + * List all invoices tied to an account. * * @param {string[]} queries * @throws {AppwriteException} @@ -695,9 +702,9 @@ This endpoint can also be used to convert an anonymous account to a normal one, * @param {string} challengeId * @param {string} otp * @throws {AppwriteException} - * @returns {Promise<{}>} + * @returns {Promise<Models.Session>} */ - async updateMfaChallenge(challengeId: string, otp: string): Promise<{}> { + async updateMfaChallenge(challengeId: string, otp: string): Promise<Models.Session> { if (typeof challengeId === 'undefined') { throw new AppwriteException('Missing required parameter: "challengeId"'); } @@ -897,6 +904,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * List payment methods * + * List payment methods for this account. * * @param {string[]} queries * @throws {AppwriteException} @@ -925,6 +933,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * Create new payment method * + * Create a new payment method for the current user account. * * @throws {AppwriteException} * @returns {Promise<Models.PaymentMethod>} @@ -949,6 +958,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * Get payment method * + * Get a specific payment method for the user. * * @param {string} paymentMethodId * @throws {AppwriteException} @@ -977,6 +987,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * Update payment method * + * Update a new payment method for the current user account. * * @param {string} paymentMethodId * @param {number} expiryMonth @@ -1019,6 +1030,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * Delete payment method * + * Delete a specific payment method from a user's account. * * @param {string} paymentMethodId * @throws {AppwriteException} @@ -1047,6 +1059,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * Update payment method provider id * + * Update payment method provider. * * @param {string} paymentMethodId * @param {string} providerMethodId @@ -1089,6 +1102,7 @@ This endpoint can also be used to convert an anonymous account to a normal one, /** * Update payment method with new setup with mandates for indian cards * + * Update payment method mandate options. * * @param {string} paymentMethodId * @throws {AppwriteException} @@ -1695,6 +1709,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about /** * Create push target * + * Use this endpoint to register a device for push notifications. Provide a target ID (custom or generated using ID.unique()), a device identifier (usually a device token), and optionally specify which provider should send notifications to this target. The target is automatically linked to the current session and includes device information like brand and model. * * @param {string} targetId * @param {string} identifier @@ -1737,6 +1752,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about /** * Update push target * + * Update the currently logged in user's push notification target. You can modify the target's identifier (device token) and provider ID (token, email, phone etc.). The target must exist and belong to the current user. If you change the provider ID, notifications will be sent through the new messaging provider instead. * * @param {string} targetId * @param {string} identifier @@ -1772,6 +1788,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about /** * Delete push target * + * Delete a push notification target for the currently logged in user. After deletion, the device will no longer receive push notifications. The target must exist and belong to the current user. * * @param {string} targetId * @throws {AppwriteException} diff --git a/src/services/assistant.ts b/src/services/assistant.ts index 8834118..5e72789 100644 --- a/src/services/assistant.ts +++ b/src/services/assistant.ts @@ -12,6 +12,7 @@ export class Assistant { /** * Ask query * + * Send a prompt to the AI assistant and receive a response. This endpoint allows you to interact with Appwrite's AI assistant by sending questions or prompts and receiving helpful responses in real-time through a server-sent events stream. * * @param {string} prompt * @throws {AppwriteException} diff --git a/src/services/backups.ts b/src/services/backups.ts index 2eb12e7..90443ec 100644 --- a/src/services/backups.ts +++ b/src/services/backups.ts @@ -12,6 +12,7 @@ export class Backups { /** * List archives * + * List all archives for a project. * * @param {string[]} queries * @throws {AppwriteException} @@ -40,6 +41,7 @@ export class Backups { /** * Create archive * + * Create a new archive asynchronously for a project. * * @param {string[]} services * @param {string} resourceId @@ -75,6 +77,7 @@ export class Backups { /** * Get backup archive * + * Get a backup archive using it's ID. * * @param {string} archiveId * @throws {AppwriteException} @@ -103,6 +106,7 @@ export class Backups { /** * Delete archive * + * Delete an existing archive for a project. * * @param {string} archiveId * @throws {AppwriteException} @@ -131,6 +135,7 @@ export class Backups { /** * List backup policies * + * List all policies for a project. * * @param {string[]} queries * @throws {AppwriteException} @@ -159,6 +164,7 @@ export class Backups { /** * Create backup policy * + * Create a new backup policy. * * @param {string} policyId * @param {string[]} services @@ -223,6 +229,7 @@ export class Backups { /** * Get backup policy * + * Get a backup policy using it's ID. * * @param {string} policyId * @throws {AppwriteException} @@ -251,6 +258,7 @@ export class Backups { /** * Update backup policy * + * Update an existing policy using it's ID. * * @param {string} policyId * @param {string} name @@ -295,6 +303,7 @@ export class Backups { /** * Delete backup policy * + * Delete a policy using it's ID. * * @param {string} policyId * @throws {AppwriteException} @@ -323,6 +332,7 @@ export class Backups { /** * Create restoration * + * Create and trigger a new restoration for a backup on a project. * * @param {string} archiveId * @param {string[]} services @@ -369,6 +379,7 @@ export class Backups { /** * List restorations * + * List all backup restorations for a project. * * @param {string[]} queries * @throws {AppwriteException} @@ -397,12 +408,13 @@ export class Backups { /** * Get backup restoration * + * Get the current status of a backup restoration. * * @param {string} restorationId * @throws {AppwriteException} - * @returns {Promise<Models.BackupArchive>} + * @returns {Promise<Models.BackupRestoration>} */ - async getRestoration(restorationId: string): Promise<Models.BackupArchive> { + async getRestoration(restorationId: string): Promise<Models.BackupRestoration> { if (typeof restorationId === 'undefined') { throw new AppwriteException('Missing required parameter: "restorationId"'); } diff --git a/src/services/console.ts b/src/services/console.ts index b362a78..cb9f9a5 100644 --- a/src/services/console.ts +++ b/src/services/console.ts @@ -12,6 +12,7 @@ export class Console { /** * Get campaign details * + * Recieve the details of a compaign using it's ID. * * @param {string} campaignId * @throws {AppwriteException} @@ -40,6 +41,7 @@ export class Console { /** * Get coupon details * + * Get the details of a coupon using it's coupon ID. * * @param {string} couponId * @throws {AppwriteException} @@ -68,6 +70,7 @@ export class Console { /** * Get plans * + * Return a list of all available plans. * * @throws {AppwriteException} * @returns {Promise<Models.BillingPlanList>} @@ -92,12 +95,13 @@ export class Console { /** * Create program membership * + * Create a new membership for an account to a program. * * @param {string} programId * @throws {AppwriteException} - * @returns {Promise<{}>} + * @returns {Promise<Models.Organization<Preferences>>} */ - async createProgramMembership(programId: string): Promise<{}> { + async createProgramMembership<Preferences extends Models.Preferences>(programId: string): Promise<Models.Organization<Preferences>> { if (typeof programId === 'undefined') { throw new AppwriteException('Missing required parameter: "programId"'); } @@ -120,6 +124,7 @@ export class Console { /** * Get Regions * + * Get all available regions for the console. * * @throws {AppwriteException} * @returns {Promise<Models.ConsoleRegionList>} @@ -144,6 +149,7 @@ export class Console { /** * Create source * + * Create a new source. * * @param {string} ref * @param {string} referrer diff --git a/src/services/databases.ts b/src/services/databases.ts index 0ff67d2..ac7aa4f 100644 --- a/src/services/databases.ts +++ b/src/services/databases.ts @@ -93,6 +93,7 @@ export class Databases { /** * Get databases usage stats * + * Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and 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 {DatabaseUsageRange} range * @throws {AppwriteException} @@ -2187,6 +2188,7 @@ Attributes can be `key`, `fulltext`, and `unique`. /** * Get collection usage stats * + * Get usage metrics and statistics for a collection. Returning the total number of documents. 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} databaseId * @param {string} collectionId @@ -2256,6 +2258,7 @@ Attributes can be `key`, `fulltext`, and `unique`. /** * Get database usage stats * + * Get usage metrics and statistics for a database. You can view the total number of collections, documents, and 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} databaseId * @param {DatabaseUsageRange} range diff --git a/src/services/functions.ts b/src/services/functions.ts index 5bce133..52c13be 100644 --- a/src/services/functions.ts +++ b/src/services/functions.ts @@ -291,6 +291,7 @@ export class Functions { /** * Get functions usage * + * Get usage metrics and statistics for a for all functions. View statistics including total functions, deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. 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, defaults to 30 days. * * @param {FunctionUsageRange} range * @throws {AppwriteException} @@ -669,6 +670,7 @@ Use the "command" param to set the entrypoint used to execute your cod /** * Rebuild deployment * + * Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build. * * @param {string} functionId * @param {string} deploymentId @@ -705,6 +707,7 @@ Use the "command" param to set the entrypoint used to execute your cod /** * Cancel deployment * + * Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details. * * @param {string} functionId * @param {string} deploymentId @@ -932,6 +935,7 @@ Use the "command" param to set the entrypoint used to execute your cod /** * Get function usage * + * Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. 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, defaults to 30 days. * * @param {string} functionId * @param {FunctionUsageRange} range diff --git a/src/services/health.ts b/src/services/health.ts index 28fd415..312cf96 100644 --- a/src/services/health.ts +++ b/src/services/health.ts @@ -192,6 +192,7 @@ export class Health { /** * Get billing aggregation queue * + * Get billing aggregation queue * * @param {number} threshold * @throws {AppwriteException} @@ -249,6 +250,7 @@ export class Health { /** * Get billing aggregation queue * + * Get the priority builds queue size. * * @param {number} threshold * @throws {AppwriteException} @@ -566,6 +568,35 @@ export class Health { } + return await this.client.call( + 'get', + uri, + apiHeaders, + payload + ); + } + /** + * Get usage count aggregation queue + * + * Get the usage count aggregation queue. + * + * @param {number} threshold + * @throws {AppwriteException} + * @returns {Promise<Models.HealthQueue>} + */ + async getQueueUsageCount(threshold?: number): Promise<Models.HealthQueue> { + const apiPath = '/health/queue/usage-count'; + const payload: Payload = {}; + if (typeof threshold !== 'undefined') { + payload['threshold'] = threshold; + } + const uri = new URL(this.client.config.endpoint + apiPath); + + const apiHeaders: { [header: string]: string } = { + 'content-type': 'application/json', + } + + return await this.client.call( 'get', uri, diff --git a/src/services/messaging.ts b/src/services/messaging.ts index d40f8e5..f0a3bbd 100644 --- a/src/services/messaging.ts +++ b/src/services/messaging.ts @@ -1,6 +1,7 @@ import { Service } from '../service'; import { AppwriteException, Client, type Payload, UploadProgress } from '../client'; import type { Models } from '../models'; +import { MessagePriority } from '../enums/message-priority'; import { SmtpEncryption } from '../enums/smtp-encryption'; export class Messaging { @@ -217,22 +218,19 @@ export class Messaging { * @param {string} sound * @param {string} color * @param {string} tag - * @param {string} badge + * @param {number} badge * @param {boolean} draft * @param {string} scheduledAt + * @param {boolean} contentAvailable + * @param {boolean} critical + * @param {MessagePriority} priority * @throws {AppwriteException} * @returns {Promise<Models.Message>} */ - async createPush(messageId: string, title: string, body: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message> { + async createPush(messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message> { if (typeof messageId === 'undefined') { throw new AppwriteException('Missing required parameter: "messageId"'); } - if (typeof title === 'undefined') { - throw new AppwriteException('Missing required parameter: "title"'); - } - if (typeof body === 'undefined') { - throw new AppwriteException('Missing required parameter: "body"'); - } const apiPath = '/messaging/messages/push'; const payload: Payload = {}; if (typeof messageId !== 'undefined') { @@ -283,6 +281,15 @@ export class Messaging { if (typeof scheduledAt !== 'undefined') { payload['scheduledAt'] = scheduledAt; } + if (typeof contentAvailable !== 'undefined') { + payload['contentAvailable'] = contentAvailable; + } + if (typeof critical !== 'undefined') { + payload['critical'] = critical; + } + if (typeof priority !== 'undefined') { + payload['priority'] = priority; + } const uri = new URL(this.client.config.endpoint + apiPath); const apiHeaders: { [header: string]: string } = { @@ -319,10 +326,13 @@ export class Messaging { * @param {number} badge * @param {boolean} draft * @param {string} scheduledAt + * @param {boolean} contentAvailable + * @param {boolean} critical + * @param {MessagePriority} priority * @throws {AppwriteException} * @returns {Promise<Models.Message>} */ - async updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string): Promise<Models.Message> { + async updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message> { if (typeof messageId === 'undefined') { throw new AppwriteException('Missing required parameter: "messageId"'); } @@ -373,6 +383,15 @@ export class Messaging { if (typeof scheduledAt !== 'undefined') { payload['scheduledAt'] = scheduledAt; } + if (typeof contentAvailable !== 'undefined') { + payload['contentAvailable'] = contentAvailable; + } + if (typeof critical !== 'undefined') { + payload['critical'] = critical; + } + if (typeof priority !== 'undefined') { + payload['priority'] = priority; + } const uri = new URL(this.client.config.endpoint + apiPath); const apiHeaders: { [header: string]: string } = { @@ -449,7 +468,7 @@ export class Messaging { /** * Update SMS * - * Update an email message by its unique ID. + * Update an SMS message by its unique ID. * * @param {string} messageId diff --git a/src/services/migrations.ts b/src/services/migrations.ts index b8331b8..eba7d80 100644 --- a/src/services/migrations.ts +++ b/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} diff --git a/src/services/organizations.ts b/src/services/organizations.ts index 79ad9a7..6326a9b 100644 --- a/src/services/organizations.ts +++ b/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 diff --git a/src/services/project.ts b/src/services/project.ts index 001cf53..42e69ea 100644 --- a/src/services/project.ts +++ b/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 diff --git a/src/services/projects.ts b/src/services/projects.ts index 7cd9f71..d903ca8 100644 --- a/src/services/projects.ts +++ b/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'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 diff --git a/src/services/proxy.ts b/src/services/proxy.ts index ce5bedf..1ac5014 100644 --- a/src/services/proxy.ts +++ b/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} diff --git a/src/services/storage.ts b/src/services/storage.ts index e91a5dc..e1896b5 100644 --- a/src/services/storage.ts +++ b/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 diff --git a/src/services/users.ts b/src/services/users.ts index be72801..9d5ee63 100644 --- a/src/services/users.ts +++ b/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"'); } diff --git a/src/services/vcs.ts b/src/services/vcs.ts index c29e3a8..580392f 100644 --- a/src/services/vcs.ts +++ b/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}