@appwrite.io/console 1.4.5 → 1.4.7

package/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

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